Changeset 50174 for trunk/src/wp-includes/cron.php

Timestamp:

02/03/2021 10:56:39 AM (5 years 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:

• trunk/src/wp-includes/cron.php (modified) (1 diff)

trunk/src/wp-includes/cron.php

@@ -530 +530 @@
  * @since 5.1.0 Return value modified to indicate success or failure,
  *              {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.
- *
- * @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.
+ * @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.
  * @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