Changeset 47122 for trunk/src/wp-includes/class-wp-walker.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

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

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

@@ -136 +136 @@
                 $id       = $element->$id_field;
 
-                //display this element
+                // Display this element.
                 $this->has_children = ! empty( $children_elements[ $id ] );
                 if ( isset( $args[0] ) && is_array( $args[0] ) ) {
@@ -144 +144 @@
                 $this->start_el( $output, $element, $depth, ...array_values( $args ) );
 
-                // descend only when the depth is right and there are childrens for this element
+                // 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 ] ) ) {
 
@@ -151 +151 @@
                                 if ( ! isset( $newlevel ) ) {
                                         $newlevel = true;
-                                        //start the child delimiter
+                                        // Start the child delimiter.
                                         $this->start_lvl( $output, $depth, ...array_values( $args ) );
                                 }
@@ -160 +160 @@
 
                 if ( isset( $newlevel ) && $newlevel ) {
-                        //end the child delimiter
+                        // End the child delimiter.
                         $this->end_lvl( $output, $depth, ...array_values( $args ) );
                 }
 
-                //end this element
+                // End this element.
                 $this->end_el( $output, $element, $depth, ...array_values( $args ) );
         }
@@ -189 +189 @@
                 $output = '';
 
-                //invalid parameter or nothing to walk
+                // Invalid parameter or nothing to walk.
                 if ( $max_depth < -1 || empty( $elements ) ) {
                         return $output;
@@ -196 +196 @@
                 $parent_field = $this->db_fields['parent'];
 
-                // flat display
+                // Flat display.
                 if ( -1 == $max_depth ) {
                         $empty_array = array();
@@ -296 +296 @@
                 }
                 if ( $page_num < 1 || $per_page < 0 ) {
-                        // No paging
+                        // No paging.
                         $paging = false;
                         $start  = 0;
@@ -312 +312 @@
                 }
 
-                // flat display
+                // Flat display.
                 if ( -1 == $max_depth ) {
                         if ( ! empty( $args[0]['reverse_top_level'] ) ) {
@@ -445 +445 @@
         }
 
-} // Walker
+}