wpseek.com
A WordPress-centric search engine for devs and theme authors
wp_unschedule_event › WordPress Function
Since2.1.0
Deprecatedn/a
› wp_unschedule_event ( $timestamp, $hook, $args = array() )
Parameters: (3) |
|
Returns: |
|
Defined at: |
|
Codex: | |
Change Log: |
|
Unschedule a previously scheduled event.
The $timestamp and $hook parameters are required so that the event can be identified.Related Functions: wp_schedule_event, wp_reschedule_event, wp_get_scheduled_event, wp_schedule_single_event, wp_scheduled_delete
Source
function wp_unschedule_event( $timestamp, $hook, $args = array() ) { // Make sure timestamp is a positive integer. if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) { return false; } /** * Filter to preflight or hijack unscheduling of events. * * Returning a non-null value will short-circuit the normal unscheduling * process, causing the function to return the filtered value instead. * * For plugins replacing wp-cron, return true if the event was successfully * unscheduled, false if not. * * @since 5.1.0 * * @param null|bool $pre Value to return instead. Default null to continue unscheduling the event. * @param int $timestamp Timestamp for when to run the event. * @param string $hook Action hook, the execution of which will be unscheduled. * @param array $args Arguments to pass to the hook's callback function. */ $pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args ); if ( null !== $pre ) { return $pre; } $crons = _get_cron_array(); $key = md5( serialize( $args ) ); unset( $crons[ $timestamp ][ $hook ][ $key ] ); if ( empty( $crons[ $timestamp ][ $hook ] ) ) { unset( $crons[ $timestamp ][ $hook ] ); } if ( empty( $crons[ $timestamp ] ) ) { unset( $crons[ $timestamp ] ); } return _set_cron_array( $crons ); }