Member Directory Page

RYO Membership Directory Plugin Administrator Manual
Back to Index

This is how you set up a page to display a listing of your members.

The Member Directory Page is created with the [memberdirectory] shortcode.

Create a Page and place the shortcode on the page. Normally, you would have nothing else on the page. In it's simplest form, it would look like this:

[memberdirectory]

This will display the member listing with our standard format. You may modify that somewhat by specifying special attributes within the [memberlist] shortcode, as in :

[memberdirectory attribute1=value attribute2="Value of more than one word"]

Note that if you're assigning more than one word as a value, the value must be enclosed in quotation marks.

Each directory has three separate "views" which you control:

1. The "Directory View" is the initial page seen by a guest. It's either a list of members or a list of categories that can be clicked to search for members who have selected that category. For the basic Member Directory, it's a list of members.
2. The "Search View" is the list of members seen after a search request, either a keyword request or a category click.
3. The "Detail View" is the detailed information displayed about a single member after clicking that members listing in a directory list or search results list.

As far as WordPress is concerned this all happens on one Page. In practice, that one Page shows a lot of different information.

Use these attributes to customize your Directory:

None of these need to be used unless you want to change the way your directory is put together. The standard directory is already set up in the software.

• membertypes: This is a list of member types to include in this page. You may include multiple types by listing them with a comma separating them and enclosing the list in quotation marks. If you don't set this, all member types are included.
• sortby: This must be either company or name or firstname -- lower case as shown. Results will be sorted in the respective order.
• format: This attribute indicates whether a Search Field will be included on your Directory Page. SD = Search Field included. D = No Search Field.
• top: Set this to change the text that appears at the top of the page.

Appearance of the Directory View:

• directoryview: Set this to the name of the list template you want to display each record in the initial directory listing. Typically listtemplate1 for a text listing, listtemplate2 for a listing that displays an uploaded image or Gravatar left of the text listing, or listtemplate3 for a names only listing.
• index: Set this to 1 to display an alphabetical index at the top of the page with the first letters of entries on that page. These can be clicked to jump directly to that portion of the list. Set this to 0 for no index. If you are displaying a lot of entries on the page, you may want to repeat the index every 40 or 50 entries. If so, set this to the number of entries to display before repeating.
• perpage: Set this to the number of entries you want to display per page for the initial directory listing.

If you're including a Search Box:

• searchhead: This text will appear over the Search entry box.

Appearance of the Search View:

• searchview: Set this to the name of the list template you want to display the each record when a search has been initiated. This might be the same as directoryview, but we like to use a larger template with more information, since search results are typically smaller than the whole membership. Typically listtemplate4
• resultsinstructions: This text will appear over the search results after a report indicating how many results were obtained.
• searchindex: Set this to 1 to display an alphabetical index at the top of the page with the first letters of entries on that page. These can be clicked to jump directly to that portion of the list. Set this to 0 for no index. If you are displaying a lot of entries on the page, you may want to repeat the index every 40 or 50 entries. If so, set this to the number of entries to display before repeating.
• searchperpage: Set this to the number of entries you want to display per page for search results.
• returnlink: This text will appear at the end of search results as a link back to the Main page.

Appearance of the Detail View, a Member's Detail Page:

• detailview: Set this to the name of the page template you want to display the full member profile when someone clicks on a directory listing. Typically detailtemplate1

Here's an example. Note that you only need to set the attributes for those you want to change.

[memberdirectory
membertypes=Regular
sortby=company
top="For your convenience we present this member list"]

Template Layout Codes

Back to Index