vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Add a @since note to wp_clear_scheduled_hook() for the $wp_error parameter.

Browse Source 
Follow-up to [50143].

See #49961.

git-svn-id: https://develop.svn.wordpress.org/trunk@50174 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2021-02-03 10:56:39 +00:00
parent 3c3590103a
commit 7d0367b851
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -529,12 +529,13 @@ function wp_unschedule_event( $timestamp, $hook, $args = array(), $wp_error = fa
* @since 2.1.0
* @since 5.1.0 Return value modified to indicate success or failure,
* {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.
* @since 5.7.0 The `$wp_error` parameter was added.
*
* @param string $hook Action hook, the execution of which will be unscheduled.
* @param array $args Optional. Array containing each separate argument to pass to the hook's callback function.
* Although not passed to a callback, these arguments are used to uniquely identify the
* event, so they should be the same as those used when originally scheduling the event.
* @param bool $wp_error Optional. Whether to return a WP_Error on failure. Default false.
* @param string $hook Action hook, the execution of which will be unscheduled.
* @param array $args Optional. Array containing each separate argument to pass to the hook's callback function.
* Although not passed to a callback, these arguments are used to uniquely identify the
* event, so they should be the same as those used when originally scheduling the event.
* @param bool $wp_error Optional. Whether to return a WP_Error on failure. Default false.
* @return int|false|WP_Error On success an integer indicating number of events unscheduled (0 indicates no
* events were registered with the hook and arguments combination), false or WP_Error
* if unscheduling one or more events fail.