Title: WP REST Menus
Author: skapator
Published: ޖުލައި 4, 2018
Last modified: ފެބްރުއަރީ 17, 2022
---
Search plugins
This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.
# WP REST Menus
By [skapator](https://profiles.wordpress.org/skapator/)
[Download](https://downloads.wordpress.org/plugin/wp-rest-menu.1.0.4.zip)
* [Details](https://dv.wordpress.org/plugins/wp-rest-menu/#description)
* [Reviews](https://dv.wordpress.org/plugins/wp-rest-menu/#reviews)
* [Installation](https://dv.wordpress.org/plugins/wp-rest-menu/#installation)
* [Development](https://dv.wordpress.org/plugins/wp-rest-menu/#developers)
[Support](https://wordpress.org/support/plugin/wp-rest-menu/)
## Description
This plugin adds new endpoints for WordPress registered menus.
Usefull when building
SPAs with Vuejs, React or any front-end framework. Works with Advacned Custom Fields,
WPML, Polylang
The new endpoints available:
**Get all menus**
```
GET /menus/v1/menus
// Response sample
{
term_id: 2,
name: "Main Menu",
slug: "main-menu",
term_group: 0,
term_taxonomy_id: 2,
taxonomy: "nav_menu",
description: "",
parent: 0,
count: 8,
filter: "raw"
},
...
```
**Get a menus items by id (term_id)**
```
GET /menus/v1/menus/
// Response sample
{
ID: 5,
post_author: "1",
post_date: "2018-07-03 06:42:18",
post_date_gmt: "2018-07-03 06:42:18",
filter: "raw",
db_id:5,
menu_item_parent: "0",
object_id: "5",
object: "custom",
type: "custom",
type_label: "Custom Link",
title: "Home",
url: "https:\/\/wp-rest-menu.local\/",
target: "",
attr_title: "",
description: "",
classes: [
""
],
xfn: "",
meta: null
},
...
```
**Get all menu locations**
All menu locations assigned in /wp-admin/nav-menus.php?
action=locations
```
GET /menus/v1/menus/locations is deprecated and will be removed in newer versions use:
GET /menus/v1/locations
// Response example
{
slug: "top",
description: "Top Menu"
},
{
slug: "social",
description: "Social Links Menu"
}
...
```
**Get all menu location items**
All menu locations assigned in /wp-admin/nav-menus.
php?action=locations
```
GET /menus/v1/menus/locations/ is deprecated and will be removed in newer versions use:
GET /menus/v1/locations/
// Response samexampleple
{
ID: 5,
post_author: "1",
post_date: "2018-07-03 06:42:18",
post_date_gmt: "2018-07-03 06:42:18",
filter: "raw",
db_id:5,
menu_item_parent: "0",
object_id: "5",
object: "custom",
type: "custom",
type_label: "Custom Link",
title: "Home",
url: "https:\/\/wp-rest-menu.local\/",
target: "",
attr_title: "",
description: "",
classes: [
""
],
xfn: "",
meta: null
},
...
```
There are two filters availiable:
**Fields Filter**
```
// it will return only the fields specified
GET /menus/v1/menus//?fields=ID,title,meta
// Response sample
// Response sample
{
ID: 5,
title: "Home",
meta: null
},
...
```
**Nested Items Filter**
```
// it will return menu items parents and nested children in a 'children' field
// Currently only one level deep is supported
GET /menus/v1/menus//?nested=1
// Response sample
{
ID: 1716,
menu_item_parent: "0",
object_id: "174",
object: "page",
title: "Level 1",
meta: {
vue_component: "LevelComponent",
menu-item-field-01: "Field 1 value",
menu-item-field-02: "Field 2 value"
},
children:[
{
ID: 1717,
menu_item_parent: "1716",
object_id: "744",
object: "page",
title: "Level 2b",
meta : {
vue_component: null
}
},
...
]
},
...
```
**WP filter hooks**
This plugin is quite configurable and provides lots of wp filter hooks from returned
data in responses for each endpoint to params validation and endpoint permissions.
```
add_filter( 'wprm/get_menus/wp_get_nav_menus/args', 'my_wp_get_nav_menus', 10, 1 );
(used in GET /menus/v1/menus)
function my_wp_get_nav_menus( $args ) {
// do something with wp_get_nav_menus $args array
return $args;
}
add_filter( 'wprm/get_menus', 'my_get_menus', 10, 1 );
(used in GET /menus/v1/menus)
function my_get_menus( $menus ) {
// do something with $menus array
return $menus; // WP_Error|WP_HTTP_Response|WP_REST_Response|mixed
}
add_filter( 'wprm/get_menu_locations', 'my_get_menu_locations', 10, 1 );
(used in GET /menus/v1/locations)
function my_get_menu_locations( $locations ) {
// You can modify the $locations array response (get_registered_nav_menus())
return $locations; // WP_Error|WP_HTTP_Response|WP_REST_Response|mixed
}
add_filter( 'wprm/get_menu_items', 'my_get_menu_items', 10, 1 );
(used in GET /menus/v1/menus/)
function my_rest_menu_item_fields( $menu ) {
// You can modify the $menu items
return $menu;
}
add_filter( 'wprm/get_location_menu_items', 'my_get_location_menu_items', 10, 1 );
(used in GET /menus/v1/menus/)
function my_get_location_menu_items( $menu ) {
// You can modify the locations $menu items
return $menu;
}
add_filter( 'wprm/get_item_fields/filter_fields', 'my_filter_fields', 10, 1 );
(used to filter return field -node edges-)
function my_filter_fields( $fields ) {
// You can modify the $fields array so
// you can filter the return fields for all endpoints
// without using the url param ?fields
$fields = array( 'ID', 'title' );
return $fields;
}
```
More filters
```
apply_filters('wprm/get_menus/permissions', '__return_true', $request );
apply_filters('wprm/get_menu_locations/permissions', '__return_true', $request );
apply_filters('wprm/get_menu_items/permissions', '__return_true', $request );
apply_filters('wprm/get_menu_items/validate/args/id', is_numeric( $param ), $param, $request, $key );
apply_filters('wprm/get_menu_items/validate/args/fields', is_string( $param ), $param, $request, $key );
apply_filters('wprm/get_menu_items/validate/args/nested', absint( $param ), $param, $request, $key );
apply_filters('wprm/get_location_menu_items/permissions', '__return_true', $request );
apply_filters('wprm/get_location_menu_items/validate/args/slug', is_string( $param ), $param, $request, $key );
apply_filters('wprm/get_location_menu_items/validate/args/fields', is_string( $param ), $param, $request, $key );
apply_filters('wprm/get_location_menu_items/validate/args/nested', absint( $param ), $param, $request, $key );
apply_filters('wprm/get_location_menu_items/permissions', '__return_true', $request );
apply_filters('wprm/get_location_menu_items/validate/args/slug', is_string( $param ), $param, $request, $key );
apply_filters('wprm/get_location_menu_items/validate/args/fields', is_string( $param ), $param, $request, $key );
apply_filters('wprm/get_location_menu_items/validate/args/nested', absint( $param ), $param, $request, $key );
```
Supports custom fields and Advanced Custom Fields
If ACF is installed the response
node edge is _acf_ else _meta_ In newer version these two edges will co exist and
the plugin will separate natively registered custom fields ad acf registered ones.
## Installation
There are no requirements other than WordPress and one active menu. Installation
is simple:
1. Upload the `wp-rest-menus` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the ‘Plugins’ menu in WordPress
## FAQ
### How do I use this plugin?
It creates endpoints for wp nav menus to use in your front end.
### Can I contribute?
Yes, you can fork it on [github](https://github.com/kostasxyz/wp-rest-menus).
## Reviews
### [Awesome plugin!](https://wordpress.org/support/topic/awesome-plugin-4955/)
[Yiannis Christodoulou](https://profiles.wordpress.org/yiannistaos/) އޭޕްރިލް 12,
2020
This plugin is what I was looking for! Very easy to add new endpoints in WP menus.
Thanks!
### [Better than WP-REST-API V2 Menus](https://wordpress.org/support/topic/better-than-wp-rest-api-v2-menus/)
[ITomSawyerI](https://profiles.wordpress.org/itomsawyeri/) އޭޕްރިލް 5, 2020
This plugin has a fields filter ability.
### [Awesome for building front end apps with wp-rest api for dynamic menus](https://wordpress.org/support/topic/awesome-for-building-front-end-apps-with-wp-rest-api-for-dynamic-menus/)
[imaginena](https://profiles.wordpress.org/imaginena/) ނޮވެމްބަރ 26, 2018
Just saved some days on development, thrilled that ACF is supported. Thumbs up,
good work.
### [Does exactly what it’s supposed to do!!!](https://wordpress.org/support/topic/does-exactly-what-its-supposed-to-do-16/)
[alexitsios](https://profiles.wordpress.org/alexitsios/) ނޮވެމްބަރ 9, 2018
I’ve been searching for something like that for some time now. Really grateful that
it supports Advanced Custom Fields and meta fields.
[ Read all 3 reviews ](https://wordpress.org/support/plugin/wp-rest-menu/reviews/)
## Contributors & Developers
“WP REST Menus” is open source software. The following people have contributed to
this plugin.
Contributors
* [ skapator ](https://profiles.wordpress.org/skapator/)
[Translate “WP REST Menus” into your language.](https://translate.wordpress.org/projects/wp-plugins/wp-rest-menu)
### Interested in development?
[Browse the code](https://plugins.trac.wordpress.org/browser/wp-rest-menu/), check
out the [SVN repository](https://plugins.svn.wordpress.org/wp-rest-menu/), or subscribe
to the [development log](https://plugins.trac.wordpress.org/log/wp-rest-menu/) by
[RSS](https://plugins.trac.wordpress.org/log/wp-rest-menu/?limit=100&mode=stop_on_copy&format=rss).
## Meta
* Version **1.0.4**
* Last updated **4 years ago**
* Active installations **100+**
* WordPress version ** 5.0 or higher **
* Tested up to **5.9.13**
* PHP version ** 5.6 or higher **
* Language
* [English (US)](https://wordpress.org/plugins/wp-rest-menu/)
* Tags
* [api](https://dv.wordpress.org/plugins/tags/api/)[v2](https://dv.wordpress.org/plugins/tags/v2/)
[wp-rest-api](https://dv.wordpress.org/plugins/tags/wp-rest-api/)
* [Advanced View](https://dv.wordpress.org/plugins/wp-rest-menu/advanced/)
## Ratings
5 out of 5 stars.
* [ 4 5-star reviews ](https://wordpress.org/support/plugin/wp-rest-menu/reviews/?filter=5)
* [ 0 4-star reviews ](https://wordpress.org/support/plugin/wp-rest-menu/reviews/?filter=4)
* [ 0 3-star reviews ](https://wordpress.org/support/plugin/wp-rest-menu/reviews/?filter=3)
* [ 0 2-star reviews ](https://wordpress.org/support/plugin/wp-rest-menu/reviews/?filter=2)
* [ 0 1-star reviews ](https://wordpress.org/support/plugin/wp-rest-menu/reviews/?filter=1)
[Your review](https://wordpress.org/support/plugin/wp-rest-menu/reviews/#new-post)
[See all reviews](https://wordpress.org/support/plugin/wp-rest-menu/reviews/)
## Contributors
* [ skapator ](https://profiles.wordpress.org/skapator/)
## Support
Got something to say? Need help?
[View support forum](https://wordpress.org/support/plugin/wp-rest-menu/)