Abilities 2
clanbite-ranks/rank-typesclanbite-ranksLists configured rank ladder keys and names (metadata only).clanbite-ranks/user-rank-progressclanbite-ranksReturns rank ladder progress for a user (points, level labels, progress percent). Callers may only read their own data unless they can list users.
Blocks 1
clanbite-ranks/rank-progressclanbite-ranksShows one rank ladder’s progress bar for the current player (profile, loops) or a fixed user ID.
Classes 9
Avatar_Rank_Progressclanbite-ranksRenders avatar/user-nav rank progress UI and exposes progress REST endpoint.Icon_Packsclanbite-ranksEntry point for rank icon packs.Pluginclanbite-ranksSingleton entry.Rank_Status_Updatesclanbite-ranksHandles automatic social announcements when users earn/receive ranks.Ranksclanbite-ranksOfficial companion extension; requires Players.Ranks_Abilitiesclanbite-ranksRegisters Ranks abilities under the core Abilities category.Ranks_Adminclanbite-ranksSettings for the Ranks extension (Clanbite → Settings → Ranks): rank ladders and status-update options.Ranks_Managementclanbite-ranksLives in the **Ranks** tab of Clanbite → Settings as a "Manage members" sub-view.Team_Ranksclanbite-ranksAdds team rank settings + team manage UI.
Functions 45
clanbite_ranks_attach_point_display_labels()clanbite-ranksAdd human-readable point type names for progress UI (from Clanbite Points settings).clanbite_ranks_extension_active()clanbite-ranksWhether the Ranks extension is installed (enabled in Clanbite → Extensions).clanbite_ranks_extension_active()clanbite-ranksGlobal alias of Kernowdev\ClanbiteRanks\clanbite_ranks_extension_active().clanbite_ranks_filter_rank_progress_payload()clanbite-ranksFilterable rank progress payload (REST, avatar polling).clanbite_ranks_find_rank_type_row()clanbite-ranksFind a rank ladder definition row by its stable key.clanbite_ranks_get_avatar_badge_for_rest()clanbite-ranksAvatar ring / badge data shaped for Interactivity templates (REST author payload avatar_badge).clanbite_ranks_get_avatar_badge_for_rest()clanbite-ranksAvatar ring / badge data shaped for Interactivity templates (REST author payload avatar_badge).clanbite_ranks_get_avatar_badge()clanbite-ranksEverything an avatar needs to draw its XP ring and rank badge, in one call.clanbite_ranks_get_avatar_badge()clanbite-ranksEverything an avatar needs to draw its XP ring and rank badge, in one call.clanbite_ranks_get_avatar_icon_rank_types()clanbite-ranksRank ladders configured to overlay the current level icon on player avatars (large / medium presets only).clanbite_ranks_get_avatar_icon_rank_types()clanbite-ranksRank ladders configured to overlay the current level icon on player avatars (large / medium presets only).clanbite_ranks_get_avatar_progress_rank_types()clanbite-ranksRank ladders configured to show the XP ring on player avatars and the user menu.clanbite_ranks_get_avatar_progress_rank_types()clanbite-ranksGlobal alias of Kernowdev\ClanbiteRanks\clanbite_ranks_get_avatar_progress_rank_types().clanbite_ranks_get_points_balance()clanbite-ranksA member's balance for one point type.clanbite_ranks_get_rank_icon()clanbite-ranksGet user's rank icon URL.clanbite_ranks_get_rank_icon()clanbite-ranksGet user's rank icon URL.clanbite_ranks_get_rank_progress()clanbite-ranksRank progress payload for a user and rank type (used by the progress bar, REST and the rank toasts).clanbite_ranks_get_rank_progress()clanbite-ranksRank progress payload for a user and rank type (used by the progress bar, REST and the rank toasts).clanbite_ranks_get_rank_types_rows()clanbite-ranksRank ladder rows from options (rank_types, with fallback for camelCase rankTypes).clanbite_ranks_get_team_member_rank_icon()clanbite-ranksTeam-specific assigned rank icon URL for a member.clanbite_ranks_get_team_member_rank_icon()clanbite-ranksTeam-specific assigned rank icon URL for a member.clanbite_ranks_get_team_member_rank()clanbite-ranksTeam-specific assigned rank label for a member.clanbite_ranks_get_team_member_rank()clanbite-ranksTeam-specific assigned rank label for a member.clanbite_ranks_get_user_rank_label()clanbite-ranksCurrent rank label of a user for one rank type.clanbite_ranks_get_user_rank_label()clanbite-ranksCurrent rank label of a user for one rank type.clanbite_ranks_get_user_rank_name()clanbite-ranksGet user's rank name.clanbite_ranks_get_user_rank_name()clanbite-ranksGet user's rank name.clanbite_ranks_get_user_rank_progress()clanbite-ranksGet user's overall rank progress percentage (0-100).clanbite_ranks_get_user_rank_progress()clanbite-ranksGet user's overall rank progress percentage (0-100).clanbite_ranks_icon_url_for_level_label()clanbite-ranksIcon URL for a level row matching the given label (ladder definition).clanbite_ranks_level_index()clanbite-ranksPosition of a level on a ladder.clanbite_ranks_message_definitions()clanbite-ranksMessages Ranks registers with Clanbite's message registry.clanbite_ranks_message_template()clanbite-ranksWording for one of Ranks' messages, with its {placeholders} still in place.clanbite_ranks_normalize_rank_levels_from_storage()clanbite-ranksNormalize ladder levels from stored settings (snake_case and camelCase keys; JSON object lists).clanbite_ranks_points_active()clanbite-ranksWhether the Points extension is active, so ladders can be driven by a points balance.clanbite_ranks_popups_available()clanbite-ranksWhether Clanbite's popups are available (the Notifications extension is on). Older cores without the check count as available.clanbite_ranks_progress_metrics_for_balance()clanbite-ranksProgress toward the next tier from a balance and normalized ladder levels.clanbite_ranks_progress_metrics_for_level()clanbite-ranksProgress toward the next tier for a rank that is pinned to a level (assigned by an admin) rather than earned.clanbite_ranks_rank_row_bool()clanbite-ranksRead a boolean flag from a rank type row (REST / JSON may use snake_case or camelCase).clanbite_ranks_rank_up_popup_enabled()clanbite-ranksWhether the rank-up popup is switched on (Clanbite → Settings → Ranks → Rank-up popup).clanbite_ranks_resolve_current_rank_icon_url()clanbite-ranksIcon URL for the user’s current level on a rank ladder (from saved level definitions).clanbite_ranks_show_icon_on_avatar()clanbite-ranksCheck if rank icon should be shown on avatars.clanbite_ranks_show_icon_on_avatar()clanbite-ranksCheck if rank icon should be shown on avatars.clanbite_ranks_show_progress_on_avatar()clanbite-ranksCheck if rank progress should be shown on avatars.clanbite_ranks_show_progress_on_avatar()clanbite-ranksCheck if rank progress should be shown on avatars.
Hooks 18
clanbite_ranks_abilities_registeredclanbite-ranksFires after Clanbite Ranks registers Abilities API entries.clanbite_ranks_avatar_badgeclanbite-ranksFilters the avatar ring / badge data for a player.clanbite_ranks_icon_packsclanbite-ranksFilter rank icon packs for the icon picker modal.clanbite_ranks_initclanbite-ranksFires when Clanbite Ranks is loaded and Clanbite is available.clanbite_ranks_points_activeclanbite-ranksFilters whether the Points extension counts as active for rank ladders.clanbite_ranks_rank_assignedclanbite-ranksFires after a rank label is manually assigned to a user.clanbite_ranks_rank_progressclanbite-ranksFilter rank progress data returned from the ladder and used by avatar bars / level-up toasts.clanbite_ranks_rank_up_popup_enabledclanbite-ranksFilters whether the rank-up popup is shown.clanbite_ranks_team_member_rankclanbite-ranksFilter resolved team member rank label.clanbite_ranks_team_member_rank_iconclanbite-ranksFilter resolved team member rank icon URL.clanbite_social_kit_post_createdclanbite-ranksMirror composer-created post hook for compatibility with mentions/integrations.clanbite.points.levelUpToastPayloadclanbite-ranksFilters the level-up toast payload before the toast is rendered.clanbite.points.levelUpToastShownclanbite-ranksFires after the level-up toast has been handled.clanbite.points.renderLevelUpToastclanbite-ranksLets a handler render its own level-up toast (checked after clanbite.ranks.renderRankUpToast).clanbite.ranks.rankUpToastPayloadclanbite-ranksFilters the rank-up toast payload (title, subtitle, duration…) before the toast is rendered.clanbite.ranks.rankUpToastShownclanbite-ranksFires after the rank-up toast has been handled.clanbite.ranks.renderRankUpToastclanbite-ranksLets a handler render its own rank-up toast.clanbite.ranks.shouldShowRankUpToastclanbite-ranksFilters whether a rank-up toast is shown after the progress bar updates. Return false to suppress it.
Messages 4
rank_toast.detailsclanbite-ranksShown under the heading.rank_toast.maxclanbite-ranksAdded after the line above when the member reaches the highest rank.rank_toast.nextclanbite-ranksAdded after the line above when there is a higher rank to aim for.rank_toast.titleclanbite-ranksThe bold first line of the popup a member sees when their rank goes up.
Methods 73
Avatar_Rank_Progress::add_progress_to_unified_avatar()clanbite-ranksAdd rank progress bars to unified avatar system.Avatar_Rank_Progress::avatar_allows_rank_icon_overlay()clanbite-ranksWhether this avatar render should allow rank icon overlays (all presets except small).Avatar_Rank_Progress::enqueue_assets()clanbite-ranksEnqueue avatar progress assets when at least one enabled rank type exists.Avatar_Rank_Progress::enqueue_progress_assets()clanbite-ranksEnqueue rank bar CSS/JS (REST polling, level-up toasts) once per request.Avatar_Rank_Progress::filter_forums_rest_author()clanbite-ranksAdds rank icon URLs for Clanbite Forums board avatars (Interactivity data-wp-each).Avatar_Rank_Progress::filter_player_avatar_block_parts()clanbite-ranksLarge player-avatar block: rank icons outside the clip only (progress uses Rank progress block).Avatar_Rank_Progress::filter_player_avatar_icon_overlay()clanbite-ranksWrap avatar inner markup and overlay current-rank icons (bottom-right) for enabled rank types.Avatar_Rank_Progress::filter_player_avatar_markup()clanbite-ranksAppend rank label/progress markup beside large avatars and user-nav avatars (trigger + dropdown).Avatar_Rank_Progress::filter_social_kit_rest_author()clanbite-ranksAdds rank icon URLs for Social Kit feed / comment author payloads.Avatar_Rank_Progress::register_rest_routes()clanbite-ranksRegister public REST route for rank progress polling.Avatar_Rank_Progress::register()clanbite-ranksRegister front-end hooks.Avatar_Rank_Progress::render_rank_progress_block_markup()clanbite-ranksFront-end / editor: output a selected ladder’s bar for a user (used by the Rank progress block).Avatar_Rank_Progress::render_single_rank_progress_bar_html()clanbite-ranksOne rank ladder progress bar (same markup as user-nav / REST polling expects).Icon_Packs::append_for_react_admin()clanbite-ranksMerge rank icon packs into the unified Clanbite React admin bootstrap.Icon_Packs::enqueue_admin_assets()clanbite-ranksEnqueue icon picker assets for WP admin.Icon_Packs::get_icon_packs()clanbite-ranksRegistered rank icon packs.Icon_Packs::register_starter_pack()clanbite-ranksBuilt-in starter icon pack.Icon_Packs::register()clanbite-ranksRegister hooks.Plugin::bootstrap_clanbite_extension()clanbite-ranksInstantiate extension early on init so Clanbite can register/validate it.Plugin::init()clanbite-ranksSecondary hooks after extension bootstrap.Plugin::instance()clanbite-ranksThe plugin singleton.Plugin::is_clanbite_available()clanbite-ranksWhether Clanbite is active and bootstrapped.Plugin::load_textdomain()clanbite-ranksLoad translations early (plugins_loaded, priority 1).Plugin::render_clanbite_missing_notice()clanbite-ranksAdmin notice when Clanbite is missing.Rank_Status_Updates::maybe_post_status_for_manual_assignment()clanbite-ranksHandle manual rank assignment.Rank_Status_Updates::maybe_post_status_for_points_award()clanbite-ranksHandle points-triggered rank progress.Rank_Status_Updates::register()clanbite-ranksRegister rank update hooks.Ranks_Abilities::execute_rank_types()clanbite-ranksAbility callback: the configured rank ladders and their levels.Ranks_Abilities::execute_user_rank_progress()clanbite-ranksAbility callback: a member's progress on one ladder (see clanbite_ranks_get_rank_progress()).Ranks_Abilities::permission_rank_progress()clanbite-ranksPermission callback for the rank progress ability: any signed-in member.Ranks_Abilities::register_abilities()clanbite-ranksRegister the rank abilities: list ladders and read a member's rank progress.Ranks_Abilities::register_hooks()clanbite-ranksRegister the abilities on the Abilities API init action (no-op when the API is unavailable).Ranks_Admin::get_all()clanbite-ranks{@inheritDoc}Ranks_Admin::get_defaults()clanbite-ranks{@inheritDoc}Ranks_Admin::get_menu_title()clanbite-ranks{@inheritDoc}Ranks_Admin::get_page_title()clanbite-ranks{@inheritDoc}Ranks_Admin::get_sections()clanbite-ranks{@inheritDoc}Ranks_Admin::handle_save_types()clanbite-ranksHandle custom modal-based rank type save request.Ranks_Admin::render_page()clanbite-ranks{@inheritDoc}Ranks_Admin::sanitize_rank_types_field()clanbite-ranksSanitize the rank ladders repeater: unique keys, trimmed names and levels sorted by minimum points.Ranks_Management::apply_operation()clanbite-ranksAssign or reset a member's rank on a ladder.Ranks_Management::enqueue_assets()clanbite-ranksLoad the management view script on the Clanbite settings screen.Ranks_Management::get_manage_url()clanbite-ranksURL of the management view inside the Ranks settings tab.Ranks_Management::handle_post()clanbite-ranksLegacy admin-post.php handler (kept for integrations that still post the old form).Ranks_Management::member_payload()clanbite-ranksDescribe a member and where they stand on each ladder.Ranks_Management::redirect_legacy_page()clanbite-ranksThe management screen used to be its own menu page; send old bookmarks to the Ranks tab.Ranks_Management::register_menu()removed clanbite-ranksRegister Ranks Management submenu.Ranks_Management::register_rest_routes()clanbite-ranksRegister the member lookup and rank change routes (manage_options only).Ranks_Management::register()clanbite-ranksRegister admin hooks.Ranks_Management::render_page()removed clanbite-ranksRender management page.Ranks_Management::rest_change_rank()clanbite-ranksREST: assign or reset a member's rank on one ladder.Ranks_Management::rest_get_member()clanbite-ranksREST: a member's rank on every ladder.Ranks_Management::rest_permission()clanbite-ranksPermission check shared by the management routes.Ranks::__construct()clanbite-ranksConstructor.Ranks::enqueue_rank_progress_block_editor_data()clanbite-ranksSupplies rank ladder titles for the Rank progress block inspector (values remain internal keys).Ranks::filter_render_block_context_rank_progress()clanbite-ranksSupplies clanbite/playerId to the rank progress block on player profile routes.Ranks::get_settings_admin()clanbite-ranks{@inheritDoc}Ranks::register_block_category()clanbite-ranksBlock category in the editor.Ranks::register_blocks()clanbite-ranksRegisters the rank progress block from /build/rank-progress.Ranks::run()clanbite-ranks{@inheritDoc}Ranks::setup_extension()clanbite-ranksRegister the extension with the Clanbite loader as an official (first-party) extension.Team_Ranks::filter_manage_sections()clanbite-ranksInject Team Ranks section into team manage form.Team_Ranks::filter_teams_sections()removed clanbite-ranksAdd global Teams settings field for enabling team ranks (Clanbite → Teams → Extension integrations).Team_Ranks::get_team_rank_assignments()clanbite-ranksMember => assigned team rank label map.Team_Ranks::get_team_rank_definitions()clanbite-ranksTeam rank definitions (label + icon URL).Team_Ranks::get_team_rank_labels()clanbite-ranksTeam rank labels for assignment dropdowns.Team_Ranks::handle_save_team_ranks_nopriv()clanbite-ranksReject unauthenticated team rank save requests.Team_Ranks::handle_save_team_ranks()clanbite-ranksPersist team rank definitions and member assignments.Team_Ranks::maybe_migrate_team_rank_meta_keys()clanbite-ranksOne-time migration: rename team rank post meta keys from pre-rebrand installs.Team_Ranks::register()clanbite-ranksRegister Teams integration hooks.Team_Ranks::render_team_manage_section_team_ranks()clanbite-ranksRender Team Ranks section UI in team manage screen.Team_Ranks::teams_ranks_enabled()clanbite-ranksWhether team rank management is enabled (Clanbite → Ranks → Team ranks).Team_Ranks::user_can_manage_team_ranks()clanbite-ranksPermission check for team rank management.
REST API 3
clanbite-ranks/v1/members/(?P\d+)clanbite-ranksclanbite-ranks/v1/members/(?P\d+)/rankclanbite-ranksclanbite-ranks/v1/rank-progressclanbite-ranks
Settings 1
clanbite_ranks_settingsclanbite-ranks