wppizza / markup / pages / page.cancelled.php
“Order Cancelled” page when an order has been cancelled
CSS Targeting
-
Wrapper div element ID:
#wppizza-order-cancelled
(unique to this page) -
Wrapper div element class:
.wppizza-order-wrap
(used on all pages)
if you simply want to edit some styles/layout (text-sizes, color, margins, paddings etc etc ) it is strongly recommended to use css instead of filters/actions. Please refer to “Modify Styles/Layout”
Filters/Actions – Notes
There are typically 2 different ways payment gateways provide to cancel an order before payment is made. Some will send a notification in the background before allowing the customer to return to the site. If this is the case, the $cancel_type
parameter referred to below will be ipn
. If however the payment gateway needs a distinct link back to the website upon clicking of which the order will be cancelled, the $cancel_type
parameter will be link
Filters available
apply filters by adding them to your child-theme’s functions.php (notes regarding functions.php)
-
filter name:
wppizza_filter_pages_cancelled_markup
purpose: modify the html markup of the page as required@param: $markup array (array of markup elements)
@param: $order_formatted array (array of order details)
@param: $cancel_type string (ipn | link) – see Notes above
@return: arrayexamples:
add_filter('wppizza_filter_pages_cancelled_markup', 'prefix_filter_pages_cancelled_markup', 10, 3); function prefix_filter_pages_cancelled_markup($markup, $order_formatted, $cancel_type){ /* notes: use print_r($markup) to view array keys with their respective markup use print_r($order_formatted) to view array containing order details $cancel_type is either 'ipn' or 'link' use global $wppizza_options; to access all options/settings/localization strings etc set in the plugin */ /* example: adding a paragraph AFTER opening div element using standard php concatenation */ $markup['div_'] .= '<p>more text after opening div</p>'; /* example: adding a paragraph BEFORE opening div element using standard php concatenation */ $markup['div_'] = '<p>more text before opening div</p>' . $markup['div_']; /* example: adding a paragraph AFTER opening div element using wppizza array_splice helper function */ $splice_before['myprefix_paragraph'] = '<p>more text after opening div</p>'; $markup = wppizza_array_splice($markup, $splice_before, 'div_' ); /* example: adding a paragraph BEFORE opening div element using wppizza array_splice helper function */ $splice_after['myprefix_paragraph'] = '<p>more text before opening div</p>'; $markup = wppizza_array_splice($markup, $splice_after, 'div_' , true); /* example: removing the return to site/shop link*/ unset($markup['return_link']); /* example: using actions of another plugin that by default outputs html to add it before the end of the form element */ ob_start(); # start buffering do_action('other_plugin_output'); # run action of other plugin that outputs things $buffer= ob_get_contents(); # capture buffer in variable ob_end_clean(); # clean buffer $markup['_div'] = $buffer. $markup['_div']; # add buffered output before end of wrapper div return $markup; }
Actions available
Actions should NOT output / echo / print anything, if you need to output any elements, use the filter provided (see above)
-
action:
wppizza_cancelledpage
purpose: run an action when an order has been cancelled@param: $order_results array
@param: $cancel_type string (ipn | link) – see Notes above
@return: void
examples:
add_action('wppizza_cancelledpage', 'prefix_cancelledpage_myaction', 10, 2);
function prefix_cancelledpage_myaction($order_results, $cancel_type){
/*
note: use print_r($order_results) to view order parameters
$cancel_type is either ipn or link
*/
/*
# run your code/action
*/
/* do not output/echo anything - use the filter above instead if you need to*/
return;
}
Editing files directly
ensure you have also read the “Modify/Edit Templates – Readme”
basepath: [plugin-path]/wppizza/templates/markup
filepath: [plugin-path]/wppizza/templates/markup/pages/page.cancelled.php
Modules used in file
- none