Rankings
Who has the most points on your site, from myCred, as a native leaderboard your members can switch between point types and time periods.
Before you start
Section titled “Before you start”| Plugin | myCred, set up. The Ranks and Badges add-ons are optional |
| Endpoint group | Rankings |
| Plan | Every plan |
The leaderboard needs the Memberside plugin 2.75.0 or later on your site. On an older one the screen shows the feature as unavailable.
myCred has to have finished its setup wizard. Until it has, myCred loads none of its point types and the feature card stays greyed out.
Rankings works without Ultimate Member. On an Ultimate Member site, rows can show Ultimate Member profile fields; on a BuddyPress site, BuddyPress profile fields.
Add it to your app
Section titled “Add it to your app”- Drag Rankings onto a navigation bar or into the side drawer.
- Open its settings and tick the Point types and Periods to offer.
- Choose a Layout, and pick Profile fields if you want details under each name.
Tapping a member opens their profile.
Settings
Section titled “Settings”| Setting | What it does | Default |
|---|---|---|
| Point types | Which of your myCred point types members can switch between, up to five. With more than one, a switch sits at the top | Your first point type |
| Periods | All time, This month, This week and Today. Tick at least one; with more than one, members switch between them | All time |
| Rank all time by | Current balance, or Total earned over the member’s whole history | Current balance |
| Layout | A list, or a grid of 2 or 3 columns | List |
| Podium | The top three on a podium above the rest, with medals | On |
| Search | A search box that finds members by name, with an X to clear it | On |
| Show rank | The member’s myCred rank title and logo under their name | On |
| Show badges | How many badges the member has earned | On |
| Profile fields | Up to three profile fields under each name | None |
| Gap, Padding | The space between rows and around the list | Your app’s spacing tokens |
| Name, Details, Points | Text styles for the member’s name, the line under it, and the points: size, weight, and a colour for light and dark mode | Your app’s type tokens |
| Background, Text colour | The screen’s own colours | Your app’s colours |
| Title, Description | Shown at the top | Empty |
Periods
Section titled “Periods”A period board ranks by the points members earned in that period: everything they gained, less any points an administrator took away by hand. All time ranks by the setting under Rank all time by instead.
The periods other than All time read myCred’s points history. If your site has switched myCred’s logging off, the app offers All time only.
This week starts on the day set under Settings → General → Week Starts On in WordPress.
Rank and badges
Section titled “Rank and badges”Show rank needs myCred’s Ranks add-on, and Show badges its Badges add-on. With an add-on off, its detail is left out of every row. A member with no rank yet shows none. Badge counts include published badges only.
Profile fields
Section titled “Profile fields”Pick up to three. Each one shows under the member’s name only when the person looking may see it:
- Ultimate Member fields follow each field’s own privacy setting, so a field set to Only me is never shown to anyone else.
- BuddyPress fields follow each member’s visibility choice, so a field set to My Friends shows only to their friends.
- A member whose whole profile is private to the viewer shows no fields.
An empty field is left out.
What your members see
Section titled “What your members see”The point type switch and the period tabs, then the search box, then the podium with the top three, then everyone else in order. Each row has the member’s position, photo, name, the details you chose, and their points formatted the way myCred formats them.
A Your position bar stays at the bottom of the screen for a signed-in member who is on the board, showing their place and points. It is hidden for visitors and for members who are not on the board.
Search narrows the list without renumbering it: a member in fifth place still shows 5 when they are the only match. The podium hides while a search is on.
Members on equal points are listed in the order they joined, so every member has a position of their own.
The Rankings screen, switching periods and searching
record → src/assets/media/rankings.mp4
Who is left off the board
Section titled “Who is left off the board”Some members never appear, and positions are counted as if they were not there:
- Members hidden from the directory. On an Ultimate Member site, accounts that are not approved yet, and members who chose to hide their profile from the member directory. Administrators and anyone else who may edit users still see them, as in Ultimate Member’s own directory.
- Blocked members. When one member has blocked another, neither sees the other on the board. Moderators see everyone.
- Members excluded from the point type. Anyone on the point type’s exclusion list in myCred, anyone with a role it excludes, and point administrators or editors when the point type is set to leave them out.
- Members on zero. A board lists only members with points to show.
When it does not work
Section titled “When it does not work”| Symptom | Cause | Fix |
|---|---|---|
| The card is greyed out | myCred is inactive, or its setup wizard has not been finished | Activate myCred and complete its setup |
| The screen says the feature is unavailable | The Rankings group is off, or the Memberside plugin is older than 2.75.0 | Enable the group under Memberside → REST API, or update the plugin |
| Only All time is offered | myCred’s logging is switched off on your site | Turn logging back on, or offer All time only |
| The board is empty | Nobody has points for this type and period yet | Award some points, or pick a longer period |
| A member is missing | They are hidden from the directory, blocked by or blocking the viewer, excluded from the point type, or on zero | See Who is left off the board |
| Ranks are missing | The Ranks add-on is off, Show rank is off, or the member has no rank yet | Turn the add-on and setting on |
| Badge counts are missing | The Badges add-on is off, or Show badges is off | Turn the add-on and setting on |
| A profile field shows for some members and not others | Those members left it empty, or it is private to the viewer | Nothing to fix |
| Your position is missing | The viewer is signed out, or is not on this board | Nothing to fix |