WordPress.org

Plugin Directory

Test out the new Plugin Directory and let us know what you think.

WP API Menus

Extends WordPress WP REST API with new routes pointing to WordPress menus.

This plugin extends the WordPress JSON REST API with new routes for WordPress registered menus

The new routes available will be:

  • /menus list of every registered menu.
  • /menus/<id> data for a specific menu.
  • /menu-locations list of all registered theme locations.
  • /menu-locations/<location> data for menu in specified menu in theme location.

Currently, the menu-locations/<location> route for individual menus will return a tree with full menu hierarchy, with correct menu item order and listing children for each menu item. The menus/<id> route will output menu details and a flat array of menu items. Item order or if each item has a parent will be indicated in each item attributes, but this route won't output items as a tree.

You can alter the data arrangement of each individual menu items and children using the filter hook json_menus_format_menu_item.

An important note on WP API V2:

In V1 the routes are located by default at wp-json/menus/ etc.

In V2 the routes by default are at wp-json/wp-api-menus/v2/ (e.g. wp-json/wp-api-menus/v2/menus/, etc.) since V2 encourages prefixing and version namespacing.

Requires: 3.6.0 or higher
Compatible up to: 4.4.7
Last Updated: 5 months ago
Active Installs: 2,000+

Ratings

5 out of 5 stars

Support

0 of 1 support threads in the last two months have been marked resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1
100,1,1 100,1,1
100,1,1
0,1,0
100,1,1
100,1,1
100,1,1