Automattic\WooCommerce\Blocks\BlockTypes\ProductCollection

HandlerRegistry::register_collection_handlers()publicWC 1.0

Register handlers for a collection.

Method of the class: HandlerRegistry{}

No Hooks.

Return

null. Nothing (null).

Usage

$HandlerRegistry = new HandlerRegistry();
$HandlerRegistry->register_collection_handlers( $collection_name, $build_query, $frontend_args, $editor_args, $preview_query );
$collection_name(string) (required)
The name of the collection.
$build_query(callable) (required)
The query builder callable.
$frontend_args(callable|null)
Optional frontend args callable.
Default: null
$editor_args(callable|null)
Optional editor args callable.
Default: null
$preview_query(callable|null)
Optional preview query callable.
Default: null

HandlerRegistry::register_collection_handlers() code WC 9.6.0

public function register_collection_handlers( $collection_name, $build_query, $frontend_args = null, $editor_args = null, $preview_query = null ) {
	if ( isset( $this->collection_handler_store[ $collection_name ] ) ) {
		throw new InvalidArgumentException( 'Collection handlers already registered for ' . esc_html( $collection_name ) );
	}

	$this->collection_handler_store[ $collection_name ] = [
		'build_query'   => $build_query,
		'frontend_args' => $frontend_args,
		'editor_args'   => $editor_args,
		'preview_query' => $preview_query,
	];

	return $this->collection_handler_store[ $collection_name ];
}