Changeset 49357

Timestamp:

10/28/2020 06:35:14 PM (4 years ago)

Author:

johnbillion

Message:

Cron API: Improve the inline documentation for the args passed to the cron event scheduling functions.

Props chadreitsma, peterwilsoncc

Fixes #51605

File:

• trunk/src/wp-includes/cron.php (modified) (4 diffs)

trunk/src/wp-includes/cron.php

@@ -29 +29 @@
  * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.
  * @param string $hook       Action hook to execute when the event is run.
- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
+ * @param array  $args       Optional. Array containing arguments to pass to the
+ *                           hook's callback function. Each value in the array is passed
+ *                           to the callback as an individual parameter. The array keys
+ *                           are ignored. Default: empty array.
  * @return bool True if event successfully scheduled. False for failure.
  */
@@ -181 +184 @@
  *
  * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.
- * @param string $recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.
+ * @param string $recurrence How often the event should subsequently recur.
+ *                           See wp_get_schedules() for accepted values.
  * @param string $hook       Action hook to execute when the event is run.
- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
+ * @param array  $args       Optional. Array containing arguments to pass to the
+ *                           hook's callback function. Each value in the array is passed
+ *                           to the callback as an individual parameter. The array keys
+ *                           are ignored. Default: empty array.
  * @return bool True if event successfully scheduled. False for failure.
  */
@@ -246 +253 @@
  *
  * @param int    $timestamp  Unix timestamp (UTC) for when the event was scheduled.
- * @param string $recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.
+ * @param string $recurrence How often the event should subsequently recur.
+ *                           See wp_get_schedules() for accepted values.
  * @param string $hook       Action hook to execute when the event is run.
- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
+ * @param array  $args       Optional. Array containing arguments to pass to the
+ *                           hook's callback function. Each value in the array is passed
+ *                           to the callback as an individual parameter. The array keys
+ *                           are ignored. Default: empty array.
  * @return bool True if event successfully rescheduled. False for failure.
  */
@@ -393 +404 @@
  *
  * @param string $hook Action hook, the execution of which will be unscheduled.
- * @param array  $args Optional. Arguments that were to be passed to the hook's callback function.
+ * @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.
  * @return int|false On success an integer indicating number of events unscheduled (0 indicates no
  *                   events were registered with the hook and arguments combination), false if