i4w_member_dir
Usage
This shortcode returns an ajax table consisting of a segment of your Keap contacts, selected by tag ID and/or company ID. Through this shortcode, both regular and custom contact fields can be viewed.
[ELSE_member_dir] conditional branching is NOT supported.
Shortcode nesting is NOT supported.
Parameters
| Parameter | Description | Default | Required |
|---|---|---|---|
| companyid | This parameter can take one of three possible values: 'no', 'yes' or '123' (where '123' is a specific, existing CompanyId). If 'no' is specified, the company ID will not be taken into account during the query. If 'yes' is given, the current user's company ID, if available, will be used. If the user doesn't have a company ID, no member directory will be returned. Finally, if a specific company ID is given, a member directory will be returned using that company ID. | no | No |
| tagid | One or more comma separated (CSV) tag IDs, to select the segments of your list to be displayed. | None | Yes |
| fields | The Keap fields to display. Please use the identical spelling as documented in the API. | None | Yes |
| header_labels | Column headers to be used instead of field names. | None | No |
| onlyid | A comma separated list of Keap contact IDs of members allowed to see the generated list. If used, only those members will be able to see the list. If not used, anyone can see it. | None | No |
| headers | May be 'y' or 'n', to define whether a table header is displayed or not. | y | No |
| pagelength | Specifies the number of items displayed per page. | 10 | No |
| sort_field | The column to sort by. Starting with 0 for the first column. | 0 | No |
| sort_order | The sort order. asc for ascending, desc for descending. | asc | No |
| avatar_field | Specifies a Keap field name (NOT custom field) where alternate avatar URLs are stored. | None | No |
| avatar_header | Specify a column header for the avatar column. | None | No |
| avatar_size | Defines the size of the avatar, limited to 1x1 minimum and 128x128 maximum. If no default is provided, the shortcode falls back on the global Gravatar size. | None | No |
| avatar_default | Defines which gravatar to use when the user doesn't have one registered. | mm | No |
| avatar_alt | Determines which "alt" text is going to used in the image link. | None | No |
Example
Shortcode
[i4w_member_dir tagid='123,234,345' fields='FirstName,LastName,Phone1']
Shortcode
[i4w_member_dir tagid='123,234,345' companyid='no' fields='FirstName,LastName,Phone1']
Shortcode
[i4w_member_dir tagid='123,234,345' companyid='yes' fields='FirstName,LastName,Phone1']
Shortcode
[i4w_member_dir tagid='123,234,345' companyid='123' fields='FirstName,LastName,Phone1']
Shortcode
[i4w_member_dir tagid='123,234,345' fields='avatar,FirstName,LastName,Phone1']
Shortcode
[i4w_member_dir tagid='123,234,345' fields='avatar,FirstName,LastName,Phone1' avatar_field='Address3Street' avatar_size='48' avatar_default='mm']
Shortcode
[i4w_member_dir tagid='123,234,345' fields='avatar,FirstName,LastName,Phone1' header_labels=',Nombre,Apellido,Telefono' avatar_field='Address3Street' avatar_size='48' avatar_default='mm']
Notes
info
The list is sorted on the first field defined in the fields list.
In addition to all the available Keap contact fields, this shortcode provides one virtual field: avatar which is converted to a person's gravatar.
For additional information concerning gravatars and default values, please refer to: https://en.gravatar.com/site/implement/images/