After List Query

apply_filters_ref_array( 'vikappointments_after_list_query_export_csv', bool $status, array &$rows, mixed $options )

Fires before returning the array of appointments to export.

Description

Trigger hook to allow the plugins to manipulate the response fetched by 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.

&$rows

(array)  An array of results (objects).

$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 hook to allow the plugins to manipulate response fetched by
 * the query used to retrieve a standard list of records.
 *
 * @param  boolean  $status   True on success, false on failure.
 * @param  mixed    &$rows    An array of results (objects).
 * @param  mixed    $options  A configuration registry.
 */
add_filter('vikappointments_after_list_query_export_csv', function($status, &$rows, $options)
{
    /**
     * @todo it is possible to manipulate here the export rows
     */

    return $status;
}, 10, 3);

Changelog