PHPXRef 0.7.1 : BuddyPress : Detail view of bp-members-template.php

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 URL base.

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.

param: string $member_type Optional. Member type. Defaults to current member type.
since: 2.5.0

bp_get_member_type_directory_permalink( $member_type = '' ) X-Ref

Return member type directory permalink.

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

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_members_invitations_slug() X-Ref

Output the members invitation pane slug.

since: 8.0.0

bp_get_members_invitations_slug() X-Ref

Return the members invitations root slug.

since: 8.0.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.

param: array|string $args {
since: 1.2.0
since: 7.0.0 Added `xprofile_query` parameter. Added `user_ids` parameter.
since: 10.0.0 Added `date_query` parameter.
return: bool Returns true when blogs are found, otherwise false.

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: int Member ID.

bp_member_class( $classes = array() X-Ref

Output the row class of the current member in the loop.

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

bp_get_member_class( $classes = array() X-Ref

Return the row class of the current member in the loop.

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

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
since: 10.0.0 Updated to get member ID from `bp_get_member_user_id`.
return: bool

bp_member_avatar( $args = '' ) X-Ref

Output a member's avatar.

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

bp_get_member_avatar( $args = '' ) X-Ref

Get a member's avatar.

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

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.

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

bp_get_member_last_active( $args = array() X-Ref

Return the current member's last active time.

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

bp_member_latest_update( $args = '' ) X-Ref

Output the latest update of the current member in the loop.

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

bp_get_member_latest_update( $args = '' ) X-Ref

Get the latest update from the current member in the loop.

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

bp_member_profile_data( $args = '' ) X-Ref

Output a piece of user profile data.

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

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.

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

bp_member_registered( $args = array() X-Ref

Output the 'registered [x days ago]' string for the current member.

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

bp_get_member_registered( $args = array() X-Ref

Get the 'registered [x days ago]' string for the current member.

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

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
since: 10.0.0 Updated to get member ID using `bp_get_member_user_id`.

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: string

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.

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

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.

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

bp_get_loggedin_user_avatar( $args = '' ) X-Ref

Get the logged-in user's avatar.

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

bp_displayed_user_avatar( $args = '' ) X-Ref

Output the displayed user's avatar.

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

bp_get_displayed_user_avatar( $args = '' ) X-Ref

Get the displayed user's avatar.

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

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.

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

bp_get_last_activity( $user_id = 0 ) X-Ref

Get the "active [x days ago]" string for a user.

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

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.

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

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_member_type_directory_link( $member_type = '' ) X-Ref

Output member type directory link.

param: string $member_type Unique member type identifier as used in bp_register_member_type().
since: 7.0.0

bp_get_member_type_directory_link( $member_type = '' ) X-Ref

Return member type directory link.

param: string $member_type Unique member type identifier as used in bp_register_member_type().
since: 7.0.0
return: string

bp_member_type_list( $user_id = 0, $r = array() X-Ref

Output a comma-delimited list of member types.

param: int $user_id User ID.
param: array $r Optional. Member type list arguments. Default empty array.
since: 7.0.0

bp_get_member_type_list( $user_id = 0, $r = array() X-Ref

Return a comma-delimited list of member types.

param: int $user_id User ID. Defaults to displayed user ID if on a member page.
param: array|string $r {
since: 7.0.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: bool 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.

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

bp_get_signup_avatar( $args = '' ) X-Ref

Get the user avatar during signup.

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

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_get_members_invitations_allowed() X-Ref

Are users allowed to invite users to join this site?

since: 8.0.0
return: bool

bp_get_membership_requests_required( $context = 'site' ) X-Ref

Are membership requests required for joining this site?

param: bool $context "raw" to fetch value from database,
since: 10.0.0
return: bool

bp_allow_access_to_registration_pages() X-Ref

Should the system create and allow access
to the Register and Activate pages?

since: 10.0.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.

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()}.
since: 1.5.0

bp_get_members_component_link( $component, $action = '', $query_args = '', $nonce = false ) X-Ref

Generate a link to a members component subpage.

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
since: 1.5.0
return: string

bp_avatar_delete_link() X-Ref

Render an avatar delete link.

since: 1.1.0
since: 6.0.0 Moved from /bp-xprofile/bp-xprofile-template.php to this file.

bp_get_avatar_delete_link() X-Ref

Return an avatar delete link.

since: 1.1.0
since: 6.0.0 Moved from /bp-xprofile/bp-xprofile-template.php to this file.
return: string

bp_has_members_invitations( $args = '' ) X-Ref

Initialize the community invitations loop.

Based on the $args passed, bp_has_invitations() populates
buddypress()->invitations->query_loop global, enabling the use of BP
templates and template functions to display a list of invitations.

param: array|string $args {
since: 8.0.0
return: bool

bp_the_members_invitations() X-Ref

Get the network invitations returned by the template loop.

since: 8.0.0
return: array List of network invitations.

bp_the_members_invitation() X-Ref

Get the current network invitation object in the loop.

since: 8.0.0
return: object The current network invitation within the loop.

bp_members_invitations_pagination_count() X-Ref

Output the pagination count for the current network invitations loop.

since: 8.0.0

bp_get_members_invitations_pagination_count() X-Ref

Return the pagination count for the current network invitation loop.

since: 8.0.0
return: string HTML for the pagination count.

bp_members_invitations_pagination_links() X-Ref

Output the pagination links for the current network invitation loop.

since: 8.0.0

bp_get_members_invitations_pagination_links() X-Ref

Return the pagination links for the current network invitations loop.

since: 8.0.0
return: string HTML for the pagination links.

bp_the_members_invitation_property( $property = '', $context = 'html' ) X-Ref

Output the requested property of the invitation currently being iterated on.

param: string $property The name of the property to display.
param: string $context The context of display.
since: 8.0.0

bp_get_the_members_invitation_property( $property = 'id' ) X-Ref

Return the value for a property of the network invitation currently being iterated on.

since: 8.0.0
return: int ID of the current network invitation.

bp_the_members_invitation_action_links( $args = '' ) X-Ref

Output the action links for the current invitation.

param: array|string $args Array of arguments.
since: 8.0.0

bp_get_the_members_invitation_action_links( $args = '' ) X-Ref

Return the action links for the current invitation.

param: array|string $args {
since: 8.0.0
return: string HTML links for actions to take on single notifications.

bp_the_members_invitations_resend_link( $user_id = 0 ) X-Ref

Output the resend link for the current invitation.

param: int $user_id The user ID.
since: 8.0.0

bp_get_the_members_invitation_resend_link( $user_id = 0 ) X-Ref

Return the resend link for the current notification.

param: int $user_id The user ID.
since: 8.0.0
return: string

bp_the_members_invitations_resend_url( $user_id = 0 ) X-Ref

Output the URL used for resending a single invitation.

Since this function directly outputs a URL, it is escaped.

param: int $user_id The user ID.
since: 8.0.0

bp_get_the_members_invitations_resend_url( $user_id = 0 ) X-Ref

Return the URL used for resending a single invitation.

param: int $user_id The user ID.
since: 8.0.0
return: string

bp_the_members_invitations_delete_link( $user_id = 0 ) X-Ref

Output the delete link for the current invitation.

param: int $user_id The user ID.
since: 8.0.0

bp_get_the_members_invitation_delete_link( $user_id = 0 ) X-Ref

Return the delete link for the current invitation.

param: int $user_id The user ID.
since: 8.0.0
return: string

bp_the_members_invitations_delete_url( $user_id = 0 ) X-Ref

Output the URL used for deleting a single invitation.

Since this function directly outputs a URL, it is escaped.

param: int $user_id The user ID.
since: 8.0.0

bp_get_the_members_invitations_delete_url( $user_id = 0 ) X-Ref

Return the URL used for deleting a single invitation.

param: int $user_id The user ID.
since: 8.0.0
return: string

bp_members_invitations_list_invites_permalink( $user_id = 0 ) X-Ref

Output the members invitations list permalink for a user.

param: int $user_id The user ID.
since: 8.0.0

bp_get_members_invitations_list_invites_permalink( $user_id = 0 ) X-Ref

Return the members invitations list permalink for a user.

since: 8.0.0
return: string Members invitations list permalink for a user.

bp_members_invitations_send_invites_permalink( $user_id = 0 ) X-Ref

Output the send invitation permalink for a user.

param: int $user_id The user ID.
since: 8.0.0

bp_get_members_invitations_send_invites_permalink( $user_id = 0 ) X-Ref

Return the send invitations permalink.

param: int $user_id The user ID.
since: 8.0.0
return: string The send invitations permalink.

bp_members_invitations_bulk_management_dropdown() X-Ref

Output the dropdown for bulk management of invitations.

since: 8.0.0

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

PHP Cross Reference of BuddyPress

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

Defines 158 functions