1.1

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.

category.php content template

content template used for all product collection pages.

checkout.php content template

content template used for the storefront checkout page.

collection.php content template

content template used for all product collections.

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

paypal_freeorder_handling_label

filters the label given to PayPal for default $1 shipping fee on $0 subtotal orders.

print_scripts_array

used in the Shopp script server in the same way print_scripts_array filters the array of script dependencies that will need to be loaded in WordPress.

product-{id}.php content template

content template used for a specific product.

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.download-items')

Loops through only the downloadable items in the cart (ignoring other types of products).

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-downloads')

Used to test whether the cart has items that are derived from a download-product type.

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-shipped')

Used to test whether the cart has items that need to be physically shipped to an address.

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.shipped-items')

Loops through only the shipped items in the cart (ignoring other types of products).

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.addon')

Displays one or more properties of the current cart item addon.

shopp('cartitem.addons')

The cart item loop iterator.

shopp('cartitem.addons-list')

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

shopp('cartitem.coverimage')

Displays the default image, known as the cover image for the product.

shopp('cartitem.description')

Display the item description.

shopp('cartitem.discount')

Displays the single unit discount applied to the cart item.

shopp('cartitem.discounts')

Displays the total discount applied to the cart line item.

shopp('cartitem.has-addons')

Tests the cart item for addon items.

shopp('cartitem.hasinputs')

Tests whether the cart item has any custom inputs.

shopp('cartitem.id')

Displays the ID of the cart item as it relates to the array index number in the contents of the Cart.

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.name')

Displays the name of the item. This value is copied from the selected product when it was added to the cart.

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.product')

Displays the ID the catalog product that is the original source of the cart 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.type')

Displays the type of product the cart item is, one of Shipped, Download, Donation, or Virtual.

shopp('cartitem.unit-tax')

Displays the per-unit taxes calculated for the item in the store’s 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-locale')

Displays a drop-down menu (HTML <select>) field for the locales available for the currently selected country, state and applicable tax rate.

shopp('checkout.billing-localities')

Used to test when a locale set is available for the current billing location.

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.billing-xcsc')

Displays the markup for additional input fields used for extra card security.

shopp('checkout.billing-xcsc-required')

Tests if the current payment method supports cards with additional input requirements for extra card security (xcsc).

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.company')

Displays a text field for the customer’s company name on the checkout form.

shopp('checkout.completed')

Tests if the current checkout has completed successfully and loads purchase context.

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.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.gateway-inputs')

Displays any additional inputs required for the payment gateways.

shopp('checkout.lastname')

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

shopp('checkout.local-payment')

DEPRECATED

shopp('checkout.loginname')

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

shopp('checkout.loginname-login')

DEPRECATED

shopp('checkout.marketing')

Displays a checkbox for the customer to select to opt-in to marketing.

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.payment-option')

Displays the current payment option.

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.receipt')

Renders a receipt for the currently loaded order using the layout specified in the [[receipt.php template file]].

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

Displays an interactive checkbox toggle to use to mark the shipping address as a residential address.

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.submit-login')

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

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.carousel')

Shows a side-scrolling carousel of products loaded in the category.

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.feed-url')

Displays the product collection RSS feed url

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.load-products')

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

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.slideshow')

Generates a slideshow of product cover images for the products loaded in the category.

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.marketing')

Displays the marketing opt-in/opt-out checkbox input for the customer profile.

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-changed')

Test to see if the current customer profile password was just changed and saved.

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.profile-saved')

Test to determine if the viewed customer profile has just been saved.

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.recovery-url')

Displays the Shopp customer password recovery url.

shopp('customer.register')

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

shopp('customer.registration-errors')

Used on a Shopp customer registration page to display any errors that may have occurred on customer registration.

shopp('customer.registration-form')

Used on a Shopp customer registration form to output the action attribute.

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

Displays the residential shipping address checkbox input on the customer profile form.

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')

Returns the customer’s Shipping address object.

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('error.addon')

DEPRECATED

shopp('error.admin')

DEPRECATED

shopp('error.auth')

DEPRECATED

shopp('error.comm')

DEPRECATED

shopp('error.db')

DEPRECATED

shopp('error.debug')

DEPRECATED

shopp('error.stock')

DEPRECATED

shopp('error.trxn')

DEPRECATED

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.addons')

By default, this tag loops through each of the product addons available. Can also be used to output a menu of addons.

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-addons')

Used to detect if there are product addons available for the 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.customer')

Displays the customer id associated with the current purchase.

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.has-promo')

Used to test for a specific promotion applied to a purchase.

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-addons')

Used to loop through a purchased item’s addons.

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-price')

Display the price-line id of the current purchased item.

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.items-addons-list')

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

shopp('purchase.lastname')

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

shopp('purchase.not-paid')

Tests the transaction status to see if the status is not set to captured.

shopp('purchase.order-data')

Loops through purchase order data.

shopp('purchase.paid')

Tests the transaction status to see if the status is set to captured.

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('shipping.url')

Display the shipping method form action attribute url.

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-cart')

Alias for is_cart_page() core api function.

shopp('storefront.is-category')

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

shopp('storefront.is-checkout')

Used to determine when the shopper is viewing the checkout page.

shopp('storefront.is-landing')

Used to determine when the customer is on the main store catalog page, known as the store landing 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')

Embedded into the searchform.php template to enforce searching the storefront’s product catalog.

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.type')

Displays the type of catalog page being rendered (storefront, category, product).

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('storefront.zoom-options')

Modifies the default options for the zoom effect used on the current page.

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_menu

called after loading customer account page menu.

shopp_account_template

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

shopp_account_vieworder

filters the order receipt content displayed on users account page.

shopp_activate

called on Shopp activation.

SHOPP_ADDON_ERR

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

shopp_admin_boxhelp

filters the anchor tag for the help links on Shopp admin pages.

SHOPP_ADMIN_DIR

Admin interface directory stub.

SHOPP_ADMIN_ERR

Used for Shopp admin errors.

shopp_admin_menu

called after Shopp admin pages are added.

shopp_admin_order_receipt

filters the order content displayed to the order manager in the admin.

shopp_after_purchased_data

called in order admin for each item in the purchase as it is displayed.

SHOPP_ALL_ERR

Used for logging all errors in Shopp.

shopp_areas

filters country areas defined in Lookup::country_areas().

shopp_auth

called after customer login authorization.

SHOPP_AUTH_ERR

Used for login and credential errors.

shopp_autoupdate

called after Shopp auto update.

shopp_billing_address_required

filters the boolean value used to determine if the billing address field is needed on the checkout.

shopp_billing_cardexpires_month_required

filters the test for an empty billing card month field.

shopp_billing_cardexpires_year_required

filters the test for an empty billing card year field.

shopp_billing_cardholder_required

filters the validation test of the billing cardholder field.

shopp_billing_cardtype_required

filters the validation test on the billing cardtype field on the checkout.

shopp_billing_card_expired

filters the validation test on the card expiration date.

shopp_billing_card_required

filters the validation test on the payment card number field on the checkout.

shopp_billing_country_required

filters the validation test on the billing country field on the checkout form.

shopp_billing_cvv_required

filters the validation of the payment card security or verification code (cvv) on the checkout form.

shopp_billing_postcode_required

filters the validation check of the postal code field on the checkout form.

shopp_billing_valid_card

filters the validation test on the checkout form for a valid payment card number.

shopp_boolean_search

filters the list of keywords to be used in the catalog boolean Full-Text terms search query.

shopp_calculate_item_shipping

called for each shipped item for per item shipping calculation.

shopp_calculate_shipping

called when shipping options are calculated.

shopp_calculate_shipping_init

called before shipping calculations.

shopp_cartitem_stock

filters the cart item stock override.

shopp_cart_add_item

called when an item is added to the cart.

shopp_cart_fees

DEPRECATED filters the total additional cart fee added to each shipping method.

shopp_cart_request

called on a cart request.

shopp_cart_retotal

called after cart totals are calculated.

shopp_cart_taxrate

filters the returned tax rate percentage in the cart.

shopp_cart_taxrate_settings

filters the current tax setting.

shopp_cart_template

filters the cart page content.

shopp_cart_updated

called when cart has been updated.

shopp_catalog_template

filters the catalog page template content.

shopp_category_admin_scripts

called after categories admin scripts are enqueued.

shopp_category_arrange_scripts

called when category sort scripts are enqueued in admin.

shopp_category_editor_scripts

called after category editor scripts are enqueued in admin.

shopp_category_products_arrange_scripts

called after product sort order scripts are enqueued in admin.

shopp_category_products_hardlimit

filters the number of products to be displayed on one category page.

shopp_category_saved

called on category save in the category editor.

shopp_category_shortcode

filters the content/markup from a [category] shortcode, or in Shopp 1.2 a [catalog-collection] shortcode.

shopp_category_sortoptions

filters array of category sort options used for building menu on storefront.

shopp_category_template

filters the content of the category template.

shopp_checkout_confirm_button

filters the submit form input markup for the confirm-order button.

shopp_checkout_form

filters the checkout form input.

shopp_checkout_gateway_inputs

filters any additional inputs needed for processing for a gateway.

shopp_checkout_page

filters the checkout page content.

shopp_checkout_processed

called after checkout form validation.

shopp_checkout_submit_button

filters the submit form input markup for the checkout buttons.

shopp_checkout_url

filters the checkout page url.

SHOPP_COMM_ERR

Used for communication, connectivity errors.

shopp_confirmorder_pagetitle

filters the page title for the confirm-order page.

shopp_confirm_form

filters the confirm order form input.

shopp_confirm_order

called on submission of the confirm order page.

shopp_confirm_url

filters the confirm order url

shopp_countries

filters the countries lookup table.

shopp_country_zones

filters the country zones (states/provinces) lookup table.

shopp_create_purchase

called to trigger the creation of a new purchase.

shopp_customer_admin_scripts

called after customer admin scripts are enqueued.

shopp_customer_editor_info

runs after customer editor save meta box content.

shopp_customer_editor_scripts

called after the customer editor scripts are enqueued.

shopp_customer_editor_settings

called after customer editor settings meta box content is displayed.

shopp_customer_info_input

filters the text form input for each custom customer information field currently saved to the customer.

shopp_customer_taxrule_match

filters the match result for each conditional tax rule for a tax setting.

shopp_customer_types

filters the customer types lookup table.

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_default_scripts

called when shopp default scripts are enqueued.

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_EDITOR_MEDIA_BTNS

Configurable flag to show or hide the media buttons.

shopp_email_data

filters the email template substituted value.

shopp_email_exists

filters the test results for an existing Shopp customer record with the specified email address.

shopp_email_receipt_data

filters order receipt data used for email notification.

shopp_email_valid

filters the validation check on the checkout form which tests for a valid email address.

SHOPP_ERR

Used for general errors visible to the shopper.

shopp_errors_page

filters the error template content before outputting errors.

shopp_error_message_debugdata

filters an error message before error handling.

shopp_firstname_required

filters the validation test result for missing firstname information on the checkout form.

shopp_free_order

filters the free order status.

shopp_gateway_ajax_{purchase-gateway-slug}

called on shopp_gateway ajax requests.

shopp_gateway_module_settings

called after payments setting ui.

SHOPP_GATEWAY_TIMEOUT

Configurable timeout in seconds for gateways. Default 10.

SHOPP_GATEWAY_USERAGENT

Configurable useragent for Shopp server to server connections.

shopp_generate_password_key

called on customer password reset request.

shopp_googlecheckout_build_request

filters the array of checkout-shopping-cart xml text sent to Google Checkout to process the checkout.

shopp_googlecheckout_download_delivery_markup

filters the email-delivery tag for Google Checkout digital-content sales.

shopp_googlecheckout_download_instructions

filters the download instructions text delivered to the customer when digital-content is purchased over Google Checkout.

shopp_google_alternate_tax_tables_content

filters alternative-tax-table xml tags to add to the Google Checkout API request.

shopp_google_checkout_analytics

called in header to enqueue Google Checkout analytics scripts.

shopp_google_item_tax_table_selector

filters alternate tax table xml tag added to item markup in the Google Checkout API to apply a particular tax table to an item.

shopp_image_scale

filters the ImageProcessor object returned after the image scale operation.

shopp_index_content

filters each of the the search index entries content before it is saved

shopp_index_factors

filters the search index weight factors.

shopp_index_product_properties

filters the properties of the Product object used for indexing.

shopp_index_stopwords

filters the search indexing stopwords list.

shopp_init

called at end of Shopp’s init action

shopp_init_checkout

called before the checkout, order confirmation, or receipt is displayed.

shopp_init_confirmation

called before confirm order page.

shopp_inventory_manager_scripts

called before inventory manager scripts are loaded on the products admin page.

shopp_js_settings

filters localization settings passed to javascript environment on the storefront.

shopp_lastname_required

filters the validation test result for missing lastname information on the checkout form.

shopp_loaded

runs when the plugin is fully loaded.

shopp_local_taxrates_upload

filters uploaded local tax rates

shopp_logged_out

called after a customer is logged out.

shopp_login

called on login to Shopp customer

shopp_login_exists

filters the form validation on new the login field.

shopp_login_required

filters the checkout login field validation.

shopp_login_valid

filters the login name validity check on the checkout form.

shopp_logout

called on store logout.

SHOPP_LOG_PATH

Configurable filesystem path to Shopp log directory.

shopp_meta_description

filters the meta description tag content in the page markup.

shopp_meta_keywords

filters the meta keywords tag content in the page markup.

shopp_module_loaded

called after an add-on module is loaded.

SHOPP_NOSSL

Configurable flag to disable SSL across the storefront. Default false. (Unsupported)

shopp_offline_payment_instructions

filters the payment instructions setting for the Offline Payments module.

shopp_ordering_empty_cart

filter the order validation failure on empty cart.

shopp_ordering_empty_customer

filters the order validation failure on empty customer.

shopp_ordering_empty_email

filters the order validation failure on missing customer email.

shopp_ordering_empty_firstname

filters the order validation failure on missing customer firstname.

shopp_ordering_empty_lastname

filters the order validation failure on missing customer lastname.

shopp_ordering_empty_shipping_address

filters the order validation failure on missing shipping address.

shopp_ordering_empty_shipping_country

filters the order validation failure on missing shipping country.

shopp_ordering_empty_shipping_postcode

filters the order validation failure on missing shipping postcode.

shopp_ordering_items_outofstock

filters the stock check failure on ordered items before order processing.

shopp_ordering_no_shipping_cost

filters the order validation failure on no shipping cost.

shopp_orderui_orderdata

filters the listed contents of the orderdata meta box in the Shopp Order Manager.

shopp_orderui_orderdata_{data-name}

filters one orderdata list item on the Shopp Order Manager order-data meta box.

shopp_orderui_payment_card

filters the markup displaying the payment card details in the Shopp Order Manager in the admin.

shopp_orderui_show_orderdata

filters the show order-data override for the order-data metabox in the Shopp Order Admin.

shopp_order_admin_script

called during in-line javascript output on order manager in the admin.

shopp_order_customer_email_url

the customer email url in the customer contact metabox in the order manager admin.

shopp_order_customer_phone_url

filters the phone number url on the customer contact metabox in the order manager admin.

shopp_order_customer_url

filters the customer url on the customer contact metabox in the order admin manager.

shopp_order_customer_wpuser_url

filters the WordPress user profile url associated with the customer on the current order in the Shopp Order Manager.

shopp_order_lookup

filters the customer’s account page content when viewing the order history or a particular order receipt.

shopp_order_management_scripts

called after order manager admin scripts are enqueued.

shopp_order_new_note_ui

called after order notes UI in the order manager admin..

shopp_order_note

filters the content of an order note.

shopp_order_note_controls

called after order note UI controls.

shopp_order_notifications

called on new order notification.

shopp_order_receipt

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

shopp_order_row_css

called after styling classes are determined for an order row in the orders admin.

shopp_order_success

called on transaction completion.

shopp_order_txnstatus_update

called on transaction/payment status update.

shopp_paged_link

filters the pagination url for a product collection/category.

shopp_passwords_required

filters the form validation of the password field on the checkout form.

shopp_password_mismatch

filters the validation check on the password and confirm password fields on the checkout form.

shopp_payment_cards

filter the payment card lookup table of PayCard objects.

shopp_payment_methods

filters the number of active payment methods available on the checkout.

shopp_payment_status_labels

filters the payment status labels lookup table.

SHOPP_PHP_ERR

Used for logging PHP errors in Shopp.

SHOPP_PREPAYMENT_DOWNLOADS

Configurable flag to allow download on order before payment is complete. Default: false

shopp_print_footer_scripts

called before shopp javascript tags are output in the footer.

shopp_print_footer_scripts

filters the override value allowing footer scripts to be printed or not.

shopp_print_head_scripts

filters the override value allowing header scripts to be printed or not.

shopp_print_scripts

called before Shopp javascript tags are output in the page header.

shopp_process_checkout

called on checkout form submission to process the form data.

shopp_process_free_order

filters the test during checkout for processing free orders or not.

shopp_process_order

called on submission of confirm order page to process the order.

shopp_process_shipmethod

called when shipping method selection has been submitted.

SHOPP_PRODUCTS_PATH

Configurable filesystem path to Shopp product files.

shopp_product_addons()

retrieves a list of add-ons for the product.

shopp_product_admin_scripts

called after product admin pages scripts are enqueued.

shopp_product_description

filters the product description on the storefront output by the shopp(‘product’,’description’) tag.

shopp_product_editor_scripts

called after the product editor scripts are enqueued.

shopp_product_name

filters the product name on the storefront output by the shopp(‘product’,’name’) theme api call.

shopp_product_saved

Called after product save in product editor.

shopp_product_shortcode

filters the product shortcode content.

shopp_product_spec

filters the value of a spec/detail of the product rendered from the shopp(‘product’,’spec’) theme api call.

shopp_product_summary

filters the product summary content rendered by the shopp(‘product’,’summary’) theme api call.

shopp_promo_admin_scripts

called after promotion admin pages scripts are enqueued.

shopp_promo_editor_scripts

called after promotion editor admin page scripts are enqueued.

shopp_promo_saved

called after save in promotions editor.

shopp_purchased_addon_name

filters the addon name for an addon that has been purchased, as it is displayed in the Order Manager.

shopp_purchased_addon_sku

filters the addon SKU for an addon that has been purchased, as it is displayed in the Order Manager.

shopp_purchased_addon_unitprice

filters the addon unitprice for an addon that has been purchased, as it is displayed in the Order Manager.

shopp_purchased_data_name

filters the purchase item data name as displayed on the Order Manager.

shopp_purchased_data_value

filters the order data value as displayed on the Order Manager.

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_regions

filters the word-wide regions lookup table.

shopp_register_smartcategories

called after built-in smart categories are registered.

shopp_remote_payment

called on remote payment return call to Shopp.

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_reset_session

called when session reset is called.

shopp_resource_{src}

called dynamically on resource requests to Shopp.

SHOPP_REVISION

Revision string of Shopp.php

shopp_rss_description

filters the product summary as it appears in the rss feed.

shopp_rss_item

filters the key/value pairs used to create xml feed markup for each item in the feed.

shopp_rss_meta

filters the rss feed meta entries.

shopp_save_payment_settings

called on Payments Settings save.

shopp_search_query

filters the search query used to render the SearchResults smart collection.

SHOPP_SECURE_KEY

Configurable hash value for creating Shopp security cookie.

shopp_session_load

called after new session is created or existing session is reloaded.

shopp_session_loaded

called after an existing session is reloaded.

shopp_session_reset

called to trigger session reset.

SHOPP_SESSION_TIMEOUT

Configurable session timeout value in seconds. Default: 7200

shopp_settings_shipping_ui

called during javascript generation of shipping module settings UI.

shopp_setup

called after database schema updates during plugin activation, and triggers Shopp plugin setup routines.

shopp_shipping_hasestimates

filters the return value of the shopp(‘shipping’,’hasestimates’) and shopp(‘cart’,’has-shipping-methods’) theme api calls.

shopp_shortword_search

filters the search terms after shortword filtering.

shopp_show_account_errors

filters the shopp account show errors override.

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_thanks_pagetitle

filters the page title for the thanks page.

SHOPP_TRXN_ERR

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

SHOPP_TXNLOCK_TIMEOUT

Configurable concurrency database lock timeout in seconds, used for purchase creation. Default: 10

shopp_txnstatus_labels

filters the transaction status labels lookup table.

shopp_txn_update

called when a transaction update Shopp callback url is loaded.

shopp_unit_conversion_table

filters the unit conversion table for the convert_unit() utility function.

SHOPP_UNSUPPORTED

Configurable flag to prevent Shopp from loading. Shopp is not loaded if set to true. Default unset.

shopp_update_destination

called when the shipping destination update has been submitted on the cart.

shopp_validate_checkout

filters the checkout validation status.

shopp_valid_order

filters the validity test on an order.

shopp_vat_countries

filters the lookup table of two-digit alpha country codes for countries using inclusive sales tax.

shopp_verify_shipping_services

called to trigger settings validation in shipping calculation services.

shopp_verify_stored_file

called via AJAX to verify a file existing in a storage engine.

SHOPP_VERSION

Current version of of the running Shopp plugin.

shopp_{module-classname}_loaded

dynamic action called on the load of each addon module.

sidecart.php content template

content template used to display the side cart content.

sideproduct-{id}.php content template

content template used for a specific sideproduct.

summary.php content template

content template used to display the cat summary.

thanks.php content template

content template used for the storefront thanks (order receipt) page.

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

Skip to toolbar