WP_REST_Menu_Locations_Controller::check_has_read_only_access( WP_REST_Request $request ): true|WP_Error

In this article

Checks whether the current user has read permission for the endpoint.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

true|WP_Error True if the current user has permission, WP_Error object otherwise.

Source

protected function check_has_read_only_access( $request ) {
	/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php */
	$read_only_access = apply_filters( 'rest_menu_read_access', false, $request, $this );
	if ( $read_only_access ) {
		return true;
	}

	if ( ! current_user_can( 'edit_theme_options' ) ) {
		return new WP_Error(
			'rest_cannot_view',
			__( 'Sorry, you are not allowed to view menu locations.' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}

	return true;
}

Hooks

apply_filters( ‘rest_menu_read_access’, bool $read_only_access, WP_REST_Request $request, WP_REST_Controller $this )

Filters whether the current user has read access to menu items via the REST API.

Changelog

VersionDescription
6.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.