WordPress 4.0

[autoinstalls/wordpress.git] / wp-admin / includes / nav-menu.php

diff --git a/wp-admin/includes/nav-menu.php b/wp-admin/includes/nav-menu.php
index d3aa7bd07dcfad168f8ea35d14da134cf3f89239..44f3ee08435263e7a797ccff328847fb0c95053e 100644 (file)
--- a/wp-admin/includes/nav-menu.php
+++ b/wp-admin/includes/nav-menu.php
@@ -19,7 +19,7 @@ class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {
         * @param int    $depth  Depth of menu item. Used for padding.
         * @param array  $args   Not used.
         */
         * @param int    $depth  Depth of menu item. Used for padding.
         * @param array  $args   Not used.
         */

-       function start_lvl( &$output, $depth = 0, $args = array() ) {}
+       public function start_lvl( &$output, $depth = 0, $args = array() ) {}

 
        /**
         * Ends the list of after the elements are added.
 
        /**
         * Ends the list of after the elements are added.


@@ -32,7 +32,7 @@ class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {
         * @param int    $depth  Depth of menu item. Used for padding.
         * @param array  $args   Not used.
         */
         * @param int    $depth  Depth of menu item. Used for padding.
         * @param array  $args   Not used.
         */

-       function end_lvl( &$output, $depth = 0, $args = array() ) {}
+       public function end_lvl( &$output, $depth = 0, $args = array() ) {}

 
        /**
         * Start the element output.
 
        /**
         * Start the element output.


@@ -46,7 +46,7 @@ class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {
         * @param array  $args   Not used.
         * @param int    $id     Not used.
         */
         * @param array  $args   Not used.
         * @param int    $id     Not used.
         */

-       function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
+       public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {

                global $_wp_nav_menu_max_depth;
                $_wp_nav_menu_max_depth = $depth > $_wp_nav_menu_max_depth ? $depth : $_wp_nav_menu_max_depth;
 
                global $_wp_nav_menu_max_depth;
                $_wp_nav_menu_max_depth = $depth > $_wp_nav_menu_max_depth ? $depth : $_wp_nav_menu_max_depth;
 


@@ -231,12 +231,11 @@ class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {
 /**
  * Create HTML list of nav menu input items.
  *
 /**
  * Create HTML list of nav menu input items.
  *

- * @package WordPress

  * @since 3.0.0
  * @uses Walker_Nav_Menu
  */
 class Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {
  * @since 3.0.0
  * @uses Walker_Nav_Menu
  */
 class Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {

-       function __construct( $fields = false ) {
+       public function __construct( $fields = false ) {

                if ( $fields ) {
                        $this->db_fields = $fields;
                }
                if ( $fields ) {
                        $this->db_fields = $fields;
                }


@@ -253,7 +252,7 @@ class Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {
         * @param int    $depth  Depth of page. Used for padding.
         * @param array  $args   Not used.
         */
         * @param int    $depth  Depth of page. Used for padding.
         * @param array  $args   Not used.
         */

-       function start_lvl( &$output, $depth = 0, $args = array() ) {
+       public function start_lvl( &$output, $depth = 0, $args = array() ) {

                $indent = str_repeat( "\t", $depth );
                $output .= "\n$indent<ul class='children'>\n";
        }
                $indent = str_repeat( "\t", $depth );
                $output .= "\n$indent<ul class='children'>\n";
        }


@@ -269,7 +268,7 @@ class Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {
         * @param int    $depth  Depth of page. Used for padding.
         * @param array  $args   Not used.
         */
         * @param int    $depth  Depth of page. Used for padding.
         * @param array  $args   Not used.
         */

-       function end_lvl( &$output, $depth = 0, $args = array() ) {
+       public function end_lvl( &$output, $depth = 0, $args = array() ) {

                $indent = str_repeat( "\t", $depth );
                $output .= "\n$indent</ul>";
        }
                $indent = str_repeat( "\t", $depth );
                $output .= "\n$indent</ul>";
        }


@@ -287,7 +286,7 @@ class Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {
         * @param array  $args   Not used.
         * @param int    $id     Not used.
         */
         * @param array  $args   Not used.
         * @param int    $id     Not used.
         */

-       function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
+       public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {

                global $_nav_menu_placeholder;
 
                $_nav_menu_placeholder = ( 0 > $_nav_menu_placeholder ) ? intval($_nav_menu_placeholder) - 1 : -1;
                global $_nav_menu_placeholder;
 
                $_nav_menu_placeholder = ( 0 > $_nav_menu_placeholder ) ? intval($_nav_menu_placeholder) - 1 : -1;


@@ -357,7 +356,6 @@ function _wp_ajax_menu_quick_search( $request = array() ) {
                                if ( 'markup' == $response_format ) {
                                        echo walk_nav_menu_tree( array_map('wp_setup_nav_menu_item', array( get_post( $object_id ) ) ), 0, (object) $args );
                                } elseif ( 'json' == $response_format ) {
                                if ( 'markup' == $response_format ) {
                                        echo walk_nav_menu_tree( array_map('wp_setup_nav_menu_item', array( get_post( $object_id ) ) ), 0, (object) $args );
                                } elseif ( 'json' == $response_format ) {

-                                       $post_obj = get_post( $object_id );

                                        echo json_encode(
                                                array(
                                                        'ID' => $object_id,
                                        echo json_encode(
                                                array(
                                                        'ID' => $object_id,


@@ -503,10 +501,22 @@ function wp_nav_menu_post_type_meta_boxes() {
                return;
 
        foreach ( $post_types as $post_type ) {
                return;
 
        foreach ( $post_types as $post_type ) {

+               /**
+                * Filter whether a menu items meta box will be added for the current
+                * object type.
+                *
+                * If a falsey value is returned instead of an object, the menu items
+                * meta box for the current meta box object will not be added.
+                *
+                * @since 3.0.0
+                *
+                * @param object $meta_box_object The current object to add a menu items
+                *                                meta box for.
+                */

                $post_type = apply_filters( 'nav_menu_meta_box_object', $post_type );
                if ( $post_type ) {
                        $id = $post_type->name;
                $post_type = apply_filters( 'nav_menu_meta_box_object', $post_type );
                if ( $post_type ) {
                        $id = $post_type->name;

-                       // give pages a higher priority
+                       // Give pages a higher priority.

                        $priority = ( 'page' == $post_type->name ? 'core' : 'default' );
                        add_meta_box( "add-{$id}", $post_type->labels->name, 'wp_nav_menu_item_post_type_meta_box', 'nav-menus', 'side', $priority, $post_type );
                }
                        $priority = ( 'page' == $post_type->name ? 'core' : 'default' );
                        add_meta_box( "add-{$id}", $post_type->labels->name, 'wp_nav_menu_item_post_type_meta_box', 'nav-menus', 'side', $priority, $post_type );
                }


@@ -525,6 +535,7 @@ function wp_nav_menu_taxonomy_meta_boxes() {
                return;
 
        foreach ( $taxonomies as $tax ) {
                return;
 
        foreach ( $taxonomies as $tax ) {

+               /** This filter is documented in wp-admin/includes/nav-menu.php */

                $tax = apply_filters( 'nav_menu_meta_box_object', $tax );
                if ( $tax ) {
                        $id = $tax->name;
                $tax = apply_filters( 'nav_menu_meta_box_object', $tax );
                if ( $tax ) {
                        $id = $tax->name;


@@ -604,7 +615,7 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
 
        $post_type_name = $post_type['args']->name;
 
 
        $post_type_name = $post_type['args']->name;
 

-       // paginate browsing for large numbers of post objects
+       // Paginate browsing for large numbers of post objects.

        $per_page = 50;
        $pagenum = isset( $_REQUEST[$post_type_name . '-tab'] ) && isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 1;
        $offset = 0 < $pagenum ? $per_page * ( $pagenum - 1 ) : 0;
        $per_page = 50;
        $pagenum = isset( $_REQUEST[$post_type_name . '-tab'] ) && isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 1;
        $offset = 0 < $pagenum ? $per_page * ( $pagenum - 1 ) : 0;


@@ -631,8 +642,6 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
                return;
        }
 
                return;
        }
 

-       $post_type_object = get_post_type_object($post_type_name);
-

        $num_pages = $get_posts->max_num_pages;
 
        $page_links = paginate_links( array(
        $num_pages = $get_posts->max_num_pages;
 
        $page_links = paginate_links( array(


@@ -651,9 +660,6 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
                'current' => $pagenum
        ));
 
                'current' => $pagenum
        ));
 

-       if ( !$posts )
-               $error = '<li id="error">'. $post_type['args']->labels->not_found .'</li>';
-

        $db_fields = false;
        if ( is_post_type_hierarchical( $post_type_name ) ) {
                $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
        $db_fields = false;
        if ( is_post_type_hierarchical( $post_type_name ) ) {
                $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );


@@ -756,7 +762,10 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
                                <?php
                                $args['walker'] = $walker;
 
                                <?php
                                $args['walker'] = $walker;
 

-                               // if we're dealing with pages, let's put a checkbox for the front page at the top of the list
+                               /*
+                                * If we're dealing with pages, let's put a checkbox for the front
+                                * page at the top of the list.
+                                */

                                if ( 'page' == $post_type_name ) {
                                        $front_page = 'page' == get_option('show_on_front') ? (int) get_option( 'page_on_front' ) : 0;
                                        if ( ! empty( $front_page ) ) {
                                if ( 'page' == $post_type_name ) {
                                        $front_page = 'page' == get_option('show_on_front') ? (int) get_option( 'page_on_front' ) : 0;
                                        if ( ! empty( $front_page ) ) {


@@ -780,7 +789,22 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
                                        }
                                }
 
                                        }
                                }
 

-                               $posts = apply_filters( 'nav_menu_items_'.$post_type_name, $posts, $args, $post_type );
+                               /**
+                                * Filter the posts displayed in the 'View All' tab of the current
+                                * post type's menu items meta box.
+                                *
+                                * The dynamic portion of the hook name, $post_type_name,
+                                * refers to the slug of the current post type.
+                                *
+                                * @since 3.2.0
+                                *
+                                * @see WP_Query::query()
+                                *
+                                * @param array  $posts     The posts for the current post type.
+                                * @param array  $args      An array of WP_Query arguments.
+                                * @param object $post_type The current post type object for this menu item meta box.
+                                */
+                               $posts = apply_filters( "nav_menu_items_{$post_type_name}", $posts, $args, $post_type );

                                $checkbox_items = walk_nav_menu_tree( array_map('wp_setup_nav_menu_item', $posts), 0, (object) $args );
 
                                if ( 'all' == $current_tab && ! empty( $_REQUEST['selectall'] ) ) {
                                $checkbox_items = walk_nav_menu_tree( array_map('wp_setup_nav_menu_item', $posts), 0, (object) $args );
 
                                if ( 'all' == $current_tab && ! empty( $_REQUEST['selectall'] ) ) {


@@ -812,7 +836,7 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
                        </span>
 
                        <span class="add-to-menu">
                        </span>
 
                        <span class="add-to-menu">

-                               <input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( __( 'Add to Menu' ) ); ?>" name="add-post-type-menu-item" id="<?php esc_attr_e( 'submit-posttype-' . $post_type_name ); ?>" />
+                               <input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( 'Add to Menu' ); ?>" name="add-post-type-menu-item" id="<?php echo esc_attr( 'submit-posttype-' . $post_type_name ); ?>" />

                                <span class="spinner"></span>
                        </span>
                </p>
                                <span class="spinner"></span>
                        </span>
                </p>


@@ -833,7 +857,7 @@ function wp_nav_menu_item_taxonomy_meta_box( $object, $taxonomy ) {
        global $nav_menu_selected_id;
        $taxonomy_name = $taxonomy['args']->name;
 
        global $nav_menu_selected_id;
        $taxonomy_name = $taxonomy['args']->name;
 

-       // paginate browsing for large numbers of objects
+       // Paginate browsing for large numbers of objects.

        $per_page = 50;
        $pagenum = isset( $_REQUEST[$taxonomy_name . '-tab'] ) && isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 1;
        $offset = 0 < $pagenum ? $per_page * ( $pagenum - 1 ) : 0;
        $per_page = 50;
        $pagenum = isset( $_REQUEST[$taxonomy_name . '-tab'] ) && isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 1;
        $offset = 0 < $pagenum ? $per_page * ( $pagenum - 1 ) : 0;


@@ -1000,7 +1024,7 @@ function wp_nav_menu_item_taxonomy_meta_box( $object, $taxonomy ) {
                        </span>
 
                        <span class="add-to-menu">
                        </span>
 
                        <span class="add-to-menu">

-                               <input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( __( 'Add to Menu' ) ); ?>" name="add-taxonomy-menu-item" id="<?php esc_attr_e( 'submit-taxonomy-' . $taxonomy_name ); ?>" />
+                               <input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( 'Add to Menu' ); ?>" name="add-taxonomy-menu-item" id="<?php echo esc_attr( 'submit-taxonomy-' . $taxonomy_name ); ?>" />

                                <span class="spinner"></span>
                        </span>
                </p>
                                <span class="spinner"></span>
                        </span>
                </p>


@@ -1024,21 +1048,26 @@ function wp_save_nav_menu_items( $menu_id = 0, $menu_data = array() ) {
 
        if ( 0 == $menu_id || is_nav_menu( $menu_id ) ) {
 
 
        if ( 0 == $menu_id || is_nav_menu( $menu_id ) ) {
 

-               // Loop through all the menu items' POST values
+               // Loop through all the menu items' POST values.

                foreach( (array) $menu_data as $_possible_db_id => $_item_object_data ) {
                        if (
                foreach( (array) $menu_data as $_possible_db_id => $_item_object_data ) {
                        if (

-                               empty( $_item_object_data['menu-item-object-id'] ) && // checkbox is not checked
+                               // Checkbox is not checked.
+                               empty( $_item_object_data['menu-item-object-id'] ) &&

                                (
                                (

-                                       ! isset( $_item_object_data['menu-item-type'] ) || // and item type either isn't set
-                                       in_array( $_item_object_data['menu-item-url'], array( 'http://', '' ) ) || // or URL is the default
+                                       // And item type either isn't set.
+                                       ! isset( $_item_object_data['menu-item-type'] ) ||
+                                       // Or URL is the default.
+                                       in_array( $_item_object_data['menu-item-url'], array( '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)
                                        ! ( '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)

-                                       ! empty( $_item_object_data['menu-item-db-id'] ) // or it *is* a custom menu item that already exists
+                                       // Or it *is* a custom menu item that already exists.
+                                       ! empty( $_item_object_data['menu-item-db-id'] )

                                )
                        ) {
                                )
                        ) {

-                               continue; // then this potential menu item is not getting added to this menu
+                               // Then this potential menu item is not getting added to this menu.
+                               continue;

                        }
 
                        }
 

-                       // if this possible menu item doesn't actually have a menu database ID yet
+                       // If this possible menu item doesn't actually have a menu database ID yet.

                        if (
                                empty( $_item_object_data['menu-item-db-id'] ) ||
                                ( 0 > $_possible_db_id ) ||
                        if (
                                empty( $_item_object_data['menu-item-db-id'] ) ||
                                ( 0 > $_possible_db_id ) ||


@@ -1091,20 +1120,20 @@ function _wp_nav_menu_meta_box_object( $object = null ) {
                                'post_status' => 'publish',
                        );
 
                                'post_status' => 'publish',
                        );
 

-               // posts should show only published items
+               // Posts should show only published items.

                } elseif ( 'post' == $object->name ) {
                        $object->_default_query = array(
                                'post_status' => 'publish',
                        );
 
                } elseif ( 'post' == $object->name ) {
                        $object->_default_query = array(
                                'post_status' => 'publish',
                        );
 

-               // cats should be in reverse chronological order
+               // Categories should be in reverse chronological order.

                } elseif ( 'category' == $object->name ) {
                        $object->_default_query = array(
                                'orderby' => 'id',
                                'order' => 'DESC',
                        );
 
                } elseif ( 'category' == $object->name ) {
                        $object->_default_query = array(
                                'orderby' => 'id',
                                'order' => 'DESC',
                        );
 

-               // custom post types should show only published items
+               // Custom post types should show only published items.

                } else {
                        $object->_default_query = array(
                                'post_status' => 'publish',
                } else {
                        $object->_default_query = array(
                                'post_status' => 'publish',


@@ -1137,6 +1166,14 @@ function wp_get_nav_menu_to_edit( $menu_id = 0 ) {
                if( empty($menu_items) )
                        return $result . ' <ul class="menu" id="menu-to-edit"> </ul>';
 
                if( empty($menu_items) )
                        return $result . ' <ul class="menu" id="menu-to-edit"> </ul>';
 

+               /**
+                * Filter the Walker class used when adding nav menu items.
+                *
+                * @since 3.0.0
+                *
+                * @param string $class   The walker class to use. Default 'Walker_Nav_Menu_Edit'.
+                * @param int    $menu_id ID of the menu being rendered.
+                */

                $walker_class_name = apply_filters( 'wp_edit_nav_menu_walker', 'Walker_Nav_Menu_Edit', $menu_id );
 
                if ( class_exists( $walker_class_name ) )
                $walker_class_name = apply_filters( 'wp_edit_nav_menu_walker', 'Walker_Nav_Menu_Edit', $menu_id );
 
                if ( class_exists( $walker_class_name ) )


@@ -1197,7 +1234,7 @@ function _wp_delete_orphaned_draft_menu_items() {
        global $wpdb;
        $delete_timestamp = time() - ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS );
 
        global $wpdb;
        $delete_timestamp = time() - ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS );
 

-       // delete orphaned draft menu items
+       // Delete orphaned draft menu items.

        $menu_items_to_delete = $wpdb->get_col($wpdb->prepare("SELECT ID FROM $wpdb->posts AS p LEFT JOIN $wpdb->postmeta AS m ON p.ID = m.post_id WHERE post_type = 'nav_menu_item' AND post_status = 'draft' AND meta_key = '_menu_item_orphaned' AND meta_value < '%d'", $delete_timestamp ) );
 
        foreach( (array) $menu_items_to_delete as $menu_item_id )
        $menu_items_to_delete = $wpdb->get_col($wpdb->prepare("SELECT ID FROM $wpdb->posts AS p LEFT JOIN $wpdb->postmeta AS m ON p.ID = m.post_id WHERE post_type = 'nav_menu_item' AND post_status = 'draft' AND meta_key = '_menu_item_orphaned' AND meta_value < '%d'", $delete_timestamp ) );
 
        foreach( (array) $menu_items_to_delete as $menu_item_id )


@@ -1281,6 +1318,7 @@ function wp_nav_menu_update_menu_items ( $nav_menu_selected_id, $nav_menu_select
 
        wp_defer_term_counting( false );
 
 
        wp_defer_term_counting( false );
 

+       /** This action is documented in wp-includes/nav-menu.php */

        do_action( 'wp_update_nav_menu', $nav_menu_selected_id );
 
        $messages[] = '<div id="message" class="updated"><p>' . sprintf( __( '<strong>%1$s</strong> has been updated.' ), $nav_menu_selected_title ) . '</p></div>';
        do_action( 'wp_update_nav_menu', $nav_menu_selected_id );
 
        $messages[] = '<div id="message" class="updated"><p>' . sprintf( __( '<strong>%1$s</strong> has been updated.' ), $nav_menu_selected_title ) . '</p></div>';