PHPXRef 0.7 : WordPress 3.0 beta 1 : Detail view of nav-menu.php

Navigation Menu functions

File Size:	283 lines (8 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 8 functions

  wp_get_nav_menu_object()
  is_nav_menu()
  wp_create_nav_menu()
  wp_delete_nav_menu()
  wp_get_nav_menus()
  wp_get_nav_menu_items()
  walk_nav_menu_tree()
  wp_setup_nav_menu_item()

Functions

Functions that are not part of a class:

wp_get_nav_menu_object( $menu ) X-Ref

Returns a navigation menu object.

param: string $menu Menu id
return: mixed $menu|false Or WP_Error

is_nav_menu( $menu ) X-Ref

Check if navigation menu exists.

Returns the menu object, or false if the term doesn't exist.

param: int|string $menu The menu to check
return: mixed Menu Object, if it exists. Else, false or WP_Error

wp_create_nav_menu( $menu_name, $args = array() X-Ref

Create a Navigation Menu.

Optional args:
slug - the url friendly version of the nav menu.

param: string $menu_name Menu Name
param: string $args Optional.
return: mixed Menu object on sucess|WP_Error on failure

wp_delete_nav_menu( $menu ) X-Ref

Delete a Navigation Menu.

param: string $menu name|id|slug
return: mixed Menu object on sucess|WP_Error on failure

wp_get_nav_menus() X-Ref

Returns all navigation menu objects.

return: array menu objects

wp_get_nav_menu_items( $menu, $args = array() X-Ref

Returns all menu items of a navigation menu.

param: string $menu menu name, id, or slug
param: string $args
return: mixed $items array of menu items, else false.

walk_nav_menu_tree( $items, $depth, $r ) X-Ref

Retrieve the HTML list content for nav menu items.

wp_setup_nav_menu_item( $menu_item, $menu_item_type = null, $menu_item_object = '' ) X-Ref

Adds all the navigation menu properties to the menu item.

param: string $menu_item The menu item to modify
param: string $menu_item_type The menu item type (frontend, custom, post_type, taxonomy).
param: string $menu_item_object Optional. The menu item object type (post type or taxonomy).
return: object $menu_item The modified menu item.

PHP Cross Reference of WordPress 3.0 beta 1

/wp-includes/ -> nav-menu.php (summary)

Defines 8 functions

[ Index ]	PHP Cross Reference of WordPress 3.0 beta 1
[ Index ] [ Variables ] [ Functions ] [ Classes ] [ Constants ] [ Statistics ]