shopp('shipping.option-selected')

A boolean tag that returns true when the current shipping option is the selected option.

shopp('shipping', 'option-selected', '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 bool true if the current shipping option has been selected, else false

Alternative Forms

shopp('shipping','method-selected');
shopp('shipping.option-selected');

Description

A boolean tag that returns true when the current shipping option is the selected option.

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

if ( shopp('shipping', 'has-options') ) {
    while ( shopp('shipping','options') ) {
        if ( shopp('shipping', 'option-selected') ) {
        // do something if option selected
        }
    }
}

shipping options as select menu

<?php if ( shopp('shipping', 'has-options') ): ?>
<?php while ( shopp('shipping','options')): 

// add selected="selected" attribute to the option
// if the current option is selected
$selected = ''; 
if ( shopp('shipping','option-selected') ) 
    $selected = ' selected="selected"';

$value = shopp('shipping','get-option-slug');
$name = shopp('shipping','get-option-name');
$cost = shopp('shipping','get-option-cost);
$delivery = shopp('shipping', 'get-option-delivery');
$label = $name.' &mdash '.$cost.' '.$delivery;
?>

<select name="shipmethod" class="shopp shipmethod">
<option value="<?php echo $value; ?>"<?php echo $selected; ?> ><?php echo $label; ?></option>
</select>

<?php endwhile; ?>
<?php endif; ?>

See Also

  1. Avatar of David Clough

    the above should probably read

    <option value="">

    March 27th   #

  2. Avatar of David Clough

    *shipping options as select menu

    http://pastebin.com/MvUFAFWc

    March 27th   #

You must be logged in to post a comment.

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

Skip to toolbar