Member Directories 2.1.0+

This article describes member directory settings. You can use the existing member directory or create a new one on wp-admin > Ultimate Member > Member Directories.

Contents

• General Options
• Sorting Options
• Profile Card
• Search Options
• Results & Pagination

General Options #

View type(s) - this option allows you to select view types of the Member Directory. There are able Grid and List views. If you select more than 1 view type, there will be displayed the change layout button at the member directory front-end.

Default view type - this option allows you to select the default view type from already selected view type(s).

User roles to display – this option allows you to select which user roles are displayed in the directory. If left blank the directory will display the profile cards of all members of your site.

Only show members who have uploaded a profile photo – this option allows you to only show members who have uploaded a profile photo. If turned on any member who does not upload a profile photo will not be shown in the directory. This option is turned off by default.

Only show members who have uploaded a cover photo – this option allows you to only show members who have uploaded a cover photo. If turned on any member who does not upload a cover photo will not be shown in the directory. This option is turned off by default.

Only show specific users (Enter one username per line) - this option allows you to show only selected members by username.

Exclude specific users (Enter one username per line) - this option allows you to exclude only selected members by username.

Only show members who have completed their profile - this option allows you to show only members who completed their profile with the Required completeness (%) option value. The last one is visible when the "Only show members who have completed their profile" option is enabled. These options are integrated by the Profile Completeness extension.

Only show members who have verified their profile - this option allows you to only show members who verified their profile. This option is integrated by the Verified Users extension.

Sorting Options #

Default sort users by - this option allows you to decide the order of how members are shown in the directory.

You can sort members by:

Enable custom sorting - this option allows you to show the dropdown with sorting options, which are selected in the "Choose fields to enable in sorting" option.

Choose fields to enable in sorting - this option allows you to select the fields for the member directory sorting. If you select the "Other (Custom Field)." option, please fill in the fields "Meta Key" and "Label" below.

Note: The value of the "Default sort users by" option will be added to the list on the front end if it is not selected here. If the total number of unique sorting options for a directory is 1 or less, the sorting field will be hidden on the front end. And users will be sorted by default sort value.

Profile Card #

Search Options #

Enable Search feature - This option allows you to show or hide the general search line on the member directory. If you enable the search "User Roles that can use search" option will appear below.

Ultimate Member uses for searching all Ultimate Member custom metadata, created via Ultimate Member > Forms > Fields screen and WP native fields like username, user_email, display_name, first_name, last_name, user_nicename.

User Roles that can use search - This option allows you to select which user roles can use the general search line. If left blank anyone can use the search line.

Exclude fields from search - This option allows you to choose specific fields to exclude from the search function, including all other fields in the search. This can help refine search results by excluding certain information from the search results.

Example: If you select "Email" and "Phone Number" in the "Exclude fields from search" setting, the search function will exclude matches in the "Email" and "Phone Number" fields from the search results, including all other fields in the search.

Scenario: Imagine you have a database of customer records with fields for "First Name," "Last Name," "Email," and "Phone Number." If you select "Email" and "Phone Number" in the "Exclude fields from search" setting, any search queries will only consider the "First Name" and "Last Name" fields.

Outcome: So, if a user searches for "John" and "John" is in the "First Name" field for a user, that user will appear in the search results. However, if "John" is in the "Email" or "Phone Number" fields, that user will not appear in the search results, even though their name matches the search query.

Fields to search by - This option allows you to choose specific fields to include in the search function, excluding all other fields from the search. This can help refine search results to only include relevant information.

Example: If you select "First Name" and "Last Name" in the "Fields to search by" setting, the search function will only look for matches in the "First Name" and "Last Name" fields, excluding all other fields from the search.

Scenario: Imagine you have a database of customer records with fields for "First Name," "Last Name," "Email," and "Phone Number." If you select "First Name" and "Last Name" in the "Fields to search by" setting, the search function will only consider these two fields for matching search queries.

Outcome: So, if a user searches for "John Doe," the search function will only look for matches in the "First Name" and "Last Name" fields. If there is a customer named "John Doe" in your database, they will appear in the search results. However, if "John Doe" is in the "Email" or "Phone Number" fields but not in the "First Name" or "Last Name" fields, that customer will not appear in the search results because the search is only considering the "First Name" and "Last Name" fields for matches.

Enable Filters feature - This option allows you to show or hide the filters on the member directory. If you enable the filters "User Roles that can use filters" and "Choose filter(s) meta to enable" options will appear below.

User Roles that can use filters - This option allows you to select which user roles can use the filters. If left blank anyone can use the filters.

Choose filter(s) meta to enable - This option allows you to select fields that will be shown in the filters section. The filters section can be expanded by default via the Expand the filter bar by default option below. Please note that not all field types are allowed in the search filters, so not all of your custom fields will appear in this list.

There are 4 filter types by default in Ultimate Member core and extensions: Dropdown, Slider range, Date range, and Time range.

The values available in the filters (Dropdown options, Slider range limits, Date range period) depend on the members' data. Therefore, a dropdown option is shown if there are members who have selected this option in their profiles. The option is hidden if no one has selected this option in their profile.

Table - Supported filter fields and their types.

Note: The Role is a reserved word to determine if the field is a role field.

Image - Filters in the member directory

Admin filtering - this option allows you to select the predefined filters that display users on the page's first loading. All fields available for front-end filtering are available here. Particular attention should be paid to the fact that if a field for a predefined filter is selected, and then filtered by it using the “Choose filter(s) meta to enable” fields, then the “Choose filter (s) meta to enable” fields will be more priority.

Results & Pagination #

Show results only after search/filtration - you can decide how to display members in the directory. On page loading or after the searching/filtration.

Maximum number of profiles, Number of profiles per page, Number of profiles per page (for Mobiles & Tablets) - you can decide the number of profiles to show on each page (Please note: the higher the number the longer the page will take to load) and there is also an option to limit the total number of profiles that will be shown in this directory (leave blank to show all users in the directory).

Results Text - This option allows you to customize the text that is shown after a user performs a search. The tag {total_users} will show the number of users that match the search criteria. The same but for single result Single Result Text option.

Custom text if no users were found - This option allows you to customize the text that is shown after a user performs a search and the search returns empty (no users were matched the search criteria).