1. Documentation
  2. Shortcodes
  3. [gamipress_achievements]

[gamipress_achievements]

Output a list of achievements.

Attributes:

  • type – Single or comma-separated list of achievement type(s) to display. Accepts: all or any slug of any achievement type. Default: all
  • title – Display achievements title. Default: yes
  • link – Add a link on achievements title to the achievement page. Default: yes
  • thumbnail – Display achievements featured images. Default: yes
  • points_awarded – Display achievements points awarded (on achievements where this setting is set). Default: yes
  • excerpt – Display achievements short descriptions. Default: yes
  • steps – Display achievements steps. Default: yes
  • toggle – Display the achievement steps toggle. Default: yes
  • unlock_button – Display the “Unlock using points” (on achievements where unlock with points is allowed). Default: yes
  • earners – Display a list of users that has earned the achievement. Default: no
  • layout – Layout to show the achievement. Accepts: left, top, right, bottom or none Default: left
  • columns – Columns to divide achievements. Accepts: 1, 2, 3, 4, 5 or 6 Default: 1
  • filter – Display filter controls. Default: yes
  • filter_value – Set filter initial value. If you hide the filter, user won’t be able to change this value. Accepts: all, completed or not-completed Default: all
  • search – Display a search input. Default: yes
  • load_more – Display the load more button. Default: yes
  • limit – Number of achievements to display. Default: 10
  • orderby – Parameter to use for sorting. Accepts: menu_order, ID, title, date, modified, author, rand, points_awarded, points_to_unlock Default: menu_order
  • order – Sort order. Accepts: ASC, DESC Default: ASC
  • current_user – Show achievements of current logged in user. Accepts: yes, no Default: no
  • user_id – Show only achievements earned by a specific user.
  • include – Comma-separated list of specific achievement IDs to include.
  • exclude – Comma-separated list of specific achievement IDs to exclude.
  • wpms – Show achievements from all network sites.

Example: [gamipress_achievements type="all" thumbnail="yes" excerpt="yes" steps="yes" earners="yes" layout="left" filter="yes" search="yes" limit="10" orderby="menu_order" order="ASC" user_id="1" include="1,2,3" exclude="4,5,6" wpms="no"]

Was this article helpful to you? Yes No 1

How can we help?