[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-members/ -> bp-members-template.php (summary)

BuddyPress Member Template Tags. Functions that are safe to use inside your template files and themes.

File Size: 2647 lines (74 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 123 functions

  bp_profile_slug()
  bp_get_profile_slug()
  bp_members_slug()
  bp_get_members_slug()
  bp_members_root_slug()
  bp_get_members_root_slug()
  bp_members_member_type_base()
  bp_get_members_member_type_base()
  bp_members_directory_permalink()
  bp_get_members_directory_permalink()
  bp_member_type_directory_permalink()
  bp_get_member_type_directory_permalink()
  bp_signup_slug()
  bp_get_signup_slug()
  bp_activate_slug()
  bp_get_activate_slug()
  bp_has_members()
  bp_the_member()
  bp_members()
  bp_members_pagination_count()
  bp_get_members_pagination_count()
  bp_members_pagination_links()
  bp_get_members_pagination_links()
  bp_member_user_id()
  bp_get_member_user_id()
  bp_member_class()
  bp_get_member_class()
  bp_member_user_nicename()
  bp_get_member_user_nicename()
  bp_member_user_login()
  bp_get_member_user_login()
  bp_member_user_email()
  bp_get_member_user_email()
  bp_member_is_loggedin_user()
  bp_member_avatar()
  bp_get_member_avatar()
  bp_member_permalink()
  bp_get_member_permalink()
  bp_member_link()
  bp_get_member_link()
  bp_member_name()
  bp_get_member_name()
  bp_member_last_active()
  bp_get_member_last_active()
  bp_member_latest_update()
  bp_get_member_latest_update()
  bp_member_profile_data()
  bp_get_member_profile_data()
  bp_member_registered()
  bp_get_member_registered()
  bp_member_random_profile_data()
  bp_member_hidden_fields()
  bp_directory_members_search_form()
  bp_total_site_member_count()
  bp_get_total_site_member_count()
  bp_get_loggedin_user_nav()
  bp_displayed_user_front_template_part()
  bp_displayed_user_get_front_template()
  bp_displayed_user_has_front_template()
  bp_get_displayed_user_nav()
  bp_displayed_user_use_cover_image_header()
  bp_loggedin_user_avatar()
  bp_get_loggedin_user_avatar()
  bp_displayed_user_avatar()
  bp_get_displayed_user_avatar()
  bp_displayed_user_email()
  bp_get_displayed_user_email()
  bp_last_activity()
  bp_get_last_activity()
  bp_user_firstname()
  bp_get_user_firstname()
  bp_loggedin_user_link()
  bp_get_loggedin_user_link()
  bp_displayed_user_link()
  bp_get_displayed_user_link()
  bp_user_link()
  bp_current_user_id()
  bp_displayed_user_domain()
  bp_loggedin_user_domain()
  bp_displayed_user_fullname()
  bp_get_displayed_user_fullname()
  bp_user_fullname()
  bp_loggedin_user_fullname()
  bp_get_loggedin_user_fullname()
  bp_displayed_user_username()
  bp_get_displayed_user_username()
  bp_loggedin_user_username()
  bp_get_loggedin_user_username()
  bp_current_member_type_message()
  bp_get_current_member_type_message()
  bp_has_custom_signup_page()
  bp_signup_page()
  bp_get_signup_page()
  bp_has_custom_activation_page()
  bp_activation_page()
  bp_get_activation_page()
  bp_get_current_activation_key()
  bp_signup_username_value()
  bp_get_signup_username_value()
  bp_signup_email_value()
  bp_get_signup_email_value()
  bp_signup_with_blog_value()
  bp_get_signup_with_blog_value()
  bp_signup_blog_url_value()
  bp_get_signup_blog_url_value()
  bp_signup_subdomain_base()
  bp_signup_get_subdomain_base()
  bp_signup_blog_title_value()
  bp_get_signup_blog_title_value()
  bp_signup_blog_privacy_value()
  bp_get_signup_blog_privacy_value()
  bp_signup_avatar_dir_value()
  bp_get_signup_avatar_dir_value()
  bp_signup_requires_privacy_policy_acceptance()
  bp_current_signup_step()
  bp_get_current_signup_step()
  bp_signup_avatar()
  bp_get_signup_avatar()
  bp_signup_allowed()
  bp_get_signup_allowed()
  bp_members_activity_feed()
  bp_members_component_link()
  bp_get_members_component_link()

Functions
Functions that are not part of a class:

bp_profile_slug()   X-Ref
Output the profile component slug.

since: 2.4.0

bp_get_profile_slug()   X-Ref
Return the profile component slug.

since: 2.4.0
return: string

bp_members_slug()   X-Ref
Output the members component slug.

since: 1.5.0

bp_get_members_slug()   X-Ref
Return the members component slug.

since: 1.5.0
return: string

bp_members_root_slug()   X-Ref
Output the members component root slug.

since: 1.5.0

bp_get_members_root_slug()   X-Ref
Return the members component root slug.

since: 1.5.0
return: string

bp_members_member_type_base()   X-Ref
Output the member type base slug.

since: 2.5.0

bp_get_members_member_type_base()   X-Ref
Get the member type base slug.

The base slug is the string used as the base prefix when generating member type directory URLs.
For example, in example.com/members/type/foo/, 'foo' is the member type and 'type' is the
base slug.

since: 2.5.0
return: string

bp_members_directory_permalink()   X-Ref
Output member directory permalink.

since: 1.5.0

bp_get_members_directory_permalink()   X-Ref
Return member directory permalink.

since: 1.5.0
return: string

bp_member_type_directory_permalink( $member_type = '' )   X-Ref
Output member type directory permalink.

since: 2.5.0
param: string $member_type Optional. Member type.

bp_get_member_type_directory_permalink( $member_type = '' )   X-Ref
Return member type directory permalink.

since: 2.5.0
return: string Member type directory URL on success, an empty string on failure.
param: string $member_type Optional. Member type. Defaults to current member type.

bp_signup_slug()   X-Ref
Output the sign-up slug.

since: 1.5.0

bp_get_signup_slug()   X-Ref
Return the sign-up slug.

since: 1.5.0
return: string

bp_activate_slug()   X-Ref
Output the activation slug.

since: 1.5.0

bp_get_activate_slug()   X-Ref
Return the activation slug.

since: 1.5.0
return: string

bp_has_members( $args = '' )   X-Ref
Initialize the members loop.

Based on the $args passed, bp_has_members() populates the $members_template
global, enabling the use of BuddyPress templates and template functions to
display a list of members.

since: 1.2.0
return: bool Returns true when blogs are found, otherwise false.
param: array|string $args {

bp_the_member()   X-Ref
Set up the current member inside the loop.

since: 1.2.0
return: object

bp_members()   X-Ref
Check whether there are more members to iterate over.

since: 1.2.0
return: bool

bp_members_pagination_count()   X-Ref
Output the members pagination count.

since: 1.2.0

bp_get_members_pagination_count()   X-Ref
Generate the members pagination count.

since: 1.5.0
return: string

bp_members_pagination_links()   X-Ref
Output the members pagination links.

since: 1.2.0

bp_get_members_pagination_links()   X-Ref
Fetch the members pagination links.

since: 1.2.0
return: string

bp_member_user_id()   X-Ref
Output the ID of the current member in the loop.

since: 1.2.0

bp_get_member_user_id()   X-Ref
Get the ID of the current member in the loop.

since: 1.2.0
return: string Member ID.

bp_member_class( $classes = array()   X-Ref
Output the row class of the current member in the loop.

since: 1.7.0
param: array $classes Array of custom classes.

bp_get_member_class( $classes = array()   X-Ref
Return the row class of the current member in the loop.

since: 1.7.0
return: string Row class of the member
param: array $classes Array of custom classes.

bp_member_user_nicename()   X-Ref
Output nicename of current member in the loop.

since: 1.2.5

bp_get_member_user_nicename()   X-Ref
Get the nicename of the current member in the loop.

since: 1.2.5
return: string Members nicename.

bp_member_user_login()   X-Ref
Output login for current member in the loop.

since: 1.2.5

bp_get_member_user_login()   X-Ref
Get the login of the current member in the loop.

since: 1.2.5
return: string Member's login.

bp_member_user_email()   X-Ref
Output the email address for the current member in the loop.

since: 1.2.5

bp_get_member_user_email()   X-Ref
Get the email address of the current member in the loop.

since: 1.2.5
return: string Member's email address.

bp_member_is_loggedin_user()   X-Ref
Check whether the current member in the loop is the logged-in user.

since: 1.2.5
return: bool

bp_member_avatar( $args = '' )   X-Ref
Output a member's avatar.

since: 1.2.0
param: array|string $args See {@link bp_get_member_avatar()}.

bp_get_member_avatar( $args = '' )   X-Ref
Get a member's avatar.

since: 1.2.0
return: string User avatar string.
param: array|string $args  {

bp_member_permalink()   X-Ref
Output the permalink for the current member in the loop.

since: 1.2.0

bp_get_member_permalink()   X-Ref
Get the permalink for the current member in the loop.

since: 1.2.0
return: string

bp_member_link()   X-Ref
Alias of {@link bp_member_permalink()}.

since: 1.2.0

bp_get_member_link()   X-Ref
Alias of {@link bp_get_member_permalink()}.

since: 1.2.0

bp_member_name()   X-Ref
Output display name of current member in the loop.

since: 1.2.0

bp_get_member_name()   X-Ref
Get the display name of the current member in the loop.

Full name is, by default, pulled from xprofile's Full Name field.
When this field is empty, we try to get an alternative name from the
WP users table, in the following order of preference: display_name,
user_nicename, user_login.

since: 1.2.0
return: string The user's fullname for display.

bp_member_last_active( $args = array()   X-Ref
Output the current member's last active time.

since: 1.2.0
param: array $args {@see bp_get_member_last_active()}.

bp_get_member_last_active( $args = array()   X-Ref
Return the current member's last active time.

since: 1.2.0
since: 2.7.0 Added 'relative' as a parameter to $args.
return: string
param: array $args {

bp_member_latest_update( $args = '' )   X-Ref
Output the latest update of the current member in the loop.

since: 1.2.0
param: array|string $args {@see bp_get_member_latest_update()}.

bp_get_member_latest_update( $args = '' )   X-Ref
Get the latest update from the current member in the loop.

since: 1.2.0
return: string
param: array|string $args {

bp_member_profile_data( $args = '' )   X-Ref
Output a piece of user profile data.

since: 1.2.0
param: array|string $args See {@link bp_get_member_profile_data()}.

bp_get_member_profile_data( $args = '' )   X-Ref
Get a piece of user profile data.

When used in a bp_has_members() loop, this function will attempt
to fetch profile data cached in the template global. It is also safe
to use outside of the loop.

since: 1.2.0
return: string|bool Profile data if found, otherwise false.
param: array|string $args {

bp_member_registered( $args = array()   X-Ref
Output the 'registered [x days ago]' string for the current member.

since: 1.2.0
since: 2.7.0 Added $args as a parameter.
param: array $args Optional. {@see bp_get_member_registered()}

bp_get_member_registered( $args = array()   X-Ref
Get the 'registered [x days ago]' string for the current member.

since: 1.2.0
since: 2.7.0 Added $args as a parameter.
return: string
param: array $args {

bp_member_random_profile_data()   X-Ref
Output a random piece of profile data for the current member in the loop.

since: 1.2.0

bp_member_hidden_fields()   X-Ref
Output hidden input for preserving member search params on form submit.

since: 1.2.0

bp_directory_members_search_form()   X-Ref
Output the Members directory search form.

since: 1.0.0

bp_total_site_member_count()   X-Ref
Output the total member count.

since: 1.2.0

bp_get_total_site_member_count()   X-Ref
Get the total site member count.

since: 1.2.0
return: int

bp_get_loggedin_user_nav()   X-Ref
Render the navigation markup for the logged-in user.

Each component adds to this navigation array within its own
[component_name]setup_nav() function.

This navigation array is the top level navigation, so it contains items such as:
[Blog, Profile, Messages, Groups, Friends] ...

The function will also analyze the current component the user is in, to
determine whether or not to highlight a particular nav item.

since: 1.1.0

bp_displayed_user_front_template_part()   X-Ref
Output the contents of the current user's home page.

since: 2.6.0

bp_displayed_user_get_front_template( $displayed_user = null )   X-Ref
Locate a custom user front template if it exists.

since: 2.6.0
return: string|bool                 Path to front template on success; boolean false on failure.
param: object|null $displayed_user Optional. Falls back to current user if not passed.

bp_displayed_user_has_front_template()   X-Ref
Check if the displayed user has a custom front template.

since: 2.6.0

bp_get_displayed_user_nav()   X-Ref
Render the navigation markup for the displayed user.

since: 1.1.0

bp_displayed_user_use_cover_image_header()   X-Ref
Should we use the cover image header

since: 2.4.0
return: bool True if the displayed user has a cover image,

bp_loggedin_user_avatar( $args = '' )   X-Ref
Output the logged-in user's avatar.

since: 1.1.0
param: array|string $args {@see bp_get_loggedin_user_avatar()}.

bp_get_loggedin_user_avatar( $args = '' )   X-Ref
Get the logged-in user's avatar.

since: 1.1.0
return: string User avatar string.
param: array|string $args  {

bp_displayed_user_avatar( $args = '' )   X-Ref
Output the displayed user's avatar.

since: 1.1.0
param: array|string $args {@see bp_get_displayed_user_avatar()}.

bp_get_displayed_user_avatar( $args = '' )   X-Ref
Get the displayed user's avatar.

since: 1.1.0
return: string User avatar string.
param: array|string $args  {

bp_displayed_user_email()   X-Ref
Output the email address of the displayed user.

since: 1.5.0

bp_get_displayed_user_email()   X-Ref
Get the email address of the displayed user.

since: 1.5.0
return: string

bp_last_activity( $user_id = 0 )   X-Ref
Output the "active [x days ago]" string for a user.

since: 1.0.0
param: int $user_id See {@link bp_get_last_activity()}.

bp_get_last_activity( $user_id = 0 )   X-Ref
Get the "active [x days ago]" string for a user.

since: 1.5.0
return: string
param: int $user_id ID of the user. Default: displayed user ID.

bp_user_firstname()   X-Ref
Output the calculated first name of the displayed or logged-in user.

since: 1.2.0

bp_get_user_firstname( $name = false )   X-Ref
Output the first name of a user.

Simply takes all the characters before the first space in a name.

since: 1.2.0
return: string
param: string|bool $name Full name to use when generating first name.

bp_loggedin_user_link()   X-Ref
Output the link for the logged-in user's profile.

since: 1.2.4

bp_get_loggedin_user_link()   X-Ref
Get the link for the logged-in user's profile.

since: 1.0.0
return: string

bp_displayed_user_link()   X-Ref
Output the link for the displayed user's profile.

since: 1.2.4

bp_get_displayed_user_link()   X-Ref
Get the link for the displayed user's profile.

since: 1.0.0
return: string

bp_user_link()   X-Ref
Alias of {@link bp_displayed_user_domain()}.


bp_current_user_id()   X-Ref
Alias of {@link bp_displayed_user_id()}.

since: 1.0.0

bp_displayed_user_domain()   X-Ref
Generate the link for the displayed user's profile.

since: 1.0.0
return: string

bp_loggedin_user_domain()   X-Ref
Generate the link for the logged-in user's profile.

since: 1.0.0
return: string

bp_displayed_user_fullname()   X-Ref
Output the displayed user's display name.

since: 1.0.0

bp_get_displayed_user_fullname()   X-Ref
Get the displayed user's display name.

since: 1.2.0
return: string

bp_user_fullname()   X-Ref
Alias of {@link bp_get_displayed_user_fullname()}.

since: 1.0.0

bp_loggedin_user_fullname()   X-Ref
Output the logged-in user's display name.

since: 1.0.0

bp_get_loggedin_user_fullname()   X-Ref
Get the logged-in user's display name.

since: 1.0.0
return: string

bp_displayed_user_username()   X-Ref
Output the username of the displayed user.

since: 1.2.0

bp_get_displayed_user_username()   X-Ref
Get the username of the displayed user.

since: 1.2.0
return: string

bp_loggedin_user_username()   X-Ref
Output the username of the logged-in user.

since: 1.2.0

bp_get_loggedin_user_username()   X-Ref
Get the username of the logged-in user.

since: 1.2.0
return: string

bp_current_member_type_message()   X-Ref
Echo the current member type message.

since: 2.3.0

bp_get_current_member_type_message()   X-Ref
Generate the current member type message.

since: 2.3.0
return: string

bp_has_custom_signup_page()   X-Ref
Do we have a working custom sign up page?

since: 1.5.0
return: bool True if page and template exist, false if not.

bp_signup_page()   X-Ref
Output the URL to the signup page.

since: 1.0.0

bp_get_signup_page()   X-Ref
Get the URL to the signup page.

since: 1.1.0
return: string

bp_has_custom_activation_page()   X-Ref
Do we have a working custom activation page?

since: 1.5.0
return: boolean True if page and template exist, false if not.

bp_activation_page()   X-Ref
Output the URL of the activation page.

since: 1.0.0

bp_get_activation_page()   X-Ref
Get the URL of the activation page.

since: 1.2.0
return: string

bp_get_current_activation_key()   X-Ref
Get the activation key from the current request URL.

since: 3.0.0
return: string

bp_signup_username_value()   X-Ref
Output the username submitted during signup.

since: 1.1.0

bp_get_signup_username_value()   X-Ref
Get the username submitted during signup.

since: 1.1.0
return: string

bp_signup_email_value()   X-Ref
Output the user email address submitted during signup.

since: 1.1.0

bp_get_signup_email_value()   X-Ref
Get the email address submitted during signup.

since: 1.1.0
return: string

bp_signup_with_blog_value()   X-Ref
Output the 'signup_with_blog' value submitted during signup.

since: 1.1.0

bp_get_signup_with_blog_value()   X-Ref
Get the 'signup_with_blog' value submitted during signup.

since: 1.1.0
return: string

bp_signup_blog_url_value()   X-Ref
Output the 'signup_blog_url' value submitted at signup.

since: 1.1.0

bp_get_signup_blog_url_value()   X-Ref
Get the 'signup_blog_url' value submitted at signup.

since: 1.1.0
return: string

bp_signup_subdomain_base()   X-Ref
Output the base URL for subdomain installations of WordPress Multisite.

since: 2.1.0

bp_signup_get_subdomain_base()   X-Ref
Return the base URL for subdomain installations of WordPress Multisite.

Replaces bp_blogs_get_subdomain_base()

since: 2.1.0
return: string The base URL - eg, 'example.com' for site_url() example.com or www.example.com.

bp_signup_blog_title_value()   X-Ref
Output the 'signup_blog_titl' value submitted at signup.

since: 1.1.0

bp_get_signup_blog_title_value()   X-Ref
Get the 'signup_blog_title' value submitted at signup.

since: 1.1.0
return: string

bp_signup_blog_privacy_value()   X-Ref
Output the 'signup_blog_privacy' value submitted at signup.

since: 1.1.0

bp_get_signup_blog_privacy_value()   X-Ref
Get the 'signup_blog_privacy' value submitted at signup.

since: 1.1.0
return: string

bp_signup_avatar_dir_value()   X-Ref
Output the avatar dir used during signup.

since: 1.1.0

bp_get_signup_avatar_dir_value()   X-Ref
Get the avatar dir used during signup.

since: 1.1.0
return: string

bp_signup_requires_privacy_policy_acceptance()   X-Ref
Determines whether privacy policy acceptance is required for registration.

since: 4.0.0
return: bool

bp_current_signup_step()   X-Ref
Output the current signup step.

since: 1.1.0

bp_get_current_signup_step()   X-Ref
Get the current signup step.

since: 1.1.0
return: string

bp_signup_avatar( $args = '' )   X-Ref
Output the user avatar during signup.

since: 1.1.0
param: array|string $args See {@link bp_get_signup_avatar(}.

bp_get_signup_avatar( $args = '' )   X-Ref
Get the user avatar during signup.

since: 1.1.0
return: string
param: array|string $args {

bp_signup_allowed()   X-Ref
Output whether signup is allowed.

since: 1.1.0

bp_get_signup_allowed()   X-Ref
Is user signup allowed?

since: 1.1.0
return: bool

bp_members_activity_feed()   X-Ref
Hook member activity feed to <head>.

since: 1.5.0

bp_members_component_link( $component, $action = '', $query_args = '', $nonce = false )   X-Ref
Output a link to a members component subpage.

since: 1.5.0
param: string      $component See {@bp_get_members_component_link()}.
param: string      $action See {@bp_get_members_component_link()}.
param: string      $query_args See {@bp_get_members_component_link()}.
param: string|bool $nonce See {@bp_get_members_component_link()}.

bp_get_members_component_link( $component, $action = '', $query_args = '', $nonce = false )   X-Ref
Generate a link to a members component subpage.

since: 1.5.0
return: string
param: string       $component  ID of the component (eg 'friends').
param: string       $action     Optional. 'action' slug (eg 'invites').
param: array|string $query_args Optional. Array of URL params to add to the
param: array|bool   $nonce      Optional. If provided, the URL will be passed



Generated: Thu Sep 19 01:01:39 2019 Cross-referenced by PHPXref 0.7.1