Changeset 47060 for trunk/src/wp-includes/cron.php

Timestamp:

01/11/2020 06:30:58 PM (13 months ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

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

trunk/src/wp-includes/cron.php

@@ -394 +394 @@
  * @param string $hook Action hook, the execution of which will be unscheduled.
  * @param array  $args Optional. Arguments that were to be passed to the hook's callback function.
- * @return false|int On success an integer indicating number of events unscheduled (0 indicates no
+ * @return int|false On success an integer indicating number of events unscheduled (0 indicates no
  *                   events were registered with the hook and arguments combination), false if
  *                   unscheduling one or more events fail.
@@ -462 +462 @@
  *
  * @param string $hook Action hook, the execution of which will be unscheduled.
- * @return false|int On success an integer indicating number of events unscheduled (0 indicates no
+ * @return int|false On success an integer indicating number of events unscheduled (0 indicates no
  *                   events were registered on the hook), false if unscheduling fails.
  */
@@ -529 +529 @@
  *                            event, so they should be the same as those used when originally scheduling the event.
  * @param int|null $timestamp Optional. Unix timestamp (UTC) of the event. If not specified, the next scheduled event is returned.
- * @return false|object The event object. False if the event does not exist.
+ * @return object|false The event object. False if the event does not exist.
  */
 function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {
@@ -607 +607 @@
  *                     Although not passed to a callback, these arguments are used to uniquely identify the
  *                     event, so they should be the same as those used when originally scheduling the event.
- * @return false|int The Unix timestamp of the next time the event will occur. False if the event doesn't exist.
+ * @return int|false The Unix timestamp of the next time the event will occur. False if the event doesn't exist.
  */
 function wp_next_scheduled( $hook, $args = array() ) {
@@ -927 +927 @@
  * @access private
  *
- * @return false|array CRON info array.
+ * @return array|false CRON info array.
  */
 function _get_cron_array() {