WP_REST_Menu_Locations_Controller::check_has_read_only_access │ protected │ WP 6.8.0

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

Method of the class: WP_REST_Menu_Locations_Controller{}

Returns

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

Usage

// protected - for code of main (parent) or child class
$result = $this->check_has_read_only_access( $request );

$request(WP_REST_Request) (required)

Full details about the request.

Changelog

WP_REST_Menu_Locations_Controller::check_has_read_only_access() WP REST Menu Locations Controller::check has read only access code ^{WP 7.0}

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;
}