BadgeOS Shortcodes

Achievements List

[badgeos_achievements_list]

Use this shortcode to generate a list of achievements of any type on any page.

Available parameters:

• “type” — Which Achievement Types to list. Default: all. (Use the Achievement Type’s slug as the type.)
• “limit” — the number of achievements to display per page. Default: 10.
• “show_filter” — Display the filter menu options above the list. (Accepts: true, false) Default: true
• “show_search” — Display the search form above the list. (Accepts: true, false) Default: true

Example:
[badgeos_achievements_list type=badges limit=15]

Single Achievement

[badgeos_achievement]

Use this shortcode to embed a single achievement on any post or page. This is a great tool if you want to display a specific achievement (including its title, badge image, and excerpt, along with a link to the full achievement) on any page.

Required parameter:
“id” — The ID of the achievement to display.

Example:
[badgeos_achievement id=12]

Submission Box

[badgeos_submission]

Use this shortcode to add a submission box on any page that is tied to a specific achievement. When the submission is accepted, the achievement is earned. This is a great way to create a call to action on any post or page on your site that invites submissions. (The achievement specified must be set to require a Submission by the user.)

Required parameter:
“id” — The ID of the achievement to be awarded when the submission is accepted.

Example:
[badgeos_submission achievement_id=35]

Nomination Box

[badgeos_nomination]

Use this shortcode to add a nomination box on any page that is tied to a specific achievement. When the nomination is accepted, the achievement is earned. This is a great way to create a call to action on any post or page on your site that invites nominations of fellow members of your site. (The achievement specified must be set to be awarded by Nomination.)

Required parameter:
“id” — The ID of the achievement to be awarded when the nomination is accepted.

Example:
[badgeos_nomination achievement_id=35]

Submissions List

[badgeos_submissions]

Use this shortcode to place a list of pending, accepted and/or denied achievement Submissions on any page. The shortcode is role dependent. If a user has BadgeOS review privileges to review incoming BadgeOS Submissions, the listing will include all user Submissions and the ability to accept or deny. It the current user does not have the ability to review Submissions, they will instead see just their own Submissions. In this way, this shortcode lets you essentially set up an inbox/outbox on the front-end of your site so users and reviewers alike can track progress for achievements requiring interaction between site admin and site members.

Available parameters:

• “limit” — Number of submissions to display per page. Default: 10
• “status” — Which Approval Status type to show on initial page load. (Accepts: all, pending, auto-approved, approved, denied) Default: all
• “show_filter” — Display the filter select input. (Accepts: true, false) Default: true
• “show_search” — Display the search form. (Accepts: true, false) Default: true
• “show_attachments” — Display attachments connected to the submission. (Accepts: true, false) Default: true
• “show_comments” — Display comments associated with the submission. Default: true

Example:
[badgeos_submissions status=pending limit=15]

Nominations List

[badgeos_nominations]

Use this shortcode to place a list of pending, accepted and/or denied achievement Nominations on any page. The shortcode is role dependent. If a user has BadgeOS review privileges to review incoming BadgeOS Nominations, the listing will include all user Nominations and the ability to accept or deny. It the current user does not have the ability to review Nominations, they will instead see just their own Nominations.

Available parameters:

• “limit” — Number of nominations to display per page. Default: 10
• “status” — Which Approval Status type to show on initial page load. (Accepts: all, pending, approved, denied) Default: all
• “show_filter” — Display the filter select input. (Accepts: true, false) Default: true
• “show_search” — Display the search form. (Accepts: true, false) Default: true

Example:
[badgeos_nominations show_search=false limit=20]