WordPress 4.6.3-scripts

[autoinstalls/wordpress.git] / wp-includes / class-wp-walker.php

diff --git a/wp-includes/class-wp-walker.php b/wp-includes/class-wp-walker.php
index f1d759789244115730fab602dc7285bb02801d7f..57bd90bfd32d7434e635532d76c91d2e89fde2ca 100644 (file)
--- a/wp-includes/class-wp-walker.php
+++ b/wp-includes/class-wp-walker.php
@@ -127,12 +127,11 @@ class Walker {
         * @param int    $depth             Depth of current element.
         * @param array  $args              An array of arguments.
         * @param string $output            Passed by reference. Used to append additional content.
-        * @return null Null on failure with no changes to parameters.
         */
        public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
-
-               if ( !$element )
+               if ( ! $element ) {
                        return;
+               }
 
                $id_field = $this->db_fields['id'];
                $id       = $element->$id_field;
@@ -140,7 +139,7 @@ class Walker {
                //display this element
                $this->has_children = ! empty( $children_elements[ $id ] );
                if ( isset( $args[0] ) && is_array( $args[0] ) ) {
-                       $args[0]['has_children'] = $this->has_children; // Backwards compatibility.
+                       $args[0]['has_children'] = $this->has_children; // Back-compat.
                }
 
                $cb_args = array_merge( array(&$output, $element, $depth), $args);
@@ -149,7 +148,7 @@ class Walker {
                // descend only when the depth is right and there are childrens for this element
                if ( ($max_depth == 0 || $max_depth > $depth+1 ) && isset( $children_elements[$id]) ) {
 
-                       foreach( $children_elements[ $id ] as $child ){
+                       foreach ( $children_elements[ $id ] as $child ){
 
                                if ( !isset($newlevel) ) {
                                        $newlevel = true;
@@ -188,16 +187,14 @@ class Walker {
         * @param int   $max_depth The maximum hierarchical depth.
         * @return string The hierarchical item output.
         */
-       public function walk( $elements, $max_depth) {
-
+       public function walk( $elements, $max_depth ) {
                $args = array_slice(func_get_args(), 2);
                $output = '';
 
-               if ($max_depth < -1) //invalid parameter
-                       return $output;
-
-               if (empty($elements)) //nothing to walk
+               //invalid parameter or nothing to walk
+               if ( $max_depth < -1 || empty( $elements ) ) {
                        return $output;
+               }
 
                $parent_field = $this->db_fields['parent'];
 
@@ -218,7 +215,7 @@ class Walker {
                $top_level_elements = array();
                $children_elements  = array();
                foreach ( $elements as $e) {
-                       if ( 0 == $e->$parent_field )
+                       if ( empty( $e->$parent_field ) )
                                $top_level_elements[] = $e;
                        else
                                $children_elements[ $e->$parent_field ][] = $e;
@@ -253,7 +250,7 @@ class Walker {
                if ( ( $max_depth == 0 ) && count( $children_elements ) > 0 ) {
                        $empty_array = array();
                        foreach ( $children_elements as $orphans )
-                               foreach( $orphans as $op )
+                               foreach ( $orphans as $op )
                                        $this->display_element( $op, $empty_array, 1, 0, $args, $output );
                 }
 
@@ -272,15 +269,16 @@ class Walker {
         *
         * @since 2.7.0
         *
-        * @param int $max_depth The maximum hierarchical depth.
-        * @param int $page_num  The specific page number, beginning with 1.
-        * @return string XHTML of the specified page of elements
-        */
+        * @param array $elements
+        * @param int   $max_depth The maximum hierarchical depth.
+        * @param int   $page_num The specific page number, beginning with 1.
+        * @param int   $per_page
+        * @return string XHTML of the specified page of elements
+        */
        public function paged_walk( $elements, $max_depth, $page_num, $per_page ) {
-
-               /* sanity check */
-               if ( empty($elements) || $max_depth < -1 )
+               if ( empty( $elements ) || $max_depth < -1 ) {
                        return '';
+               }
 
                $args = array_slice( func_get_args(), 4 );
                $output = '';
@@ -376,15 +374,23 @@ class Walker {
                if ( $end >= $total_top && count( $children_elements ) > 0 ) {
                        $empty_array = array();
                        foreach ( $children_elements as $orphans )
-                               foreach( $orphans as $op )
+                               foreach ( $orphans as $op )
                                        $this->display_element( $op, $empty_array, 1, 0, $args, $output );
                }
 
                return $output;
        }
 
+       /**
+        * Calculates the total number of root elements.
+        *
+        * @since 2.7.0
+        * @access public
+        *
+        * @param array $elements Elements to list.
+        * @return int Number of root elements.
+        */
        public function get_number_of_root_elements( $elements ){
-
                $num = 0;
                $parent_field = $this->db_fields['parent'];
 
@@ -395,11 +401,16 @@ class Walker {
                return $num;
        }
 
-       // Unset all the children for a given top level element.
+       /**
+        * Unset all the children for a given top level element.
+        *
+        * @param object $e
+        * @param array $children_elements
+        */
        public function unset_children( $e, &$children_elements ){
-
-               if ( !$e || !$children_elements )
+               if ( ! $e || ! $children_elements ) {
                        return;
+               }
 
                $id_field = $this->db_fields['id'];
                $id = $e->$id_field;
@@ -408,9 +419,7 @@ class Walker {
                        foreach ( (array) $children_elements[$id] as $child )
                                $this->unset_children( $child, $children_elements );
 
-               if ( isset($children_elements[$id]) )
-                       unset( $children_elements[$id] );
-
+               unset( $children_elements[ $id ] );
        }
 
 } // Walker