Changeset 32588

Timestamp:

05/24/2015 09:10:00 PM (9 years ago)

Author:

wonderboymusic

Message:

Alter some @return doc blocks for cron.php.

See #32444.

File:

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

trunk/src/wp-includes/cron.php

@@ -19 +19 @@
  * @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()) {
@@ -67 +68 @@
  * @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()) {
@@ -100 +101 @@
  * @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() ) {
@@ -196 +197 @@
  * @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() ) {
@@ -214 +215 @@
  *
  * @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 );
@@ -311 +309 @@
  *
  * @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 ) )
@@ -393 +388 @@
  * @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()) {
@@ -417 +412 @@
  * @access private
  *
- * @return array CRON info array.
+ * @return false|array CRON info array.
  */
 function _get_cron_array()  {