Changeset 32549

Timestamp:

05/22/2015 05:58:42 PM (9 years ago)

Author:

wonderboymusic

Message:

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

See #32444.

File:

• trunk/src/wp-includes/class-wp-walker.php (modified) (5 diffs)

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

@@ -128 +128 @@
      * @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'];
@@ -189 +188 @@
      * @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
+        //invalid parameter or nothing to walk
+        if ( $max_depth < -1 || empty( $elements ) ) {
             return $output;
-
-        if (empty($elements)) //nothing to walk
-            return $output;
+        }
 
         $parent_field = $this->db_fields['parent'];
@@ -273 +270 @@
      * @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 );
@@ -384 +382 @@
     }
 
+    /**
+     *
+     * @param array $elements
+     * @return int
+     */
     public function get_number_of_root_elements( $elements ){
-
         $num = 0;
         $parent_field = $this->db_fields['parent'];
@@ -396 +398 @@
     }
 
-    // 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'];