Ticket #25528: nav-menus-hook-docs.diff

src/wp-admin/nav-menus.php

@@ -3 +3 @@
  * WordPress Administration for Navigation Menus
  * Interface functions
  *
- * @version 2.0.0
+ * @link http://codex.wordpress.org/Navigation_Menus
+ * @since 2.0.0
  *
  * @package WordPress
  * @subpackage Administration
  */
 
-/** Load WordPress Administration Bootstrap */
+/**
+ * Load WordPress Administration Bootstrap
+ */
 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' );
 
 if ( ! current_theme_supports( 'menus' ) && ! current_theme_supports( 'widgets' ) )
@@ -461 +466 @@
         $edit_markup = wp_get_nav_menu_to_edit( $nav_menu_selected_id );
 }
 
+/**
+ * Appends a menu-max-depth-n class to the admin body classes where n represents the max level of the nav menu.
+ *
+ * @global int $_wp_nav_menu_max_depth Number of levels of the nav menu.
+ *
+ * @param string $classes Admin body tag classes.
+ * @return string Body classes.
+ */
 function wp_nav_menu_max_depth($classes) {
         global $_wp_nav_menu_max_depth;
         return "$classes menu-max-depth-$_wp_nav_menu_max_depth";
@@ -529 +542 @@
         '<p>' . __('<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
 );
 
-// Get the admin header
+/**
+ * Get the admin header
+ */
 require_once( ABSPATH . 'wp-admin/admin-header.php' );
 ?>
 <div class="wrap">
@@ -602 +617 @@
                         <input type="hidden" name="menu" id="nav-menu-meta-object-id" value="<?php echo esc_attr( $nav_menu_selected_id ); ?>" />
                 </form>
         </div><!-- #menu-locations-wrap -->
-        <?php do_action( 'after_menu_locations_table' ); ?>
+        <?php
+                /**
+                 * Fires actions to be run after displaying the menu locations table.
+                 *
+                 * @since 3.6
+                 */
+                do_action( 'after_menu_locations_table' );
+                ?>
         <?php else : ?>
         <div class="manage-menus">
                 <?php if ( $menu_count < 2 ) : ?>
@@ -627 +649 @@
                                                         foreach ( array_keys( $menu_locations, $_nav_menu->term_id ) as $menu_location_key ) {
                                                                  $locations_assigned_to_this_menu[] = $locations[ $menu_location_key ];
                                                         }
+
+                                                        /**
+                                                         * Filter the nav menu assigned locations.
+                                                         *
+                                                         * @since 3.6
+                                                         */
                                                         $assigned_locations = array_slice( $locations_assigned_to_this_menu, 0, absint( apply_filters( 'wp_nav_locations_listed_per_menu', 3 ) ) );
 
                                                         // Adds ellipses following the number of locations defined in $assigned_locations
@@ -762 +790 @@
         </div><!-- /#nav-menus-frame -->
         <?php endif; ?>
 </div><!-- /.wrap-->
-<?php include( ABSPATH . 'wp-admin/admin-footer.php' ); ?>
+<?php
+/**
+ * Load the admin footer template.
+ */
+include( ABSPATH . 'wp-admin/admin-footer.php' );
+?>