Filter hook 'rest_pattern_directory_collection_params'

in WP Core File wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php at line 374

View Source

rest_pattern_directory_collection_params

Filter Hook
Description
Filter collection parameters for the block pattern directory controller.

Hook Information

File Location wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php View on GitHub
Hook Type Filter
Line Number 374

Hook Parameters

Type Name Description
array $query_params JSON Schema-formatted collection parameters.

Usage Examples

Basic Usage
<?php
// Hook into rest_pattern_directory_collection_params
add_filter('rest_pattern_directory_collection_params', 'my_custom_filter', 10, 1);

function my_custom_filter($query_params) {
    // Your custom filtering logic here
    return $query_params;
}

Source Code Context

wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php:374 - How this hook is used in WordPress core
<?php
 369  		 *
 370  		 * @since 5.8.0
 371  		 *
 372  		 * @param array $query_params JSON Schema-formatted collection parameters.
 373  		 */
 374  		return apply_filters( 'rest_pattern_directory_collection_params', $query_params );
 375  	}
 376  
 377  	/**
 378  	 * Include a hash of the query args, so that different requests are stored in
 379  	 * separate caches.

PHP Documentation

<?php
/**
		 * Filter collection parameters for the block pattern directory controller.
		 *
		 * @since 5.8.0
		 *
		 * @param array $query_params JSON Schema-formatted collection parameters.
		 */
Quick Info
  • Hook Type: Filter
  • Parameters: 1
  • File: wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php
Related Hooks

Related hooks will be displayed here in future updates.