Filter hook 'rest_user_collection_params'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into rest_user_collection_params
add_filter('rest_user_collection_params', 'my_custom_filter', 10, 1);

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

Source Code Context

<?php
1668  		 *
1669  		 * @since 4.7.0
1670  		 *
1671  		 * @param array $query_params JSON Schema-formatted collection parameters.
1672  		 */
1673  		return apply_filters( 'rest_user_collection_params', $query_params );
1674  	}
1675  }

PHP Documentation

<?php
/**
		 * Filters REST API collection parameters for the users controller.
		 *
		 * This filter registers the collection parameter, but does not map the
		 * collection parameter to an internal WP_User_Query parameter.  Use the
		 * `rest_user_query` filter to set WP_User_Query arguments.
		 *
		 * @since 4.7.0
		 *
		 * @param array $query_params JSON Schema-formatted collection parameters.
		 */