Displays an interactive checkbox toggle to use to mark the shipping address as a residential address.

shopp('checkout', 'residential-shipping-address', '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, the residential shipping address checkbox when the return option is used.

Alternative Forms

shopp('checkout.residential-shipping-address', 'options');


This is useful primarily when using online shipping rate add-ons such as FedEx Rates as carriers often have different rates when shipping to commercial addresses compared to residential addresses.

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.


  • label: Default is set to Residential shipping address. Used to specify a custom label for the residential shipping address control.
  • checked: Set to checked=on to force the input to be checked.
  • title: used to set the title attribute of the input.
  • class: used to set the class attribute of the input.


<?php shopp('checkout.residential-shipping-address'); ?>
<?php shopp('checkout.residential-shipping-address', 'checked=on&title=The shipping address is residential&label=Residential shipping address'); ?>

See Also

You must be logged in to post a comment.

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