Changeset 26267

Timestamp:

11/19/2013 05:00:39 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/cron.php.

Props tmtoy for the initial patch.
Fixes #25475.

File:

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

trunk/src/wp-includes/cron.php

@@ -28 +28 @@
     $crons = _get_cron_array();
     $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
-    $event = apply_filters('schedule_event', $event);
+    /**
+     * Filter a single event before it is scheduled.
+     *
+     * @since 3.1.0
+     *
+     * @param object $event An object containing an event's data.
+     */
+    $event = apply_filters( 'schedule_event', $event );
 
     // A plugin disallowed this event
@@ -69 +76 @@
 
     $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
-    $event = apply_filters('schedule_event', $event);
+    /** This filter is documented in wp-includes/cron.php */
+    $event = apply_filters( 'schedule_event', $event );
 
     // A plugin disallowed this event
@@ -245 +253 @@
     set_transient( 'doing_cron', $doing_wp_cron );
 
+    /**
+     * Filter the cron request arguments.
+     *
+     * @since 3.5.0
+     *
+     * @param array $cron_request_array {
+     *     An array of cron request URL arguments.
+     *
+     *     @type string $url  The cron request URL.
+     *     @type int    $key  The 22 digit GMT microtime.
+     *     @type array  $args {
+     *         An array of cron request arguments.
+     *
+     *         @type int  $timeout   The request timeout in seconds. Default .01 seconds.
+     *         @type bool $blocking  Whether to set blocking for the request. Default false.
+     *         @type bool $sslverify Whether to sslverify. Default true.
+     *     }
+     * }
+     */
     $cron_request = apply_filters( 'cron_request', array(
-        'url' => site_url( 'wp-cron.php?doing_wp_cron=' . $doing_wp_cron ),
-        'key' => $doing_wp_cron,
-        'args' => array( 'timeout' => 0.01, 'blocking' => false, 'sslverify' => apply_filters( 'https_local_ssl_verify', true ) )
+        'url'  => add_query_arg( array( 'doing_wp_cron', $doing_wp_cron ), site_url( 'wp-cron.php' ) ),
+        'key'  => $doing_wp_cron,
+        'args' => array(
+            'timeout'   => 0.01,
+            'blocking'  => false,
+            /** This filter is documented in wp-includes/class-http.php */
+            'sslverify' => apply_filters( 'https_local_ssl_verify', true )
+        )
     ) );
 
@@ -323 +355 @@
         'daily'      => array( 'interval' => DAY_IN_SECONDS,       'display' => __( 'Once Daily' ) ),
     );
+    /**
+     * Filter the non-default cron schedules.
+     *
+     * @since 2.1.0
+     *
+     * @param array $new_schedules An array of non-default cron schedules. Default empty.
+     */
     return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );
 }