Build Appointments Query

public function onBuildEmploginAppointmentsQuery(mixed &$query, array &$options, mixed $auth) : void

Fires while loading the upcoming appointments to display.

Description

Trigger hook to manipulate at runtime the query used to load the upcoming appointments to display under the Employees Area dashboard page in the front-end.

Third party plugins can extend the query by applying further conditions or selecting additional data.

Parameters

&$query

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

&$options

(array)  An array of options.

• start - the query offset to handle the pagination;
• limit - the maximum number of appointments to display per page.

$auth

(VAPEmployeeAuth)  The authenticated employee instance.

Return Value

None.

Example

/**
 * Trigger hook to manipulate the query at runtime. Third party plugins
 * can extend the query by applying further conditions or selecting
 * additional data.
 *
 * @param   mixed            &$query    Either a query builder or a query string.
 * @param   array            &$options  An array of options.
 * @param   VAPEmployeeAuth  $auth      The authenticated employee instance.
 *
 * @return  void
 *
 * @since   1.7.9
 */
public function onBuildEmploginAppointmentsQuery(&$query, &$options, $auth)
{
    // do something here...
}

Changelog