WordPress.org

Make WordPress Core

Changeset 50174


Ignore:
Timestamp:
02/03/2021 10:56:39 AM (10 months ago)
Author:
SergeyBiryukov
Message:

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

Follow-up to [50143].

See #49961.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/cron.php

    r50152 r50174  
    530530 * @since 5.1.0 Return value modified to indicate success or failure,
    531531 *              {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.
    532  *
    533  * @param string $hook Action hook, the execution of which will be unscheduled.
    534  * @param array  $args Optional. Array containing each separate argument to pass to the hook's callback function.
    535  *                     Although not passed to a callback, these arguments are used to uniquely identify the
    536  *                     event, so they should be the same as those used when originally scheduling the event.
    537  * @param bool   $wp_error  Optional. Whether to return a WP_Error on failure. Default false.
     532 * @since 5.7.0 The `$wp_error` parameter was added.
     533 *
     534 * @param string $hook     Action hook, the execution of which will be unscheduled.
     535 * @param array  $args     Optional. Array containing each separate argument to pass to the hook's callback function.
     536 *                         Although not passed to a callback, these arguments are used to uniquely identify the
     537 *                         event, so they should be the same as those used when originally scheduling the event.
     538 * @param bool   $wp_error Optional. Whether to return a WP_Error on failure. Default false.
    538539 * @return int|false|WP_Error On success an integer indicating number of events unscheduled (0 indicates no
    539540 *                            events were registered with the hook and arguments combination), false or WP_Error
Note: See TracChangeset for help on using the changeset viewer.