PHP Класс WP_REST_Menus

С версии: 1.0.0
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
format_menu_item ( object | array $menu_item, boolean $children = false, array $menu = [] ) : array Format a menu item for REST API consumption.
get_api_namespace ( ) : string Get WP API namespace.
get_menu ( $request ) : array Get a menu.
get_menu_location ( $request ) : array Get menu for location.
get_menu_locations ( $request ) : array Get menu locations.
get_menus ( ) : array Get menus.
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.
get_plugin_namespace ( ) : string Get WP API Menus namespace.
register_routes ( ) Register menu routes for WP API v2.

Приватные методы

Метод Описание
has_children ( array $items, integer $id ) : array Check if a collection of menu items contains an item that is the parent id of 'id'.
nested_menu_items ( &$menu_items, $parent = null ) : array Handle nested menu items.

Описание методов

format_menu_item() публичный Метод

Format a menu item for REST API consumption.
С версии: 1.2.0
public format_menu_item ( object | array $menu_item, boolean $children = false, array $menu = [] ) : array
$menu_item object | array The menu item
$children boolean Get menu item children (default false)
$menu array The menu the item belongs to (used when $children is set to true)
Результат array a formatted menu item for REST

get_api_namespace() публичный статический Метод

Get WP API namespace.
С версии: 1.2.0
public static get_api_namespace ( ) : string
Результат string

get_menu() публичный Метод

Get a menu.
С версии: 1.2.0
public get_menu ( $request ) : array
$request
Результат array Menu data

get_menu_location() публичный Метод

Get menu for location.
С версии: 1.2.0
public get_menu_location ( $request ) : array
$request
Результат array The menu for the corresponding location

get_menu_locations() публичный статический Метод

Get menu locations.
С версии: 1.2.0
public static get_menu_locations ( $request ) : array
$request
Результат array All registered menus locations

get_menus() публичный статический Метод

Get menus.
С версии: 1.2.0
public static get_menus ( ) : array
Результат array All registered menus

get_nav_menu_item_children() публичный Метод

Returns all child nav_menu_items under a specific parent.
С версии: 1.2.0
public get_nav_menu_item_children ( integer $parent_id, array $nav_menu_items, boolean $depth = true ) : array
$parent_id integer The parent nav_menu_item ID
$nav_menu_items array Navigation menu items
$depth boolean Gives all children or direct children only
Результат array returns filtered array of nav_menu_items

get_plugin_namespace() публичный статический Метод

Get WP API Menus namespace.
С версии: 1.2.1
public static get_plugin_namespace ( ) : string
Результат string

register_routes() публичный Метод

Register menu routes for WP API v2.
С версии: 1.2.0
public register_routes ( )