WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / cron.php
index 4b755068ab98cf6f4f97771256d25a8f47f0020a..8b88c1220be96e42b22aa8a53968588e0d82537c 100644 (file)
@@ -18,6 +18,7 @@
  * @param int $timestamp Timestamp for when to run the event.
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
+ * @return void|false
  */
 function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
        // don't schedule a duplicate if there's already an identical event due within 10 minutes of it
@@ -66,7 +67,7 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
  * @param string $recurrence How often the event should recur.
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return false|null False on failure, null when complete with scheduling event.
+ * @return false|void False when does not schedule event.
  */
 function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
        $crons = _get_cron_array();
@@ -99,7 +100,7 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
  * @param string $recurrence How often the event should recur.
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return false|null False on failure. Null when event is rescheduled.
+ * @return false|void False when does not schedule event.
  */
 function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
        $crons = _get_cron_array();
@@ -195,7 +196,7 @@ function wp_clear_scheduled_hook( $hook, $args = array() ) {
  *
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return bool|int The UNIX timestamp of the next time the scheduled event will occur.
+ * @return false|int The UNIX timestamp of the next time the scheduled event will occur.
  */
 function wp_next_scheduled( $hook, $args = array() ) {
        $crons = _get_cron_array();
@@ -213,11 +214,8 @@ function wp_next_scheduled( $hook, $args = array() ) {
  * Send request to run cron through HTTP request that doesn't halt page loading.
  *
  * @since 2.1.0
- *
- * @return null Cron could not be spawned, because it is not needed to run.
  */
 function spawn_cron( $gmt_time = 0 ) {
-
        if ( ! $gmt_time )
                $gmt_time = microtime( true );
 
@@ -225,9 +223,12 @@ function spawn_cron( $gmt_time = 0 ) {
                return;
 
        /*
-       * multiple processes on multiple web servers can run this code concurrently
-       * try to make this as atomic as possible by setting doing_cron switch
-       */
+        * Get the cron lock, which is a unix timestamp of when the last cron was spawned
+        * and has not finished running.
+        *
+        * Multiple processes on multiple web servers can run this code concurrently,
+        * this lock attempts to make spawning as atomic as possible.
+        */
        $lock = get_transient('doing_cron');
 
        if ( $lock > $gmt_time + 10 * MINUTE_IN_SECONDS )
@@ -266,6 +267,7 @@ function spawn_cron( $gmt_time = 0 ) {
                return;
        }
 
+       // Set the cron lock with the current unix timestamp, when the cron is being spawned.
        $doing_wp_cron = sprintf( '%.22F', $gmt_time );
        set_transient( 'doing_cron', $doing_wp_cron );
 
@@ -306,11 +308,8 @@ function spawn_cron( $gmt_time = 0 ) {
  * Run scheduled callbacks or spawn cron for all scheduled events.
  *
  * @since 2.1.0
- *
- * @return null When doesn't need to run Cron.
  */
 function wp_cron() {
-
        // Prevent infinite loops caused by lack of wp-cron.php
        if ( strpos($_SERVER['REQUEST_URI'], '/wp-cron.php') !== false || ( defined('DISABLE_WP_CRON') && DISABLE_WP_CRON ) )
                return;
@@ -388,7 +387,7 @@ function wp_get_schedules() {
  *
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return string|bool False, if no schedule. Schedule on success.
+ * @return string|false False, if no schedule. Schedule on success.
  */
 function wp_get_schedule($hook, $args = array()) {
        $crons = _get_cron_array();
@@ -412,7 +411,7 @@ function wp_get_schedule($hook, $args = array()) {
  * @since 2.1.0
  * @access private
  *
- * @return array CRON info array.
+ * @return false|array CRON info array.
  */
 function _get_cron_array()  {
        $cron = get_option('cron');