2010-02-24 08:06:36 +00:00
< ? php
/**
* Navigation Menu functions
*
* @ package WordPress
2010-03-31 07:54:09 +00:00
* @ subpackage Nav_Menus
2010-02-24 08:06:36 +00:00
* @ since 3.0 . 0
*/
2010-02-28 20:00:49 +00:00
/**
2010-03-22 19:56:16 +00:00
* Returns a navigation menu object .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
*
2010-05-18 05:59:25 +00:00
* @ uses get_term
* @ uses get_term_by
*
* @ param string $menu Menu id , slug or name
2010-05-31 16:11:20 +00:00
* @ return mixed false if $menu param isn ' t supplied or term does not exist , menu object if successful .
2010-02-28 20:00:49 +00:00
*/
function wp_get_nav_menu_object ( $menu ) {
2010-05-03 20:26:11 +00:00
if ( ! $menu )
2010-04-27 01:05:58 +00:00
return false ;
$menu_obj = get_term ( $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' );
2010-05-31 16:11:20 +00:00
if ( ! $menu_obj )
2010-04-27 01:05:58 +00:00
$menu_obj = false ;
return $menu_obj ;
2010-02-28 20:00:49 +00:00
}
2010-02-24 08:06:36 +00:00
2010-02-28 20:00:49 +00:00
/**
2010-05-31 16:11:20 +00:00
* Check if the given ID is a navigation menu .
2010-02-28 20:00:49 +00:00
*
2010-04-28 02:04:30 +00:00
* Returns true if it is ; false otherwise .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
*
2010-05-18 05:59:25 +00:00
* @ param int | string $menu The menu to check ( id , slug , or name )
2010-04-27 01:05:58 +00:00
* @ return bool Whether the menu exists .
2010-02-28 20:00:49 +00:00
*/
function is_nav_menu ( $menu ) {
2010-04-27 01:05:58 +00:00
if ( ! $menu )
2010-03-02 17:56:24 +00:00
return false ;
2010-05-03 20:26:11 +00:00
2010-04-27 01:05:58 +00:00
$menu_obj = wp_get_nav_menu_object ( $menu );
2010-03-02 17:56:24 +00:00
2010-05-03 20:26:11 +00:00
if (
$menu_obj &&
! is_wp_error ( $menu_obj ) &&
2010-04-28 18:30:32 +00:00
! empty ( $menu_obj -> taxonomy ) &&
'nav_menu' == $menu_obj -> taxonomy
2010-05-03 20:26:11 +00:00
)
2010-04-27 01:05:58 +00:00
return true ;
2010-05-03 20:26:11 +00:00
2010-04-27 01:05:58 +00:00
return false ;
2010-02-24 08:06:36 +00:00
}
2010-05-13 22:14:54 +00:00
/**
2010-05-31 16:11:20 +00:00
* Register navigation menus for a theme .
2010-05-13 22:14:54 +00:00
*
* @ since 3.0 . 0
*
2010-05-14 06:20:30 +00:00
* @ param array $locations Associative array of menu location identifiers ( like a slug ) and descriptive text .
2010-05-13 22:14:54 +00:00
*/
2010-05-14 06:20:30 +00:00
function register_nav_menus ( $locations = array () ) {
2010-05-13 22:14:54 +00:00
global $_wp_registered_nav_menus ;
2010-06-10 17:57:30 +00:00
add_theme_support ( 'menus' );
2010-05-13 22:14:54 +00:00
2010-05-14 06:20:30 +00:00
$_wp_registered_nav_menus = array_merge ( ( array ) $_wp_registered_nav_menus , $locations );
2010-05-13 22:14:54 +00:00
}
2010-07-22 20:50:11 +00:00
/**
* Unregisters a navigation menu for a theme .
*
* @ param array $location the menu location identifier
*
* @ return bool True on success , false on failure .
*/
function unregister_nav_menu ( $location ) {
global $_wp_registered_nav_menus ;
if ( is_array ( $_wp_registered_nav_menus ) && isset ( $_wp_registered_nav_menus [ $location ] ) ) {
unset ( $_wp_registered_nav_menus [ $location ] );
return true ;
}
return false ;
}
2010-05-14 06:20:30 +00:00
/**
2010-05-31 16:11:20 +00:00
* Register a navigation menu for a theme .
2010-05-14 06:20:30 +00:00
*
* @ since 3.0 . 0
*
* @ param string $location Menu location identifier , like a slug .
* @ param string $description Menu location descriptive text .
*/
function register_nav_menu ( $location , $description ) {
register_nav_menus ( array ( $location => $description ) );
}
2010-05-18 05:59:25 +00:00
/**
2010-05-31 16:11:20 +00:00
* Returns an array of all registered navigation menus in a theme
2010-05-18 05:59:25 +00:00
*
* @ since 3.0 . 0
* @ return array
*/
2010-05-14 06:20:30 +00:00
function get_registered_nav_menus () {
2010-05-21 19:02:36 +00:00
global $_wp_registered_nav_menus ;
if ( isset ( $_wp_registered_nav_menus ) )
return $_wp_registered_nav_menus ;
return array ();
2010-05-13 22:14:54 +00:00
}
2010-05-18 05:59:25 +00:00
/**
2010-05-31 16:11:20 +00:00
* Returns an array with the registered navigation menu locations and the menu assigned to it
2010-05-18 05:59:25 +00:00
*
* @ since 3.0 . 0
* @ return array
*/
2010-05-14 06:20:30 +00:00
function get_nav_menu_locations () {
2010-05-31 16:11:20 +00:00
return get_theme_mod ( 'nav_menu_locations' );
2010-05-13 22:14:54 +00:00
}
2010-06-01 16:40:14 +00:00
/**
* 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 ) {
$locations = get_nav_menu_locations ();
return ( ! empty ( $locations [ $location ] ) );
}
2010-04-28 02:04:30 +00:00
/**
* Determine whether the given ID is a nav menu item .
*
* @ since 3.0 . 0
*
* @ param int $menu_item_id The ID of the potential nav menu item .
* @ return bool Whether the given ID is that of a nav menu item .
*/
function is_nav_menu_item ( $menu_item_id = 0 ) {
return ( ! is_wp_error ( $menu_item_id ) && ( 'nav_menu_item' == get_post_type ( $menu_item_id ) ) );
}
2010-02-28 20:00:49 +00:00
/**
2010-03-22 19:56:16 +00:00
* Create a Navigation Menu .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
*
* @ param string $menu_name Menu Name
2010-05-31 16:11:20 +00:00
* @ return mixed Menu object on success | WP_Error on failure
2010-02-28 20:00:49 +00:00
*/
2010-05-31 16:11:20 +00:00
function wp_create_nav_menu ( $menu_name ) {
2010-06-02 13:43:46 +00:00
return wp_update_nav_menu_object ( 0 , array ( 'menu-name' => $menu_name ) );
2010-02-24 08:06:36 +00:00
}
2010-02-28 20:00:49 +00:00
/**
2010-03-22 19:56:16 +00:00
* Delete a Navigation Menu .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
*
* @ param string $menu name | id | slug
2010-05-31 16:11:20 +00:00
* @ return mixed Menu object on success | WP_Error on failure
2010-02-28 20:00:49 +00:00
*/
function wp_delete_nav_menu ( $menu ) {
$menu = wp_get_nav_menu_object ( $menu );
2010-05-31 16:11:20 +00:00
if ( ! $menu )
2010-02-28 20:00:49 +00:00
return false ;
$menu_objects = get_objects_in_term ( $menu -> term_id , 'nav_menu' );
2010-05-31 16:11:20 +00:00
if ( ! empty ( $menu_objects ) ) {
2010-02-28 20:00:49 +00:00
foreach ( $menu_objects as $item ) {
wp_delete_post ( $item );
}
}
2010-03-26 19:36:49 +00:00
2010-03-22 19:56:16 +00:00
$result = wp_delete_term ( $menu -> term_id , 'nav_menu' );
2010-03-26 19:36:49 +00:00
2010-05-31 16:11:20 +00:00
if ( $result && ! is_wp_error ( $result ) )
2010-03-22 19:56:16 +00:00
do_action ( 'wp_delete_nav_menu' , $menu -> term_id );
2010-05-31 16:11:20 +00:00
return $result ;
2010-02-28 20:00:49 +00:00
}
2010-04-27 01:05:58 +00:00
/**
* Save the properties of a menu or create a new menu with those properties .
*
* @ since 3.0 . 0
*
2010-06-02 13:43:46 +00:00
* @ param int $menu_id The ID of the menu or " 0 " to create a new menu .
2010-04-27 01:05:58 +00:00
* @ param array $menu_data The array of menu data .
2010-04-28 18:30:32 +00:00
* @ return int | error object The menu ' s ID or WP_Error object .
2010-04-27 01:05:58 +00:00
*/
function wp_update_nav_menu_object ( $menu_id = 0 , $menu_data = array () ) {
$menu_id = ( int ) $menu_id ;
$_menu = wp_get_nav_menu_object ( $menu_id );
2010-05-31 16:11:20 +00:00
$args = array (
'description' => ( isset ( $menu_data [ 'description' ] ) ? $menu_data [ 'description' ] : '' ),
'name' => ( isset ( $menu_data [ 'menu-name' ] ) ? $menu_data [ 'menu-name' ] : '' ),
'parent' => ( isset ( $menu_data [ 'parent' ] ) ? ( int ) $menu_data [ 'parent' ] : 0 ),
'slug' => null ,
);
2010-04-27 01:05:58 +00:00
2010-06-02 13:43:46 +00:00
// double-check that we're not going to have one menu take the name of another
2010-05-31 16:11:20 +00:00
$_possible_existing = get_term_by ( 'name' , $menu_data [ 'menu-name' ], 'nav_menu' );
if (
$_possible_existing &&
! 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' ] ) ) );
2010-06-02 13:43:46 +00:00
// 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' ] ) ) );
$_menu = wp_insert_term ( $menu_data [ 'menu-name' ], 'nav_menu' , $args );
if ( is_wp_error ( $_menu ) )
return $_menu ;
do_action ( 'wp_create_nav_menu' , $_menu [ 'term_id' ], $menu_data );
return ( int ) $_menu [ 'term_id' ];
}
if ( ! $_menu || ! isset ( $_menu -> term_id ) )
return 0 ;
$menu_id = ( int ) $_menu -> term_id ;
2010-05-31 16:11:20 +00:00
$update_response = wp_update_term ( $menu_id , 'nav_menu' , $args );
2010-06-02 13:43:46 +00:00
if ( is_wp_error ( $update_response ) )
2010-05-31 16:11:20 +00:00
return $update_response ;
2010-06-02 13:43:46 +00:00
do_action ( 'wp_update_nav_menu' , $menu_id , $menu_data );
return $menu_id ;
2010-04-27 01:05:58 +00:00
}
/**
* Save the properties of a menu item or create a new one .
*
* @ since 3.0 . 0
*
2010-06-14 19:52:30 +00:00
* @ param int $menu_id The ID of the menu . Required . If " 0 " , makes the menu item a draft orphan .
2010-04-27 01:05:58 +00:00
* @ 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 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 () ) {
$menu_id = ( int ) $menu_id ;
$menu_item_db_id = ( int ) $menu_item_db_id ;
2010-04-28 02:04:30 +00:00
// make sure that we don't convert non-nav_menu_item objects into nav_menu_item objects
2010-05-27 22:22:09 +00:00
if ( ! empty ( $menu_item_db_id ) && ! is_nav_menu_item ( $menu_item_db_id ) )
2010-04-28 02:04:30 +00:00
return new WP_Error ( 'update_nav_menu_item_failed' , __ ( 'The given object ID is not that of a menu item.' ));
2010-04-27 01:05:58 +00:00
$menu = wp_get_nav_menu_object ( $menu_id );
2010-05-27 22:22:09 +00:00
if ( ( ! $menu && 0 !== $menu_id ) || is_wp_error ( $menu ) )
2010-04-27 01:05:58 +00:00
return $menu ;
2010-06-14 19:52:30 +00:00
$menu_items = 0 == $menu_id ? array () : ( array ) wp_get_nav_menu_items ( $menu_id , array ( 'post_status' => 'publish,draft' ) );
2010-04-27 01:05:58 +00:00
$count = count ( $menu_items );
$defaults = array (
'menu-item-db-id' => $menu_item_db_id ,
'menu-item-object-id' => 0 ,
'menu-item-object' => '' ,
'menu-item-parent-id' => 0 ,
'menu-item-position' => 0 ,
'menu-item-type' => 'custom' ,
'menu-item-title' => '' ,
'menu-item-url' => '' ,
'menu-item-description' => '' ,
'menu-item-attr-title' => '' ,
'menu-item-target' => '' ,
'menu-item-classes' => '' ,
'menu-item-xfn' => '' ,
2010-05-26 06:59:14 +00:00
'menu-item-status' => '' ,
2010-04-27 01:05:58 +00:00
);
$args = wp_parse_args ( $menu_item_data , $defaults );
2010-06-02 20:04:07 +00:00
2010-05-27 22:22:09 +00:00
if ( 0 == $menu_id ) {
$args [ 'menu-item-position' ] = 1 ;
} elseif ( 0 == ( int ) $args [ 'menu-item-position' ] ) {
2010-04-27 01:05:58 +00:00
$last_item = array_pop ( $menu_items );
2010-05-26 06:59:14 +00:00
$args [ 'menu-item-position' ] = ( $last_item && isset ( $last_item -> menu_order ) ) ? 1 + $last_item -> menu_order : $count ;
2010-04-27 01:05:58 +00:00
}
2010-05-03 20:26:11 +00:00
2010-05-04 19:40:04 +00:00
$original_parent = 0 < $menu_item_db_id ? get_post_field ( 'post_parent' , $menu_item_db_id ) : 0 ;
2010-04-28 18:30:32 +00:00
if ( 'custom' != $args [ 'menu-item-type' ] ) {
/* if non - custom menu item , then :
* use original object ' s URL
* blank default title to sync with original object ' s
*/
$args [ 'menu-item-url' ] = '' ;
$original_title = '' ;
if ( 'taxonomy' == $args [ 'menu-item-type' ] ) {
2010-05-04 19:40:04 +00:00
$original_parent = get_term_field ( 'parent' , $args [ 'menu-item-object-id' ], $args [ 'menu-item-object' ], 'raw' );
2010-04-28 18:30:32 +00:00
$original_title = get_term_field ( 'name' , $args [ 'menu-item-object-id' ], $args [ 'menu-item-object' ], 'raw' );
} elseif ( 'post_type' == $args [ 'menu-item-type' ] ) {
2010-04-29 07:33:56 +00:00
2010-04-28 18:30:32 +00:00
$original_object = get_post ( $args [ 'menu-item-object-id' ] );
2010-05-04 19:40:04 +00:00
$original_parent = ( int ) $original_object -> post_parent ;
2010-04-28 18:30:32 +00:00
$original_title = $original_object -> post_title ;
}
if ( empty ( $args [ 'menu-item-title' ] ) || $args [ 'menu-item-title' ] == $original_title ) {
$args [ 'menu-item-title' ] = '' ;
// hack to get wp to create a post object when too many properties are empty
2010-05-31 16:11:20 +00:00
if ( empty ( $args [ 'menu-item-description' ] ) )
2010-04-28 18:30:32 +00:00
$args [ 'menu-item-description' ] = ' ' ;
}
}
2010-04-27 01:05:58 +00:00
// Populate the menu item object
$post = array (
'menu_order' => $args [ 'menu-item-position' ],
'ping_status' => 0 ,
'post_content' => $args [ 'menu-item-description' ],
'post_excerpt' => $args [ 'menu-item-attr-title' ],
2010-05-04 19:40:04 +00:00
'post_parent' => $original_parent ,
2010-05-03 20:26:11 +00:00
'post_title' => $args [ 'menu-item-title' ],
'post_type' => 'nav_menu_item' ,
2010-04-27 01:05:58 +00:00
);
2010-05-27 22:22:09 +00:00
if ( 0 != $menu_id )
$post [ 'tax_input' ] = array ( 'nav_menu' => array ( intval ( $menu -> term_id ) ) );
2010-06-14 19:52:30 +00:00
// New menu item. Default is draft status
2010-04-27 01:05:58 +00:00
if ( 0 == $menu_item_db_id ) {
2010-04-28 02:04:30 +00:00
$post [ 'ID' ] = 0 ;
2010-06-14 19:52:30 +00:00
$post [ 'post_status' ] = 'publish' == $args [ 'menu-item-status' ] ? 'publish' : 'draft' ;
2010-04-27 01:05:58 +00:00
$menu_item_db_id = wp_insert_post ( $post );
2010-05-26 06:59:14 +00:00
// Update existing menu item. Default is publish status
2010-04-27 01:05:58 +00:00
} else {
$post [ 'ID' ] = $menu_item_db_id ;
2010-05-26 06:59:14 +00:00
$post [ 'post_status' ] = 'draft' == $args [ 'menu-item-status' ] ? 'draft' : 'publish' ;
2010-04-27 01:05:58 +00:00
wp_update_post ( $post );
}
if ( 'custom' == $args [ 'menu-item-type' ] ) {
$args [ 'menu-item-object-id' ] = $menu_item_db_id ;
$args [ 'menu-item-object' ] = 'custom' ;
}
2010-05-31 16:11:20 +00:00
if ( ! $menu_item_db_id || is_wp_error ( $menu_item_db_id ) )
return $menu_item_db_id ;
$menu_item_db_id = ( int ) $menu_item_db_id ;
update_post_meta ( $menu_item_db_id , '_menu_item_type' , sanitize_key ( $args [ 'menu-item-type' ]) );
update_post_meta ( $menu_item_db_id , '_menu_item_menu_item_parent' , ( int ) $args [ 'menu-item-parent-id' ] );
update_post_meta ( $menu_item_db_id , '_menu_item_object_id' , ( int ) $args [ 'menu-item-object-id' ] );
update_post_meta ( $menu_item_db_id , '_menu_item_object' , sanitize_key ( $args [ 'menu-item-object' ]) );
update_post_meta ( $menu_item_db_id , '_menu_item_target' , sanitize_key ( $args [ 'menu-item-target' ]) );
2010-06-02 20:04:07 +00:00
2010-05-31 16:11:20 +00:00
$args [ 'menu-item-classes' ] = array_map ( 'sanitize_html_class' , explode ( ' ' , $args [ 'menu-item-classes' ] ) );
$args [ 'menu-item-xfn' ] = implode ( ' ' , array_map ( 'sanitize_html_class' , explode ( ' ' , $args [ 'menu-item-xfn' ] ) ) );
update_post_meta ( $menu_item_db_id , '_menu_item_classes' , $args [ 'menu-item-classes' ] );
update_post_meta ( $menu_item_db_id , '_menu_item_xfn' , $args [ 'menu-item-xfn' ] );
update_post_meta ( $menu_item_db_id , '_menu_item_url' , esc_url_raw ( $args [ 'menu-item-url' ]) );
2010-06-02 20:04:07 +00:00
2010-05-31 16:11:20 +00:00
if ( 0 == $menu_id )
update_post_meta ( $menu_item_db_id , '_menu_item_orphaned' , time () );
else
delete_post_meta ( $menu_item_db_id , '_menu_item_orphaned' );
do_action ( 'wp_update_nav_menu_item' , $menu_id , $menu_item_db_id , $args );
2010-04-27 01:05:58 +00:00
return $menu_item_db_id ;
}
2010-02-28 20:00:49 +00:00
/**
2010-03-22 19:56:16 +00:00
* Returns all navigation menu objects .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
2010-03-15 16:26:46 +00:00
*
2010-09-07 11:21:11 +00:00
* @ param array $args Array of arguments passed on to get_terms () .
2010-03-15 16:26:46 +00:00
* @ return array menu objects
2010-02-28 20:00:49 +00:00
*/
2010-05-19 18:52:37 +00:00
function wp_get_nav_menus ( $args = array () ) {
$defaults = array ( 'hide_empty' => false , 'orderby' => 'none' );
$args = wp_parse_args ( $args , $defaults );
2010-06-02 16:31:42 +00:00
return apply_filters ( 'wp_get_nav_menus' , get_terms ( 'nav_menu' , $args ), $args );
2010-02-25 21:06:44 +00:00
}
2010-04-27 01:05:58 +00:00
/**
* Sort menu items by the desired key .
*
* @ since 3.0 . 0
* @ access private
*
* @ 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 .
*/
2010-05-31 16:11:20 +00:00
function _sort_nav_menu_items ( $a , $b ) {
2010-04-27 01:05:58 +00:00
global $_menu_item_sort_prop ;
2010-05-31 16:11:20 +00:00
if ( empty ( $_menu_item_sort_prop ) )
2010-04-27 01:05:58 +00:00
return 0 ;
2010-05-31 16:11:20 +00:00
if ( ! isset ( $a -> $_menu_item_sort_prop ) || ! isset ( $b -> $_menu_item_sort_prop ) )
2010-04-27 01:05:58 +00:00
return 0 ;
2010-05-31 16:11:20 +00:00
$_a = ( int ) $a -> $_menu_item_sort_prop ;
$_b = ( int ) $b -> $_menu_item_sort_prop ;
if ( $a -> $_menu_item_sort_prop == $b -> $_menu_item_sort_prop )
return 0 ;
elseif ( $_a == $a -> $_menu_item_sort_prop && $_b == $b -> $_menu_item_sort_prop )
return $_a < $_b ? - 1 : 1 ;
else
return strcmp ( $a -> $_menu_item_sort_prop , $b -> $_menu_item_sort_prop );
2010-04-27 01:05:58 +00:00
}
2011-06-11 00:55:48 +00:00
/**
* Returns if a menu item is valid . Bug #13958
*
* @ since 3.2 . 0
* @ access private
*
* @ param object $menu_item The menu item to check
* @ return bool false if invalid , else true .
*/
function _is_valid_nav_menu_item ( $item ) {
if ( ! empty ( $item -> _invalid ) )
return false ;
return true ;
}
2010-02-28 20:00:49 +00:00
/**
2010-03-15 16:26:46 +00:00
* Returns all menu items of a navigation menu .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
*
* @ param string $menu menu name , id , or slug
2010-03-17 16:27:25 +00:00
* @ param string $args
2010-02-28 20:00:49 +00:00
* @ return mixed $items array of menu items , else false .
*/
2010-02-24 08:06:36 +00:00
function wp_get_nav_menu_items ( $menu , $args = array () ) {
2010-05-11 15:55:17 +00:00
global $_wp_using_ext_object_cache ;
2010-02-28 20:00:49 +00:00
$menu = wp_get_nav_menu_object ( $menu );
2010-03-17 16:27:25 +00:00
2010-04-27 01:05:58 +00:00
if ( ! $menu )
2010-02-28 20:00:49 +00:00
return false ;
2010-05-03 20:26:11 +00:00
2010-05-11 15:55:17 +00:00
static $fetched = array ();
2010-02-28 20:00:49 +00:00
$items = get_objects_in_term ( $menu -> term_id , 'nav_menu' );
2010-02-24 08:06:36 +00:00
2010-05-11 14:21:03 +00:00
if ( empty ( $items ) )
return $items ;
2010-05-31 16:11:20 +00:00
$defaults = array ( 'order' => 'ASC' , 'orderby' => 'menu_order' , 'post_type' => 'nav_menu_item' ,
'post_status' => 'publish' , 'output' => ARRAY_A , 'output_key' => 'menu_order' , 'nopaging' => true ,
'update_post_term_cache' => false );
2010-05-11 14:21:03 +00:00
$args = wp_parse_args ( $args , $defaults );
if ( count ( $items ) > 1 )
$args [ 'include' ] = implode ( ',' , $items );
else
$args [ 'include' ] = $items [ 0 ];
$items = get_posts ( $args );
if ( is_wp_error ( $items ) || ! is_array ( $items ) )
return false ;
// Get all posts and terms at once to prime the caches
2010-05-31 16:11:20 +00:00
if ( empty ( $fetched [ $menu -> term_id ] ) || $_wp_using_ext_object_cache ) {
2010-05-11 15:55:17 +00:00
$fetched [ $menu -> term_id ] = true ;
$posts = array ();
$terms = array ();
foreach ( $items as $item ) {
$object_id = get_post_meta ( $item -> ID , '_menu_item_object_id' , true );
2010-05-31 16:11:20 +00:00
$object = get_post_meta ( $item -> ID , '_menu_item_object' , true );
$type = get_post_meta ( $item -> ID , '_menu_item_type' , true );
2010-05-18 05:59:25 +00:00
2010-05-11 15:55:17 +00:00
if ( 'post_type' == $type )
$posts [ $object ][] = $object_id ;
elseif ( 'taxonomy' == $type )
$terms [ $object ][] = $object_id ;
2010-05-11 14:21:03 +00:00
}
2010-05-18 05:59:25 +00:00
2010-05-31 16:11:20 +00:00
if ( ! empty ( $posts ) ) {
2010-05-11 15:55:17 +00:00
foreach ( array_keys ( $posts ) as $post_type ) {
get_posts ( array ( 'post__in' => $posts [ $post_type ], 'post_type' => $post_type , 'nopaging' => true , 'update_post_term_cache' => false ) );
}
}
unset ( $posts );
2010-05-18 05:59:25 +00:00
2010-05-31 16:11:20 +00:00
if ( ! empty ( $terms ) ) {
2010-05-11 15:55:17 +00:00
foreach ( array_keys ( $terms ) as $taxonomy ) {
get_terms ( $taxonomy , array ( 'include' => $terms [ $taxonomy ]) );
}
2010-04-28 18:30:32 +00:00
}
2010-05-11 15:55:17 +00:00
unset ( $terms );
2010-05-11 14:21:03 +00:00
}
2010-04-28 18:30:32 +00:00
2010-05-11 14:21:03 +00:00
$items = array_map ( 'wp_setup_nav_menu_item' , $items );
2011-06-11 15:44:06 +00:00
if ( ! in_array ( $args [ 'post_status' ], array ( 'draft' , 'any' ) ) )
2011-06-11 00:55:48 +00:00
$items = array_filter ( $items , '_is_valid_nav_menu_item' );
2010-04-28 18:30:32 +00:00
2010-05-11 14:21:03 +00:00
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 ++ ;
2010-02-24 08:06:36 +00:00
}
}
2010-05-11 14:21:03 +00:00
2010-06-14 20:50:55 +00:00
return apply_filters ( 'wp_get_nav_menu_items' , $items , $menu , $args );
2010-02-24 08:06:36 +00:00
}
2010-02-28 20:00:49 +00:00
/**
2010-04-27 01:05:58 +00:00
* Decorates a menu item object with the shared navigation menu item properties .
2010-03-22 19:56:16 +00:00
*
2010-04-27 01:05:58 +00:00
* Properties :
2010-05-04 19:40:04 +00:00
* - db_id : The DB ID of this item as a nav_menu_item object , if it exists ( 0 if it doesn ' t exist ) .
2010-04-27 01:05:58 +00:00
* - 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. "
2010-05-11 19:52:50 +00:00
* - type_label : The singular label used to describe this type of menu item .
2010-05-04 19:40:04 +00:00
* - 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 .
2010-04-27 01:05:58 +00:00
* - 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 .
2010-05-03 20:26:11 +00:00
* - attr_title : The title attribute of the link element for this menu item .
2010-05-26 15:41:21 +00:00
* - classes : The array of class attribute values for the link element of this menu item .
2010-04-27 01:05:58 +00:00
* - xfn : The XFN relationship expressed in the link of this menu item .
* - description : The description of this menu item .
2010-02-28 20:00:49 +00:00
*
* @ since 3.0 . 0
*
2010-04-27 01:05:58 +00:00
* @ param object $menu_item The menu item to modify .
* @ return object $menu_item The menu item with standard menu item properties .
2010-02-28 20:00:49 +00:00
*/
2010-04-27 01:05:58 +00:00
function wp_setup_nav_menu_item ( $menu_item ) {
if ( isset ( $menu_item -> post_type ) ) {
if ( 'nav_menu_item' == $menu_item -> post_type ) {
2010-03-15 16:26:46 +00:00
$menu_item -> db_id = ( int ) $menu_item -> ID ;
2010-05-27 02:24:33 +00:00
$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 ;
2010-05-03 20:26:11 +00:00
2010-03-22 19:56:16 +00:00
if ( 'post_type' == $menu_item -> type ) {
$object = get_post_type_object ( $menu_item -> object );
2011-06-11 00:55:48 +00:00
if ( $object ) {
$menu_item -> type_label = $object -> labels -> singular_name ;
} else {
$menu_item -> type_label = $menu_item -> object ;
$menu_item -> post_status = 'draft' ;
$menu_item -> _invalid = true ;
}
2010-04-07 15:25:48 +00:00
$menu_item -> url = get_permalink ( $menu_item -> object_id );
2010-05-03 20:26:11 +00:00
2010-04-28 18:30:32 +00:00
$original_object = get_post ( $menu_item -> object_id );
$original_title = $original_object -> post_title ;
$menu_item -> title = '' == $menu_item -> post_title ? $original_title : $menu_item -> post_title ;
2010-03-26 19:36:49 +00:00
2010-03-22 19:56:16 +00:00
} elseif ( 'taxonomy' == $menu_item -> type ) {
$object = get_taxonomy ( $menu_item -> object );
2011-06-11 00:55:48 +00:00
if ( $object ) {
$menu_item -> type_label = $object -> labels -> singular_name ;
} else {
$menu_item -> type_label = $menu_item -> object ;
$menu_item -> post_status = 'draft' ;
$menu_item -> _invalid = true ;
}
2010-05-13 16:34:14 +00:00
$term_url = get_term_link ( ( int ) $menu_item -> object_id , $menu_item -> object );
$menu_item -> url = ! is_wp_error ( $term_url ) ? $term_url : '' ;
2010-03-26 19:36:49 +00:00
2010-04-28 18:30:32 +00:00
$original_title = get_term_field ( 'name' , $menu_item -> object_id , $menu_item -> object , 'raw' );
$menu_item -> title = '' == $menu_item -> post_title ? $original_title : $menu_item -> post_title ;
2010-03-22 19:56:16 +00:00
} else {
2010-05-11 19:52:50 +00:00
$menu_item -> type_label = __ ( 'Custom' );
2010-04-28 18:30:32 +00:00
$menu_item -> title = $menu_item -> post_title ;
2010-05-27 02:24:33 +00:00
$menu_item -> url = empty ( $menu_item -> url ) ? get_post_meta ( $menu_item -> ID , '_menu_item_url' , true ) : $menu_item -> url ;
2010-03-22 19:56:16 +00:00
}
2010-05-03 20:26:11 +00:00
2010-05-27 02:24:33 +00:00
$menu_item -> target = empty ( $menu_item -> target ) ? get_post_meta ( $menu_item -> ID , '_menu_item_target' , true ) : $menu_item -> target ;
2010-03-17 16:27:25 +00:00
2010-05-27 02:24:33 +00:00
$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 -> description = empty ( $menu_item -> description ) ? apply_filters ( 'nav_menu_description' , $menu_item -> post_content ) : $menu_item -> description ;
2010-03-17 16:27:25 +00:00
2010-05-27 02:24:33 +00:00
$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 ;
2010-04-27 01:05:58 +00:00
} else {
2010-03-15 16:26:46 +00:00
$menu_item -> db_id = 0 ;
2010-05-04 19:40:04 +00:00
$menu_item -> menu_item_parent = 0 ;
2010-03-15 16:26:46 +00:00
$menu_item -> object_id = ( int ) $menu_item -> ID ;
2010-04-27 01:05:58 +00:00
$menu_item -> type = 'post_type' ;
2010-03-17 16:27:25 +00:00
2010-04-27 01:05:58 +00:00
$object = get_post_type_object ( $menu_item -> post_type );
2010-03-22 19:56:16 +00:00
$menu_item -> object = $object -> name ;
2010-05-11 19:52:50 +00:00
$menu_item -> type_label = $object -> labels -> singular_name ;
2010-03-15 16:26:46 +00:00
$menu_item -> title = $menu_item -> post_title ;
2010-03-16 16:34:30 +00:00
$menu_item -> url = get_permalink ( $menu_item -> ID );
2010-04-03 22:52:30 +00:00
$menu_item -> target = '' ;
2010-03-17 16:27:25 +00:00
2010-05-23 22:56:51 +00:00
$menu_item -> attr_title = apply_filters ( 'nav_menu_attr_title' , $menu_item -> post_excerpt );
$menu_item -> description = apply_filters ( 'nav_menu_description' , $menu_item -> post_content );
2010-05-26 15:41:21 +00:00
$menu_item -> classes = array ();
2010-03-22 19:56:16 +00:00
$menu_item -> xfn = '' ;
2010-04-27 01:05:58 +00:00
}
} elseif ( isset ( $menu_item -> taxonomy ) ) {
$menu_item -> ID = $menu_item -> term_id ;
$menu_item -> db_id = 0 ;
2010-05-04 19:40:04 +00:00
$menu_item -> menu_item_parent = 0 ;
2010-04-27 01:05:58 +00:00
$menu_item -> object_id = ( int ) $menu_item -> term_id ;
$menu_item -> post_parent = ( int ) $menu_item -> parent ;
$menu_item -> type = 'taxonomy' ;
$object = get_taxonomy ( $menu_item -> taxonomy );
$menu_item -> object = $object -> name ;
2010-05-14 00:34:04 +00:00
$menu_item -> type_label = $object -> labels -> singular_name ;
2010-04-27 01:05:58 +00:00
$menu_item -> title = $menu_item -> name ;
$menu_item -> url = get_term_link ( $menu_item , $menu_item -> taxonomy );
$menu_item -> target = '' ;
$menu_item -> attr_title = '' ;
2010-05-23 22:56:51 +00:00
$menu_item -> description = get_term_field ( 'description' , $menu_item -> term_id , $menu_item -> taxonomy );
2010-05-26 15:41:21 +00:00
$menu_item -> classes = array ();
2010-04-27 01:05:58 +00:00
$menu_item -> xfn = '' ;
2010-03-15 16:26:46 +00:00
2010-03-26 19:36:49 +00:00
}
2010-04-27 01:05:58 +00:00
return apply_filters ( 'wp_setup_nav_menu_item' , $menu_item );
2010-02-24 08:06:36 +00:00
}
2010-04-29 07:33:56 +00:00
/**
* Get the menu items associated with a particular object .
*
* @ since 3.0 . 0
2010-05-03 20:26:11 +00:00
*
2010-04-29 07:33:56 +00:00
* @ param int $object_id The ID of the original object .
* @ param string $object_type The type of object , such as " taxonomy " or " post_type. "
* @ 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' ) {
$object_id = ( int ) $object_id ;
$menu_item_ids = array ();
$query = new WP_Query ;
$menu_items = $query -> query (
array (
'meta_key' => '_menu_item_object_id' ,
'meta_value' => $object_id ,
'post_status' => 'any' ,
'post_type' => 'nav_menu_item' ,
2010-10-13 05:25:00 +00:00
'posts_per_page' => - 1 ,
2010-04-29 07:33:56 +00:00
)
);
foreach ( ( array ) $menu_items as $menu_item ) {
if ( isset ( $menu_item -> ID ) && is_nav_menu_item ( $menu_item -> ID ) ) {
2010-05-31 16:11:20 +00:00
if ( get_post_meta ( $menu_item -> ID , '_menu_item_type' , true ) != $object_type )
2010-04-29 07:33:56 +00:00
continue ;
$menu_item_ids [] = ( int ) $menu_item -> ID ;
}
}
return array_unique ( $menu_item_ids );
}
/**
* Callback for handling a menu item when its original object is deleted .
*
* @ since 3.0 . 0
* @ access private
*
* @ param int $object_id The ID of the original object being trashed .
*
*/
function _wp_delete_post_menu_item ( $object_id = 0 ) {
$object_id = ( int ) $object_id ;
$menu_item_ids = wp_get_associated_nav_menu_items ( $object_id , 'post_type' );
foreach ( ( array ) $menu_item_ids as $menu_item_id ) {
wp_delete_post ( $menu_item_id , true );
}
}
/**
* Callback for handling a menu item when its original object is deleted .
*
* @ since 3.0 . 0
* @ access private
*
* @ param int $object_id The ID of the original object being trashed .
*
*/
function _wp_delete_tax_menu_item ( $object_id = 0 ) {
$object_id = ( int ) $object_id ;
$menu_item_ids = wp_get_associated_nav_menu_items ( $object_id , 'taxonomy' );
foreach ( ( array ) $menu_item_ids as $menu_item_id ) {
wp_delete_post ( $menu_item_id , true );
}
}
2010-05-27 22:22:09 +00:00
/**
2010-06-14 19:52:30 +00:00
* Automatically add newly published page objects to menus with that as an option .
2010-05-27 22:22:09 +00:00
*
* @ since 3.0 . 0
* @ access private
*
* @ 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
*/
2010-06-14 19:52:30 +00:00
function _wp_auto_add_pages_to_menu ( $new_status , $old_status , $post ) {
if ( 'publish' != $new_status || 'publish' == $old_status || 'page' != $post -> post_type )
return ;
if ( ! empty ( $post -> post_parent ) )
return ;
$auto_add = get_option ( 'nav_menu_options' );
if ( empty ( $auto_add ) || ! is_array ( $auto_add ) || ! isset ( $auto_add [ 'auto_add' ] ) )
return ;
$auto_add = $auto_add [ 'auto_add' ];
if ( empty ( $auto_add ) || ! is_array ( $auto_add ) )
return ;
2010-06-11 20:19:35 +00:00
2010-06-14 19:52:30 +00:00
$args = array (
'menu-item-object-id' => $post -> ID ,
'menu-item-object' => $post -> post_type ,
'menu-item-type' => 'post_type' ,
'menu-item-status' => 'publish' ,
);
2010-05-26 02:42:15 +00:00
2010-06-14 19:52:30 +00:00
foreach ( $auto_add as $menu_id ) {
$items = wp_get_nav_menu_items ( $menu_id , array ( 'post_status' => 'publish,draft' ) );
if ( ! is_array ( $items ) )
continue ;
foreach ( $items as $item ) {
if ( $post -> ID == $item -> object_id )
continue 2 ;
2010-05-25 13:49:56 +00:00
}
2010-06-14 19:52:30 +00:00
wp_update_nav_menu_item ( $menu_id , 0 , $args );
2010-05-25 13:49:56 +00:00
}
}
2010-04-27 01:05:58 +00:00
?>