public function onDisplayOrderSummary(object $order) : string

Fires after displaying all the booked appointments.


Description

Trigger hook to let the plugins add custom HTML contents below the order summary. The returned HTML will be always included outside the form of the page.

Our VikAppointments - Zoom plugin uses this hook to display the button to start the meeting on site.

The following image indicates where the resulting HTML will be appended.


Parameters

$order

(VAPOrderAppointment)  The instance holding the order details.

Return Value

String. The HTML to include.


Example

/**
 * Trigger event to let the plugins add custom HTML contents below the order summary.
 *
 * @param   object  $order  The object holding the appointments details.
 *
 * @return  string  The HTML string to include within the document.
 */
public function onDisplayOrderSummary($order)
{
    // append custom HTML
    return '<code>HTML CODE WILL BE ADDED HERE</code>';
}

Changelog

VersionDescription
1.7 Introduced.
Last Update: 2021-10-11 09:46
Helpful?