shopp('checkout.payment-option')

Displays the current payment option.

shopp('checkout', 'payment-option', '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 payment option markup if the return option is used.

Alternative Forms

shopp('checkout.payment-option', 'options');
shopp('checkout.pay-option', 'options');

Description

Used to display a single form input for selecting a payment option.

This call is used within a shopp(‘checkout.payment-options’) loop. Note that your code will be responsible for adding/removing additional payment method inputs from the checkout form.

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.

  • labelpos – Default after, specify before or after to place label before of after the current payment option input.
  • labeling – Default (not set), specify true, on, 1 to add label to current payment option. Adds user-specified label from Payments Settings for current payment option.
  • type – Default hidden, specify hidden, checkbox, or radio for the type of input.
  • return – (Deprecated use) specify true, on, 1 to return the payment option object (not the markup). Use the get prefix to have this theme api call return the markup. This option is a non-standard use in the theme api, and will be retired in favor of a developer api call in a future version.

Examples

Add a hidden input for each payment option

while ( shopp('checkout.pay-options','mode=loop') )
    shopp('checkout.pay-option');

Add a radio input for each payment option, with wrapped in label tag, with the payment option label appearing after the radio.

while ( shopp('checkout.pay-options','mode=loop') )
    shopp('checkout.pay-option', array(
        'labeling'=>'on',
        'labelpos'=>'after',
        'type'=>'radio'
    ));

Add a checkbox input for each payment option, with wrapped in label tag, with the payment option label appearing before the checkbox.

while ( shopp('checkout.pay-options','mode=loop') )
    shopp('checkout.pay-option', array(
        'labeling'=>'on',
        'labelpos'=>'before',
        'type'=>'checkbox'
    ));

See Also

You must be logged in to post a comment.

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

Skip to toolbar