sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Cron API: Introduce wp_unschedule_hook() to clear all events attached to a hook.

Browse Source 
This complements `wp_clear_scheduled_hook()`, which only clears events attached with specific arguments.

Props arena, mordauk, jrf.
Fixes #18997.

git-svn-id: https://develop.svn.wordpress.org/trunk@40965 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2017-06-30 00:21:49 +00:00
parent a970c07994
commit 21a6c7b050
2 changed files with 45 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/wp-includes/cron.php
View File

@ -191,7 +191,7 @@ function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
}
/**
* Unschedule all events attached to the specified hook.
* Unschedule all events attached to the hook with the specified arguments.
*
* @since 2.1.0
*
@ -221,6 +221,29 @@ function wp_clear_scheduled_hook( $hook, $args = array() ) {
}
}
/**
* Unschedule all events attached to the hook.
*
* Can be useful for plugins when deactivating to clean up the cron queue.
*
* @since 4.9.0
*
* @param string $hook Action hook, the execution of which will be unscheduled.
*/
function wp_unschedule_hook( $hook ) {
$crons = _get_cron_array();
foreach( $crons as $timestamp => $args ) {
unset( $crons[ $timestamp ][ $hook ] );
if ( empty( $crons[ $timestamp ] ) ) {
unset( $crons[ $timestamp ] );
}
}
_set_cron_array( $crons );
}
/**
* Retrieve the next timestamp for an event.
*

21
tests/phpunit/tests/cron.php
View File

@ -186,7 +186,28 @@ class Tests_Cron extends WP_UnitTestCase {
// wp_clear_scheduled_hook() should take args as an array like the other functions and does from WP 3.0
wp_clear_scheduled_hook($multi_hook, $multi_args);
$this->assertFalse( wp_next_scheduled($multi_hook, $multi_args) );
}
/**
* @ticket 18997
*/
function test_unschedule_hook() {
$hook = __FUNCTION__;
$args = array( rand_str() );
// schedule several events with and without arguments.
wp_schedule_single_event( strtotime( '+1 hour' ), $hook );
wp_schedule_single_event( strtotime( '+2 hour' ), $hook );
wp_schedule_single_event( strtotime( '+3 hour' ), $hook, $args );
wp_schedule_single_event( strtotime( '+4 hour' ), $hook, $args );
// make sure they're returned by wp_next_scheduled().
$this->assertTrue( wp_next_scheduled( $hook ) > 0 );
$this->assertTrue( wp_next_scheduled( $hook, $args ) > 0 );
// clear the schedule and make sure it's gone.
wp_unschedule_hook( $hook );
$this->assertFalse( wp_next_scheduled( $hook ) );
}
/**