WP_REST_Pattern_Directory_Controller::get_collection_params() – Retrieves the search parameters for the block pattern’s collection.

You appear to be a bot. Output may be restricted

Description

Retrieves the search parameters for the block pattern's collection.

Usage

$array = WP_REST_Pattern_Directory_Controller::get_collection_params();

Parameters

Returns

array Collection parameters.

Source

File name: wordpress/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php
Lines:

1 to 36 of 36
  public function get_collection_params() {
    $query_params = parent::get_collection_params();

    // Pagination is not supported.
    unset( $query_params['page'] );
    unset( $query_params['per_page'] );

    $query_params['search']['minLength'] = 1;
    $query_params['context']['default']  = 'view';

    $query_params['category'] = array(
      'description' => __( 'Limit results to those matching a category ID.' ),
      'type'        => 'integer',
      'minimum'     => 1,
    );

    $query_params['keyword'] = array(
      'description' => __( 'Limit results to those matching a keyword ID.' ),
      'type'        => 'integer',
      'minimum'     => 1,
    );

    $query_params['slug'] = array(
      'description' => __( 'Limit results to those matching a pattern (slug).' ),
      'type'        => 'array',
    );

    
/**
 * Filter collection parameters for the block pattern directory controller.
 *
 * @since 5.8.0
 *
 * @param array $query_params JSON Schema-formatted collection parameters.
 */
    return apply_filters( 'rest_pattern_directory_collection_params', $query_params );
  }
 

 View on GitHub View on Trac