shopp('storefront.recent-shoppers')

Displays a list of the most recent shoppers.

shopp('storefront', 'recent-shoppers', '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 string Outputs a list of the most recent shoppers

Displays a list of the most recent shoppers. The list is setup to mask the shopper’s personally identifiable information to protect individual identities.

Options

  • abbr: (Default firstname) Set to firstname to abbreviate the firstname, otherwise the lastname is abbreviated.
  • city: (Default true) Set to boolean true to include the shopper’s city in the recent shoppers list.
  • state: (Default true) Set to boolean true to include the shopper’s state in the recent shoppers list.
  • avatar: (Default true) Set to boolean true to include the shopper’s email gravatar. Use size option to set the gravatar size.
  • size: (Default 48) Set the size of the gravatar.
  • show: (Default 5) Set the number of recent shoppers to appear.

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.

Alternative Forms

shopp('storefront.recent-shoppers', 'options');

Examples

shopp('storefront', 'recent-shoppers');
// remove city, state, and avatar
shopp('storefront.recent-shoppers', array(
    'city' => false,
    'state' => false,
    'avatar' => false,
));
// set avatar size to 75 pixels
// show 10 shoppers
// abbreviate lastname
shopp('storefront.recent-shoppers', array(
    'size' => 75,
    'show' => 10,
    'abbr' => 'lastname',
));

See Also

You must be logged in to post a comment.

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

Skip to toolbar