API Documentation
\

\WP_REST_Menus

WP REST Menus class.

WP API Menus support for WP API v2.

Summary

Methods
Properties
Constants
get_api_namespace()
get_plugin_namespace()
register_routes()
get_menus()
get_menu()
get_nav_menu_item_children()
format_menu_item()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
nested_menu_items()
has_children()
No private properties found
N/A

Methods

get_api_namespace()

get_api_namespace() : string

Get WP API namespace.

Returns

string

get_plugin_namespace()

get_plugin_namespace() : string

Get WP API Menus namespace.

Returns

string

register_routes()

register_routes() : void

Register menu routes for WP API v2.

get_menus()

get_menus() : array

Get menus.

Returns

array —

All registered menus

get_menu()

get_menu(  $request) : array

Get a menu.

Parameters

$request

Returns

array —

Menu data

get_nav_menu_item_children()

get_nav_menu_item_children(integer  $parent_id, array  $nav_menu_items, boolean  $depth = true) : array

Returns all child nav_menu_items under a specific parent.

Parameters

integer $parent_id

The parent nav_menu_item ID
array $nav_menu_items

Navigation menu items
boolean $depth

Gives all children or direct children only

Returns

array —

returns filtered array of nav_menu_items

format_menu_item()

format_menu_item(object|array  $menu_item, boolean  $children = false, array  $menu = array()) : array

Format a menu item for REST API consumption.

Parameters

object|array $menu_item

The menu item
boolean $children

Get menu item children (default false)
array $menu

The menu the item belongs to (used when $children is set to true)

Returns

array —

a formatted menu item for REST

nested_menu_items()

nested_menu_items(  $menu_items,   $parent = null) : array

Handle nested menu items.

Given a flat array of menu items, split them into parent/child items and recurse over them to return children nested in their parent.

Parameters

$menu_items
$parent

Returns

array

has_children()

has_children(array  $items, integer  $id) : array

Check if a collection of menu items contains an item that is the parent id of 'id'.

Parameters

array $items
integer $id

Returns

array