shopp('cart.promo-code')

Displays an empty text input box and a button to accept promotional codes and apply them to the cart.

DEPRECATED IN SHOPP 1.3

shopp('cart', 'promo-code', '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 string Controls for entering a promo code

Renders HTML markup for entering a promo code into the shopping cart. Typically only used in the cart.php content template.

The markup created by this tag follows this format:

<ul>
    <li>
    <p class="error">An error message.</p>
    <span><input type="text" id="promocode" name="promocode" value="" size="10" /></span>
    <span><input type="submit" id="apply-code" name="update" value="{label option}" /></span>
    </li>
</ul>

Options

  • class: Default is not set. Allows you to specify custom CSS classes to the button element.
  • disabled: Default is not set. A flag value that when included and set to any value (including empty) will disable the button.
  • value: Default is Apply Promo Code. Set to the text to be used as the text on the button.
  • accesskey: Default is not set. Specify a character (a letter for example) to be used as the button’s accesskey.
  • title: Default is not set. Set the title attribute of the rendered button element.
  • tabindex: Default is not set. Set to a number to set the tab order of the element. When not set, the element will automatically be assigned a tab order by the web browser.

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.

Examples

<?php shopp('cart','promo-code'); ?>
<?php shopp('cart','promo-code','class=promo-input&value=Apply Promo Code'); ?>

See Also

  1. Avatar of msigley

    Replaced in Shopp 1.3 with shopp(‘cart.apply-code’)

    November 14th   #

You must be logged in to post a comment.

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

Skip to toolbar