From 7d0367b8516cb002e4fd49f50ebbf0fca8121f35 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 3 Feb 2021 10:56:39 +0000 Subject: [PATCH] Docs: Add a `@since` note to `wp_clear_scheduled_hook()` for the `$wp_error` parameter. Follow-up to [50143]. See #49961. git-svn-id: https://develop.svn.wordpress.org/trunk@50174 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/cron.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/cron.php b/src/wp-includes/cron.php index c0c9664ca4..516c20d287 100644 --- a/src/wp-includes/cron.php +++ b/src/wp-includes/cron.php @@ -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.