CLA People Plugin

Last Updated
Prerequisites

The site must be on the CLA WordPress Multisite system in order to have access to the CLA People plugin.

Table of Contents

Summary

In an effort to improve user management, and make it easy to display faculty and staff profiles across multiple sites and pages, the CLA People plugin was created. Since user profiles are saved at the college level they can be changed in one location and information will automatically be updated everywhere they're being displayed. The plugin has many options and four distinct use cases:

  • display a list of faculty/staff (on a People page)
  • display specific individuals (calling out specific faculty/staff)
  • display a profile (only used by the site theme)
  • link to an individual profile

To make things as simple as possible, we have created a Beaver Builder module that is drag and drop, with all of the options available in the module settings. Alternatively you can use our the legacy custom WordPress Shortcodes.

List

Listing groups of faculty, staff, students, or affiliates can be done by using the Libarts People module within Beaver Builder and selecting the list type, or the [cla_people_list] shortcode. There are numerous options available with this type so we recommend using the Beaver Builder module.

Legacy Shortcode: cla_people_list

Options:

  • slider (boolean)
    • If true, queues the cla-people-slider.js to restyle the list into slider format - with next/previous pages and alphabetical listing
    • Default value: false
  • accordion (boolean)
    • If true, queues the cla-people-accordion.js to add the necessary JavaScript
    • Default value: false
  • network_users (boolean)
    • If true, pulls users from the entire multisite network rather than just the local site. Automatically sets the transient expiration to a much longer time if this is true.
    • Default value: false
  • order (string)
    • Value can be 'ASC' or 'DESC'.
    • Default value: 'ASC'
  • orderby (string)
    • Value can be 'ID', 'login', 'nicename', 'email', 'url', 'registered', 'display_name', 'post_count' - Alternatively, any other user meta key can be used, however if department is set (limiting users to a specific department) then orderby will be set to 'display_name'.
    • Default value: 'last_name'
  • department (string)
    • Value can be any slug value of a Department taxonomy_term, or multiple slugs separated by a comma - will only include users that have this department slug selected in their profile.
  • department_exclusive (boolean)
    • Only used if one department is listed. If true will only show users that exclusively belong to that department (rather than to multiple departments). If false will show users that belong to the designated department whether they belong to others as well, or not.
    • Default value: false
  • exclude_department (string)
    • Value can be any slug value of a Department taxonomy_term, or multiple slugs separated by a comma - will exclude all users that have this department slug selected in their profile (possible use is if a user has multiple departments selected and you only want users that exclusively belong to one department)
  • exclude_username (string)
    • Username(s) to be removed from the users query result if they are included
  • include_username (string)
    • Username(s) to be included that may not otherwise be included in the user query. In some cases role_combine_all may need to be set to true for this to work.
  • exclusive_username (string)
    • Username(s) to exclusively include in the users query result. Only profiles with usernames in this list will be displayed, and all others will be omitted.
  • flickr (boolean)
    • If true, limits the list of users to those who have set a value in their user profile for flickr_photoset_id
    • Default value: false
  • role (string)
    • Value can be 'faculty', 'adjunct', 'staff', 'student' - Or any combination of those values separated by a comma
    • Default value: 'faculty,adjunct,staff,student'
  • role_combine_all (boolean)
    • Combines the output of all users into one list. No headings are output (faculty, adjunct, staff, graduate student) and instead all users are output as one group ordered by the orderby option
    • Default value: false
  • role_combine_faculty_and_adjunct (boolean)
    • By default faculty and adjunct (faculty) are separated into two sections. If this is set to two both will be listed under the Faculty section
    • Default value: false
  • show_concentration (boolean)
    • Show / Hide concentration
    • Default value: false
  • show_department (boolean)
    • Show / Hide department
    • Default value: false
  • show_education (boolean)
    • Show / Hide education
    • Default value: false
  • show_email (boolean)
    • Show / Hide email
    • Default value: false
  • show_name (boolean)
    • Show / Hide name
    • Default value: true
  • show_office (boolean)
    • Show / Hide office
    • Default value: false
  • show_officehours (boolean)
    • Show / Hide office_hours
    • Default value: false
  • show_only (string)
    • Filtering options - if set to 'concentration' it will only display users with a value added to their concentration field. Multiple fields can be specified separated by a comma.
  • show_phone (boolean)
    • Show / Hide phone
    • Default value: false
  • show_position_title (boolean)
    • Show / Hide position_title
    • Default value: true
  • show_userphoto (boolean)
    • Show / Hide userphoto
    • Default value: true
  • show_website (boolean)
    • Show / Hide user website link
    • Default value: false

Examples:

[cla_people_list accordion="true" slider="true" department="cla-deans-office" show_website="true" /]
[cla_people_list department="cla-deans-office" show_website="true" exclude_username="russellj" /]

Individual

Legacy Shortcode: cla_people_individual

Options:

  • slider (boolean)
    • If true, queues the cla-people-slider.js to restyle the list into slider format - with next/previous pages and alphabetical listing
    • Default value: false
  • accordion (boolean)
    • If true, queues the cla-people-accordion.js to add the necessary JavaScript
    • Default value: false
  • network_users (boolean)
    • If true, pulls users from the entire multisite network rather than just the local site. Automatically sets the transient expiration to a much longer time if this is true.
    • Default value: false
  • order (string)
    • Value can be 'ASC' or 'DESC'.
    • Default value: 'ASC'
  • orderby (string)
    • Value can be 'ID', 'login', 'nicename', 'email', 'url', 'registered', 'display_name', 'post_count' - Alternatively, any other user meta key can be used, however if department is set (limiting users to a specific department) then orderby will be set to 'display_name'.
    • Default value: 'last_name'
  • department (string)
    • Value can be any slug value of a Department taxonomy_term, or multiple slugs separated by a comma - will only include users that have this department slug selected in their profile.
  • department_exclusive (boolean)
    • Only used if one department is listed. If true will only show users that exclusively belong to that department (rather than to multiple departments). If false will show users that belong to the designated department whether they belong to others as well, or not.
    • Default value: false
  • exclude_department (string)
    • Value can be any slug value of a Department taxonomy_term, or multiple slugs separated by a comma - will exclude all users that have this department slug selected in their profile (possible use is if a user has multiple departments selected and you only want users that exclusively belong to one department)
  • exclude_username (string)
    • Username(s) to be removed from the users query result if they are included
  • include_username (string)
    • Username(s) to be included that may not otherwise be included in the user query. In some cases role_combine_all may need to be set to true for this to work.
  • exclusive_username (string)
    • Username(s) to exclusively include in the users query result. Only profiles with usernames in this list will be displayed, and all others will be omitted.
  • flickr (boolean)
    • If true, limits the list of users to those who have set a value in their user profile for flickr_photoset_id
    • Default value: false
  • role (string)
    • Value can be 'faculty', 'adjunct', 'staff', 'student' - Or any combination of those values separated by a comma
    • Default value: 'faculty,adjunct,staff,student'
  • role_combine_all (boolean)
    • Combines the output of all users into one list. No headings are output (faculty, adjunct, staff, graduate student) and instead all users are output as one group ordered by the orderby option
    • Default value: false
  • role_combine_faculty_and_adjunct (boolean)
    • By default faculty and adjunct (faculty) are separated into two sections. If this is set to two both will be listed under the Faculty section
    • Default value: false
  • show_concentration (boolean)
    • Show / Hide concentration
    • Default value: false
  • show_department (boolean)
    • Show / Hide department
    • Default value: false
  • show_education (boolean)
    • Show / Hide education
    • Default value: false
  • show_email (boolean)
    • Show / Hide email
    • Default value: false
  • show_name (boolean)
    • Show / Hide name
    • Default value: true
  • show_office (boolean)
    • Show / Hide office
    • Default value: false
  • show_officehours (boolean)
    • Show / Hide office_hours
    • Default value: false
  • show_only (string)
    • Filtering options - if set to 'concentration' it will only display users with a value added to their concentration field. Multiple fields can be specified separated by a comma.
  • show_phone (boolean)
    • Show / Hide phone
    • Default value: false
  • show_position_title (boolean)
    • Show / Hide position_title
    • Default value: true
  • show_userphoto (boolean)
    • Show / Hide userphoto
    • Default value: true
  • show_website (boolean)
    • Show / Hide user website link
    • Default value: false

Examples:

[cla_people_list accordion="true" slider="true" department="cla-deans-office" show_website="true" /]
[cla_people_list department="cla-deans-office" show_website="true" exclude_username="russellj" /]

Profile

This will allow you to list the full content of a faculty or staff members' profile on any page. This is already built into the website theme for profile pages, so it's generally not needed, but there may be times when it's useful.

Legacy Shortcode: cla_people_profile

Options:

  • user_id (integer) (optional)
    • The id of the individual.
  • username (string) (optional)
    • The username of the individual
  • show_contact_information (boolean) (optional)
    • Show / Hide contact information
    • Default value: true
  • show_courses (boolean) (optional)
    • Show / Hide courses
    • Default value: true
  • show_curriculum_vitae (boolean) (optional)
    • Show / Hide curriculum vitae
    • Default value: true
  • show_education (boolean) (optional)
    • Show / Hide education
    • Default value: true
  • show_publications (boolean) (optional)
    • Show / Hide publications
    • Default value: true
  • show_flickr (boolean) (optional)
    • Show / Hide flickr
    • Default value: true

Examples:

[cla_people_profile username="russellj" /]

Link

There are times where it's necessary to link to a persons profile from another page, which is exactly what the [cla_people_link /] shortcode is for. This is the one instance where we recommend using the shortcode over the Beaver Builder module since it can be added inline with existing text.

Legacy Shortcode: cla_people_link

This shortcode differs from the others in the sense that it allows the use of "content", which is the text that goes between an opening and closing shortcode tag.

Options:

  • username (string) (optional)
    • The username of the person to use to make the link
  • name (string) (optional)
    • The name of the person to use to make the link

Examples:

[cla_people_link]John Russell[/cla_people_link]

In the above example "John Russell" is used in place of the name option.

[cla_people_link]Dr. John Russell[/cla_people_link]

All name prefixes (Dr., Mr., Ms., Mrs., etc) are dropped from the content in order to filter down to just the name. The words Instructor, Professor, Associate Professor, and Assistant Professor are also ignored when searching for the name, but will be displayed as part of the link.

[cla_people_link username="russellj"]John[/cla_people_link]

The username option can be specified instead of relying on the content. This guarantees that the correct profile is linked to.

[cla_people_link name="John Russell"]John[/cla_people_link]

The name option can be specified, much like the username, but may be more convenient. If the name is not working (since it must be a close match to their actual first and last name), try using the username option instead.

Related Articles
Categories
Tags