Badgearoo

MEG

How do I create a badge?

Badges are a custom post type. You can create a new badge by clicking the Add New menu option under the Badges menu.

How do I setup automatic assignment of badges and points to users?

You need to setup conditions. Go to the Conditions menu option under the Badges menu. Here you can setup and manage conditions that need to be satisfied in order for users to be automatically assigned basdges and points.

How do I manually assigned a badge or points to users?

Go to the Assignments menu option under the Badges menu and then click Add New.

How do I upload a badge icon

If you want to display icons for badges, you first need to make sure the badge icon theme is set in your settings. You can upload badge icons when editing a badge in the Badge Theme metabox.

How do I create my own step actions or custom assign badges or points in my plugin or theme

Sample code and developer notes are documented in the plugin-sample.php file.

The API function add_user_assignment() can be used to assign badges or points using PHP code. See the class-api.php file.

$user_id = get_current_user_id(); 
$condition_id = null; // optional to have a condition otherwise null
$expiry_dt = null; // date format "Y-m-d H:i:s" or null
$points = 100;
Badgearoo::instance()->api->add_user_assignment( $condition_id, $user_id, 'points', $points, $expiry_dt );

[broo_user_badges] – Shows a list of badges assigned to a user

Attributes:

• user_id – User id of user. If not set, the default is the current logged in user id.
• username – Username of user. This will override user_id if set. Default empty.

e.g. [broo_user_badges username=”johnsmith”]

[broo_user_points] – Shows total points assigned to a user

Attributes:

• user_id – User id of user. If not set, the default is the current logged in user id.
• username – Username of user. This will override user_id if set. Default empty.

e.g. [broo_user_points username=”johnsmith”]

[broo_leaderboard] – Shows a leaderboard of user badges and points

Attributes:

• show_avatar – Show user’s avatar. true or false. Default is true.
• before_name –
• after_name –
• show_badges – Include badges in the leaderboard. true or false. Default is true.
• show_points – Include points in the leaderboard. true or false. Default is true.
• sort_by – Sort leaderboard. points or badges. Default is points.
• show_filters – Show leaderboard filters i.e. sort by, type, date range etc… true or false. Default is true.
• from_date – yyyy-mm-dd format. Default empty.
• to_date – yyyy-mm-dd format. Default empty.
• include_no_assignments – whether to include users who do not have any assignments (i.e. points or badges)
• limit – How many users to limit in the leaderboard. Default is null which means show all.
• offset – Start offset for user leaderboard. This can be used for paging. Default is 0.

e.g. [broo_leaderboard show_filters=”false” show_avatar=”false”]

[broo_badge] – Shows badge details

Attributes:

• badge_id – The badge post id. This is required otherwise no badge can be shown.
• show_description – Show badge post content. true or false. Default is true.
• before_name –
• after_name –
• show_users – show users who have been assigned this bade. true or false. Default is true.
• show_users_count – show count of users who have been assigned this badge. Default is true.

e.g. [broo_badge badge_id=”10″]

[broo_badge_list] – Shows a list of badge details

Attributes:

• badge_ids – A list of badge post id’s to show. Default is empty which means all badges are shown.
• show_description – Show badge excerpt. Default is true.
• before_name –
• after_name –
• show_users – show users who have been assigned this bade. true or false. Default is true.
• show_users_count – show count of users who have been assigned this badge. Default is true.
• layout – Layout for displaying badges. summary or table. Default is table.
• taxonomy – Taxonomy slug to filter badges.
• terms – comma separated of taxonomy term slugs to filter badges. Default is empty which means all terms.
• terms_operator – Taxonomy query operator to test. Possible values are “IN”, “NOT IN”, “AND”, “EXISTS” and “NOT EXISTS”. Default value is “IN”.

e.g. [broo_badge_list layout=”table” show_users=”false” badge_ids=”10,11,12″]

e.g. [broo_badge_list taxonomy=”category” terms=”test2,test3″ tax_operator=”NOT IN”]

[broo_condition] – Shows condition details

Attributes:

• condition_id – The condition id to show. This is required otherwise no condition is shown.
• show_steps – Show the step details that need to be completed. Default is true.
• show_badges – Show the badges that are assigned when condition is satisfied. Default is true.
• show_points – Show the points that are assigned when condition is satisfied. Default is true.

e.g. [broo_condition condition_id=”1″]

[broo_user_dashboard] Shows a dashboard of badges, points and assignments for a user

Attributes:

• show_badges – Include badges in the dashboard summary. true or false. Default is true.
• show_points – Include points in the dashboard summary. true or false. Default is true.
• show_assignments – Include assignments table in the dashboard. Default is true.
• limit – How many assignments to limit in the table. More can be retrieved using the Load more button. Default is 5.
• offset – Start offset for assignments. This can be used for paging. Default is 0.
• type – Type of assignments to show. empty “” for all, badges or points. Default is empty.
• show_filters – Show assignments filters i.e. sort by, type, date range etc… true or false. Default is true.
• from_date – yyyy-mm-dd format. Default empty.
• to_date – yyyy-mm-dd format. Default empty.

e.g. [broo_user_dashboard limit=”10″ show_filters=”false”]