[Guide] Using AccessAlly Shortcodes

With both AccessAlly and AccessAlly Pro, you can easily add options into your WordPress page through the use of shortcodes.

How to Use The Shortcode Adder to Easily Insert Shortcodes

For most WordPress pages, once you activate your plugin, the shortcode icon will appear in the toolbar on the page/post you are editing.

When in the page/post editor, you can be in one of two modes, text or visual. Below are how the icons appear for both plugins.

Text Editor View:

Visual Editor View:

 

Once clicked, both will display a variety of codes to appear on your page. Please select the proper code and always refer back to the links above for their expected action and any additional attribute changes you may need to make.

A List of AccessAlly Shortcodes

AccessAlly Shortcodes

Login/Logout

[accessally_login]

Show the custom login box control (same as the login widget)

Arguments:

  • use_https: force to load on HTTPS (Value options: ‘yes’, ‘no’. Default: ‘no’)
  • show_logged_in: show the control when user has logged in (Value options: ‘yes’, ‘no’. Default: ‘no’)
  • show_logged_in: show the control when user has not logged in (Value options: ‘yes’, ‘no’. Default: ‘yes’)
  • button_text: submit button text (Default: “Login!”)
  • username_label: label before username input field (Default: “Email”)
  • password_label: label before password input field (Default: “Password”)
  • rememberme_label: label after the remember-me checkbox (Default: “Remember Me”)
  • lost_password_label: lost password link text (Default: “Lost your password?”)
[accessally_logout_url]

Show the link to logout.

Arguments:

  • text: link text (Default: “Logout”)

User Profile Update

[accessally_profile_update]

Show the control to update basic user profile.

  • update_password: allow users to modify password (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_shipping_address_update]

Show the control to update shipping address profile.

Arguments:
None.

[accessally_billing_address_update]

Show the control to update billing address profile

Arguments:
None.

[accessally_credit_card_update]

Show credit card update control (only show on HTTPS pages with AccessAlly settings enabled).

Arguments:
None.

User Data

[accessally_user_fullname]

Show the full name of user. When used with user directory, show the full name of selected user.

Arguments:

  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_user_firstname]

Show the first name of user. When used with user directory, show the first name of selected user.

Arguments:

  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_user_lastname]

Show the last name of user. When used with user directory, show the last name of selected user.

Arguments:

  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_user_email]

Show the email of user. When used with user directory, show the email of selected user.

Arguments:

  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_user_login]

Show the login (username) of user. When used with user directory, show the login (username) of selected user.

Arguments:

  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_profile_image]

Show the (editable) user profile image.

Arguments:

  • readonly: whether to hide the edit button (Value options: ‘yes’, ‘no’. Default: ‘yes’)
  • label_text: label under the image (Default: “”)
  • button_text: edit button text (Default: “Update Image”)
[accessally_profile_image_url]

Show the URL of the user profile image.

Arguments:

  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
  • esc_html: encode the value for valid html (Value options: ‘yes’, ‘no’. Default: ‘yes’)
[accessally_inline_profile]

Show the (editable) user profile data.

Arguments:

  • attr: attribute to show (required) (Value options: ‘first_name’, ‘last_name’, ‘description’)
  • readonly: show the value as read only (not editable) (Value options: ‘yes’, ‘no’. Default: ‘yes’)
  • button: button text (Default: “Update”)
  • multi: show a single line input or multi-line textarea. Only applicable to editable values (Value options: ‘yes’, ‘no’. Default: ‘no’)
  • size: number of text for single line, number of rows for multi-line (Default: 30)
  • order: show edit button before or after the input/textarea (Value options: ‘normal’, ‘reverse’. Default: ‘normal’)
  • prefix: prefix of css class (Default: “”)
[accessally_user_link]

Encode a link with user id information.

Arguments:

  • link: base url to encode (required)
[accessally_user_crm_id]

Show the CRM contact ID for the current user.

Arguments:
None.

Purchase History & Affiliate

[accessally_list_order]

Show all orders of the current login user (only show on HTTPS pages with AccessAlly settings enabled).

Arguments:
None.

[accessally_list_subscription]

Show all subscription of the current login user (only show on HTTPS pages with AccessAlly settings enabled).

Arguments:
None.

[affiliate_total]

Show total earning related information of affiliate till now.

Arguments:

  • precision: number of precision digits (Default: 2)
  • item: type of information (Value options: ‘Balance’, ‘AmountEarned’, ‘Clawbacks’, ‘Payments’. Default: ‘Balance’)
[affiliate_summary]

Show earning related information of affiliate during a certain period.

Arguments:

  • precision: number of precision digits (Default: 2)
  • item: type of information (Value options: ‘Commissions’, ‘Clawbacks’. Default: ‘Commissions’)
  • duration: number of days prior to now (Default: 30)
[affiliate_details]

Show earning related information detail of affiliate till now.

Arguments:

  • precision: number of precision digits (Default: 2)
  • item: type of information (Value options: ‘Commissions’, ‘Clawbacks’, ‘Payment’. Default: ‘Commissions’)
  • duration: number of days prior to now (Default: 30)
[affiliate_link]

Show the affiliate link of a program for the current user to earn commissions.

Arguments:

  • program: code of the program/product to affiliate, set up in CRM (required)
  • item: type of information (Value options: ‘Commissions’, ‘Clawbacks’, ‘Payment’. Default: ‘Commissions’)
  • esc_html: escape the characters for valid html (Value options: ‘true’, ‘false’. Default: ‘true’)

Course / Program

[accessally_icon]

Show course icon of a page depending on the status of user.

Arguments:

  • post_id: post id of page where the icon is set up (required)
  • link: target url (Value options: ‘true’, ‘false’, target url. Default: ‘true’)
    • ‘true’: show the icon as link to the page in post_id
    • ‘false’: show the icon as image
  • link_class: css class of icon link, applicable when ‘link’ set to true (Default: “”)
  • link_class: css class of icon image (Default: “”)
  • target: open the target url in same window or new window (Value option: ‘same’, ‘new’. Default: ‘same’)
  • width: width of the icon. Overwrite the css styling if not ‘false’. Format is ‘5px’ or ‘50%’ (Default: ‘false’)
  • height: height of the icon. Overwrite the css styling if not ‘false’. Format is ‘5px’ or ‘50%’ (Default: ‘false’)
  • text: alternate text for icon image (Default: “”)

Conditional Content

[accessally_is_logged_in]

Show the content in the scope when the visitor has logged in. Used in a pair.

Arguments:
None.

[accessally_not_logged_in]

Show the content in the scope when the visitor has not logged in. Used in a pair.

Arguments:
None.

[accessally_has_any_tag]

Show the content in the scope when the visitor has any of the tags. Used in a pair.

Arguments:

  • tag_id: list of tag ids separated by comma (required)
[accessally_missing_any_tag]
Description

Show the content in the scope when the visitor misses any of the tags. Used in a pair

Arguments
  • tag_id: list of tag ids separated by comma (required)
[accessally_has_all_tag]

Show the content in the scope when the visitor has all of the tags. Used in a pair.

Arguments:

  • tag_id: list of tag ids separated by comma (required)
[accessally_missing_all_tag]

Show the content in the scope when the visitor misses all of the tags. Used in a pair.

Arguments:

  • tag_id: list of tag ids separated by comma (required)
[accessally_can_access]

Show the content in the scope when the visitor can access a specific page. Used in a pair.

Arguments:

  • post_id: post id of page (required)
[accessally_cannot_access]

Show the content in the scope when the visitor cannot access a specific page. Used in a pair.

Arguments:

  • post_id: post id of page (required)

Tab Section & Film Strips

[accessally_tab_section]

Create a section of tabs. Used together with shortcodes [accessally_tab_header] and [accessally_tab_content]. Syntax example:

[accessally_tab_section]
[accessally_tab_header]
TAB 1 LABEL
[/accessally_tab_header]
[accessally_tab_content]
CONTENT UNDERNEATH TAB 1
[/accessally_tab_content]
[accessally_tab_header]
TAB 2 LABEL
[/accessally_tab_header]
[accessally_tab_content]
CONTENT INSIDE UNDERNEATH TAB 2
[/accessally_tab_content]
[/accessally_tab_section]

Arguments:

  • direction: direction of the tabs (Value options: ‘horizontal’, ‘vertical’. Default: ‘horizontal’)
  • header_width: width of each tab header. Format is ‘5px’ or ‘50%’ (Default: ‘150px’)
  • prefix: prefix of css class (Default: “”)
[accessally_filmstrip_section]

Create a section of video strips including pre/next arrows. Used together with shortcodes [accessally_filmstrip_header] and [accessally_filmstrip_content]. Syntax is similar to [accessally_tab_section]

Arguments:

  • layout: location of the strip row (Value options: ‘bottom’, ‘top’. Default: ‘bottom’)
  • count: number of tab headers to show between arrow signs (Default: 3)
  • prefix: prefix of css class (Default: “”)
[accessally_tab_header] / [accessally_filmstrip_header]

Create a clickable tab or filmstrip header. See [accessally_tab_section] for usage

Arguments:

  • id: id of tab/filmstrip header (Automatic increment by default)
  • active: tab is active/clicked (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_tab_content] / [accessally_filmstrip_content]

Create a content block for tab or filmstrip header. See [accessally_tab_section] for usage

Arguments:

  • id: id of content block. Need match the corresponding tab/filmstrip header id (Automatic increment by default)

Custom Field Operation

[accessally_field_value]

Show the value of CRM field which can be displayed by a custom operation

Arguments:

  • operation_id: id of custom operation that can display the field (required)
  • url_encode: encode the value for valid url (Value options: ‘yes’, ‘no’. Default: ‘no’)
[accessally_custom_operation_log]

Show change log for value of CRM field which can be modified by a custom operation.

Arguments:

  • operation_id: id of custom operation that can modify the field (required)
  • num: maximum number of log to display (Default: 30)
  • prefix: prefix of css class (Default: “”)
[accessally_custom_operation]

Show the button to execute a custom operation with AccessAlly settings enabled.

Arguments:

  • operation_id: id of custom operation (required)

User Directory

[accessally_user_directory]

Show user directory. (See tutorial for more information).

Arguments:

  • directory: id of directory id to show (required)
  • search_text: label before the search box (Default: “Search for a member:”)
  • filter_text: label before the filter dropdown (Default: “Filter”)
  • button_text: submit button text (Default: “GO!”)
  • prefix: prefix of css class (Default: “”)

Order Form

[accessally_order_form]

Display an order form where visitors can place their order.

Arguments:

  • offer_id: id of offer to show (required)
  • prefix: prefix of css class (Default: “”)

A List of ProgressAlly Shortcodes

Progress Shortcodes

[progressally_progress_text]

This shortcode shows the progress of the current user in text form.

Arguments

  • post_id: post id of page/post based on which the progress is calculated (current page/post by default)
[progressally_progress_pie_chart]

Shows the progress of the current user with a visual pie chart.

Arguments

  • post_id: post id of page/post based on which the progress is calculated (current page/post by default)
  • background: background color in hex (transparent by default)
  • size: diameter of the pie chart in px (Default: ‘100’)
  • prefix: prefix of css class (Default: “”)
[progressally_progress_bar]

Shows the progress of the current user with a visual progress bar

Arguments

  • post_id: post id of page/post based on which the progress is calculated (current page/post by default)
  • background: background color in hex (transparent by default)
  • width: width of the bar. Overwrite the css settings if set. Format is ‘5px’ or ‘50%’
  • height: height of the bar. Overwrite the css settings if set. Format is ‘5px’
  • prefix: prefix of css class (Default: “”)
[progressally_objective_count]

Show the total number of objectives in a page

Arguments:

  • post_id: post id of page/post based on which the objectives is counted (current page/post by default)
[progressally_objective_completed_count]

Show the number of objectives completed by user in a page

Arguments:

  • post_id: post id of page/post based on which the objectives is counted (current page/post by default)

Objective Shortcodes

[progressally_objectives]

Show the objective table with checkboxes

Arguments:

  • post_id: post id of page/post where the objectives are defined(current page/post by default)
  • prefix: prefix of css class (Default: “”)
[progressally_objective_completion]

Show the content if the user progress is 100%. Used in a pair.

Arguments:

  • post_id: post id of page/post based on which the progress is calculated (current page/post by default)
  • prefix: prefix of css class (Default: “”)

Quiz Shortcodes

[progressally_quiz]

Show the quiz (Note: if the quiz is not defined in current page, the corresponding objective in the objective table won’t be auto-checked off)

Arguemnts:

  • post_id: post id of page/post where the quiz is defined(current page/post by default)
  • prefix: prefix of css class (Default: “”)

Video Shortcodes

[progressally_vimeo_video]

Embed a Vimeo video.

Arguments:

  • vimeo_id: vimeo id of the video (required)
  • id: id of the video corresponding to the video setting in objective table (required when the video is used in the objective table)
  • width: width of the video. Format is ‘5px’ or ‘50%’ (required)
  • height: height of the video. Format is ‘5px’ or ‘50%’ (required)
  • additional_args: additional arguments for the ‘src’ attribute in iframe code (Default: ”)
  • prefix: prefix of css class (Default: “”)
[progressally_youtube_video]

Embed a YouTube video.

Arguments:

  • youtube_id: youtube video id (required)
  • id: id of the video corresponding to the video setting in objective table (required when the video is used in the objective table)
  • width: width of the video. Format is ‘5px’ or ‘50%’ (required)
  • height: height of the video. Format is ‘5px’ or ‘50%’ (required)
  • additional_args: additional arguments for the ‘src’ attribute in iframe code (Default: ‘rel=0&showinfo=0’ The default value will hide related video and sharing button)
  • prefix: prefix of css class (Default: “”)
[progressally_wistia_video]

Embed a Wistia video.

Arguments:

  • wistia_id: wistia video id (required)
  • id: id of the video corresponding to the video setting in objective table (required when the video is used in the objective table)
  • width: width of the video. Format is ‘5px’ or ‘50%’ (required)
  • height: height of the video. Format is ‘5px’ or ‘50%’ (required)
  • additional_args: additional arguments for the ‘src’ attribute in iframe code (Default: ”)
  • prefix: prefix of css class (Default: “”)

Social Share Shortcodes

[progressally_social_share]

Generate the social share link to wrap the content. Used in a pair.

Arguments:

  • post_id: post id of page/post where the social share information is defined (current page/post by default)
  • type: type of social share link. (Value options: ‘facebook’, ‘twitter’, ‘gplus’, ‘pinterest’, ’email’. Default: ‘facebook’)

Custom Certificate Shortodes

[progressally_certificate]

Provide the download of custom certificate

Arguments:

  • post_id: post id of page/post where the certificate is defined (current page/post by default)
  • certificate_id: id of certificate (required)
  • text: text on the download button (Default: “Download Certificate”)
  • class: name of css class (Default: “”)
  • link: how to display the download url (Value options: ‘yes’ – as raw url, ‘no’ – as default styled download button. Default: “no”)

Private Notes Shortcodes

[progressally_note]

Add a private note input to the page.

Arguments:

  • post_id: post id of page/post where the private note is defined (current page/post by default)
  • note_id: id of private note(required)
  • save_text: text on the Save button (Default: "Save")
  • cancel_text: text on the Cancel button (Default: "Cancel")
[progressally_progress_bar]
Updated on August 14, 2018

Was this article helpful?

Related Articles