# gutenberg/12.6.0/lib/class-wp-rest-block-navigation-areas-controller.php

Gutenberg, version 12.6.0. 286 lines.

- Page: https://pluginprobe.com/plugins/gutenberg/12.6.0/code/lib/class-wp-rest-block-navigation-areas-controller.php
- Raw: https://pluginprobe.com/plugins/gutenberg/12.6.0/raw/lib/class-wp-rest-block-navigation-areas-controller.php
- Modified: 2021-11-24T16:50:38+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/gutenberg/12.6.0/code/lib/class-wp-rest-block-navigation-areas-controller.php#L10-L20`.

```php
<?php
/**
 * REST API: WP_REST_Block_Navigation_Areas_Controller class
 *
 * @subpackage REST_API
 * @package    WordPress
 */

/**
 * Core class used to access block navigation areas via the REST API.
 *
 * @see   WP_REST_Controller
 */
class WP_REST_Block_Navigation_Areas_Controller extends WP_REST_Controller {

	/**
	 * Constructor.
	 */
	public function __construct() {
		$this->namespace = 'wp/v2';
		$this->rest_base = 'block-navigation-areas';
	}

	/**
	 * Registers the routes for the objects of the controller.
	 *
	 * @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' ),
				'allow_batch' => array( 'v1' => true ),
			)
		);

		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/(?P<area>[\w-]+)',
			array(
				'args'   => array(
					'area' => array(
						'description' => __( 'An alphanumeric identifier for the navigation area.', 'gutenberg' ),
						'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' ) ),
					),
				),
				array(
					'methods'             => WP_REST_Server::EDITABLE,
					'callback'            => array( $this, 'update_item' ),
					'permission_callback' => array( $this, 'update_item_permissions_check' ),
					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
				),
				'schema' => array( $this, 'get_public_item_schema' ),
			)
		);
	}

	/**
	 * Checks whether a given request has permission to read navigation areas.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return WP_Error|bool True if the request has read access, WP_Error object otherwise.
	 */
	public function get_items_permissions_check( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		if ( ! current_user_can( 'edit_theme_options' ) ) {
			return new WP_Error(
				'rest_cannot_view',
				__( 'Sorry, you are not allowed to view navigation areas.', 'gutenberg' ),
				array( 'status' => rest_authorization_required_code() )
			);
		}

		return true;
	}

	/**
	 * Retrieves all navigation areas, depending on user context.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
	 */
	public function get_items( $request ) {
		$data = array();
		foreach ( gutenberg_get_navigation_areas() as $name => $description ) {
			$area          = $this->get_navigation_area_object( $name );
			$area          = $this->prepare_item_for_response( $area, $request );
			$data[ $name ] = $this->prepare_response_for_collection( $area );
		}
		return rest_ensure_response( $data );
	}

	/**
	 * Checks if a given request has access to read a navigation area.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return WP_Error|bool True if the request has read access for the item, WP_Error object otherwise.
	 */
	public function get_item_permissions_check( $request ) {
		if ( ! current_user_can( 'edit_theme_options' ) ) {
			return new WP_Error(
				'rest_cannot_view',
				__( 'Sorry, you are not allowed to view navigation areas.', 'gutenberg' ),
				array( 'status' => rest_authorization_required_code() )
			);
		}
		if ( ! array_key_exists( $request['area'], gutenberg_get_navigation_areas() ) ) {
			return new WP_Error( 'rest_navigation_area_invalid', __( 'Invalid navigation area.', 'gutenberg' ), array( 'status' => 404 ) );
		}

		return true;
	}

	/**
	 * Checks if a request has access to update the specified term.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return bool|WP_Error True if the request has access to update the item, false or WP_Error object otherwise.
	 */
	public function update_item_permissions_check( $request ) {
		return $this->get_item_permissions_check( $request );
	}

	/**
	 * Retrieves a specific navigation area.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
	 */
	public function get_item( $request ) {
		$name = $request['area'];
		$area = $this->get_navigation_area_object( $name );
		$data = $this->prepare_item_for_response( $area, $request );

		return rest_ensure_response( $data );
	}

	/**
	 * Updates a specific navigation area.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
	 */
	public function update_item( $request ) {
		$name = $request['area'];

		$mapping          = gutenberg_get_navigation_areas_menus();
		$mapping[ $name ] = $request['navigation'];
		update_option( 'wp_navigation_areas', $mapping );

		$area = $this->get_navigation_area_object( $name );
		$data = $this->prepare_item_for_response( $area, $request );
		return rest_ensure_response( $data );
	}

	/**
	 * Converts navigation area name to a convenient object that this endpoint can reason about.
	 *
	 * @param string $name Navigation area name.
	 * @return stdClass An object representation of the navigation area.
	 */
	private function get_navigation_area_object( $name ) {
		$available_areas   = gutenberg_get_navigation_areas();
		$mapping           = gutenberg_get_navigation_areas_menus();
		$area              = new stdClass();
		$area->name        = $name;
		$area->navigation  = ! empty( $mapping[ $name ] ) ? $mapping[ $name ] : null;
		$area->description = $available_areas[ $name ];
		return $area;
	}

	/**
	 * Prepares a navigation area object for serialization.
	 *
	 * @param stdClass        $area Post status data.
	 * @param WP_REST_Request $request Full details about the request.
	 *
	 * @return WP_REST_Response Post status data.
	 */
	public function prepare_item_for_response( $area, $request ) {
		$areas      = gutenberg_get_navigation_areas();
		$navigation = ( isset( $areas[ $area->name ] ) ) ? $area->navigation : 0;

		$fields = $this->get_fields_for_response( $request );
		$data   = array();

		if ( rest_is_field_included( 'name', $fields ) ) {
			$data['name'] = $area->name;
		}

		if ( rest_is_field_included( 'description', $fields ) ) {
			$data['description'] = $area->description;
		}

		if ( rest_is_field_included( 'navigation', $fields ) ) {
			$data['navigation'] = (int) $navigation;
		}

		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
		$data    = $this->add_additional_fields_to_object( $data, $request );
		$data    = $this->filter_response_by_context( $data, $context );

		$response = rest_ensure_response( $data );

		/**
		 * Filters a navigation area returned from the REST API.
		 *
		 * Allows modification of the navigation area data right before it is
		 * returned.
		 *
		 * @param WP_REST_Response $response The response object.
		 * @param object $area The original status object.
		 * @param WP_REST_Request $request Request used to generate the response.
		 */
		return apply_filters( 'rest_prepare_navigation_area', $response, $area, $request );
	}

	/**
	 * Retrieves the navigation area's schema, conforming to JSON Schema.
	 *
	 * @return array Item schema data.
	 */
	public function get_item_schema() {
		$schema = array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'navigation-area',
			'type'       => 'object',
			'properties' => array(
				'name'        => array(
					'description' => __( 'The name of the navigation area.', 'gutenberg' ),
					'type'        => 'string',
					'context'     => array( 'embed', 'view', 'edit' ),
					'readonly'    => true,
				),
				'description' => array(
					'description' => __( 'The description of the navigation area.', 'gutenberg' ),
					'type'        => 'string',
					'context'     => array( 'embed', 'view', 'edit' ),
					'readonly'    => true,
				),
				'navigation'  => array(
					'description' => __( 'The ID of the assigned navigation.', 'gutenberg' ),
					'type'        => 'integer',
					'context'     => array( 'embed', 'view', 'edit' ),
					'readonly'    => true,
				),
			),
		);

		return $this->add_additional_fields_schema( $schema );
	}

	/**
	 * Retrieves the query params for collections.
	 *
	 * @return array Collection parameters.
	 */
	public function get_collection_params() {
		return array(
			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
		);
	}

}

```