Output

The following hooks are provided for Output related events.

AdminAreaFooterOutput

Runs on every admin area page load. All template variables defined at the time the hook is invoked are made availble to this hook point. This can vary by page. The list below is not an exhaustive list.

Parameters

Response

Accepts HTML to be output before the closing body tag of the admin area output

Example Code

<?php
add_hook('AdminAreaFooterOutput', 1, function($vars)
{
   return "HTML output here";
});

AdminAreaHeadOutput

Runs on every admin area page load. All template variables defined at the time the hook is invoked are made availble to this hook point. This can vary by page. The list below is not an exhaustive list.

Parameters

Response

Accepts HTML to be output before the closing body tag of the admin area output

Example Code

<?php
add_hook('AdminAreaHeadOutput', 1, function($vars)
{
    $html ='';
    $html .='';
    return $html;
});

AdminAreaHeaderOutput

Runs on every admin area page load. All template variables defined at the time the hook is invoked are made availble to this hook point. This can vary by page. The list below is not an exhaustive list.

Parameters

Response

Accepts HTML to be output before the closing body tag of the admin area output

Example Code

<?php
add_hook('AdminAreaHeaderOutput', 1, function($vars)
{
    $html  = 'This is a custom output on the header';
    return $html;
});

ClientAreaDomainDetailsOutput

Allows returning of output for display in the client area domain details page.

Parameters

Response

Return the HTML to be output on the page.

Example Code

<?php
add_hook('ClientAreaDomainDetailsOutput', 1, function($vars)
{
   return 'You can place any HTML here that will be output in the $ClientAreaDomainDetailsOutput smarty variable array';
});

ClientAreaFooterOutput

Executes when a client area page is being output. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

Return HTML to be output before the closing body tag of the page output.

Example Code

<?php
add_hook('ClientAreaFooterOutput', 1, function($vars)
{
    $html  = 'This is a custom output on the footer';
    return $html;
});

ClientAreaHeadOutput

Executes when a client area page is being output. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

Return HTML to be output within the HEAD tags of the page output.

Example Code

<?php
add_hook('ClientAreaHeadOutput', 1, function($vars)
{
    $html ='';
    $html .='';
    return $html;
});

ClientAreaHeaderOutput

Executes when a client area page is being output. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

Return HTML to be output at the top of the body tag of the page output.

Example Code

<?php
add_hook('ClientAreaHeaderOutput', 1, function($vars)
{
    $html  = 'This is a custom output on the header when in the client area.';
    return $html;
});

ClientAreaPageProductDetails

Allows returning of output for display in the client area product details page.

Parameters

Response

Return the HTML to be output on the page.

Example Code

<?php
add_hook('ClientAreaPageProductDetails', 1, function($vars)
{
    $html  = 'This is a custom output';
    return $html;
});

ShoppingCartCheckoutOutput

Allows returning of output for display on the Shopping Cart Checkout page.

Parameters

Response

Return the HTML to be output on the page.

Example Code

<?php
add_hook('ShoppingCartCheckoutOutput', 1, function($vars)
{
    $html  = 'This is a custom output';
    return $html;
});

ShoppingCartViewCartOutput

Allows returning of output for display on the Shopping Cart View Cart page.

Parameters

Response

Return the HTML to be output on the page.

Example Code

<?php
add_hook('ShoppingCartViewCartOutput', 1, function($vars)
{
    $html  = 'This is a custom output';
    return $html;
});