Simple:Press Documentation

Short-codes

Display A Progress Bar For Goals

[spms_goal level="1,2" goal="100" goal_type="members" fill_color="#9932CC"]

The short-code attributes are:

  • after: Text to display after the goal text.
  • background_color: Hexadecimal color value for background of the entire goal bar. Default: “#BBBBBB”.
  • before: Text to display before the progress text to date.
  • fill_color: Hexadecimal color value for the goal’s progress bar. Default: “#77A02E”.
  • font_color: Hexadecimal color value for the text of the goal bar. Default: “#FFFFFF”.
  • goal: The numeric goal you would like to reach. Do not include any currency symbol or special characters; Required. (i.e. “1000”)
  • goal_type: The type of goal to track. Default: “revenue”; Accepts: “revenue”, “sales” or “members”
  • start_date: Only include orders or sign ups after this date. Use yyyy-mm-dd format.
  • end_date: Only include orders or sign ups before this date. Use yyyy-mm-dd format.
  • levels: A single or comma-separated list of level IDs to include in the goal tracking. (i.e. “1,2”) Defaults to all levels if blank.

Membership Locked Message Page

[spms_membership_locked]

The short-code attributes are:

  • message: The message to be shown if the user is redirected to a page with this short-code.

This short-code needs to be on a page and that page is then assigned under Memberships->Settings->Pages

Membership Card

Use this short-code to allow a user to view and display their membership card.

This short-code needs to be on at least one page or post in order for the View Membership Card link in the user profile to work.

[spms_membership_card]

The short-code attributes are:

  • print_size: options include: small, medium, large or all.  For example: ex: [spms_membership_card print_size=”small,medium”].

Membership (Content Restriction Short-code Pair)

Use this short-code to restrict who can view a piece of content.

[membership level='n'] your content here [/membership]

The short-code attributes are:

  • level: The level required to view the content being protected
  • levels: Use this if you need to evaluate more than one level – eg: [membership levels=’x,y,z’] your content here [/membership]

Sign Up Form

Use this short-code to embed a signup form anywhere – in your posts, in a widget – almost anywhere a short-code is accepted.

[spms_signup]

The short-code attributes are:

  • intro: (optional) Override the default ‘Register for LEVEL NAME’ text above the checkout form or hide the text completely. Enter your custom text.
  • hidelabels: (optional) Hide the form input field labels and use the input field placeholder attribute instead. (default: false; accepts: true, 1, or yes).
  • level: (required) determines which level to use for the checkout form
  • login: (optional) Set this attribute to show a ‘Log In’ link below the submit button. (i.e. login=’1′)
  • redirect: (optional) Set the page to redirect to after form submission. (default: Membership Confirmation page. accepts: referrer, account, or your custom URL)
  • short: (optional) determines whether to show the Confirm E-mail and Confirm Password fields OR show E-mail Address field only. (default: false; accepts: true, false, or emailonly)
  • submit_button: (optional) Change the ‘Submit’ button text on the checkout form. (default: ‘Sign Up Now’; accepts: your custom text)
  • title: (optional) Show a heading (h2) with a default ‘Level Name’ above the checkout form or your custom text. (default: false; accepts: true or your custom text)

If the level is free, the account will be created and the member will be automatically redirected to the specified redirect page.  If the level is not free, the user will be taken to the membership checkout page to enter billing information.

Advanced Levels (beta)

You can replace the short-code used on your normal levels page with this more advanced one in order to get some additional features.  In particular, this advanced levels short-code allows you to specify a comparison table.  You can use it to replace the [spms_levels] short-code used on the levels page.

[spms_advanced_levels]

Attributes:

  • back_link: Optional – use it to hide the Return to Home or Return to Your Account links below your levels layout (default: true).
  • checkout_button: The text to display on the action button (default: Select).
  • compare: Used only for the compare_table layout.  It  shows the comparison item rows.
  • description: Show or hide the level description; accepts “true” or “false” (default: true).
  • discount_code: Apply a discount code to the membership level pricing that is displayed. accepts the discount code (default: none).
  • expiration: Display the level expiration; accepts “true” or “false” (default: true).
  • levels: A comma-delimited list of membership level IDs to display, in the order you want to display them; can be a single level ID (default: all levels ordered by ascending ID).
  • layout: How to display the levels; accepts “div”, “table”, “2col”, “3col”, “4col” or “compare_table” (default: div).
  • price: How to display the level cost text. accepts “full”, “short” or “hide” (default: short).
  • renew_button: The button text for the action button shown to existing members with an expiring level (default: Renew).
  • template: Specify an integrated theme framework to inherit formatting. accepts “bootstrap”, “genesis”, “woo themes”, “gantry”, “pagelines” or “foundation” (default: none).

Using the compare_table option for the layout attribute

With this you can display a pricing comparison table.  It is not an easy attribute to set-up and use but we’ll as best we can to make it clear how it works.

Lets assume that you have 3 membership levels defined in MEMBERSHIPS->SETTINGS->LEVELS.

[spms_advanced_levels layout="compare_table" compare="Compare Item #1,1,1,0;Compare Item #2,0,1,1;Compare Item #3,0,1,1;Numerical Thing,10 Things,20 Things, 30 things"]

In the above short-code, the items in bold are the items that are being compared – they will show up in the first column of the comparison table.

The three values after each of the items in bold controls what appears in each of the columns for the three levels.  The number ONE represents a check-mark. The number ZERO will remove the check-mark.  Any other value will show as-is.

Thus, for the example above, “Compare Item #1” will have a check-mark for the first level and the second level but none for the third level.

Numerical things” will show “10 things” for the first level, “20 things” for the second level” and “30 things” for the third level.

Notice that each “group” of directives are separated for semi-colons.

Membership Account

This short-code shows the user their account page.  The basic usage is as follows:

[spms_account]

You can restrict the sections that show up on the account page:

[spms_account sections="membership,profile,invoices,links"]

Add-on Packages

The spms_addon_packages shortcode allows you to display a grid or list of all add-on packages.  It layout looks similar to many e-commerce stores.

[spms_addon_packages]

Attributes:

  • checkout_button: The text displayed on the button linking to checkout. (default: “Buy Now”).
  • exclude: A comma-separated list of the page IDs to exclude from display (default: none).
  • include: Optionally set this attribute to only show subpages of the active page. Accepts: “subpages”. (default: shows all pages and posts with an addon package price).
    layout: The layout of the output. (default: table). Accepts “div”, “table”, “2col”, “3col”, “4col” (column layouts will work with the any theme based on the Foundation 5 grid system).
  • link: Hyperlink the post/page title to the single view; accepts “true” or “false” (default: true).
  • orderby: Accepts any orderby parameter as defined in the codex. (default: menu_order).
  • order: Accepts ASC or DESC as defined in the codex. (default: ASC).
  • thumbnail: Optionally hide or show the subpage’s featured image; accepts “thumbnail”, “medium”, “large” or “false”. (default: thumbnail).
  • view_button: The text displayed on the button linking to view the single page. (default: “View Now”).

 

Misc

These short-codes are used on all the pre-generated pages so there is usually no-need for you to mess with them under normal circumstances.

  • [spms_levels]: Display the list of levels that the user can choose from before signing up.  Generally the first step in the sign-up process
  • [spms_account]:  Display Account data for user
  • [spms_billing]: Display billing data for user
  • [spms_cancel]: Display cancellation for for user
  • [spms_checkout]: Display checkout page
  • [spms_confirmation]: Display membership sign-up confirmation page
  • [spms_invoice]: Display invoice data for user after sign-up.