WordPress.org
Get WordPress

Make WordPress Core

Changeset 38573


Ignore:
Timestamp:
09/08/2016 04:16:39 AM (10 years ago)
Author:
DrewAPicture
Message:

Docs: Fix minor formatting for inline docs in WP_Hook following its introduction in [38571].

See #17817.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-hook.php

    r38571 r38573  
    5959         * @since 4.7.0
    6060         * @access private
    61          * @var boolean
     61         * @var bool
    6262         */
    6363        private $doing_action = false;
    … …  
    102102         * @access private
    103103         *
    104          * @param bool|int $new_priority      The priority of the new filter being added. Default false, for no priority being added.
    105          * @param bool     $priority_existed  Flag for whether the priority already existed before the new filter was added.
     104         * @param bool|int $new_priority     Optional. The priority of the new filter being added. Default false,
     105         *                                   for no priority being added.
     106         * @param bool     $priority_existed Optional. Flag for whether the priority already existed before the new
     107         *                                   filter was added. Default false.
    106108         */
    107109        private function resort_active_iterations( $new_priority = false, $priority_existed = false ) {
    … …  
    139141                        // If we have a new priority that didn't exist, but ::apply_filters() or ::do_action() thinks it's the current priority...
    140142                        if ( $new_priority === $this->current_priority[ $index ] && ! $priority_existed ) {
    141                                 // ... and the new priority is the same as what $this->iterations thinks is the previous priority,
    142                                 // We need to move back to it.
     143                                /*
     144                                 * ... and the new priority is the same as what $this->iterations thinks is the previous
     145                                 * priority, we need to move back to it.
     146                                 */
    143147
    144148                                if ( false === current( $iteration ) ) {
    … …  
    196200         *
    197201         * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
    198          * @param string        $tag               Optional. The name of the filter hook. Default empty.
    199          *                                         Used for building the callback ID when SPL is not available.
     202         * @param string        $tag               Optional. The name of the filter hook. Used for building
     203         *                                         the callback ID when SPL is not available. Default empty.
    200204         * @return bool|int The priority of that hook is returned, or false if the function is not attached.
    201205         */
    … …  
    225229         * @access public
    226230         *
    227          * @return bool True if callbacks have been registered for the current hook, false otherwise.
     231         * @return bool True if callbacks have been registered for the current hook, otherwise false.
    228232         */
    229233        public function has_filters() {
    … …  
    349353
    350354        /**
    351          * Normalizes filters setup before WordPress has initialized to WP_Hook objects.
     355         * Normalizes filters set up before WordPress has initialized to WP_Hook objects.
    352356         *
    353357         * @since 4.7.0
    … …  
    446450
    447451        /**
    448          * Return the current element
     452         * Returns the current element.
    449453         *
    450454         * @since 4.7.0
    … …  
    460464
    461465        /**
    462          * Move forward to the next element
     466         * Moves forward to the next element.
    463467         *
    464468         * @since 4.7.0
    … …  
    474478
    475479        /**
    476          * Return the key of the current element
     480         * Returns the key of the current element.
    477481         *
    478482         * @since 4.7.0
    … …  
    488492
    489493        /**
    490          * Checks if current position is valid
     494         * Checks if current position is valid.
    491495         *
    492496         * @since 4.7.0
    … …  
    502506
    503507        /**
    504          * Rewind the Iterator to the first element
     508         * Rewinds the Iterator to the first element.
    505509         *
    506510         * @since 4.7.0
    … …  
    513517        }
    514518
    515 
    516519}
Note: See TracChangeset for help on using the changeset viewer.