Changeset 55170

Timestamp:

01/31/2023 05:48:45 PM (21 months ago)

Author:

johnbillion

Message:

Cron API: Improve the docs for some cron event and cron schedule related functions.

See #56792

File:

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

trunk/src/wp-includes/cron.php

@@ -438 +438 @@
 
 /**
- * Unschedule a previously scheduled event.
- *
- * The $timestamp and $hook parameters are required so that the event can be
+ * Unschedules a previously scheduled event.
+ *
+ * The `$timestamp` and `$hook` parameters are required so that the event can be
  * identified.
  *
@@ -709 +709 @@
 
 /**
- * Retrieve a scheduled event.
- *
- * Retrieve the full event object for a given event, if no timestamp is specified the next
+ * Retrieves a scheduled event.
+ *
+ * Retrieves the full event object for a given event, if no timestamp is specified the next
  * scheduled event is returned.
  *
@@ -793 +793 @@
 
 /**
- * Retrieve the next timestamp for an event.
+ * Retrieves the next timestamp for an event.
  *
  * @since 2.1.0
@@ -925 +925 @@
 
 /**
- * Register _wp_cron() to run on the {@see 'wp_loaded'} action.
+ * Registers _wp_cron() to run on the {@see 'wp_loaded'} action.
  *
  * If the {@see 'wp_loaded'} action has already fired, this function calls
@@ -952 +952 @@
 
 /**
- * Run scheduled callbacks or spawn cron for all scheduled events.
+ * Runs scheduled callbacks or spawns cron for all scheduled events.
  *
  * Warning: This function may return Boolean FALSE, but may also return a non-Boolean
@@ -1004 +1004 @@
 
 /**
- * Retrieve supported event recurrence schedules.
+ * Retrieves supported event recurrence schedules.
  *
  * The default supported recurrences are 'hourly', 'twicedaily', 'daily', and 'weekly'.
@@ -1031 +1031 @@
  * @since 5.4.0 The 'weekly' schedule was added.
  *
- * @return array[]
+ * @return array {
+ *     The array of cron schedules keyed by the schedule name.
+ *
+ *     @type array ...$0 {
+ *         Cron schedule information.
+ *
+ *         @type int    $interval The schedule interval in seconds.
+ *         @type string $display  The schedule display name.
+ *     }
+ * }
  */
 function wp_get_schedules() {
@@ -1058 +1067 @@
      * @since 2.1.0
      *
-     * @param array[] $new_schedules An array of non-default cron schedule arrays. Default empty.
+     * @param array $new_schedules {
+     *     An array of non-default cron schedules keyed by the schedule name. Default empty array.
+     *
+     *     @type array ...$0 {
+     *         Cron schedule information.
+     *
+     *         @type int    $interval The schedule interval in seconds.
+     *         @type string $display  The schedule display name.
+     *     }
+     * }
      */
     return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );
@@ -1064 +1082 @@
 
 /**
- * Retrieve the recurrence schedule for an event.
+ * Retrieves the name of the recurrence schedule for an event.
  *
  * @see wp_get_schedules() for available schedules.
@@ -1085 +1103 @@
 
     /**
-     * Filters the schedule for a hook.
+     * Filters the schedule name for a hook.
      *
      * @since 5.1.0
@@ -1097 +1115 @@
 
 /**
- * Retrieve cron jobs ready to be run.
+ * Retrieves cron jobs ready to be run.
  *
  * Returns the results of _get_cron_array() limited to events ready to be run,
@@ -1144 +1162 @@
 
 /**
- * Retrieve cron info array option.
+ * Retrieves cron info array option.
  *
  * @since 2.1.0
@@ -1199 +1217 @@
 
 /**
- * Upgrade a cron info array.
+ * Upgrades a cron info array.
  *
  * This function upgrades the cron info array to version 2.