# gamipress/trunk/includes/admin/contextual-help.php GamiPress – Gamification plugin to reward points, badges & ranks in WordPress, now with AI, version trunk. 143 lines. - Page: https://pluginprobe.com/plugins/gamipress/trunk/code/includes/admin/contextual-help.php - Raw: https://pluginprobe.com/plugins/gamipress/trunk/raw/includes/admin/contextual-help.php - Modified: 2022-10-06T09:46:58+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/gamipress/trunk/code/includes/admin/contextual-help.php#L10-L20`. ```php , Ruben Garcia * @since 1.1.0 */ // Exit if accessed directly if( !defined( 'ABSPATH' ) ) exit; /** * Adds the contextual help for GamiPress pages * * @since 1.1.0 * @return void */ function gamipress_edit_screen_contextual_help() { $screen = get_current_screen(); $gamipress_edit_screens = array( 'points-type', 'achievement-type', 'rank-type' ); if ( ! ( in_array( $screen->id, $gamipress_edit_screens ) || in_array( $screen->id, gamipress_get_achievement_types_slugs() ) ) ) return; $screen->set_help_sidebar( '

' . sprintf( __( 'For more information:', 'gamipress' ) . '

' . '

' . sprintf( __( 'Visit the documentation on the GamiPress website.', 'gamipress' ), esc_url( 'https://gamipress.com/docs' ) ) ) . '

' ); // Points/Achievement/Rank types edit screens if( in_array( $screen->id, $gamipress_edit_screens ) ) { switch( $screen->id ) { case 'achievement-type': $label = __( 'Achievement Type', 'gamipress' ); break; case 'points-type': $label = __( 'Points Type', 'gamipress' ); break; case 'rank-type': $label = __( 'Rank Type', 'gamipress' ); break; } $screen->add_help_tab( array( 'id' => 'gamipress-' . $screen->id . '-data', 'title' => sprintf( __( '%s Data', 'gamipress' ), $label ), 'content' => '

' . sprintf( __( 'Singular Name - The singular name for this %s.', 'gamipress' ), strtolower( $label ) ) . '

' . '

' . sprintf( __( 'Plural Name - The plural name for this %s.', 'gamipress' ), strtolower( $label ) ) . '

' . '

' . sprintf( __( 'Slug - Slug is used for internal references, as some shortcode attributes, to completely differentiate this %s from any other (leave blank to automatically generate one).', 'gamipress' ), strtolower( $label ) ) . '

' . (( $screen->id === 'achievement-type' ) ? '

' . __( 'After adding a new achievement type a new menu will appear in your admin area named Achievements. Inside the achievements menu will appear new sub menus with each achievement type registered to let you manage the achievements similar to WordPress default posts or pages.', 'gamipress' ) . '

' : '' ) ) ); if( $screen->id === 'points-type' ) { $screen->add_help_tab( array( 'id' => 'gamipress-points-awards', 'title' => __( 'Points Awards', 'gamipress' ), 'content' => '

' . __( 'Points awards are automatic ways a user could retrieve an amount of a points type.', 'gamipress' ) . '

' . '

' . sprintf( __( 'For more information, see Points Awards and Deductions documentation page on the GamiPress website.', 'gamipress' ), esc_url( 'https://gamipress.com/docs/getting-started/points-awards-and-deducts/' ) ) . '

' ) ); $screen->add_help_tab( array( 'id' => 'gamipress-points-deducts', 'title' => __( 'Points Deductions', 'gamipress' ), 'content' => '

' . __( 'Points deduct are automatic ways a user could lose an amount of a points type.', 'gamipress' ) . '

' . '

' . sprintf( __( 'For more information, see Points Awards and Deductions documentation page on the GamiPress website.', 'gamipress' ), esc_url( 'https://gamipress.com/docs/getting-started/points-awards-and-deducts/' ) ) . '

' ) ); } } // Achievement edit screen if( in_array( $screen->id, gamipress_get_achievement_types_slugs() ) ) { $screen->add_help_tab( array( 'id' => 'gamipress-achievement-data', 'title' => __( 'Achievement Data', 'gamipress' ), 'content' => '

' . __( 'Points Awarded - The amount of points to award to the user for earn the achievement (Optional).', 'gamipress' ) . '

' . '

' . __( 'Points Type - The points type of the amount of points to award (Optional).', 'gamipress' ) . '

' . '

' . __( 'Earned by - To define how this achievement can be earned. Choosing "Completing steps" will add a new box to configure the steps required.', 'gamipress' ) . '

' . '

' . __( 'Sequential Steps (Only if achievement is set up to earned by completing steps) - Checking this option will force users to complete the steps in order.', 'gamipress' ) . '

' . '

' . __( 'Minimum Points Required (Only if achievement is set up to earned by a minimum number of points) - The fewest amount of points required to earn the achievement.', 'gamipress' ) . '

' . '

' . __( 'Points Type Required (Only if achievement is set up to earned by a minimum number of points) - The points type of the amount of points required to earn the achievement (Optional).', 'gamipress' ) . '

' . '

' . __( 'Rank Type Required (Only if achievement is set up to earned by reaching a rank) - The rank type of rank required to earn the achievement (Used to quickly filter the rank required options).', 'gamipress' ) . '

' . '

' . __( 'Rank Required (Only if achievement is set up to earned by reaching a rank) - The rank required to earn the achievement .', 'gamipress' ) . '

' . '

' . __( 'Show Earners - Checking this option will add a list of users who have earned this achievement on the achievement single view.', 'gamipress' ) . '

' . '

' . __( 'Congratulations Text - The text displayed after achievement is earned.', 'gamipress' ) . '

' . '

' . __( 'Maximum Earnings - Maximum number of times a user can earn the achievement. You can leave it empty for no maximum.', 'gamipress' ) . '

' . '

' . __( 'Hidden - Checking this option will hide the achievement on frontend.', 'gamipress' ) . '

' ) ); $screen->add_help_tab( array( 'id' => 'gamipress-steps', 'title' => __( 'Steps', 'gamipress' ), 'content' => '

' . __( 'Steps are the conditionals of an achievement to be considered complete. They are present just on achievements that are configured to be earned by completing steps.', 'gamipress' ) . '

' . '

' . sprintf( __( 'For more information, see Steps documentation page on the GamiPress website.', 'gamipress' ), esc_url( 'https://gamipress.com/docs/getting-started/steps/' ) ) . '

' ) ); } // Rank edit screen if( in_array( $screen->id, gamipress_get_rank_types_slugs() ) ) { $screen->add_help_tab( array( 'id' => 'gamipress-rank-data', 'title' => __( 'Rank Data', 'gamipress' ), 'content' => '

' . __( 'Sequential Requirements - Checking this option will force users to complete the requirements in order.', 'gamipress' ) . '

' . '

' . __( 'Show Earners - Checking this option will add a list of users who have reached this rank on the rank single view.', 'gamipress' ) . '

' . '

' . __( 'Congratulations Text - The text displayed after rank is earned.', 'gamipress' ) . '

' ) ); $screen->add_help_tab( array( 'id' => 'gamipress-rank-details', 'title' => __( 'Rank Details', 'gamipress' ), 'content' => '

' . __( 'Priority - The priority order of the rank.', 'gamipress' ) . '

' . '

' . __( 'Previous Rank - Link to the previous rank that user needs to reach to start completing the requirements of the this one.', 'gamipress' ) . '

' . '

' . __( 'Next Rank - Link to the next rank user can reach on complete this one.', 'gamipress' ) . '

' ) ); $screen->add_help_tab( array( 'id' => 'gamipress-rank-requirements', 'title' => __( 'Rank Requirements', 'gamipress' ), 'content' => '

' . __( 'Rank Requirements are the conditionals of a rank to be considered that user can reach it.', 'gamipress' ) . '

' . '

' . sprintf( __( 'For more information, see Rank Requirements documentation page on the GamiPress website.', 'gamipress' ), esc_url( 'https://gamipress.com/docs/getting-started/rank-requirements/' ) ) . '

' ) ); } } add_action( 'load-post.php', 'gamipress_edit_screen_contextual_help' ); add_action( 'load-post-new.php', 'gamipress_edit_screen_contextual_help' ); ```