shopp('checkout.completed')

Tests if the current checkout has completed successfully and loads purchase context.

shopp('checkout', 'completed', 'options')

@param string $object the object or object.tag combination, if object.tag is used, the tag parameter can be omitted
@param string $tag the tag, can be hyphenated or not. Prefix with 'get' as shorthand for the return=true option
@param mixed $options associative array, or url-style name=value pairs separated by ampersands (&). Each pair is passed to the theme api tag as an option.
@returns boolean true if order is completed and loads purchase into global purchase context, false if order is not yet complete.

Alternative Forms

shopp('checkout.completed', 'options');

Description

Tests if the current checkout has completed successfully and loads purchase context.

If the checkout is complete, and the purchase record is not already loaded, this tag will attempt to load the full purchase data for use in rendering a receipt with the shopp(‘checkout’,’receipt’) tag.

This tag is used at the beginning of the thanks.php content template to determine if the order receipt should be loaded.

Universal Options

All Theme API calls have these options.

  • return: when set to true, 1, or on, this option forces the tag to return the value instead of displaying/echoing the value to the page. Alternatively, prefix the tag parameter with get to get the same effect. All theme api tags that return a boolean value will return by default.
  • echo: when set to false, 0, or off, this option forces the tag to display the value to the page. This is the default for all non-boolean tags.
  • is: when set to true, 1, or on, this option will evaluate the return of the theme api call as a boolean true or false value. See how values are converted to boolean.

Options

None

Examples

<?php if (shopp('checkout','completed')): ?>
<?php shopp('checkout','receipt'); ?>
<?php else: ?>


<p>Your order is still in progress and has not yet been received from the payment processor...</p>


<?php endif; ?>

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar