Before List Query

apply_filters_ref_array( 'vikappointments_before_list_query_export_csv', bool $status, mixed &$query, mixed $options )

Fires while building the query used to fetch the appointments to export.

Description

Trigger hook to allow the plugins to manipulate the query used to retrieve a standard list of records.

It is possible to use $options->get($key) to access the internal properties of the options argument.

Parameters

$status

(bool)  True on success, false on failure.

&$query

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

$options

(JObject)  A registry of options. This instance holds the values of the settings specified by the export driver, such as the delimiter character.

Example

/**
 * Trigger event to allow the plugins to manipulate the query used to retrieve
 * a standard list of records.
 *
 * @param  boolean  $status   True on success, false on failure.
 * @param  mixed    &$query   The query string or a query builder object.
 * @param  mixed    $options  A configuration registry.
 */
add_filter('vikappointments_before_list_query_export_csv', function($status, &$query, $options)
{
    /**
     * @todo it is possible to manipulate here the query
     */

    return $status;
}, 10, 3);

Changelog