WordPress.org

Make WordPress Core

Changeset 32549


Ignore:
Timestamp:
05/22/2015 05:58:42 PM (6 years ago)
Author:
wonderboymusic
Message:

Cleanup missing doc blocks for class-wp-walker.php.

See #32444.

File:
1 edited

Legend:

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

    r32545 r32549  
    128128     * @param array  $args              An array of arguments.
    129129     * @param string $output            Passed by reference. Used to append additional content.
    130      * @return null Null on failure with no changes to parameters.
    131130     */
    132131    public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
    133 
    134         if ( !$element )
     132        if ( ! $element ) {
    135133            return;
     134        }
    136135
    137136        $id_field = $this->db_fields['id'];
     
    189188     * @return string The hierarchical item output.
    190189     */
    191     public function walk( $elements, $max_depth) {
    192 
     190    public function walk( $elements, $max_depth ) {
    193191        $args = array_slice(func_get_args(), 2);
    194192        $output = '';
    195193
    196         if ($max_depth < -1) //invalid parameter
     194        //invalid parameter or nothing to walk
     195        if ( $max_depth < -1 || empty( $elements ) ) {
    197196            return $output;
    198 
    199         if (empty($elements)) //nothing to walk
    200             return $output;
     197        }
    201198
    202199        $parent_field = $this->db_fields['parent'];
     
    273270     * @since 2.7.0
    274271     *
    275      * @param int $max_depth The maximum hierarchical depth.
    276      * @param int $page_num  The specific page number, beginning with 1.
    277      * @return string XHTML of the specified page of elements
    278      */
     272     * @param array $elements
     273     * @param int   $max_depth The maximum hierarchical depth.
     274     * @param int   $page_num The specific page number, beginning with 1.
     275     * @param int   $per_page
     276     * @return string XHTML of the specified page of elements
     277     */
    279278    public function paged_walk( $elements, $max_depth, $page_num, $per_page ) {
    280 
    281         /* sanity check */
    282         if ( empty($elements) || $max_depth < -1 )
     279        if ( empty( $elements ) || $max_depth < -1 ) {
    283280            return '';
     281        }
    284282
    285283        $args = array_slice( func_get_args(), 4 );
     
    384382    }
    385383
     384    /**
     385     *
     386     * @param array $elements
     387     * @return int
     388     */
    386389    public function get_number_of_root_elements( $elements ){
    387 
    388390        $num = 0;
    389391        $parent_field = $this->db_fields['parent'];
     
    396398    }
    397399
    398     // Unset all the children for a given top level element.
     400    /**
     401     * Unset all the children for a given top level element.
     402     *
     403     * @param object $e
     404     * @param array $children_elements
     405     */
    399406    public function unset_children( $e, &$children_elements ){
    400 
    401         if ( !$e || !$children_elements )
     407        if ( ! $e || ! $children_elements ) {
    402408            return;
     409        }
    403410
    404411        $id_field = $this->db_fields['id'];
Note: See TracChangeset for help on using the changeset viewer.