1.0

account.php content template

content template used for all account page requests.

add_product_download

called after digital product file upload in product editor.

attach_product_download

called when product asset is attached to product or product variant.

cart.php content template

content template used for the storefront cart page.

catalog.php content template

content template used for the storefront homepage.

category-{id}.php content template

content template used for a specific collection page by id.

category-{slug}.php content template

content template used for a specific collection of products by collection slug.

checkout.php content template

content template used for the storefront checkout page.

confirm.php content template

content template used for the storefront confirm order page.

errors.php content template

content template used for the storefront errors.

password_reset

called after a password reset

product.php content template

content template file used for all single products.

receipt.php content template

content template used for an order receipt.

shopp('cart.discount')

Displays the total discount amount currently applied to the cart in the store’s default currency.

shopp('cart.empty-button')

Renders a button that empties the shopper’s cart completely.

shopp('cart.function')

Includes hidden functional elements needed to control how the cart is managed.

shopp('cart.has-discount')

Used to test whether there are any discount applied to the shopping cart or not.

shopp('cart.has-items')

Provides a simple test mechanism to allow different template layouts to be shown depending on whether there are items in the cart or not.

shopp('cart.has-promos')

Provides a simple test mechanism to allow different template layouts to be shown depending on whether there are promotions applied to the current cart.

shopp('cart.has-ship-costs')

Used to test if the cart has shipping costs associated with it.

shopp('cart.has-shipping-methods')

When there is physical products to be shipped in the cart, this tag is used to determine if there is one or more shipping method estimates.

shopp('cart.has-taxes')

Used to test whether there are taxes calculated for the order.

shopp('cart.items')

Loops through the items in the cart to display information specific to a single item.

shopp('cart.lastitem')

This is a programmer’s tag, which returns the last item object added to the cart.

shopp('cart.needs-shipped')

Used to test whether shipping is enabled and that there are goods in the cart that need shipped.

shopp('cart.needs-shipping-estimates')

Used to test whether shipping estimates are needed based on your current cart (has physical products that need shipped) and shipping settings (whether shipping cost will vary).

shopp('cart.promo-code')

Displays an empty text input box and a button to accept promotional codes and apply them to the cart.

shopp('cart.promo-discount')

Shows the total discount for an applied promotion. Used within a shopp(‘cart’,’promos’) loop.

shopp('cart.promo-name')

Displays the name of the promotion currently applied. Used within a shopp('cart','promos') loop.

shopp('cart.promos')

Loops through the promotions applied to the cart to display information specific to each applied promotion.

shopp('cart.promos-available')

Used to test whether the promotions limit has been reached (when a promotions limit has been set.)

shopp('cart.referrer')

Displays the URL of the previous page the visitor was viewing from which a link to the cart page was followed.

shopp('cart.shipping')

Displays the cost of shipping of the cart in the store’s default currency.

shopp('cart.shipping-estimates')

Displays a set of inputs for getting shipping estimates in the cart, by allowing the customer to set basic address information.

shopp('cart.sidecart')

Displays the sidecart layout as defined in the [[sidecart.php template file]].

shopp('cart.subtotal')

Displays the subtotal amount of the cart in the store’s default currency.

shopp('cart.tax')

Displays the total tax assessed for the cart in the store’s default currency.

shopp('cart.total')

Displays the grand total amount for the cart in the store’s default currency.

shopp('cart.total-items')

Displays the total number of unique items in the shopping cart.

shopp('cart.totalpromos')

Displays the total number of promotions currently applied to the shopping cart.

shopp('cart.update-button')

Renders a button that when clicked will cause the shopping cart to recalculate all totals including prices, promotional discounts, shipping, and taxes.

shopp('cart.url')

Displays the shopping cart page permalink for use in href attributes of HTML anchor <a> tags or the action attribute of a <form> tag.

shopp('cartitem.discount')

Displays the single unit discount applied to the cart item.

shopp('cartitem.hasinputs')

Tests whether the cart item has any custom inputs.

shopp('cartitem.in-category')

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

shopp('cartitem.input')

Used in the ‘inputs’ loop to show an individual cart item input.

shopp('cartitem.inputs')

Loops through each cart item input so that a custom input layout can be specified within the looping block.

shopp('cartitem.inputs-list')

Displays all of the custom inputs for the cart item in an unordered list (<ul>).

shopp('cartitem.optionlabel')

Displays the label for the currently selected product variation.

shopp('cartitem.options')

Displays the currently selected product variation for the item or displays a drop-down menu that allows the shopper to change the selected product variation of the item.

shopp('cartitem.quantity')

Displays the quantity of the cart item.

shopp('cartitem.remove')

Displays a control element that can be displayed as a link or a <button> element that when clicked will remove the item from the cart.

shopp('cartitem.sku')

Displays the SKU of the item (if available).

shopp('cartitem.tax')

Displays the total tax calculated on the line item (if available).

shopp('cartitem.taxrate')

Displays the tax rate percentage that applies to the current line item.

shopp('cartitem.total')

Displays the cart item’s total price in the store’s current currency format.

shopp('cartitem.unitprice')

Displays the unit price in the store’s default currency.

shopp('cartitem.url')

Displays the URL of the product the item came from.

shopp('checkout', 'has-data')

Tests for the presence of order data values associated with the current order on checkout.

shopp('checkout.account-login')

DEPRECATED

shopp('checkout.billing-address')

Displays a text field for the street address of the billing destination.

shopp('checkout.billing-card')

Displays a text field for the credit card number.

shopp('checkout.billing-cardexpires-mm')

Displays a text field for the month portion of the credit card’s expiration date.

shopp('checkout.billing-cardexpires-yy')

Displays a text field for the year portion of the credit card’s expiration date.

shopp('checkout.billing-cardholder')

Displays a text field for the name of the credit card holder on the credit card.

shopp('checkout.billing-cardtype')

Displays a drop-down menu for the accepted credit/debit card types.

shopp('checkout.billing-city')

Displays a text field for the city of the billing destination.

shopp('checkout.billing-country')

Displays a drop-down menu (HTML <select>) field for the country of the billing destination.

shopp('checkout.billing-cvv')

Displays a text field for the card verification value, a number usually printed on the back of the card to prove the card is in the presence of the shopper.

shopp('checkout.billing-postcode')

Displays a text field for the postal code of the billing destination.

shopp('checkout.billing-state')

Displays a drop-down menu (HTML <select>) for the state/province of the billing destination.

shopp('checkout.billing-xaddress')

Displays a text field as an additional line for the street address of the billing destination.

shopp('checkout.billing-xco')

DEPRECATED

shopp('checkout.card-required')

Used to test if credit card fields are needed for the payment system of the currently selected payment method.

shopp('checkout.cart-summary')

Renders the cart summary as defined in the [[summary.php template file]].

shopp('checkout.confirm-button')

Displays a submit button that submits the order to processed by Shopp and directing the shopper to a final order confirmation screen that allows them to verify their order for mistakes before processing it.

shopp('checkout.confirm-password')

Displays a password field for the shopper to confirm that the password they entered in the password field matches to ensure they entered the password they wanted to enter correctly.

shopp('checkout.customer-info')

Displays a field of a specified type with a specific name for taking and tracking custom information about the customer.

shopp('checkout.email')

Displays a text field for taking the email address of the shopper.

shopp('checkout.email-login')

DEPRECATED

shopp('checkout.error')

Displays any error messages returned from the payment processor after the shopper attempts to submit their order for processing.

shopp('checkout.firstname')

Displays a text field for taking the first name of the shopper.

shopp('checkout.function')

Includes a number of hidden inputs required for the proper operation of the checkout process.

shopp('checkout.lastname')

Displays a text field for taking the last name of the shopper.

shopp('checkout.local-payment')

DEPRECATED

shopp('checkout.loggedin')

DEPRECATED

shopp('checkout.login-button')

DEPRECATED, use shopp(‘customer’,’submit-login’)

shopp('checkout.loginname')

Displays a text field for the login name the customer would like to use for their account.

shopp('checkout.notloggedin')

DEPRECATED

shopp('checkout.order-data')

Displays a custom text field for collecting any number of custom fields with the order.

shopp('checkout.password')

Displays a password field for the shopper to create a new password when creating a new account during checkout.

shopp('checkout.password-login')

DEPRECATED Replaced by shopp(‘customer’,’password-login’) Renders a password field used to take the password for authenticating the credentials of a user during the login process. Options 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…

shopp('checkout.payment-options')

This multipurpose tag by default is used to render a selection menu on the checkout page for one or multiple payment options.

shopp('checkout.phone')

Displays a text field for the customer’s phone number.

shopp('checkout.same-shipping-address')

Displays an interactive checkbox toggle to use the same address entered as the billing address for the shipping address.

shopp('checkout.shipping')

Used to test whether the current shopping cart/order has items that need to be shipped to a physical address.

shopp('checkout.shipping-address')

Displays a text field for the street address of the shipping destination.

shopp('checkout.shipping-city')

Displays a text field for the city of the shipping destination.

shopp('checkout.shipping-country')

Displays a drop-down menu (HTML <select>) field for the country of the shipping destination.

shopp('checkout.shipping-postcode')

Displays a text field for the postal code of the shipping destination.

shopp('checkout.shipping-state')

Displays a drop-down menu (HTML <select>) for the state/province of the shipping destination.

shopp('checkout.shipping-xaddress')

Displays a text field as an additional line for the street address of the shipping destination.

shopp('checkout.submit')

Displays a submit button to send the checkout form to Shopp for processing.

shopp('checkout.url')

For all but the Test Mode payment gateway, this tag outputs a web address that points to the checkout page of the current store over a secure (SSL) connection by using the https:// protocol prefix.

shopp('checkout.xco-buttons')

DEPRECATED

shopp('collection.coverimage')

Displays the cover image for the category.

shopp('collection.description')

Displays the description of the category.

shopp('collection.faceted-menu')

Shows a faceted menu of filter options to find products in the current category.

shopp('collection.has-categories')

Determines if the current category has any sub-categories and, if so, loads them for use with the shopp('collection','subcategories') tag.

shopp('collection.has-faceted-menu')

Tests if the current category has faceted menus enabled.

shopp('collection.has-images')

Checks if the category has any images.

shopp('collection.has-products')

Determines whether the custom category, or collection, has displayable products, and loads product data.

shopp('collection.id')

Displays the database ID of the category.

shopp('collection.image')

Used in the ‘images’ loop to show an individual category image in the loop.

shopp('collection.images')

Loops through the category images so that you can display each category image.

shopp('collection.is-subcategory')

Detects if the current category is a subcategory or not.

shopp('collection.name')

Displays the name of the category or smart collection.

shopp('collection.pagination')

Displays a linked list of page numbers for navigating pages of products in a category.

shopp('collection.products')

Loops through the products in a given product collection to display information specific to a single product in the collection.

shopp('collection.row')

Provides a test mechanism for grouping/splitting up product listings into rows (useful for grid-style displays).

shopp('collection.section-list')

Displays a linked list of the categories in the current category section.

shopp('collection.slug')

Displays the slug (or pretty URL name) for the custom category or smart collection.

shopp('collection.subcategories')

Loops through the loaded sub-categories in a given category to display information specific to a single sub-category in the collection.

shopp('collection.subcategory-list')

Displays a linked list of sub-categories of this category to be used for navigation.

shopp('collection.total')

Shows the total number of products in the category.

shopp('collection.url')

Displays the full link to the current category.

shopp('customer.account-login')

Displays login name field for customer login form. Alias for shopp(‘customer’, ’email-login’) or shopp(‘customer’, ‘login-name-login’)

shopp('customer.account-url')

Displays the account page url.

shopp('customer.accounts')

Shows the account system in use on checkout.

shopp('customer.action')

Displays the customer form action attribute url.

shopp('customer.billing-address')

Displays the customer billing address input field, populated with the currently stored billing address.

shopp('customer.billing-city')

Displays the customer billing city input field, populated with the currently stored billing city.

shopp('customer.billing-country')

Displays the customer billing country drop-down input field, populated with the currently stored billing country.

shopp('customer.billing-postcode')

Displays the customer billing postcode input field, populated with the currently stored billing postcode.

shopp('customer.billing-state')

Displays the customer billing state/province drop-down input field, populated with the currently stored billing state.

shopp('customer.billing-xaddress')

Displays the customer billing extended address input field, populated with the currently stored billing extended address.

shopp('customer.company')

Displays the customer company input field, populated with the currently stored company name.

shopp('customer.confirm-password')

Displays a password field for the shopper to confirm that the password they entered in the password field matches to ensure they entered the password they wanted to enter correctly.

shopp('customer.download')

Used in the ‘has-download’ loop to show an individual download.

shopp('customer.downloads')

Used to loop through purchased downloads in the customer’s menu.

shopp('customer.email')

Displays a text field for taking the first name of the customer.

shopp('customer.email-login')

Displays login name field for customer login form. Alias for shopp(‘customer’, ‘account-login’) or shopp(‘customer’, ‘login-name-login’)

shopp('customer.errors')

RETIRED

shopp('customer.errors-exist')

RETIRED

shopp('customer.firstname')

Displays a text field for taking the first name of the customer.

shopp('customer.has-account')

Tests a customer for an associated WordPress account, when WordPress integrated Shopp accounts are enabled.

shopp('customer.has-downloads')

Loops through each purchased download so that a custom layout can be specified within the looping block.

shopp('customer.has-info')

Loops through each customer info property so that a custom layout can be specified within the looping block.

shopp('customer.has-purchases')

Determines if there are orders for this customer.

shopp('customer.info')

Used in the ‘has-info’ loop to show the individual customer info property.

shopp('customer.lastname')

Displays a text field for taking the last name of the customer.

shopp('customer.logged-in')

Evaluates to either true or false to represent whether the shopper has yet logged in.

shopp('customer.login-button')

Displays the customer account login submit button. Alias of shopp(‘customer’,’submit-login’).

shopp('customer.login-errors')

Displays any error messages that occurred during the login attempt.

shopp('customer.login-errors')

RETIRED

shopp('customer.login-label')

Displays ‘Email Adress’ or ‘Login Name’, depending on the type of account that has been set in the Shopp settings.

shopp('customer.loginname')

Displays a text field for the login name the customer would like to use for their account.

shopp('customer.loginname-login')

Displays login name field for customer login form. Alias for shopp(‘customer’, ‘account-login’) or shopp(‘customer’, ’email-login’)

shopp('customer.management')

Deprecated, use shopp(‘storefront’,’account-menu-item’) instead.

shopp('customer.menu')

Deprecated: Use shopp(‘storefront’,’account-menu’) instead.

shopp('customer.not-logged-in')

Evaluates to either true or false to represent whether the shopper has not logged in.

shopp('customer.order')

Displays an order url in the Customer account dashboard orders history.

shopp('customer.order-lookup')

Shows the order lookup user interface screen.

shopp('customer.password')

Displays a password field for the shopper to create a new password when creating a new account during checkout.

shopp('customer.password-login')

Renders a password field used to take the password for authenticating the credentials of a user during the login process.

shopp('customer.phone')

Displays a text field for the customer’s phone number.

shopp('customer.process')

DEPRECATED

shopp('customer.purchases')

Loops through each order so that a custom layout can be specified within the looping block.

shopp('customer.receipt')

Shows the URL to view the receipt of the current order

shopp('customer.register')

Used on a Shopp customer registration form to output the submit button.

shopp('customer.same-shipping-address')

Displays a checkbox input that indicates that the shipping address is the same as the billing address.

shopp('customer.save-button')

Displays a submit button input for a customer profile form.

shopp('customer.shipping-address')

Displays the customer shipping address input field, populated with the currently stored shipping address.

shopp('customer.shipping-city')

Displays the customer shipping city input field, populated with the currently stored shipping city.

shopp('customer.shipping-country')

Displays the customer shipping country drop-down input field, populated with the currently stored shipping country.

shopp('customer.shipping-postcode')

Displays the customer shipping postcode input field, populated with the currently stored shipping postcode.

shopp('customer.shipping-state')

Displays the customer shipping state/province drop-down input field, populated with the currently stored shipping state.

shopp('customer.shipping-xaddress')

Displays the customer shipping extended address input field, populated with the currently stored shipping extended address.

shopp('customer.submit-login')

Displays the customer account login submit button. Alias of shopp(‘customer’,’login-button’).

shopp('customer.url')

Provides the link to the account page.

shopp('customer.wpuser-created')

Test to see if a new WordPress user has been created in the current session.

shopp('product.add-to-cart')

Displays the Add to Cart button that adds the product (and selected product variations) to the shopper’s cart.

shopp('product.buy-now')

Alias for shopp(‘product’,’add-to-cart’) with button value of “Buy Now”

shopp('product.categories')

Loops through each assigned category so that a custom layout for displaying the categories can be specified within the looping block.

shopp('product.category')

Used in the shopp('product','categories') loop to show information for each assigned category.

shopp('product.coverimage')

Displays the default image for the product.

shopp('product.description')

Displays the product description.

shopp('product.donation')

Displays a donation amount input that can be displayed as either a text box or a drop-down menu that allows the customer to specify an amount to donate.

shopp('product.found')

Used to test if the requested product is available.

shopp('product.freeshipping')

Used in a test to display different content when free shipping is available versus when it is not available for a specific product.

shopp('product.gallery')

Builds a dynamic image gallery with a gallery preview image display and a selection of thumbnails for all images available for a product.

shopp('product.has-categories')

Tests whether the product has any categories it is assigned to.

shopp('product.has-images')

Tests whether the product has any images and loads any unloaded images

shopp('product.has-savings')

A test intended to allow you to show a savings amount (a currency amount and/or percentage) when there is a difference between the regular price and sale price of a product.

shopp('product.has-specs')

Tests whether the product has any detail specs.

shopp('product.has-tags')

Test whether the product has any tags associated with it.

shopp('product.has-variations')

Used to detect if there are product options available that need to be selected before the product can be added to the cart.

shopp('product.id')

Displays the product ID from the database.

shopp('product.image')

Used in the shopp('product','images') loop to show an individual product image in the loop.

shopp('product.images')

Loops through the product images so that you can display each product image of a set type.

shopp('product.in-category')

Used to test whether the product exists in a specified category.

shopp('product.input')

Displays an input element to allow customer input for a product before adding it to the cart.

shopp('product.isfeatured')

Used to test when a product has been marked as a featured product that would appear in the Featured Products smart category.

shopp('product.name')

Displays the name of the product.

shopp('product.onsale')

A test to determine if there are any active sale prices.

shopp('product.outofstock')

Displays an out of stock notice if the product and all its variations have no stock.

shopp('product.price')

Displays the normal price of the product using the currency format associated with the store’s base of operations (set in the [[General Settings]] screen).

shopp('product.quantity')

Displays the quantity or donation amount input.

shopp('product.saleprice')

Displays the sale price of the product using the currency format associated with the store’s base of operations (set in the [[General Settings]] screen).

shopp('product.savings')

Normally used in the first part of a ‘has-savings’ test block to show the amount of savings between the sale price and regular price.

shopp('product.slug')

Displays the slug of the product.

shopp('product.spec')

Used in the ‘specs’ loop to show the individual product detail/spec entry.

shopp('product.specs')

Loops through each product detail spec so that custom spec layout can be specified within the looping block.

shopp('product.summary')

Displays the summary of the product.

shopp('product.tag')

Displays the current tag name in a shopp('product.tags') loop.

shopp('product.tagged')

Determines if the product is associated with a given tag name or id.

shopp('product.tags')

Each call iterates to the next tag associated with the product.

shopp('product.url')

Displays the product url.

shopp('product.variation')

Displays a specified property from the current variation in a shopp('product','variations') loop.

shopp('product.variations')

By default, this tag loops through each variation of the product available allowing custom display of variation properties through the shopp('product','variation') tag.

shopp('product.weight')

Displays the weight of a product or weight range of product variations.

shopp('purchase.address')

Displays the first line of the billing address.

shopp('purchase.card')

Displays the last four digits of the credit/debit card used to complete the purchase.

shopp('purchase.cardtype')

Displays the type of credit/debit card used to complete the transaction.

shopp('purchase.city')

Displays the name of the city associated with the billing address.

shopp('purchase.company')

Displays the company of the shopper that placed the order.

shopp('purchase.country')

Displays the name of the country associated with the billing address.

shopp('purchase.data')

Displays the current purchase data property value.

shopp('purchase.date')

Displays the date the purchase order was created.

shopp('purchase.discount')

Displays the discount amount applied to the order by deducting from the order subtotal, in the currency format associated with the base of operations.

shopp('purchase.email')

Displays the email address of the shopper that placed the order.

shopp('purchase.firstname')

Displays the first name of the shopper that placed the order.

shopp('purchase.freight')

Displays the total shipping cost in the currency format associated with the base of operations.

shopp('purchase.has-data')

Tests if order data fields are associated with a purchase.

shopp('purchase.has-download')

Test if the current purchased item has a download.

shopp('purchase.has-items')

Used to test if the order has any line items.

shopp('purchase.hasdiscount')

Displays the subtotal price of the order in the currency format associated with the base of operations.

shopp('purchase.hasfreight')

Displays the subtotal cost of the order in the currency format associated with the base of operations.

shopp('purchase.hastax')

Returns true if the purchase has a tax total, false if it does not.

shopp('purchase.id')

Displays the purchase order id number (or invoice number).

shopp('purchase.item-download')

Displays the download link for the current item.

shopp('purchase.item-hasinputs')

Tests whether the purchased item has any custom inputs.

shopp('purchase.item-id')

Displays the current id for the purchase record of the item

shopp('purchase.item-input')

Used in the ‘inputs’ loop to show an individual purchased item input.

shopp('purchase.item-inputs')

Loops through each purchased item input so that a custom input layout can be specified within the looping block.

shopp('purchase.item-inputs-list')

Displays all of the custom inputs for the purchased item in an unordered list (<ul>).

shopp('purchase.item-name')

Displays the name of the current line item.

shopp('purchase.item-options')

Displays the selected line item’s options, the selected variation’s label.

shopp('purchase.item-product')

Displays the product id of the current item

shopp('purchase.item-quantity')

Displays the item quantity ordered.

shopp('purchase.item-sku')

Displays the assigned SKU associated with the item (if any).

shopp('purchase.item-total')

Displays the total for the line item calculated by multiplying the quantity ordered by the unit price of the item.

shopp('purchase.item-unit-price')

Displays the unit price of the line item.

shopp('purchase.items')

Used to go through (iterate) each line item in the order.

shopp('purchase.lastname')

Displays the last name of the shopper that placed the order.

shopp('purchase.order-data')

Loops through purchase order data.

shopp('purchase.paymethod')

Display the merchant-defined label for the payment method associated with the current order.

shopp('purchase.phone')

Displays the phone number of the shopper that placed the order.

shopp('purchase.postcode')

Displays the postal code (or US ZIP code) associated with the billing address.

shopp('purchase.promo-list')

Display an unordered list of promotions associated with the current order.

shopp('purchase.shipaddress')

Displays the first line of the shipping address.

shopp('purchase.shipcity')

Displays the name of the city associated with the shipping address.

shopp('purchase.shipcountry')

Displays the name of the country associated with the shipping address.

shopp('purchase.shipmethod')

Displays the name of the selected shipping method.

shopp('purchase.shippostcode')

Displays the postal code (or US ZIP code) associated with the shipping address.

shopp('purchase.shipstate')

Displays the name of the state/province associated with the shipping address.

shopp('purchase.shipxaddress')

Displays a secondary line of the shipping address.

shopp('purchase.state')

Displays the name of the state/province associated with the billing address.

shopp('purchase.subtotal')

Displays the subtotal price of the order in the currency format associated with the base of operations.

shopp('purchase.tax')

Displays the tax amount applied to the order based on the order subtotal, in the currency format associated with the base of operations.

shopp('purchase.total')

Displays the total, final cost of the order in the currency format associated with the base of operations.

shopp('purchase.total-items')

Displays the total number of line items on the order.

shopp('purchase.transactionid')

Displays the transaction id provided by the payment gateway on successfully processing the purchase.

shopp('purchase.url')

Display the account page url.

shopp('purchase.xaddress')

Displays a secondary line of the billing address.

shopp('shipping.has-options')

A boolean tag to determine if there are shipping options available.

shopp('shipping.option-cost')

Displays the cost estimate of the current shipping method.

shopp('shipping.option-delivery')

Displays the delivery time estimate of the current shipping method.

shopp('shipping.option-name')

Displays the name of the current shipping method.

shopp('shipping.option-selected')

A boolean tag that returns true when the current shipping option is the selected option.

shopp('shipping.option-selector')

Displays the radio input selector markup for the current shipping method.

shopp('shipping.options')

Used to iterate through the list of available shipping options.

shopp('storefront.bestseller-products')

Displays the ‘Best Seller Products’ smart category which displays the products that have the most purchases based on your store’s order logs.

shopp('storefront.breadcrumb')

Displays the navigation breadcrumb link or set of links for the current storefront page.

shopp('storefront.catalog-products')

Displays the Catalog Products smart collection which displays all of the published products in the catalog.

shopp('storefront.categories')

Loops through the categories so that a custom layout can be specified for displaying each category within the looping block.

shopp('storefront.category')

For accessing a single, specified category from the catalog. By default, displays the category using the format described in the [[category.php template file]].

shopp('storefront.category-list')

Displays a linked list of Shopp categories to be used for shop category navigation.

shopp('storefront.featured-products')

Displays the ‘Featured Products’ smart category which displays the products that have the “Featured Product” setting toggled on in the product editor.

shopp('storefront.has-categories')

Tests whether the catalog has any categories.

shopp('storefront.is-category')

Used to determine when the shopper is viewing a category page.

shopp('storefront.is-product')

Used to determine when the shopper is viewing a product page.

shopp('storefront.new-products')

Displays the ‘New Products’ smart category which displays the products most recently added to the catalog.

shopp('storefront.onsale-products')

Displays the ‘On Sale Products’ smart category which displays the products that have a Sale Price enabled in the product editor or a promotion that applies to the product.

shopp('storefront.orderby-list')

Displays a list of product listing sort order options for the products displayed in a category.

shopp('storefront.product')

Loads a specified product and displays it using the [[product.php content template]].

shopp('storefront.random-products')

Displays the ‘Random Products’ smart category which displays a random assortment of products published to the catalog.

shopp('storefront.related-products')

Displays the ‘Related Products’ smart category which displays products related to the current product being viewed, or a specified product.

shopp('storefront.search-products')

Displays the Search Products smart category which displays products matching a keyword search.

shopp('storefront.tag-products')

Displays the ‘Tag Products’ smart collection which displays products with specified tag(s).

shopp('storefront.tagcloud')

Displays a list of product tags weighted by popularity.

shopp('storefront.url')

Displays the main catalog page permalink for use in href attribute of links or the action attribute of a <form> tag.

shopp('storefront.views')

Displays buttons to allow the shopper to change the current category view style to grid or list.

shopp()

The shopp() theme api call, used throughout all Shopp theme templates, as well as used for a global “getter” interface for certain commonly used Shopp objects.

shopp_account_management

called before customer account content template is loaded.

shopp_account_template

filters the account page content, after the account page has been loaded.

SHOPP_ADDON_ERR

Used for Shopp module errors, such as bad addon descriptors, version requirements.

SHOPP_ADMIN_DIR

Admin interface directory stub.

SHOPP_ADMIN_ERR

Used for Shopp admin errors.

SHOPP_ALL_ERR

Used for logging all errors in Shopp.

SHOPP_AUTH_ERR

Used for login and credential errors.

shopp_cart_add_item

called when an item is added to the cart.

shopp_cart_request

called on a cart request.

shopp_cart_retotal

called after cart totals are calculated.

shopp_cart_updated

called when cart has been updated.

shopp_category_saved

called on category save in the category editor.

SHOPP_COMM_ERR

Used for communication, connectivity errors.

SHOPP_DBPREFIX

Configurable prefix to shopp tables. Default ‘shopp_’

SHOPP_DB_ERR

Used for logging Shopp database errors.

shopp_deactivate

called on Shopp plugin deactivation.

SHOPP_DEBUG_ERR

Used for logging debug level message.

shopp_download_keygen

called when generating download key for product download.

shopp_download_request

called on product download request.

shopp_download_success

called after a product download.

SHOPP_ERR

Used for general errors visible to the shopper.

shopp_generate_password_key

called on customer password reset request.

shopp_login

called on login to Shopp customer

shopp_logout

called on store logout.

shopp_order_receipt

filters the content of a sales receipt after rendering the receipt template.

shopp_order_success

called on transaction completion.

shopp_order_txnstatus_update

called on transaction/payment status update.

SHOPP_PHP_ERR

Used for logging PHP errors in Shopp.

shopp_product_saved

Called after product save in product editor.

shopp_promo_saved

called after save in promotions editor.

shopp_recover_password_message

filters the password recovery message lines that is sent to the user by email on a password recovery request.

shopp_recover_password_subject

filters the subject of the email sent to the user on password recovery requests.

shopp_reset_password_message

filters the lines of the password reset message that is sent to the user after a successful password reset.

shopp_reset_password_subject

filters the subject line of the email sent to your user after the password has been successfully reset.

SHOPP_REVISION

Revision string of Shopp.php

shopp_save_payment_settings

called on Payments Settings save.

SHOPP_STOCK_ERR

Used for inventory warnings, low stock, and out of stock.

SHOPP_TEMP_PATH

Configurable filesystem path to the temporary file storage directory.

SHOPP_TRXN_ERR

Used for transactions errors, triggered by third-party services, such as payment processors.

SHOPP_VERSION

Current version of of the running Shopp plugin.

sidecart.php content template

content template used to display the side cart content.

summary.php content template

content template used to display the cat summary.

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

Skip to toolbar