Metadata

LinkedInFacebookTwitterGoogle+Share

Post Meta

_badgeos_singular_name

  • Purpose: The singular name for an achievement
  • Returns: String

_badgeos_plural_name

  • Purpose: The plural name for an achievement
  • Returns: String

_badgeos_show_in_menu

  • Purpose: A prompt to discern whether or not to show an achievement in the BadgeOS menu.
  • Returns: Boolean

_badgeos_upload_badge_image_achievement

  • Purpose: To set a default image for a badge
  • Returns: String

_badgeos_points

  • Purpose: The points awarded for earning this achievement
  • Returns: Integer

_badgeos_earned_by

  • Purpose: How this achievement can be earned
  • Returns: Array ( filterable, default: triggers | points | submission | submission_auto | nomination | admin )

_badgeos_points_required

  • Purpose: The fewest number of points required for earning this achievement
  • Returns: Integer

_badgeos_sequential

  • Purpose: Determines if the steps to earning a badge are sequential
  • Returns: Boolean

_badgeos_show_earners

  • Purpose: Determines whether or not to display the earners of an achievement
  • Returns: Boolean

_badgeos_congratulations_text

  • Purpose: Displayed after an achievement is earned.
  • Returns: String

_badgeos_maximum_earnings

  • Purpose: The maximum number of times a user can earn a badge ( default: infinite)
  • Returns: Integer

_badgeos_hidden

  • Purpose: Determines if the achievement is hidden ( Hidden from default BadgeOS lists )
  • Returns: String (Defaults: ‘show’ | ‘hidden’ )

_badgeos_submission_status

  • Purpose: Approve or deny an entry
  • Returns: String (Defaults:  ‘pending’ | ‘approved’ |  ‘denied’ )

_badgeos_submission_achievement_id

  • Purpose: The ID of the achievement that will be awarded
  • Returns: Integer

_badgeos_nomination_status

  • Purpose: Approve or deny an entry
  • Returns: String (Defaults:  ‘pending’ | ‘approved’ |  ‘denied’ )

_badgeos_nomination_user_id

  • Purpose: The user id for the nominee
  • Returns: Integer

_badgeos_nominating_user_id

  • Purpose: The user id for the nominator
  • Returns: Integer

_badgeos_nomination_achievement_id

  • Purpose: The achievement id to award to a nominee
  • Returns: Integer

_badgeos_count

  • Purpose: The count for the saves
  • Returns: Integer

_badgeos_trigger_type

  • Purpose: Defines the trigger for the call
  • Returns: String

_badgeos_achievement_type

  • Purpose: The type of achievement saved
  • Returns: String

_badgeos_awarded_points

  • Purpose: The points earned by a user
  • Returns: Integer

_badgeos_total_user_points

  • Purpose: The total points earned by a user
  • Returns: Integer

_badgeos_admin_awarded

  • Purpose: The points awarded by an admin to a user
  • Returns: Integer

_badgeos_credly_badge_id

  • Purpose: The badge id from credly
  • Returns: String

_badgeos_send_to_credly

  • Purpose: Indicates whether or not an achievement can be sent to credly
  • Returns: Boolean

_badgeos_credly_include_evidence

  • Purpose: Indicates whether or not to send earning evidence to credly
  • Returns: Boolean

_badgeos_credly_expiration

  • Purpose: Timestamp for when an achievement expires on credly
  • Returns: Integer

_badgeos_credly_is_giveable

  • Purpose: Determines whether or not other user can award achievement on credly
  • Returns: Boolean

_badgeos_credly_categories

  • Purpose: Comma separated list of categories for this achievement on credly
  • Returns: String

User Meta

_badgeos_achievements

  • Purpose: Stores a user’s earned achievements
  • Returns: Multidimensional Array, keyed with site_id
    • e.g. array( side_id => array( achievement_object_1, achievement_object_2, etc ) )
      • achievement_object
        • ->ID
        • ->post_type
        • ->date_earned

_badgeos_triggered_triggers

  • Purpose: Stores an array of triggers the user has sprung along with the triggered count
  • Returns: Array
    • e.g. array( ‘save_post’ => 7, ‘wp_login’ => 20, etc )

_badgeos_points

  • Purpose:  The users total number of points
  • Returns: Integer

credly_user_enable

  • Purpose: Stores weather or not user has enabled credlyReturns: Boolean

credly_user_id

  • Purpose: To set the user id
  • Returns:  String