Support » Plugin: BadgeOS » Checking is a user has an achievement

  • Resolved paddyohanlon


    I’m trying to check if a user has an achievement before giving them an achievement.

    I’m using badgeos_check_achievement_completion_for_user()

    And am trying this:

    if ( badgeos_check_achievement_completion_for_user( 3249, $user_id ) === false ) {
    badgeos_award_achievement_to_user( 3249, $user_id );

    Which isn’t working for me. I have a feeling it’s something simple I’m getting wrong.

    If I echo badgeos_check_achievement_completion_for_user( 3249, $user_id ), it outputs 1, in case that’s any use in diagnosing.

    Any help would be much appreciated! Thanks.

Viewing 6 replies - 1 through 6 (of 6 total)
  • Michael Beckwith


    The BenchPresser

    I’d personally recommend the following in place of your use of badgeos_check_achievement_completion_for_user()

    badgeos_maybe_award_achievement_to_user( $achievement_id = 0, $user_id = 0, $this_trigger = '', $site_id = 0, $args = array() )

    Left the default parameters in for your reference. Located in includes/rules-engine.php line 23

    Hope that nets better results for you šŸ™‚

    Thread Starter paddyohanlon


    Hey Michael, thanks for the help.

    I tried that but get nothing back.

    echo badgeos_maybe_award_achievement_to_user(3249, $user_id);

    Doesn’t output anything.

    I’ve double-checked the user id and achievement id.

    I also tried another API call to make sure something basic isn’t out of place. This output the directory path correctly.

    echo badgeos_get_directory_path();

    Any other ideas what I could be doing wrong?

    Michael Beckwith


    The BenchPresser

    Looking at the badgeos_maybe_award_achievement_to_user function, it’s either going return false on no access to the achievement, or return nothing. So there’s not going to be anything to echo from it.

    To help you visualize, here’s the whole function declaration.

    function badgeos_maybe_award_achievement_to_user( $achievement_id = 0, $user_id = 0, $this_trigger = '', $site_id = 0, $args = array() ) {
    	// Set to current site id
    	if ( ! $site_id )
    		$site_id = get_current_blog_id();
    	// Grab current user ID if one isn't specified
    	if ( ! $user_id )
    		$user_id = wp_get_current_user()->ID;
    	// If the user does not have access to this achievement, bail here
    	if ( ! badgeos_user_has_access_to_achievement( $user_id, $achievement_id, $this_trigger, $site_id, $args ) )
    		return false;
    	// If the user has completed the achievement, award it
    	if ( badgeos_check_achievement_completion_for_user( $achievement_id, $user_id, $this_trigger, $site_id, $args ) )
    		badgeos_award_achievement_to_user( $achievement_id, $user_id, $this_trigger, $site_id, $args );

    Once it’s been verified that the user has completed all of the necessary parts for the achievement, it goes ahead and calls the badgeos_award_achievement_to_user() function and proceeds. At this point, it should either be awarding the achievement, or the user just hasn’t met all the requirements yet.

    To clarify something from the original post, the echoing of “1” indicates that that function evaluated to true. That one is a boolean function that is best used in if statements.

    Thread Starter paddyohanlon


    So it seems like that first function, that’s eching “1”, is what I need.

    I want to use it in an if statement, like I’m doing in my first message.

    The trouble is the function always returns true, even when the user has not been awarded an achievement.

    I created a new user, double-checked it has no awarded achievements and tried the following:

    if ( badgeos_check_achievement_completion_for_user( 3249, $user_id ) == false ) {
      echo "false";
    if ( badgeos_check_achievement_completion_for_user( 3249, $user_id ) == true ) {
      echo "true";

    And I get true.

    I double-checked the achievement ID and user ID, and both match up to the right achievement and user.

    I disabled all other plugins to make sure there’s no conflict. And I used the [badgeos_user_achievements] shortcode on the same page I’m using the if statements above to triple check the user has not been awarded the achievement I’m testing.

    I’m sure I’m still missing something simple here. Thanks for your patience and help so far!

    Michael Beckwith


    The BenchPresser

    badgeos_check_achievement_completion_for_user, I believe, is going to check if the user has completed all the steps, but it’s not going to do the awarding. If you look at the last line in the badgeos_maybe_award_achievement_to_user it uses the same badgeos_check_achievement_completion_for_user function in an if statement, and if it returns true, then it goes and calls badgeos_award_achievement_to_user.

    This is likely why I suggested the maybe version in the first place, it takes care of some intermediate steps for you, with less code.

    Thread Starter paddyohanlon


    The badgeos_maybe_award_achievement_to_user function is working for me now. I must have been doing something wrong first time around.

    Thanks a million for your help!

Viewing 6 replies - 1 through 6 (of 6 total)
  • The topic ‘Checking is a user has an achievement’ is closed to new replies.