WordPress.org

Make WordPress Core


Ignore:
Timestamp:
09/21/2019 05:40:58 PM (2 months ago)
Author:
johnbillion
Message:

Docs: Docblock corrections and improvements, mostly related to various pre_* filters.

See #47110

File:
1 edited

Legend:

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

    r45674 r46232  
    393393 *
    394394 * @param string $hook Action hook, the execution of which will be unscheduled.
    395  * @param array $args Optional. Arguments that were to be passed to the hook's callback function.
    396  * @return bool|int On success an integer indicating number of events unscheduled (0 indicates no
    397  *                  events were registered with the hook and arguments combination), false if
    398  *                  unscheduling one or more events fail.
     395 * @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
     397 *                   events were registered with the hook and arguments combination), false if
     398 *                   unscheduling one or more events fail.
    399399 */
    400400function wp_clear_scheduled_hook( $hook, $args = array() ) {
     
    418418     * @since 5.1.0
    419419     *
    420      * @param null|array $pre  Value to return instead. Default null to continue unscheduling the event.
    421      * @param string     $hook Action hook, the execution of which will be unscheduled.
    422      * @param array      $args Arguments to pass to the hook's callback function.
     420     * @param null|int|false $pre  Value to return instead. Default null to continue unscheduling the event.
     421     * @param string         $hook Action hook, the execution of which will be unscheduled.
     422     * @param array          $args Arguments to pass to the hook's callback function.
    423423     */
    424424    $pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args );
     
    462462 *
    463463 * @param string $hook Action hook, the execution of which will be unscheduled.
    464  * @return bool|int On success an integer indicating number of events unscheduled (0 indicates no
    465  *                  events were registered on the hook), false if unscheduling fails.
     464 * @return false|int On success an integer indicating number of events unscheduled (0 indicates no
     465 *                   events were registered on the hook), false if unscheduling fails.
    466466 */
    467467function wp_unschedule_hook( $hook ) {
     
    478478     * @since 5.1.0
    479479     *
    480      * @param null|array $pre  Value to return instead. Default null to continue unscheduling the hook.
    481      * @param string     $hook Action hook, the execution of which will be unscheduled.
     480     * @param null|int|false $pre  Value to return instead. Default null to continue unscheduling the hook.
     481     * @param string         $hook Action hook, the execution of which will be unscheduled.
    482482     */
    483483    $pre = apply_filters( 'pre_unschedule_hook', null, $hook );
     
    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 bool|object The event object. False if the event does not exist.
     531 * @return false|object The event object. False if the event does not exist.
    532532 */
    533533function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {
     
    543543     * @since 5.1.0
    544544     *
    545      * @param null|bool $pre       Value to return instead. Default null to continue retrieving the event.
    546      * @param string    $hook      Action hook of the event.
    547      * @param array     $args      Array containing each separate argument to pass to the hook's callback function.
    548      *                             Although not passed to a callback, these arguments are used to uniquely identify the
    549      *                             event.
     545     * @param null|false|object $pre  Value to return instead. Default null to continue retrieving the event.
     546     * @param string            $hook Action hook of the event.
     547     * @param array             $args Array containing each separate argument to pass to the hook's callback function.
     548     *                                Although not passed to a callback, these arguments are used to uniquely identify
     549     *                                the event.
    550550     * @param int|null  $timestamp Unix timestamp (UTC) of the event. Null to retrieve next scheduled event.
    551551     */
Note: See TracChangeset for help on using the changeset viewer.