public function onBeforeQueryTax( mixed &$query ) : void

Fires while building the query used to fetch the tax details.


Description

Trigger hook to allow external plugins to manipulate the query used to load the tax details.

TIP: any column with an alias that starts with rule_ will be automatically injected within the TaxRule instance.


Parameters

&$query

(mixed)  Either a query builder object or a string.

Return Value

None.


Example

/**
 * Trigger hook to allow external plugins to manipulate the query used
 * to load the tax details.
 *
 * @param   mixed  &$query  The query string or a query builder object.
 *
 * @return  void
 */
public function onBeforeQueryTax(&$query)
{
    /**
     * @todo it is possible to manipulate here the query
     */
}

Changelog

Version Description
1.9 Introduced.
Last Update: 2023-12-29 14:15
Helpful?