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

Timestamp:

09/20/2022 08:30:03 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various improvements and corrections to inline docs.

See #55646

File:

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

trunk/src/wp-includes/cron.php

@@ -378 +378 @@
 
         /**
-         * Filter to preflight or hijack rescheduling of events.
+         * Filter to preflight or hijack rescheduling of a recurring event.
          *
          * Returning a non-null value will short-circuit the normal rescheduling
@@ -393 +393 @@
          *     An object containing an event's data.
          *
-         *     @type string       $hook      Action hook to execute when the event is run.
-         *     @type int          $timestamp Unix timestamp (UTC) for when to next run the event.
-         *     @type string|false $schedule  How often the event should subsequently recur.
-         *     @type array        $args      Array containing each separate argument to pass to the hook's callback function.
-         *     @type int          $interval  The interval time in seconds for the schedule. Only present for recurring events.
+         *     @type string $hook      Action hook to execute when the event is run.
+         *     @type int    $timestamp Unix timestamp (UTC) for when to next run the event.
+         *     @type string $schedule  How often the event should subsequently recur.
+         *     @type array  $args      Array containing each separate argument to pass to the hook's callback function.
+         *     @type int    $interval  The interval time in seconds for the schedule.
          * }
          * @param bool               $wp_error Whether to return a WP_Error on failure.