wppaste
WordPress

WP_REST_Pattern_Directory_Controller

Since
5.8.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php:20
Controller which provides REST endpoint for block patterns.

Description

This simply proxies the endpoint at http://api.wordpress.org/patterns/1.0/. That isn't necessary for functionality, but is desired for privacy. It prevents api.wordpress.org from knowing the user's IP address.

Compatibility

WordPress
since 5.8.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).

Hooks and filters fired · 2

Every hook that fires from inside WP_REST_Pattern_Directory_Controller, in the order it appears in the class, grouped by the method that fires it.

Methods · 8

Source code

class WP_REST_Pattern_Directory_Controller extends WP_REST_Controller { 	/**	 * Constructs the controller.	 *	 * @since 5.8.0	 */	public function __construct() {		$this->namespace = 'wp/v2';		$this->rest_base = 'pattern-directory';	} 	/**	 * Registers the necessary REST API routes.	 *	 * @since 5.8.0	 */	public function register_routes() {		register_rest_route(			$this->namespace,			'/' . $this->rest_base . '/patterns',			array(				array(					'methods'             => WP_REST_Server::READABLE,					'callback'            => array( $this, 'get_items' ),					'permission_callback' => array( $this, 'get_items_permissions_check' ),					'args'                => $this->get_collection_params(),				),				'schema' => array( $this, 'get_public_item_schema' ),			)		);	} 	/**	 * Checks whether a given request has permission to view the local block pattern directory.	 *	 * @since 5.8.0	 *	 * @param WP_REST_Request $request Full details about the request.	 * @return true|WP_Error True if the request has permission, 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_pattern_directory_cannot_view',			__( 'Sorry, you are not allowed to browse the local block pattern directory.' ),			array( 'status' => rest_authorization_required_code() )		);	} 	/**	 * Search and retrieve block patterns metadata	 *	 * @since 5.8.0	 * @since 6.0.0 Added 'slug' to request.	 * @since 6.2.0 Added 'per_page', 'page', 'offset', 'order', and 'orderby' to request.	 *	 * @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 ) {		$valid_query_args = array(			'offset'   => true,			'order'    => true,			'orderby'  => true,			'page'     => true,			'per_page' => true,			'search'   => true,			'slug'     => true,		);		$query_args       = array_intersect_key( $request->get_params(), $valid_query_args );

Changelog

Introduced in 5.8.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 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-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.