WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
05/01/2022 09:39:02 PM (3 years ago)
Author:
audrasjb
Message:

Docs: Docblock adjustements in the Walker class.

This changeset ensures third-person singular verbs are used for function descriptions in the Walker class, and adjusts some non-standard docblock descriptions for various properties and methods of the class.

See #54729.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r52794 r53323  
    3030
    3131    /**
    32      * Max number of pages walked by the paged walker
     32     * Max number of pages walked by the paged walker.
    3333     *
    3434     * @since 2.7.0
    … …  
    7878
    7979    /**
    80      * Start the element output.
     80     * Starts the element output.
    8181     *
    8282     * The $args parameter holds additional values that may be used with the child
    83      * class methods. Includes the element output also.
     83     * class methods. Also includes the element output.
    8484     *
    8585     * @since 2.1.0
    … …  
    112112
    113113    /**
    114      * Traverse elements to create list from elements.
     114     * Traverses elements to create list from elements.
    115115     *
    116116     * Display one element if the element doesn't have any children otherwise,
    … …  
    171171
    172172    /**
    173      * Display array of elements hierarchically.
     173     * Displays array of elements hierarchically.
    174174     *
    175175     * Does not assume any existing order of elements.
    … …  
    264264
    265265    /**
    266      * paged_walk() - produce a page of nested elements
     266     * Produces a page of nested elements.
    267267     *
    268268     * Given an array of hierarchical elements, the maximum depth, a specific page number,
    … …  
    282282     * @param int   $per_page  Number of elements per page.
    283283     * @param mixed ...$args   Optional additional arguments.
    284      * @return string XHTML of the specified page of elements
     284     * @return string XHTML of the specified page of elements.
    285285     */
    286286    public function paged_walk( $elements, $max_depth, $page_num, $per_page, ...$args ) {
    … …  
    423423
    424424    /**
    425      * Unset all the children for a given top level element.
     425     * Unsets all the children for a given top level element.
    426426     *
    427427     * @since 2.7.0
Note: See TracChangeset for help on using the changeset viewer.