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

Timestamp:

02/07/2023 09:19:46 PM (2 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous improvements and corrections to docblocks.

See #56792

File:

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

trunk/src/wp-includes/cron.php

@@ -78 +78 @@
      *
      * @param null|bool|WP_Error $result   The value to return instead. Default null to continue adding the event.
-     * @param stdClass           $event    {
+     * @param object             $event    {
      *     An object containing an event's data.
      *
@@ -85 +85 @@
      *     @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 int          $interval  Optional. The interval time in seconds for the schedule. Only present for recurring events.
      * }
      * @param bool               $wp_error Whether to return a WP_Error on failure.
@@ -165 +165 @@
      * @since 3.1.0
      *
-     * @param stdClass|false $event {
+     * @param object|false $event {
      *     An object containing an event's data, or boolean false to prevent the event from being scheduled.
      *
@@ -172 +172 @@
      *     @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 int          $interval  Optional. The interval time in seconds for the schedule. Only present for recurring events.
      * }
      */
@@ -386 +386 @@
      *
      * @param null|bool|WP_Error $pre      Value to return instead. Default null to continue adding the event.
-     * @param stdClass           $event    {
+     * @param object             $event    {
      *     An object containing an event's data.
      *
@@ -723 +723 @@
  * @param int|null $timestamp Optional. Unix timestamp (UTC) of the event. If not specified, the next scheduled event
  *                            is returned. Default null.
- * @return object|false The event object. False if the event does not exist.
+ * @return object|false {
+ *     The event object. False if the event does not exist.
+ *
+ *     @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  Optional. The interval time in seconds for the schedule. Only present for recurring events.
+ * }
  */
 function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {