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

Timestamp:

01/29/2020 12:33:45 AM (5 years ago)

Author:

SergeyBiryukov

Message:

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

Follow-up to [47084].

Props passoniate, apedog.
Fixes #49223, #49227.

File:

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

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

@@ -139 +139 @@
  */
 function wp_nav_menu_setup() {
-    // Register meta boxes
+    // Register meta boxes.
     wp_nav_menu_post_type_meta_boxes();
     add_meta_box( 'add-custom-links', __( 'Custom Links' ), 'wp_nav_menu_item_link_meta_box', 'nav-menus', 'side', 'default' );
     wp_nav_menu_taxonomy_meta_boxes();
 
-    // Register advanced menu items (columns)
+    // Register advanced menu items (columns).
     add_filter( 'manage_nav-menus_columns', 'wp_nav_menu_manage_columns' );
 
@@ -423 +423 @@
     }
 
-    // @todo transient caching of these results with proper invalidation on updating of a post of this type
+    // @todo Transient caching of these results with proper invalidation on updating of a post of this type.
     $get_posts = new WP_Query;
     $posts     = $get_posts->query( $args );
@@ -922 +922 @@
                     // Or URL is the default.
                     in_array( $_item_object_data['menu-item-url'], array( 'https://', 'http://', '' ) ) ||
-                    ! ( 'custom' == $_item_object_data['menu-item-type'] && ! isset( $_item_object_data['menu-item-db-id'] ) ) || // or it's not a custom menu item (but not the custom home page)
+                    // Or it's not a custom menu item (but not the custom home page).
+                    ! ( 'custom' == $_item_object_data['menu-item-type'] && ! isset( $_item_object_data['menu-item-db-id'] ) ) ||
                     // Or it *is* a custom menu item that already exists.
                     ! empty( $_item_object_data['menu-item-db-id'] )
@@ -1143 +1144 @@
     $messages            = array();
     $menu_items          = array();
-    // Index menu items by db ID
+    // Index menu items by DB ID.
     foreach ( $unsorted_menu_items as $_item ) {
         $menu_items[ $_item->db_id ] = $_item;
@@ -1165 +1166 @@
 
     wp_defer_term_counting( true );
-    // Loop through all the menu items' POST variables
+    // Loop through all the menu items' POST variables.
     if ( ! empty( $_POST['menu-item-db-id'] ) ) {
         foreach ( (array) $_POST['menu-item-db-id'] as $_key => $k ) {
 
-            // Menu item title can't be blank
+            // Menu item title can't be blank.
             if ( ! isset( $_POST['menu-item-title'][ $_key ] ) || '' == $_POST['menu-item-title'][ $_key ] ) {
                 continue;
@@ -1189 +1190 @@
     }
 
-    // Remove menu items from the menu that weren't in $_POST
+    // Remove menu items from the menu that weren't in $_POST.
     if ( ! empty( $menu_items ) ) {
         foreach ( array_keys( $menu_items ) as $menu_item_id ) {
@@ -1214 +1215 @@
         }
     }
-    // Remove nonexistent/deleted menus
+    // Remove non-existent/deleted menus.
     $nav_menu_option['auto_add'] = array_intersect( $nav_menu_option['auto_add'], wp_get_nav_menus( array( 'fields' => 'ids' ) ) );
     update_option( 'nav_menu_options', $nav_menu_option );
@@ -1253 +1254 @@
         foreach ( $data as $post_input_data ) {
             // For input names that are arrays (e.g. `menu-item-db-id[3][4][5]`),
-            // derive the array path keys via regex and set the value in $_POST.
+            // derive the array path keys via regex and set the value in $_POST.
             preg_match( '#([^\[]*)(\[(.+)\])?#', $post_input_data->name, $matches );
 
@@ -1265 +1266 @@
 
             // Build the new array value from leaf to trunk.
-            for ( $i = count( $array_bits ) - 1; $i >= 0; $i -- ) {
+            for ( $i = count( $array_bits ) - 1; $i >= 0; $i-- ) {
                 if ( $i == count( $array_bits ) - 1 ) {
                     $new_post_data[ $array_bits[ $i ] ] = wp_slash( $post_input_data->value );