Can you get a badge from opening a page

Well, I have 2 solutions available. One from the main dev of BadgeOS, and one that’s kind of homebrewed from my head. Both are similar, but there are some differences as well. Conveniently both involve shortcodes.

My solution.

Create a shortcode that simply does a do_action( ‘my_custom_hook’ ), and use that shortcode in the page editor of your choosing. Then use an add_action with that hook and attach a callback function. Inside that function, use the badgeos_award_achievement_to_user() function, to set which achievement to award. The function will default to the current user, if you don’t provide a specific user. Documentation link below.

Example:

function mdb_my_custom_shortcode( $atts ) {
	do_action( 'my_custom_achievement_action' );

	return;
}
add_shortcode( 'my_custom_bos_trigger', 'mdb_my_custom_shortcode' );

function mdb_my_custom_achievement_trigger() {
	$achievement_id = 1; //set to whatever ID it is for your desired achievement.
	badgeos_award_achievement_to_user( $achievement_id );
}
add_action( 'my_custom_achievement_action', 'mdb_my_custom_achievement_trigger' );

This way, it’d run whenever that page is visited, and award to the current user. If you want to make this more robust and easier to set the achievement ID, you could amend the shortcode as is to accept attributes, one which would be the achievement ID.

https://badgeos.org/api/function-badgeos_award_achievement_to_user.html

Main Developer Solution:

This one is a bit more robust, and probably the more proper route. It adds a custom trigger that you want to have, to the “Earned by” dropdown. It then also creates a shortcode to add to the page editor that will listen for the “Earned by” step you set. However, given that it’s going to be one that’s available to set in any badge, you may want to limit how many times you use it. as the trigger would be the same for each page. It’d run risk of awarding multiple badges in a few areas of your site. A way around that, would be limiting the amount of times the badge could be awarded.

https://gist.github.com/brichards/06c2e95124b154142805

A second version of a shortcode that you could use: https://gist.github.com/brichards/82411186ef792680f038

Thanks for providing my with those two options!

I’m afraid however that I’m quite the novice with php, though as I understand you’re not asking me to edit much of the above code. I just don’t want to irritate you too much by coming across as clueless!

Where do I need to add both of these options?

Is there a particular .php file I need to add your lines of code to for your solution?

Do I need to create new .php files for the main developers solution – my-custom-trigger.php and my-shortcode.php?

I tried the ‘main developer solution’ earlier today. I tired adding the shortcodes php from the link you provided into the already existing shortcode.php file. I did the same with the trigger.php. No extra option was added to the drop down list on earned by menu. I also tried creating new .php files for them – my-custom-trigger.php and my-shortcode.php with the code in the above links, but again this did not add a new item on the drop down earned by menu.

I’m guessing I’ve done something very wrong! Any help you can give me would be hugely appreciated!

After some further chat last night, we’ve concluded that the following is the “best” route.

add this shortcode definition to your functions.php file OR if you’re trying to keep things organized, it sounds like you have a file specific for shortcodes. If yes, add it to that file.

https://gist.github.com/brichards/82411186ef792680f038

This would give you the following shortcode: [my_badgeos_award_achievement achievement_id=0]. Set the “achievement_id” attribute to the ID of whatever achievement you want to award. That’s all you’re going to need. With this one, you can ignore the other two parts mentioned above. In order to find the ID of the achievement, you’ll need to look in the url while editing the achievement, for the moment. For example from one of mine:

?post=120&action=edit

the achievement ID is going to be 120 and would use [my_badgeos_award_achievement achievement_id=120] in my page.

YES! Got it working! Thanks so much for your help! Really appreciate you taking the time to help me out.

This is very helpful, thanks Michael!

Hi again,

Michael, I was wondering if there is a way to modify the above code you supplied or add an IF condition to check if the achievement was already awarded or not? This way, instead of running the shortcode everytime the page loads, and where appropriate, it would award it on first load for the page X, rather than accepting the usual behavior which is to award everytime.

Of course, I am only asking this in case it was better than just editing the achievement to be awarded one time. If there is no big issue of running the code on the page everytime even it it was given, then please ignore this question and all is good!

Thanks again for this helpful code!

Hi again Ala7lam, the badgeos_maybe_award_achievement_to_user() should only award the achievement once if it’s set to be earn-able only once. It should take care of all of that for you.

If you need it to only award once per user, on pageload, with an achievement that can be earned multiple times, then we’d need to work out some more details.

In this case it’s more than enough for me :). Thanks a lot!