shopp('cartitem.in-category')

shopp('cartitem.in-category', '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 boolean true if the cart item is in the category, false if the cart item is not in the category.

Alternative Forms

shopp('cartitem', 'in-category', 'options');

Description

Test if the cart item is in a specific product category.

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.

• id: use to specify the category id to test for. Use this instead of the name option if you know the category id.
• name: use to specify the category name to test for. Use this instead of the id option if you are testing by category name.

Examples

// is the cart item in category id 1
if ( shopp('cartitem', 'in-category', 'id=1') ) { … }

// is the cart item in category id 1
if ( shopp('cartitem.in-category', array('name' => 'My Category')) ) { … }

See Also