wppaste
WordPress

WP_REST_Block_Pattern_Categories_Controller

Since
6.0.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-block-pattern-categories-controller.php:17
Core class used to access block pattern categories via the REST API.

Compatibility

WordPress
since 6.0.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Methods · 6

Source code

class WP_REST_Block_Pattern_Categories_Controller extends WP_REST_Controller { 	/**	 * Constructs the controller.	 *	 * @since 6.0.0	 */	public function __construct() {		$this->namespace = 'wp/v2';		$this->rest_base = 'block-patterns/categories';	} 	/**	 * Registers the routes for the objects of the controller.	 *	 * @since 6.0.0	 */	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' ),				),				'schema' => array( $this, 'get_public_item_schema' ),			)		);	} 	/**	 * Checks whether a given request has permission to read block patterns.	 *	 * @since 6.0.0	 *	 * @param WP_REST_Request $request Full details about the request.	 * @return true|WP_Error True if the request has read access, WP_Error object otherwise.	 */	public function get_items_permissions_check( $request ) {		if ( current_user_can( 'edit_posts' ) ) {			return true;		} 		foreach ( get_post_types( array( 'show_in_rest' => true ), 'objects' ) as $post_type ) {			if ( current_user_can( $post_type->cap->edit_posts ) ) {				return true;			}		} 		return new WP_Error(			'rest_cannot_view',			__( 'Sorry, you are not allowed to view the registered block pattern categories.' ),			array( 'status' => rest_authorization_required_code() )		);	} 	/**	 * Retrieves all block pattern categories.	 *	 * @since 6.0.0	 *	 * @param WP_REST_Request $request Full details about the request.	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.	 */	public function get_items( $request ) {		if ( $request->is_method( 'HEAD' ) ) {			// Return early as this handler doesn't add any response headers.			return new WP_REST_Response( array() );		} 		$response   = array();		$categories = WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered();		foreach ( $categories as $category ) {			$prepared_category = $this->prepare_item_for_response( $category, $request );			$response[]        = $this->prepare_response_for_collection( $prepared_category );		} 		return rest_ensure_response( $response );

Changelog

Introduced in 6.0.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-block-pattern-categories-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.