shopp('shipping.option-menu')

Displays a select menu for shipping options.

shopp('shipping', 'option-menu', '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 void by default, select and option tags when return option is used

Alternative Forms

shopp('shipping', 'method-menu', 'options...');
shopp('shipping.option-menu', 'options...');

Description

Displays a select menu for shipping options.

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

The following options are valid.

  • class: css classes to add to the select class attribute, in addition to shopp and shipmethod
  • difference: Make true, 1, or on to display the shipping cost difference on each shipping option from the currently selected method. Make false, 0, or off to display the shipping cost of the method. Default: true.
  • times: Make true, 1, or on to display the estimated delivery dates for each method. Make false, 0, or off to prevent dates from being displayed. Default: false
  • dateformat: The php date format string to be used for displaying estimated delivery dates.
  • dateseparator: When the delivery dates are a range, the string to use to separate the two dates. Default: ‘—’.

Examples

shopp('shipping', 'method-menu', array(
    'difference' => true, // show differences from selected method
    'times' => true, // show estimated delivery dates
    'dateformat' => 'M j', // php date format string
    'dateseparator' => ' to ', // Mar 1 to Mar 3
));
<?php if ((shopp('shipping','has-options'))): ?>
<small>Select a shipping method:</small>



<form action="<?php shopp('shipping','url') ?>" method="post">
<div id="shipping-methods">
    <?php shopp('shipping', 'option-menu', 'difference=on&dateseparator= to &times=on&dateformat=M j'); ?>
</div>
<?php shopp('shipping','update-button'); ?>
</form>


<?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