Title: WP_REST_Menus_Controller::get_item_schema
Published: February 3, 2022
Last modified: February 24, 2026

---

# WP_REST_Menus_Controller::get_item_schema(): array

## In this article

 * [Return](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#wp--skip-link--target)

Retrieves the term’s schema, conforming to JSON Schema.

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#return)󠁿

 array Item schema data.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#source)󠁿

    ```php
    public function get_item_schema() {
    	if ( $this->schema ) {
    		return $this->add_additional_fields_schema( $this->schema );
    	}

    	$schema = parent::get_item_schema();
    	unset( $schema['properties']['count'], $schema['properties']['link'], $schema['properties']['taxonomy'] );

    	$schema['properties']['locations'] = array(
    		'description' => __( 'The locations assigned to the menu.' ),
    		'type'        => 'array',
    		'items'       => array(
    			'type' => 'string',
    		),
    		'context'     => array( 'view', 'edit' ),
    		'arg_options' => array(
    			'validate_callback' => static function ( $locations, $request, $param ) {
    				$valid = rest_validate_request_arg( $locations, $request, $param );

    				if ( true !== $valid ) {
    					return $valid;
    				}

    				$locations = rest_sanitize_request_arg( $locations, $request, $param );

    				foreach ( $locations as $location ) {
    					if ( ! array_key_exists( $location, get_registered_nav_menus() ) ) {
    						return new WP_Error(
    							'rest_invalid_menu_location',
    							__( 'Invalid menu location.' ),
    							array(
    								'location' => $location,
    							)
    						);
    					}
    				}

    				return true;
    			},
    		),
    	);

    	$schema['properties']['auto_add'] = array(
    		'description' => __( 'Whether to automatically add top level pages to this menu.' ),
    		'context'     => array( 'view', 'edit' ),
    		'type'        => 'boolean',
    	);

    	$this->schema = $schema;

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

[View all references](https://developer.wordpress.org/reference/files/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php#L531)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php#L531-L582)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#related)󠁿

| Uses | Description | 
| [rest_validate_request_arg()](https://developer.wordpress.org/reference/functions/rest_validate_request_arg/)`wp-includes/rest-api.php` |

Validate a request argument based on details registered to the route.

  | 
| [rest_sanitize_request_arg()](https://developer.wordpress.org/reference/functions/rest_sanitize_request_arg/)`wp-includes/rest-api.php` |

Sanitize a request argument based on details registered to the route.

  | 
| [WP_REST_Terms_Controller::get_item_schema()](https://developer.wordpress.org/reference/classes/wp_rest_terms_controller/get_item_schema/)`wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php` |

Retrieves the term’s schema, conforming to JSON Schema.

  | 
| [get_registered_nav_menus()](https://developer.wordpress.org/reference/functions/get_registered_nav_menus/)`wp-includes/nav-menu.php` |

Retrieves all registered navigation menu locations in a theme.

  | 
| [__()](https://developer.wordpress.org/reference/functions/__/)`wp-includes/l10n.php` |

Retrieves the translation of $text.

  | 
| [WP_Error::__construct()](https://developer.wordpress.org/reference/classes/wp_error/__construct/)`wp-includes/class-wp-error.php` |

Initializes the error.

  |

[Show 2 more](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#)

| Used by | Description | 
| [WP_REST_Menus_Controller::prepare_item_for_database()](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/prepare_item_for_database/)`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php` |

Prepares a single term for create or update.

  | 
| [WP_REST_Menus_Controller::create_item()](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/create_item/)`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php` |

Creates a single term in a taxonomy.

  | 
| [WP_REST_Menus_Controller::update_item()](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/update_item/)`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php` |

Updates a single term from a taxonomy.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_rest_menus_controller/get_item_schema/?output_format=md#changelog)󠁿

| Version | Description | 
| [5.9.0](https://developer.wordpress.org/reference/since/5.9.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_rest_menus_controller%2Fget_item_schema%2F)
before being able to contribute a note or feedback.