WordPress.org

Make WordPress Core


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/cron.php

    r46232 r47060  
    394394 * @param string $hook Action hook, the execution of which will be unscheduled.
    395395 * @param array  $args Optional. Arguments that were to be passed to the hook's callback function.
    396  * @return false|int On success an integer indicating number of events unscheduled (0 indicates no
     396 * @return int|false On success an integer indicating number of events unscheduled (0 indicates no
    397397 *                   events were registered with the hook and arguments combination), false if
    398398 *                   unscheduling one or more events fail.
     
    462462 *
    463463 * @param string $hook Action hook, the execution of which will be unscheduled.
    464  * @return false|int On success an integer indicating number of events unscheduled (0 indicates no
     464 * @return int|false On success an integer indicating number of events unscheduled (0 indicates no
    465465 *                   events were registered on the hook), false if unscheduling fails.
    466466 */
     
    529529 *                            event, so they should be the same as those used when originally scheduling the event.
    530530 * @param int|null $timestamp Optional. Unix timestamp (UTC) of the event. If not specified, the next scheduled event is returned.
    531  * @return false|object The event object. False if the event does not exist.
     531 * @return object|false The event object. False if the event does not exist.
    532532 */
    533533function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {
     
    607607 *                     Although not passed to a callback, these arguments are used to uniquely identify the
    608608 *                     event, so they should be the same as those used when originally scheduling the event.
    609  * @return false|int The Unix timestamp of the next time the event will occur. False if the event doesn't exist.
     609 * @return int|false The Unix timestamp of the next time the event will occur. False if the event doesn't exist.
    610610 */
    611611function wp_next_scheduled( $hook, $args = array() ) {
     
    927927 * @access private
    928928 *
    929  * @return false|array CRON info array.
     929 * @return array|false CRON info array.
    930930 */
    931931function _get_cron_array() {
Note: See TracChangeset for help on using the changeset viewer.