[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/rest-api/endpoints/ -> class-wp-rest-block-pattern-categories-controller.php (summary)

REST API: WP_REST_Block_Pattern_Catergories_Controller class

File Size: 150 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_REST_Block_Pattern_Categories_Controller:: (6 methods):
  __construct()
  register_routes()
  get_items_permissions_check()
  get_items()
  prepare_item_for_response()
  get_item_schema()


Class: WP_REST_Block_Pattern_Categories_Controller  - X-Ref

Core class used to access block pattern categories via the REST API.

__construct()   X-Ref
Constructs the controller.

since: 6.0.0

register_routes()   X-Ref
Registers the routes for the objects of the controller.

since: 6.0.0

get_items_permissions_check( $request )   X-Ref
Checks whether a given request has permission to read block patterns.

param: WP_REST_Request $request Full details about the request.
since: 6.0.0
return: true|WP_Error True if the request has read access, WP_Error object otherwise.

get_items( $request )   X-Ref
Retrieves all block pattern categories.

param: WP_REST_Request $request Full details about the request.
since: 6.0.0
return: WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.

prepare_item_for_response( $item, $request )   X-Ref
Prepare a raw block pattern category before it gets output in a REST API response.

param: array           $item    Raw category as registered, before any changes.
param: WP_REST_Request $request Request object.
since: 6.0.0
return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

get_item_schema()   X-Ref
Retrieves the block pattern category schema, conforming to JSON Schema.

since: 6.0.0
return: array Item schema data.



Generated: Fri Jul 1 01:00:02 2022 Cross-referenced by PHPXref 0.7.1