Changeset 47122 for trunk/src/wp-admin/nav-menus.php

Timestamp:

01/29/2020 12:43:23 AM (7 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-admin/nav-menus.php (modified) (9 diffs)

trunk/src/wp-admin/nav-menus.php

@@ -13 +13 @@
 require_once( dirname( __FILE__ ) . '/admin.php' );
 
-// Load all the nav menu interface functions
+// Load all the nav menu interface functions.
 require_once( ABSPATH . 'wp-admin/includes/nav-menu.php' );
 
@@ -20 +20 @@
 }
 
-// Permissions Check
+// Permissions check.
 if ( ! current_user_can( 'edit_theme_options' ) ) {
         wp_die(
@@ -35 +35 @@
 }
 
-// Container for any messages displayed to the user
+// Container for any messages displayed to the user.
 $messages = array();
 
-// Container that stores the name of the active menu
+// Container that stores the name of the active menu.
 $nav_menu_selected_title = '';
 
-// The menu id of the current menu being edited
+// The menu id of the current menu being edited.
 $nav_menu_selected_id = isset( $_REQUEST['menu'] ) ? (int) $_REQUEST['menu'] : 0;
 
-// Get existing menu locations assignments
+// Get existing menu locations assignments.
 $locations      = get_registered_nav_menus();
 $menu_locations = get_nav_menu_locations();
 $num_locations  = count( array_keys( $locations ) );
 
-// Allowed actions: add, update, delete
+// Allowed actions: add, update, delete.
 $action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'edit';
 
@@ -326 +326 @@
                                         }
                                         if ( isset( $_REQUEST['zero-menu-state'] ) ) {
-                                                // If there are menu items, add them
+                                                // If there are menu items, add them.
                                                 wp_nav_menu_update_menu_items( $nav_menu_selected_id, $nav_menu_selected_title );
-                                                // Auto-save nav_menu_locations
+                                                // Auto-save nav_menu_locations.
                                                 $locations = get_nav_menu_locations();
                                                 foreach ( $locations as $location => $menu_id ) {
                                                                 $locations[ $location ] = $nav_menu_selected_id;
-                                                                break; // There should only be 1
+                                                                break; // There should only be 1.
                                                 }
                                                 set_theme_mod( 'nav_menu_locations', $locations );
@@ -400 +400 @@
                         $new_menu_locations = array_map( 'absint', $_POST['menu-locations'] );
                         $menu_locations     = array_merge( $menu_locations, $new_menu_locations );
-                        // Set menu locations
+                        // Set menu locations.
                         set_theme_mod( 'nav_menu_locations', $menu_locations );
 
@@ -472 +472 @@
         $nav_menu_selected_id = 0;
 } elseif ( empty( $nav_menu_selected_id ) && ! empty( $nav_menus ) && ! $add_new_screen ) {
-        // if we have no selection yet, and we have menus, set to the first one in the list.
+        // If we have no selection yet, and we have menus, set to the first one in the list.
         $nav_menu_selected_id = $nav_menus[0]->term_id;
 }
@@ -537 +537 @@
 }
 
-if ( ! $locations_screen ) : // Main tab
+if ( ! $locations_screen ) : // Main tab.
         $overview  = '<p>' . __( 'This screen is used for managing your navigation menus.' ) . '</p>';
         $overview .= '<p>' . sprintf(
@@ -585 +585 @@
                 )
         );
-else : // Locations Tab.
+else : // Locations tab.
         $locations_overview  = '<p>' . __( 'This screen is used for globally assigning menus to locations defined by your theme.' ) . '</p>';
         $locations_overview .= '<ul><li>' . __( 'To assign menus to one or more theme locations, <strong>select a menu from each location&#8217;s drop down.</strong> When you&#8217;re finished, <strong>click Save Changes</strong>' ) . '</li>';
@@ -746 +746 @@
                                                 </td><!-- .menu-location-menus -->
                                         </tr><!-- .menu-locations-row -->
-                                <?php } // foreach ?>
+                                <?php } // End foreach. ?>
                                 </tbody>
                         </table>