WordPress 4.3
[autoinstalls/wordpress.git] / wp-cron.php
index da2838cbda05d49272fc37415a76891f9dadefe6..15c6676b77976af549bfa470a5fd0a42fd43e937 100644 (file)
@@ -26,14 +26,25 @@ if ( !defined('ABSPATH') ) {
        require_once( dirname( __FILE__ ) . '/wp-load.php' );
 }
 
-// Uncached doing_cron transient fetch
+/**
+ * Retrieves the cron lock.
+ *
+ * Returns the uncached `doing_cron` transient.
+ *
+ * @ignore
+ * @since 3.3.0
+ *
+ * @return string|false Value of the `doing_cron` transient, 0|false otherwise.
+ */
 function _get_cron_lock() {
        global $wpdb;
 
        $value = 0;
        if ( wp_using_ext_object_cache() ) {
-               // Skip local cache and force refetch of doing_cron transient in case
-               // another processs updated the cache
+               /*
+                * Skip local cache and force re-fetch of doing_cron transient
+                * in case another process updated the cache.
+                */
                $value = wp_cache_get( 'doing_cron', 'transient', true );
        } else {
                $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", '_transient_doing_cron' ) );
@@ -53,7 +64,9 @@ $gmt_time = microtime( true );
 if ( isset($keys[0]) && $keys[0] > $gmt_time )
        die();
 
-$doing_cron_transient = get_transient( 'doing_cron');
+
+// The cron lock: a unix timestamp from when the cron was spawned.
+$doing_cron_transient = get_transient( 'doing_cron' );
 
 // Use global $doing_wp_cron lock otherwise use the GET lock. If no lock, trying grabbing a new lock.
 if ( empty( $doing_wp_cron ) ) {
@@ -68,7 +81,10 @@ if ( empty( $doing_wp_cron ) ) {
        }
 }
 
-// Check lock
+/*
+ * The cron lock (a unix timestamp set when the cron was spawned),
+ * must match $doing_wp_cron (the "key").
+ */
 if ( $doing_cron_transient != $doing_wp_cron )
        return;
 
@@ -92,10 +108,11 @@ foreach ( $crons as $timestamp => $cronhooks ) {
                        /**
                         * Fires scheduled events.
                         *
+                        * @ignore
                         * @since 2.1.0
                         *
                         * @param string $hook Name of the hook that was scheduled to be fired.
-                        * @param array $v['args'] The arguments to be passed to the hook.
+                        * @param array  $args The arguments to be passed to the hook.
                         */
                        do_action_ref_array( $hook, $v['args'] );