Automattic\WooCommerce\Internal\ProductFilters

MainQueryController{} │ WC 1.0└─ RegisterHooksInterface

Hooks into WordPress filters to handle product filters for the main query.

No Hooks.

Usage

$MainQueryController = new MainQueryController();
// use class methods

Methods

1. public add_query_vars( array $query_vars )
2. public init( QueryClauses $query_clauses, Params $params )
3. public register()

MainQueryController{} MainQueryController{} code ^{WC 10.3.3}

class MainQueryController implements RegisterHooksInterface {

	/**
	 * Instance of QueryClauses.
	 *
	 * @var QueryClauses
	 */
	private $query_clauses;

	/**
	 * Hold the filter params.
	 *
	 * @var Params
	 */
	private $params;

	/**
	 * Initialize dependencies.
	 *
	 * @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
	 * @param QueryClauses $query_clauses Instance of QueryClauses.
	 * @param Params       $params        Instance of Params.
	 *
	 * @return void
	 */
	final public function init( QueryClauses $query_clauses, Params $params ): void {
		$this->query_clauses = $query_clauses;
		$this->params        = $params;
	}

	/**
	 * Hook into actions and filters.
	 *
	 * @return void
	 */
	public function register(): void {
		add_filter( 'posts_clauses', array( $this->query_clauses, 'add_query_clauses_for_main_query' ), 10, 2 );
		add_filter( 'query_vars', array( $this, 'add_query_vars' ) );
	}

	/**
	 * Register custom query vars for our filters. Price, stock status, and attribute query vars are
	 * already registered at WC_Query.
	 *
	 * @param array $query_vars Query vars.
	 * @return array
	 */
	public function add_query_vars( array $query_vars ): array {
		return array_merge( $query_vars, $this->params->get_param_keys() );
	}
}