wppaste
WordPress

WP_REST_Menu_Locations_Controller

Since
5.9.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php:17
Core class used to access menu locations via the REST API.

Compatibility

WordPress
since 5.9.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 2

Every hook that fires from inside WP_REST_Menu_Locations_Controller, in the order it appears in the class, grouped by the method that fires it.

Methods · 11

Source code

class WP_REST_Menu_Locations_Controller extends WP_REST_Controller { 	/**	 * Menu Locations Constructor.	 *	 * @since 5.9.0	 */	public function __construct() {		$this->namespace = 'wp/v2';		$this->rest_base = 'menu-locations';	} 	/**	 * Registers the routes for the objects of the controller.	 *	 * @since 5.9.0	 *	 * @see register_rest_route()	 */	public function register_routes() {		register_rest_route(			$this->namespace,			'/' . $this->rest_base,			array(				array(					'methods'             => WP_REST_Server::READABLE,					'callback'            => array( $this, 'get_items' ),					'permission_callback' => array( $this, 'get_items_permissions_check' ),					'args'                => $this->get_collection_params(),				),				'schema' => array( $this, 'get_public_item_schema' ),			)		); 		register_rest_route(			$this->namespace,			'/' . $this->rest_base . '/(?P<location>[\w-]+)',			array(				'args'   => array(					'location' => array(						'description' => __( 'An alphanumeric identifier for the menu location.' ),						'type'        => 'string',					),				),				array(					'methods'             => WP_REST_Server::READABLE,					'callback'            => array( $this, 'get_item' ),					'permission_callback' => array( $this, 'get_item_permissions_check' ),					'args'                => array(						'context' => $this->get_context_param( array( 'default' => 'view' ) ),					),				),				'schema' => array( $this, 'get_public_item_schema' ),			)		);	} 	/**	 * Checks whether a given request has permission to read menu locations.	 *	 * @since 5.9.0	 *	 * @param WP_REST_Request $request Full details about the request.	 * @return true|WP_Error True if the request has read access, WP_Error object otherwise.	 */	public function get_items_permissions_check( $request ) {		return $this->check_has_read_only_access( $request );	} 	/**	 * Retrieves all menu locations, depending on user context.	 *	 * @since 5.9.0	 *	 * @param WP_REST_Request $request Full details about the request.	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.	 */	public function get_items( $request ) {		$data = array();

Changelog

Introduced in 5.9.0. One change between 6.7.7 and 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.8.8
Method check_has_read_only_access() added.verified against source
5.9.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.