English (United Kingdom)
Knowledge Base  >  Vik Appointments  >  Hooks  >  Site Pages  >  Order  >  Display Details

apply_filters( 'vikappointments_display_order_details', string $html, string $locationobject $order )

Fires while displaying the details of the order.


Description

Trigger event to let the plugins add custom HTML contents within the order details box. This hook fires several times, once for each supported location.

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


Parameters

$html

(string)  The HTML to include.

$location

(string)  The position in which the HTML code will be placed.

  • before - before the order box;
  • top - at the beginning of the order box;
  • actions - within the actions toolbar;
  • order - after the order details (below the status);
  • payment - after the payment details (below the total cost);
  • fields - at the end of the custom fields box;
  • bottom - at the end of the order box;
  • after - after the order box.
$order

(VAPOrderAppointment)  The instance holding the order details.


Example

/**
 * Trigger hook to let the plugins add custom HTML contents within the order details box.
 *
 * @param  string  $html      The HTML string to include within the document.
 * @param  string  $location  The HTML will be always placed after the specified location.
 * @param  object  $order     The purchased order.
 */
add_filter('vikappointments_display_order_details', function($html, $location, $order)
{
    if ($location == 'order')
    {
        // append custom HTML after the order status
        $html .= '<code>HTML CODE WILL BE ADDED HERE</code>';   
    }

    return $html;
}, 10, 3);

Changelog

Version Description
1.2 Introduced.
Last Update: 2021-07-30
Helpful?