WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / nav-menu.php
index 48549b1aaa4f464713950f8f04dce4923270e04b..91a102a8809948a9ca25f31a3648440ee5c18bdf 100644 (file)
  *
  * @since 3.0.0
  *
- * @param string $menu Menu ID, slug, or name.
- * @return mixed false if $menu param isn't supplied or term does not exist, menu object if successful.
+ * @param string $menu Menu ID, slug, or name - or the menu object.
+ * @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
  */
 function wp_get_nav_menu_object( $menu ) {
-       if ( ! $menu )
-               return false;
+       $menu_obj = false;
 
-       $menu_obj = get_term( $menu, 'nav_menu' );
+       if ( is_object( $menu ) ) {
+               $menu_obj = $menu;
+       }
 
-       if ( ! $menu_obj )
-               $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
+       if ( $menu && ! $menu_obj ) {
+               $menu_obj = get_term( $menu, 'nav_menu' );
 
-       if ( ! $menu_obj )
-               $menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
+               if ( ! $menu_obj ) {
+                       $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
+               }
+
+               if ( ! $menu_obj ) {
+                       $menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
+               }
+       }
 
-       if ( ! $menu_obj )
+       if ( ! $menu_obj || is_wp_error( $menu_obj ) ) {
                $menu_obj = false;
+       }
 
-       return $menu_obj;
+       /**
+        * Filter the nav_menu term retrieved for wp_get_nav_menu_object().
+        *
+        * @since 4.3.0
+        *
+        * @param object|false $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
+        * @param string       $menu     The menu ID, slug, or name passed to wp_get_nav_menu_object().
+        */
+       return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu );
 }
 
 /**
@@ -65,6 +81,8 @@ function is_nav_menu( $menu ) {
  *
  * @since 3.0.0
  *
+ * @global array $_wp_registered_nav_menus
+ *
  * @param array $locations Associative array of menu location identifiers (like a slug) and descriptive text.
  */
 function register_nav_menus( $locations = array() ) {
@@ -78,6 +96,8 @@ function register_nav_menus( $locations = array() ) {
 /**
  * Unregisters a navigation menu for a theme.
  *
+ * @global array $_wp_registered_nav_menus
+ *
  * @param string $location The menu location identifier.
  * @return bool True on success, false on failure.
  */
@@ -99,7 +119,7 @@ function unregister_nav_menu( $location ) {
  *
  * @since 3.0.0
  *
- * @param string $location Menu location identifier, like a slug.
+ * @param string $location    Menu location identifier, like a slug.
  * @param string $description Menu location descriptive text.
  */
 function register_nav_menu( $location, $description ) {
@@ -109,6 +129,9 @@ function register_nav_menu( $location, $description ) {
  * Returns an array of all registered navigation menus in a theme
  *
  * @since 3.0.0
+ *
+ * @global array $_wp_registered_nav_menus
+ *
  * @return array
  */
 function get_registered_nav_menus() {
@@ -134,17 +157,28 @@ function get_nav_menu_locations() {
  * Whether a registered nav menu location has a menu assigned to it.
  *
  * @since 3.0.0
+ *
  * @param string $location Menu location identifier.
  * @return bool Whether location has a menu.
  */
 function has_nav_menu( $location ) {
+       $has_nav_menu = false;
+
        $registered_nav_menus = get_registered_nav_menus();
-       if ( ! isset( $registered_nav_menus[ $location ] ) ) {
-               return false;
+       if ( isset( $registered_nav_menus[ $location ] ) ) {
+               $locations = get_nav_menu_locations();
+               $has_nav_menu = ! empty( $locations[ $location ] );
        }
 
-       $locations = get_nav_menu_locations();
-       return ( ! empty( $locations[ $location ] ) );
+       /**
+        * Filter whether a nav menu is assigned to the specified location.
+        *
+        * @since 4.3.0
+        *
+        * @param bool   $has_nav_menu Whether there is a menu assigned to a location.
+        * @param string $location     Menu location.
+        */
+       return apply_filters( 'has_nav_menu', $has_nav_menu, $location );
 }
 
 /**
@@ -220,7 +254,7 @@ function wp_delete_nav_menu( $menu ) {
  *
  * @since 3.0.0
  *
- * @param int $menu_id The ID of the menu or "0" to create a new menu.
+ * @param int   $menu_id   The ID of the menu or "0" to create a new menu.
  * @param array $menu_data The array of menu data.
  * @return int|WP_Error Menu ID on success, WP_Error object on failure.
  */
@@ -243,15 +277,27 @@ function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) {
                ! is_wp_error( $_possible_existing ) &&
                isset( $_possible_existing->term_id ) &&
                $_possible_existing->term_id != $menu_id
-       )
-               return new WP_Error( 'menu_exists', sprintf( __('The menu name <strong>%s</strong> conflicts with another menu name. Please try another.'), esc_html( $menu_data['menu-name'] ) ) );
+       ) {
+               return new WP_Error( 'menu_exists',
+                       /* translators: %s: menu name */
+                       sprintf( __( 'The menu name %s conflicts with another menu name. Please try another.' ),
+                               '<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>'
+                       )
+               );
+       }
 
        // menu doesn't already exist, so create a new menu
        if ( ! $_menu || is_wp_error( $_menu ) ) {
                $menu_exists = get_term_by( 'name', $menu_data['menu-name'], 'nav_menu' );
 
-               if ( $menu_exists )
-                       return new WP_Error( 'menu_exists', sprintf( __('The menu name <strong>%s</strong> conflicts with another menu name. Please try another.'), esc_html( $menu_data['menu-name'] ) ) );
+               if ( $menu_exists ) {
+                       return new WP_Error( 'menu_exists',
+                               /* translators: %s: menu name */
+                               sprintf( __( 'The menu name %s conflicts with another menu name. Please try another.' ),
+                                       '<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>'
+                               )
+                       );
+               }
 
                $_menu = wp_insert_term( $menu_data['menu-name'], 'nav_menu', $args );
 
@@ -281,6 +327,8 @@ function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) {
        if ( is_wp_error( $update_response ) )
                return $update_response;
 
+       $menu_id = (int) $update_response['term_id'];
+
        /**
         * Fires after a navigation menu has been successfully updated.
         *
@@ -298,9 +346,9 @@ function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) {
  *
  * @since 3.0.0
  *
- * @param int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan.
- * @param int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
- * @param array $menu_item_data The menu item's data.
+ * @param int   $menu_id         The ID of the menu. Required. If "0", makes the menu item a draft orphan.
+ * @param int   $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
+ * @param array $menu_item_data  The menu item's data.
  * @return int|WP_Error The menu item's database ID or WP_Error object on failure.
  */
 function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array() ) {
@@ -367,6 +415,9 @@ function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item
                        $original_object = get_post( $args['menu-item-object-id'] );
                        $original_parent = (int) $original_object->post_parent;
                        $original_title = $original_object->post_title;
+               } elseif ( 'post_type_archive' == $args['menu-item-type'] ) {
+                       $original_object = get_post_type_object( $args['menu-item-object'] );
+                       $original_title = $original_object->labels->archives;
                }
 
                if ( $args['menu-item-title'] == $original_title )
@@ -397,6 +448,19 @@ function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item
                $menu_item_db_id = wp_insert_post( $post );
                if ( ! $menu_item_db_id || is_wp_error( $menu_item_db_id ) )
                        return $menu_item_db_id;
+
+               /**
+                * Fires immediately after a new navigation menu item has been added.
+                *
+                * @since 4.4.0
+                *
+                * @see wp_update_nav_menu_item()
+                *
+                * @param int   $menu_id         ID of the updated menu.
+                * @param int   $menu_item_db_id ID of the new menu item.
+                * @param array $args            An array of arguments used to update/add the menu item.
+                */
+               do_action( 'wp_add_nav_menu_item', $menu_id, $menu_item_db_id, $args );
        }
 
        // Associate the menu item with the menu term
@@ -486,6 +550,8 @@ function wp_get_nav_menus( $args = array() ) {
  * @since 3.0.0
  * @access private
  *
+ * @global string $_menu_item_sort_prop
+ *
  * @param object $a The first object to compare
  * @param object $b The second object to compare
  * @return int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b.
@@ -522,10 +588,7 @@ function _sort_nav_menu_items( $a, $b ) {
  * @return bool False if invalid, otherwise true.
  */
 function _is_valid_nav_menu_item( $item ) {
-       if ( ! empty( $item->_invalid ) )
-               return false;
-
-       return true;
+       return empty( $item->_invalid );
 }
 
 /**
@@ -533,32 +596,37 @@ function _is_valid_nav_menu_item( $item ) {
  *
  * @since 3.0.0
  *
+ * @global string $_menu_item_sort_prop
+ * @staticvar array $fetched
+ *
  * @param string $menu Menu name, ID, or slug.
  * @param array  $args Optional. Arguments to pass to {@see get_posts()}.
- * @return mixed $items Array of menu items, otherwise false.
+ * @return false|array $items Array of menu items, otherwise false.
  */
 function wp_get_nav_menu_items( $menu, $args = array() ) {
        $menu = wp_get_nav_menu_object( $menu );
 
-       if ( ! $menu )
+       if ( ! $menu ) {
                return false;
+       }
 
        static $fetched = array();
 
        $items = get_objects_in_term( $menu->term_id, 'nav_menu' );
-
-       if ( empty( $items ) )
-               return $items;
+       if ( is_wp_error( $items ) ) {
+               return false;
+       }
 
        $defaults = array( 'order' => 'ASC', 'orderby' => 'menu_order', 'post_type' => 'nav_menu_item',
                'post_status' => 'publish', 'output' => ARRAY_A, 'output_key' => 'menu_order', 'nopaging' => true );
        $args = wp_parse_args( $args, $defaults );
        $args['include'] = $items;
 
-       $items = get_posts( $args );
-
-       if ( is_wp_error( $items ) || ! is_array( $items ) )
-               return false;
+       if ( ! empty( $items ) ) {
+               $items = get_posts( $args );
+       } else {
+               $items = array();
+       }
 
        // Get all posts and terms at once to prime the caches
        if ( empty( $fetched[$menu->term_id] ) || wp_using_ext_object_cache() ) {
@@ -585,7 +653,10 @@ function wp_get_nav_menu_items( $menu, $args = array() ) {
 
                if ( ! empty( $terms ) ) {
                        foreach ( array_keys($terms) as $taxonomy ) {
-                               get_terms($taxonomy, array('include' => $terms[$taxonomy]) );
+                               get_terms( $taxonomy, array(
+                                       'include' => $terms[ $taxonomy ],
+                                       'hierarchical' => false,
+                               ) );
                        }
                }
                unset($terms);
@@ -593,15 +664,16 @@ function wp_get_nav_menu_items( $menu, $args = array() ) {
 
        $items = array_map( 'wp_setup_nav_menu_item', $items );
 
-       if ( ! is_admin() ) // Remove invalid items only in frontend
+       if ( ! is_admin() ) // Remove invalid items only in frontend
                $items = array_filter( $items, '_is_valid_nav_menu_item' );
+       }
 
        if ( ARRAY_A == $args['output'] ) {
                $GLOBALS['_menu_item_sort_prop'] = $args['output_key'];
                usort($items, '_sort_nav_menu_items');
                $i = 1;
-               foreach( $items as $k => $item ) {
-                       $items[$k]->$args['output_key'] = $i++;
+               foreach ( $items as $k => $item ) {
+                       $items[$k]->{$args['output_key']} = $i++;
                }
        }
 
@@ -614,27 +686,30 @@ function wp_get_nav_menu_items( $menu, $args = array() ) {
         * @param object $menu  The menu object.
         * @param array  $args  An array of arguments used to retrieve menu item objects.
         */
-       return apply_filters( 'wp_get_nav_menu_items',  $items, $menu, $args );
+       return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args );
 }
 
 /**
  * Decorates a menu item object with the shared navigation menu item properties.
  *
  * Properties:
- * - db_id:            The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist).
- * - object_id:                The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
- * - type:             The family of objects originally represented, such as "post_type" or "taxonomy."
- * - object:           The type of object originally represented, such as "category," "post", or "attachment."
- * - type_label:       The singular label used to describe this type of menu item.
- * - post_parent:      The DB ID of the original object's parent object, if any (0 otherwise).
- * - menu_item_parent:         The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
- * - url:              The URL to which this menu item points.
- * - title:            The title of this menu item.
- * - target:           The target attribute of the link element for this menu item.
- * - attr_title:       The title attribute of the link element for this menu item.
- * - classes:          The array of class attribute values for the link element of this menu item.
- * - xfn:              The XFN relationship expressed in the link of this menu item.
- * - description:      The description of this menu item.
+ * - ID:               The term_id if the menu item represents a taxonomy term.
+ * - attr_title:       The title attribute of the link element for this menu item.
+ * - classes:          The array of class attribute values for the link element of this menu item.
+ * - db_id:            The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist).
+ * - description:      The description of this menu item.
+ * - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
+ * - object:           The type of object originally represented, such as "category," "post", or "attachment."
+ * - object_id:        The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
+ * - post_parent:      The DB ID of the original object's parent object, if any (0 otherwise).
+ * - post_title:       A "no title" label if menu item represents a post that lacks a title.
+ * - target:           The target attribute of the link element for this menu item.
+ * - title:            The title of this menu item.
+ * - type:             The family of objects originally represented, such as "post_type" or "taxonomy."
+ * - type_label:       The singular label used to describe this type of menu item.
+ * - url:              The URL to which this menu item points.
+ * - xfn:              The XFN relationship expressed in the link of this menu item.
+ * - _invalid:         Whether the menu item represents an object that no longer exists.
  *
  * @since 3.0.0
  *
@@ -645,10 +720,10 @@ function wp_setup_nav_menu_item( $menu_item ) {
        if ( isset( $menu_item->post_type ) ) {
                if ( 'nav_menu_item' == $menu_item->post_type ) {
                        $menu_item->db_id = (int) $menu_item->ID;
-                       $menu_item->menu_item_parent = empty( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent;
-                       $menu_item->object_id = empty( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;
-                       $menu_item->object = empty( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;
-                       $menu_item->type = empty( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;
+                       $menu_item->menu_item_parent = ! isset( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent;
+                       $menu_item->object_id = ! isset( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;
+                       $menu_item->object = ! isset( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;
+                       $menu_item->type = ! isset( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;
 
                        if ( 'post_type' == $menu_item->type ) {
                                $object = get_post_type_object( $menu_item->object );
@@ -665,11 +740,23 @@ function wp_setup_nav_menu_item( $menu_item ) {
                                $original_title = $original_object->post_title;
 
                                if ( '' === $original_title ) {
+                                       /* translators: %d: ID of a post */
                                        $original_title = sprintf( __( '#%d (no title)' ), $original_object->ID );
                                }
 
                                $menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
 
+                       } elseif ( 'post_type_archive' == $menu_item->type ) {
+                               $object =  get_post_type_object( $menu_item->object );
+                               if ( $object ) {
+                                       $menu_item->title = '' == $menu_item->post_title ? $object->labels->archives : $menu_item->post_title;
+                               } else {
+                                       $menu_item->_invalid = true;
+                               }
+
+                               $menu_item->type_label = __( 'Post Type Archive' );
+                               $menu_item->description = '';
+                               $menu_item->url = get_post_type_archive_link( $menu_item->object );
                        } elseif ( 'taxonomy' == $menu_item->type ) {
                                $object = get_taxonomy( $menu_item->object );
                                if ( $object ) {
@@ -690,10 +777,10 @@ function wp_setup_nav_menu_item( $menu_item ) {
                        } else {
                                $menu_item->type_label = __('Custom Link');
                                $menu_item->title = $menu_item->post_title;
-                               $menu_item->url = empty( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url;
+                               $menu_item->url = ! isset( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url;
                        }
 
-                       $menu_item->target = empty( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
+                       $menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
 
                        /**
                         * Filter a navigation menu item's title attribute.
@@ -702,9 +789,9 @@ function wp_setup_nav_menu_item( $menu_item ) {
                         *
                         * @param string $item_title The menu item title attribute.
                         */
-                       $menu_item->attr_title = empty( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;
+                       $menu_item->attr_title = ! isset( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;
 
-                       if ( empty( $menu_item->description ) ) {
+                       if ( ! isset( $menu_item->description ) ) {
                                /**
                                 * Filter a navigation menu item's description.
                                 *
@@ -715,8 +802,8 @@ function wp_setup_nav_menu_item( $menu_item ) {
                                $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) );
                        }
 
-                       $menu_item->classes = empty( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;
-                       $menu_item->xfn = empty( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
+                       $menu_item->classes = ! isset( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;
+                       $menu_item->xfn = ! isset( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
                } else {
                        $menu_item->db_id = 0;
                        $menu_item->menu_item_parent = 0;
@@ -727,8 +814,10 @@ function wp_setup_nav_menu_item( $menu_item ) {
                        $menu_item->object = $object->name;
                        $menu_item->type_label = $object->labels->singular_name;
 
-                       if ( '' === $menu_item->post_title )
+                       if ( '' === $menu_item->post_title ) {
+                               /* translators: %d: ID of a post */
                                $menu_item->post_title = sprintf( __( '#%d (no title)' ), $menu_item->ID );
+                       }
 
                        $menu_item->title = $menu_item->post_title;
                        $menu_item->url = get_permalink( $menu_item->ID );
@@ -779,9 +868,9 @@ function wp_setup_nav_menu_item( $menu_item ) {
  *
  * @since 3.0.0
  *
- * @param int $object_id The ID of the original object.
+ * @param int    $object_id   The ID of the original object.
  * @param string $object_type The type of object, such as "taxonomy" or "post_type."
- * @param string $taxonomy If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
+ * @param string $taxonomy    If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
  * @return array The array of menu item IDs; empty array if none;
  */
 function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) {
@@ -798,7 +887,7 @@ function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_
                        'posts_per_page' => -1,
                )
        );
-       foreach( (array) $menu_items as $menu_item ) {
+       foreach ( (array) $menu_items as $menu_item ) {
                if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) {
                        $menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true );
                        if (
@@ -833,7 +922,7 @@ function _wp_delete_post_menu_item( $object_id = 0 ) {
 
        $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'post_type' );
 
-       foreach( (array) $menu_item_ids as $menu_item_id ) {
+       foreach ( (array) $menu_item_ids as $menu_item_id ) {
                wp_delete_post( $menu_item_id, true );
        }
 }
@@ -852,7 +941,7 @@ function _wp_delete_tax_menu_item( $object_id = 0, $tt_id, $taxonomy ) {
 
        $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'taxonomy', $taxonomy );
 
-       foreach( (array) $menu_item_ids as $menu_item_id ) {
+       foreach ( (array) $menu_item_ids as $menu_item_id ) {
                wp_delete_post( $menu_item_id, true );
        }
 }
@@ -865,8 +954,7 @@ function _wp_delete_tax_menu_item( $object_id = 0, $tt_id, $taxonomy ) {
  *
  * @param string $new_status The new status of the post object.
  * @param string $old_status The old status of the post object.
- * @param object $post The post object being transitioned from one status to another.
- * @return void
+ * @param object $post       The post object being transitioned from one status to another.
  */
 function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) {
        if ( 'publish' != $new_status || 'publish' == $old_status || 'page' != $post->post_type )