Load Order Details

apply_filters_ref_array( 'vikappointments_load_appointments_order_details', bool $status, mixed &$query, int $id, mixed $langtag, array $options )

Fires while building the query used to fetch the details of the appointments.

Description

External plugins can attach to this hook in order to manipulate the query at runtime, in example to alter the default ordering.

Parameters

$status

(bool)  True on success, false on failure.

&$query

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

$id

(int)  The ID of the order.

$langtag

(string|null)  The language tag. If null, the default one will be used.

$options

(array)  An array of options to be passed to the order instance.

Example

/**
 * External plugins can attach to this hook in order to manipulate
 * the query at runtime, in example to alter the default ordering.
 *
 * @param  boolean  $status   True on success, false on failure.
 * @param  mixed    &$query   The query string or a query builder object.
 * @param  integer  $id       The ID of the order.
 * @param  mixed    $langtag  The language tag. If null, the default one will be used.
 * @param  array    $options  An array of options to be passed to the order instance.
 */
add_filter('vikappointments_load_appointments_order_details', function($status, &$query, $id, $langtag, $options)
{
    /**
     * @todo it is possible to manipulate here the query
     */

    return $status;
}, 10, 5);

Changelog