Used with Shopp password recovery form to display the form submit button.

shopp('customer', 'recover-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 void by default, the password recovery form submit button string if the return option is used.

Alternative Forms

shopp('customer.recover-button', 'options');


Used with Shopp password recovery form to display the form submit button.

The login-recover.php template uses this theme api function in the password recovery form. When this form is submitted, it causes the password recovery email to be sent to the customer.

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.


The following options are valid.

  • value: Defaults to ‘Get New Password’. The text displayed in the submit button.


shopp('customer.recover-button','value=Password Reset');
<form action="<?php shopp('customer.url'); ?>" method="post" class="shopp" id="login">
    <li><h3>Recover your password</h3></li>
    <span><?php shopp('customer.account-login','size=20&title=Login'); ?><label for="login"><?php shopp('customer.login-label'); ?></label></span>
    <span><?php shopp('customer.recover-button'); ?></span>

See Also

You must be logged in to post a comment.

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