Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unfulvio/wp-api-menus

:abcd: Menu routes for WordPress JSON REST API.
https://github.com/unfulvio/wp-api-menus

json-rest php wordpress wp-api

Last synced: 24 days ago
JSON representation

:abcd: Menu routes for WordPress JSON REST API.

Host: GitHub
URL: https://github.com/unfulvio/wp-api-menus
Owner: unfulvio
License: gpl-2.0
Created: 2014-07-21T02:54:33.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-05-14T02:10:26.000Z (6 months ago)
Last Synced: 2024-10-03T10:53:43.522Z (about 1 month ago)
Topics: json-rest, php, wordpress, wp-api
Language: PHP
Homepage: https://wordpress.org/plugins/wp-api-menus
Size: 225 KB
Stars: 140
Watchers: 13
Forks: 59
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: license.txt

Awesome Lists containing this project

README

## Menu routes for WordPress JSON REST API

[![GitHub version](https://badge.fury.io/gh/unfulvio%2Fwp-api-menus.svg)](http://badge.fury.io/gh/unfulvio%2Fwp-api-menus)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/unfulvio/wp-api-menus/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/unfulvio/wp-api-menus/?branch=master)
[![Join the chat at https://gitter.im/unfulvio/wp-api-menus](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/unfulvio/wp-api-menus?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[WordPress](http://www.wordpress.org/) plugin that extends the JSON REST [WP API](https://github.com/WP-API/WP-API) with new routes pointing to WordPress registered menus. Read the [WP API documentation](http://wp-api.org/).

[![Download from WordPress.org](https://github.com/unfulvio/wp-api-menus/blob/master/assets/wordpress-download-btn.png)](https://wordpress.org/plugins/wp-api-menus/)

#### New routes available:

- `/menus` list of every registered menu.
- `/menus/` data for a specific menu.
- `/menu-locations` list of all registered theme locations.
- `/menu-locations/` data for menu in specified menu in theme location.

Currently, the `menu-locations/` 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/` 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 V1 data arrangement of each individual menu items and children using the filter hook `json_menus_format_menu_item`.

#### WP API V2

In V1 of the REST API 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.

You can alter the V2 data arrangement of the REST response using the filter hooks
1. `rest_menus_format_menus` to alter the list of menu items returned (e.g from `wp-json/wp-api-menus/v2/menus/`)
2. `rest_menus_format_menu` to alter a single menu returned (e.g `wp-json/wp-api-menus/v2/menus/`)
3. `rest_menus_format_menu_item` to alter the menu items returned (e.g `wp-json/wp-api-menus/v2/menus/` `items` property)

#### Contributing

* Submit a pull request or open a ticket here on GitHub.