shopp('cart.empty-button')

Renders a button that empties the shopper’s cart completely.

shopp('cart', 'empty-button', '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 Markup for an HTML submit button element

Renders markup for an HTML submit button that, when clicked, will remove all items from the shopping cart. The button element is given an id of ’empty-button’. You may specify your own additional classes and your own value label.

<input type="submit" name="empty" id="empty-button" value="Empty Cart" />

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 Empty Cart. 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.

Alternative Forms

shopp('cart','emptybutton','options');
shopp('cart.emptybutton','options');
shopp('cart.empty-button','options');

Examples

<?php shopp('cart','empty-button','class=empty&value=Clear Your Cart'); ?>

See Also

You must be logged in to post a comment.

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

Skip to toolbar