Member Directory and Profile Pages

Add value to your membership, foster community, and build connections through member directories and listings. This Add On allows you to create a customizable Member Directory and individual Member Profile pages.

• Member Directory Page: Dynamically lists members, presents essential profile information, avatars, and direct links to the individual Member Profile pages.
• Member Profile Page: Highlights a specific member’s information. Customize the profile display with no-code User Fields to create a useful resource for each member that encourages exploration, interaction, and even generates business opportunities.
• Customization Options: Build your Member Directory to fit your unique vision and set up specific visibility and access rules. Use the built-in WordPress blocks or shortcodes to arrange and display the directory, member profiles, and included user profile data based on membership level.

Member Directory and Profile Page Setup

Step 1: Create and Assign the Directory and Profile Pages

The first step of setup is to create and assign the pages that will display your Member Directory and Member Profiles. You can generate these pages automatically, or create them manually and assign in the settings.

1. Navigate to Memberships > Settings > Pages in the WordPress admin.
2. Locate the Additional Page Settings section.
3. Click the Generate Page button to create a new page for your Member Directory and Member Profile. If you created these pages manually, assign them to the appropriate Page Settings after they are published.
4. Save Settings.

Step 2: Edit Your Member Directory

The Member Directory can be customized by changing attributes of the Shortcode [pmpro_member_directory] or adjusting the settings of the Member Directory Block.

Members can opt out of the Member Directory by checking the “Hide from Member Directory?” field on the “Edit Profile” page.

Step 3: Edit Your Member Profile

The Member Profile can be customized by changing attributes of the Shortcode [pmpro_member_profile] or adjusting the settings of the Member Profile Block.

If the shortcode, block, and available hooks and filters do not offer the level of customization you require, refer to this guide on How to Load a Custom Template for Your Member Directory and Profiles.

Step 4: Allow Members to Control Profile Visibility

Members can remove their profile from being included in the Directory. The Add On automatically adds this setting to the Member Profile Edit page. A member or admin can check the box to hide their profile and they will be immediately removed from the Directory and Profile.

Admins also have the ability to remove a member from the directory via the “Directory and Profile Preferences” panel on the Edit Member screen. A member or admin can check the box to hide their profile and they will be immediately removed from the Directory and Profile.

You can also let members opt out of the directory as part of membership checkout. Follow these steps to create a User Field that adds an “Exclude my profile from the member directory” field at membership checkout:

1. Navigate to Memberships > Settings > User Fields in the WordPress admin.
2. Click the “+ Add Field Group” button.
3. Enter your preferred title for the group in the “Group Name” field, e.g. “Hide from Directory?”.
4. Select “Yes” for the “Show fields at checkout?” option.
5. Select “No” for the “Show fields on user profile?” option.
6. Click the “+ Add Field” button.
7. Enter your preferred title for the field in the “Label” field, e.g. “Exclude my profile from the member directory”.
8. Enter pmpromd_hide_directory in the field’s “Name” field.
9. Select “Checkbox” from the field “Type” dropdown.
10. Click on the “Save All Changes” button to create and save the new field group and field.

Step 5: Add a Directory Search

The [pmpro_member_directory_search] shortcode is used to display a search form for the Member Directory Add On. This allows users to search for members within the directory.

To add a search form to any page or post, simply include the shortcode in the content editor:

[pmpro_member_directory_search]

Restrict the directory search with the Content Visibility block or shortcode.

Video: Coding with Sam Walkthrough

Customizations, Theme Compatibility, and Styling

File-Type Profile Fields

If you are displaying a field that is a file type (audio, video, image, document), the shortcode will attempt to embed or display the file based on the mime type (about WordPress filetypes).

• Audio files will embed using the WordPress [audio] shortcode
• Document files will display the appropriate wp_mime_type_icon and a link to view or download the file
• Image files will display as a standard image on the page at full size
• Video files will embed using the WordPress [video] shortcode

Third-Party Embeddable Links

If your members have a profile field that links to a third-party embeddable platform like YouTube, Vimeo, and others, the field will also display as an embed. See a list of supported oembed sites here.

Member Directory and Profile Search

By default, the search fields in this Add On will search the following profile values: user_login, user_email, display_name, and all usermeta fields.

Some servers may not allow the large queries needed to execute a directory and profiles search. You will know this is the case if you are using the search form and no results are returned when you know results should be returned.

The recipe below can be used to allow your hosting environment to process the large JOIN operations needed for this Add On.

Administrator Role Only: Security Features

The Member Directory and Profile blocks and shortcodes are very powerful. They are each capable of outputting user and user meta field for the logged in user. For this reason and the potential privacy and security risks associated with displaying user info, only users with the edit_users capability (given to people with the Administrator role) can add this block or shortcode to content.

Shortcode Examples

[pmpro_member_directory levels="1,4" elements="display_name;Level,membership_name;Member Since,membership_startdate"]

[pmpro_member_directory elements="display_name,avatar,user_email"]

[pmpro_member_directory elements="avatar|128;display_name;Company,company;Website,user_url"]

[membership level="1"]
[pmpro_member_directory levels="1"]
[/membership]

[membership level="2"]
[pmpro_member_directory levels="2"]
[/membership]

[membership level="3"]
[pmpro_member_directory levels="3"]
[/membership]

[membership level="1"]
[pmpro_member_profile elements="display_name;avatar;Level,membership_name"]
[/membership]

[membership level="2"]
[pmpro_member_profile elements="display_name;avatar;Level,membership_name;Email Address,user_email"]
[/membership]

Action and Filter Hooks

The following actions and filter hooks are available in this Add On:

do_action( 'pmpro_member_directory_before', $sqlQuery, $shortcode_atts );

Allows content to be inserted before the Member Directory content.

do_action( 'pmpro_member_directory_after', $sqlQuery, $shortcode_atts );

Allows content to be inserted after the Member Directory content.

do_action( 'pmpro_member_profile_before', $pu );

Allows content to be inserted before the Member Profile content.

do_action( 'pmpro_member_profile_after', $pu );

Allows content to be inserted after the Member Profile content.

apply_filters( 'pmpro_member_directory_display_name', $user->display_name, $user );

Modify the display name for members in your Member Directory and Member Profile.

apply_filters( 'pmpromd_user_identifier', 'slug' );

Filter to change how user identifiers are presented. Choose between slug and ID (case-sensitive).

apply_filters( 'pmpromd_profile_url', get_permalink( $pmpro_pages['profile'] ) );

Dynamically filter the profile URL. Use this filter to optionally link Directory entries to a specific Profile page per user ID or to an external URL.

apply_filters( 'pmpro_member_profile_elements', $elements_array, $pu );

Filter the elements array for the member profile.

apply_filters( 'pmpromd_member_profile_action_links', $pmpro_member_profile_action_links );

Filter which links are displayed on the single Member Directory Profile page.

apply_filters( 'pmpromd_get_display_value', $value, $element, $pu, $displayed_levels );

Filter the value of a specific element from a string of HTML.

apply_filters( 'pmpro_member_directory_sql_search_where', $sql_search_where, $s );

Allow filtering the member directory search SQL to be used.

apply_filters( 'pmpro_member_directory_sql_parts', $sql_parts, $levels, $s, $pn, $limit, $start, $end, $order_by, $order );

The $levels parameter is a single level ID or a comma-separate list of IDs (not an array of level IDs).

The $sql_parts parameter is an array of each section of the SQL query for building your list of members to include in the directory. The sections of the array you can modify include:

• $sql_parts['SELECT']
• $sql_parts['JOIN']
• $sql_parts['WHERE']
• $sql_parts['GROUP']
• $sql_parts['ORDER']
• $sql_parts['LIMIT']

apply_filters("pmpro_member_directory_sql", $sqlQuery, $levels, $s, $pn, $limit, $start, $end, $order_by, $order);

Allow filtering the final member directory SQL before users are queried.

apply_filters( 'pmpromd_user_directory_results', $theusers );

Filter the array of users returned from the query before display.

apply_filters( 'pmpro_member_directory_elements', $elements_array );

Filter the elements array for the member directory.

apply_filters( 'pmpro_member_directory_elements', $elements_array );

Filter the elements array for the member directory.

Screenshots

4 Column Layout

Table Layout

Member Profile