Skip to content

Documentation

WooRewards

  1. Home
  2. Docs
  3. WooRewards
  4. Shortcodes
  5. Shortcodes

Shortcodes

 

The following shortcodes are only available as shortcodes. As such, they don’t have a widget or endpoint counterpart.

1 – Simple Points display

Use this simple shortcode to display the points for a specific points and rewards system with no decoration. For example, this is very convenient if you want to display points within a phrase.

[wr_simple_points system="system_name"]

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.

 

2 – User Name and Title

This shortcode displays the user name and title. Therefore, customers must earn a title if they want to see it.

[wr_user_name title="yes" raw="no"]

Attribute Description
title Shows the title if user unlocked a title reward.
raw Defines if the name and title are put in stylable elements or not.

 

3 – Points to next level

This shortcode displays the points needed to reach the next level/reward of a points and rewards system. Use it to motivate customers to reach a higher level.

[wr_user_name title="yes" raw="no"]

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.
prefix (Optional) The text displayed before the points needed.
suffix (Optional) The text displayed after the points needed.
currency (Optional) If set, the points will be displayed with the points and rewards system’s currency.

 

4 – Points on Cart Tool

This shortcode is used to display the Points on Cart tool. You can customize its appearance in the WooCommerce Tab.

[wr_points_on_cart system='system_name']

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.

 

5 – Maximum Point Amount on Cart

This shortcode will show the maximum quantity of Point that could be used on this cart.

[wr_max_points_on_cart system='system_name' raw='']

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.
raw (Optional) If set, the amount will be a simple text. Otherwise, it will be presented inside a stylable element

 

6 – User Level

This shortcode displays the current user level in a leveling points and rewards system.

[wr_user_level system="system_name" nolevel="No level message"]

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.
nolevel The text displayed if the user didn’t reach the first level

 

7 – Progress bar

This shortcode displays a progress bar for a points and rewards system. This is very useful to incentivize customers to reach a higher level.

[wr_progress_bar system="system_name" header="Your Current Progress"]

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.
header The text displayed before the progress bar

 

You can edit this shortcode’s style directly in WooRewards

Instructions

Go to WooRewards → Appearance → Shortcodes → Progress Bar

Select the elements you want to customize and change the values you want.

Save your settings.

8 – Points History

This shortcode displays a user’s points history for one or several points and rewards systems.

[wr_show_history system='system_name1,system_name2' count='15']

Attribute Description
system The points and rewards system you want to display. You can find this value in WooRewards → Points and Rewards, in the Shortcode Attribute column. If you don’t set this value, nothing will be displayed.
count (Optional) The number of rows displayed. Default is 15.

 

You can edit this shortcode’s style directly in WooRewards

Instructions

Go to WooRewards → Appearance → Shortcodes → Progress Bar

Select the elements you want to customize and change the values you want.

Save your settings.

Was this article helpful to you? Yes No
Scroll To Top