Changeset 47084 for trunk/src/wp-admin/includes/menu.php

Timestamp:

01/18/2020 12:52:28 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve comments in some wp-admin files per the documentation standards.

Props passoniate.
Fixes #49215, #49216.

File:

• trunk/src/wp-admin/includes/menu.php (modified) (5 diffs)

trunk/src/wp-admin/includes/menu.php

@@ -209 +209 @@
         $i++;
 
-        if ( 0 == $order ) { // dashboard is always shown/single
+        if ( 0 == $order ) { // Dashboard is always shown/single.
             $menu[0][4] = add_cssclass( 'menu-top-first', $top[4] );
             $lastorder  = 0;
@@ -215 +215 @@
         }
 
-        if ( 0 === strpos( $top[2], 'separator' ) && false !== $lastorder ) { // if separator
+        if ( 0 === strpos( $top[2], 'separator' ) && false !== $lastorder ) { // If separator.
             $first                 = true;
             $c                     = $menu[ $lastorder ][4];
@@ -228 +228 @@
         }
 
-        if ( $mc == $i ) { // last item
+        if ( $mc == $i ) { // Last item.
             $c                 = $menu[ $order ][4];
             $menu[ $order ][4] = add_cssclass( 'menu-top-last', $c );
@@ -246 +246 @@
 }
 
-uksort( $menu, 'strnatcasecmp' ); // make it all pretty
+uksort( $menu, 'strnatcasecmp' ); // Make it all pretty.
 
 /**
@@ -311 +311 @@
 }
 
-// Prevent adjacent separators
+// Prevent adjacent separators.
 $prev_menu_was_separator = false;
 foreach ( $menu as $id => $data ) {
     if ( false === stristr( $data[4], 'wp-menu-separator' ) ) {
 
-        // This item is not a separator, so falsey the toggler and do nothing
+        // This item is not a separator, so falsey the toggler and do nothing.
         $prev_menu_was_separator = false;
     } else {
 
-        // The previous item was a separator, so unset this one
+        // The previous item was a separator, so unset this one.
         if ( true === $prev_menu_was_separator ) {
             unset( $menu[ $id ] );
         }
 
-        // This item is a separator, so truthy the toggler and move on
+        // This item is a separator, so truthy the toggler and move on.
         $prev_menu_was_separator = true;
     }