Skip to content

Add debug output for cron event arguments #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 5 commits into from
Dec 12, 2025
Merged

Add debug output for cron event arguments #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2b7ef51
Initial plan
Copilot Nov 1, 2025
537e849
Add debug output for cron event arguments
Copilot Nov 1, 2025
2077acd
Fix PHPCS error and correct test assertion format
Copilot Nov 1, 2025
f0d8705
Fix test to check STDERR for debug output
Copilot Nov 1, 2025
e89c03c
Merge branch 'main' into copilot/add-cron-arguments-logging
swissspidy Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions features/cron-event.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,31 @@ Feature: Manage WP Cron events
"""
LOG A SHUTDOWN FROM ERROR
"""

Scenario: Run cron event with arguments and debug output
When I run `wp cron event schedule wp_cli_test_event_with_args now --0=123 --1=test-value`
Then STDOUT should contain:
"""
Success: Scheduled event with hook 'wp_cli_test_event_with_args'
"""

When I try `wp cron event run wp_cli_test_event_with_args --due-now --debug=cron`
Then STDOUT should contain:
"""
Executed the cron event 'wp_cli_test_event_with_args'
"""
And STDERR should contain:
"""
Debug: Arguments: ["123","test-value"]
"""

When I run `wp cron event schedule wp_cli_test_event_no_args now`
And I try `wp cron event run wp_cli_test_event_no_args --due-now --debug=cron`
Then STDOUT should contain:
"""
Executed the cron event 'wp_cli_test_event_no_args'
"""
And STDERR should not contain:
"""
Debug: Arguments:
"""
3 changes: 3 additions & 0 deletions src/Cron_Event_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,9 @@ public function run( $args, $assoc_args ) {
$total = round( microtime( true ) - $start, 3 );
++$executed;
WP_CLI::log( sprintf( "Executed the cron event '%s' in %ss.", $event->hook, $total ) );
if ( ! empty( $event->args ) ) {
WP_CLI::debug( sprintf( 'Arguments: %s', wp_json_encode( $event->args ) ), 'cron' );
}
}

$message = ( 1 === $executed ) ? 'Executed a total of %d cron event.' : 'Executed a total of %d cron events.';
Expand Down