Wordpress 4.6

[autoinstalls/wordpress.git] / wp-includes / cron.php

diff --git a/wp-includes/cron.php b/wp-includes/cron.php
index 60492c5d045a97391afe096989c4aeb675250592..a4d160f70c75f5c4846221144207f08b7cae6a9e 100644 (file)
--- a/wp-includes/cron.php
+++ b/wp-includes/cron.php
@@ -12,6 +12,10 @@
  * a time which you specify. The action will fire off when someone visits your
  * WordPress site, if the schedule time has passed.
  *
+ * Note that scheduling an event to occur within 10 minutes of an existing event
+ * with the same action hook will be ignored, unless you pass unique `$args` values
+ * for each scheduled event.
+ *
  * @since 2.1.0
  * @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
  *
@@ -35,7 +39,7 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
        $crons = _get_cron_array();
        $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
        /**
-        * Filter a single event before it is scheduled.
+        * Filters a single event before it is scheduled.
         *
         * @since 3.1.0
         *
@@ -62,7 +66,7 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
  * visits your WordPress site, if the scheduled time has passed.
  *
  * Valid values for the recurrence are hourly, daily and twicedaily. These can
- * be extended using the cron_schedules filter in wp_get_schedules().
+ * be extended using the {@see 'cron_schedules'} filter in wp_get_schedules().
  *
  * Use wp_next_scheduled() to prevent duplicates
  *
@@ -191,7 +195,7 @@ function wp_clear_scheduled_hook( $hook, $args = array() ) {
        // Backward compatibility
        // Previously this function took the arguments as discrete vars rather than an array like the rest of the API
        if ( !is_array($args) ) {
-               _deprecated_argument( __FUNCTION__, '3.0', __('This argument has changed to an array to match the behavior of the other cron functions.') );
+               _deprecated_argument( __FUNCTION__, '3.0.0', __('This argument has changed to an array to match the behavior of the other cron functions.') );
                $args = array_slice( func_get_args(), 1 );
        }
 
@@ -232,9 +236,11 @@ function wp_next_scheduled( $hook, $args = array() ) {
 }
 
 /**
- * Send request to run cron through HTTP request that doesn't halt page loading.
+ * Sends a request to run cron through HTTP request that doesn't halt page loading.
  *
  * @since 2.1.0
+ *
+ * @param int $gmt_time Optional. Unix timestamp. Default 0 (current time is used).
  */
 function spawn_cron( $gmt_time = 0 ) {
        if ( ! $gmt_time )
@@ -293,9 +299,10 @@ function spawn_cron( $gmt_time = 0 ) {
        set_transient( 'doing_cron', $doing_wp_cron );
 
        /**
-        * Filter the cron request arguments.
+        * Filters the cron request arguments.
         *
         * @since 3.5.0
+        * @since 4.5.0 The `$doing_wp_cron` parameter was added.
         *
         * @param array $cron_request_array {
         *     An array of cron request URL arguments.
@@ -310,6 +317,7 @@ function spawn_cron( $gmt_time = 0 ) {
         *         @type bool $sslverify Whether SSL should be verified for the request. Default false.
         *     }
         * }
+        * @param string $doing_wp_cron The unix timestamp of the cron lock.
         */
        $cron_request = apply_filters( 'cron_request', array(
                'url'  => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ),
@@ -320,7 +328,7 @@ function spawn_cron( $gmt_time = 0 ) {
                        /** This filter is documented in wp-includes/class-wp-http-streams.php */
                        'sslverify' => apply_filters( 'https_local_ssl_verify', false )
                )
-       ) );
+       ), $doing_wp_cron );
 
        wp_remote_post( $cron_request['url'], $cron_request['args'] );
 }
@@ -359,7 +367,7 @@ function wp_cron() {
  * Retrieve supported and filtered Cron recurrences.
  *
  * The supported recurrences are 'hourly' and 'daily'. A plugin may add more by
- * hooking into the 'cron_schedules' filter. The filter accepts an array of
+ * hooking into the {@see 'cron_schedules'} filter. The filter accepts an array of
  * arrays. The outer array has a key that is the name of the schedule or for
  * example 'weekly'. The value is an array with two keys, one is 'interval' and
  * the other is 'display'.
@@ -392,7 +400,7 @@ function wp_get_schedules() {
                'daily'      => array( 'interval' => DAY_IN_SECONDS,       'display' => __( 'Once Daily' ) ),
        );
        /**
-        * Filter the non-default cron schedules.
+        * Filters the non-default cron schedules.
         *
         * @since 2.1.0
         *
@@ -453,7 +461,7 @@ function _get_cron_array()  {
  * @since 2.1.0
  * @access private
  *
- * @param array $cron Cron info array from {@link _get_cron_array()}.
+ * @param array $cron Cron info array from _get_cron_array().
  */
 function _set_cron_array($cron) {
        $cron['version'] = 2;
@@ -468,7 +476,7 @@ function _set_cron_array($cron) {
  * @since 2.1.0
  * @access private
  *
- * @param array $cron Cron info array from {@link _get_cron_array()}.
+ * @param array $cron Cron info array from _get_cron_array().
  * @return array An upgraded Cron info array.
  */
 function _upgrade_cron_array($cron) {