[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

Core component template tag functions.

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

Defines 140 functions

  bp_get_options_nav()
  bp_get_options_title()
  bp_get_directory_title()
  bp_has_options_avatar()
  bp_get_options_avatar()
  bp_comment_author_avatar()
  bp_post_author_avatar()
  bp_avatar_admin_step()
  bp_get_avatar_admin_step()
  bp_avatar_to_crop()
  bp_get_avatar_to_crop()
  bp_avatar_to_crop_src()
  bp_get_avatar_to_crop_src()
  bp_avatar_cropper()
  bp_site_name()
  bp_get_site_name()
  bp_format_time()
  bp_word_or_name()
  bp_styles()
  bp_search_form_action()
  bp_search_form_type_select()
  bp_search_input_name()
  bp_get_search_input_name()
  bp_search_placeholder()
  bp_get_search_placeholder()
  bp_search_default_text()
  bp_get_search_default_text()
  bp_custom_profile_boxes()
  bp_custom_profile_sidebar_boxes()
  bp_form_field_attributes()
  bp_get_form_field_attributes()
  bp_button()
  bp_get_button()
  bp_create_excerpt()
  bp_total_member_count()
  bp_get_total_member_count()
  bp_blog_signup_allowed()
  bp_get_blog_signup_allowed()
  bp_account_was_activated()
  bp_registration_needs_activation()
  bp_get_email_subject()
  bp_ajax_querystring()
  bp_current_component()
  bp_current_action()
  bp_current_item()
  bp_action_variables()
  bp_action_variable()
  bp_root_domain()
  bp_get_root_domain()
  bp_root_slug()
  bp_get_root_slug()
  bp_get_name_from_root_slug()
  bp_user_has_access()
  bp_search_slug()
  bp_get_search_slug()
  bp_displayed_user_id()
  bp_loggedin_user_id()
  bp_is_current_component()
  bp_is_current_action()
  bp_is_action_variable()
  bp_is_current_item()
  bp_is_single_item()
  bp_is_item_admin()
  bp_is_item_mod()
  bp_is_directory()
  bp_is_root_component()
  bp_is_component_front_page()
  bp_is_blog_page()
  is_buddypress()
  bp_is_active()
  bp_is_members_component()
  bp_is_profile_component()
  bp_is_activity_component()
  bp_is_blogs_component()
  bp_is_messages_component()
  bp_is_friends_component()
  bp_is_groups_component()
  bp_is_forums_component()
  bp_is_notifications_component()
  bp_is_settings_component()
  bp_is_current_component_core()
  bp_is_activity_directory()
  bp_is_single_activity()
  bp_is_members_directory()
  bp_is_my_profile()
  bp_is_user()
  bp_is_user_front()
  bp_is_user_activity()
  bp_is_user_friends_activity()
  bp_is_user_groups_activity()
  bp_is_user_profile()
  bp_is_user_profile_edit()
  bp_is_user_change_avatar()
  bp_is_user_change_cover_image()
  bp_is_user_groups()
  bp_is_user_blogs()
  bp_is_user_recent_posts()
  bp_is_user_recent_commments()
  bp_is_user_friends()
  bp_is_user_friend_requests()
  bp_is_user_notifications()
  bp_is_user_settings()
  bp_is_user_settings_general()
  bp_is_user_settings_notifications()
  bp_is_user_settings_account_delete()
  bp_is_user_settings_profile()
  bp_is_groups_directory()
  bp_is_group()
  bp_is_group_home()
  bp_is_group_create()
  bp_is_group_admin_page()
  bp_is_group_activity()
  bp_is_group_forum_topic()
  bp_is_group_forum_topic_edit()
  bp_is_group_members()
  bp_is_group_invites()
  bp_is_group_membership_request()
  bp_is_group_leave()
  bp_is_group_single()
  bp_is_group_custom_front()
  bp_is_create_blog()
  bp_is_blogs_directory()
  bp_is_user_messages()
  bp_is_messages_inbox()
  bp_is_messages_sentbox()
  bp_is_messages_compose_screen()
  bp_is_notices()
  bp_is_messages_conversation()
  bp_is_single()
  bp_is_activation_page()
  bp_is_register_page()
  bp_get_title_parts()
  bp_the_body_class()
  bp_get_the_body_class()
  bp_get_the_post_class()
  _bp_nav_menu_sort()
  bp_get_nav_menu_items()
  bp_nav_menu()
  bp_email_the_salutation()
  bp_email_get_salutation()

Functions
Functions that are not part of a class:

bp_get_options_nav( $parent_slug = '' )   X-Ref
Output the "options nav", the secondary-level single item navigation menu.

Uses the component's nav global to render out the sub navigation for the
current component. Each component adds to its sub navigation array within
its own setup_nav() function.

This sub navigation array is the secondary level navigation, so for profile
it contains:
[Public, Edit Profile, Change Avatar]

The function will also analyze the current action for the current component
to determine whether or not to highlight a particular sub nav item.

since: 1.0.0
return: string
param: string $parent_slug Options nav slug.

bp_get_options_title()   X-Ref
Get the 'bp_options_title' property from the BP global.

Not currently used in BuddyPress.


bp_get_directory_title( $component = '' )   X-Ref
Get the directory title for a component.

Used for the <title> element and the page header on the component directory
page.

since: 2.0.0
return: string
param: string $component Component to get directory title for.

bp_has_options_avatar()   X-Ref
Check to see if there is an options avatar.

An options avatar is an avatar for something like a group, or a friend.
Basically an avatar that appears in the sub nav options bar.

Not currently used in BuddyPress.

return: bool $value Returns true if an options avatar has been set, otherwise false.

bp_get_options_avatar()   X-Ref
Output the options avatar.

Not currently used in BuddyPress.


bp_comment_author_avatar()   X-Ref
Output a comment author's avatar.

Not currently used in BuddyPress.

bp_post_author_avatar()   X-Ref
Output a post author's avatar.

Not currently used in BuddyPress.

bp_avatar_admin_step()   X-Ref
Output the current avatar upload step.

since: 1.1.0

bp_get_avatar_admin_step()   X-Ref
Return the current avatar upload step.

since: 1.1.0
return: string The current avatar upload step. Returns 'upload-image'

bp_avatar_to_crop()   X-Ref
Output the URL of the avatar to crop.

since: 1.1.0

bp_get_avatar_to_crop()   X-Ref
Return the URL of the avatar to crop.

since: 1.1.0
return: string URL of the avatar awaiting cropping.

bp_avatar_to_crop_src()   X-Ref
Output the relative file path to the avatar to crop.

since: 1.1.0

bp_get_avatar_to_crop_src()   X-Ref
Return the relative file path to the avatar to crop.

since: 1.1.0
return: string Relative file path to the avatar.

bp_avatar_cropper()   X-Ref
Output the avatar cropper <img> markup.

No longer used in BuddyPress.


bp_site_name()   X-Ref
Output the name of the BP site. Used in RSS headers.

since: 1.0.0

bp_get_site_name()   X-Ref
Returns the name of the BP site. Used in RSS headers.

since: 1.6.0
return: string

bp_format_time( $time = '', $exclude_time = false, $gmt = true )   X-Ref
Format a date based on a UNIX timestamp.

This function can be used to turn a UNIX timestamp into a properly formatted
(and possibly localized) string, userful for ouputting the date & time an
action took place.

Not to be confused with `bp_core_time_since()`, this function is best used
for displaying a more exact date and time vs. a human-readable time.

Note: This function may be improved or removed at a later date, as it is
hardly used and adds an additional layer of complexity to calculating dates
and times together with timezone offsets and i18n.

since: 1.1.0
return: mixed A string representation of $time, in the format
param: int|string $time         The UNIX timestamp to be formatted.
param: bool       $exclude_time Optional. True to return only the month + day, false
param: bool       $gmt          Optional. True to display in local time, false to

bp_word_or_name( $youtext, $nametext, $capitalize = true, $echo = true )   X-Ref
Select between two dynamic strings, according to context.

This function can be used in cases where a phrase used in a template will
differ for a user looking at his own profile and a user looking at another
user's profile (eg, "My Friends" and "Joe's Friends"). Pass both versions
of the phrase, and bp_word_or_name() will detect which is appropriate, and
do the necessary argument swapping for dynamic phrases.

since: 1.0.0
return: string|null $nametext If ! $echo, returns the appropriate string.
param: string $youtext    The "you" version of the phrase (eg "Your Friends").
param: string $nametext   The other-user version of the phrase. Should be in
param: bool   $capitalize Optional. Force into title case. Default: true.
param: bool   $echo       Optional. True to echo the results, false to return them.

bp_styles()   X-Ref
Do the 'bp_styles' action, and call wp_print_styles().

No longer used in BuddyPress.


bp_search_form_action()   X-Ref
Return the "action" attribute for search forms.

since: 1.0.0
return: string URL action attribute for search forms, eg example.com/search/.

bp_search_form_type_select()   X-Ref
Generate the basic search form as used in BP-Default's header.

since: 1.0.0
return: string HTML <select> element.

bp_search_input_name( $component = '' )   X-Ref
Output the 'name' attribute for search form input element.

since: 2.7.0
param: string $component See bp_get_search_input_name().

bp_get_search_input_name( $component = '' )   X-Ref
Get the 'name' attribute for the search form input element.

since: 2.7.0
return: string Text for the 'name' attribute.
param: string $component Component name. Defaults to current component.

bp_search_placeholder( $component = '' )   X-Ref
Output the placeholder text for the search box for a given component.

since: 2.7.0
param: string $component See bp_get_search_placeholder().

bp_get_search_placeholder( $component = '' )   X-Ref
Get the placeholder text for the search box for a given component.

since: 2.7.0
return: string Placeholder text for the search field.
param: string $component Component name. Defaults to current component.

bp_search_default_text( $component = '' )   X-Ref
Output the default text for the search box for a given component.

since: 1.5.0
param: string $component See {@link bp_get_search_default_text()}.

bp_get_search_default_text( $component = '' )   X-Ref
Return the default text for the search box for a given component.

since: 1.5.0
return: string Placeholder text for search field.
param: string $component Component name. Default: current component.

bp_custom_profile_boxes()   X-Ref
Fire the 'bp_custom_profile_boxes' action.

No longer used in BuddyPress.


bp_custom_profile_sidebar_boxes()   X-Ref
Fire the 'bp_custom_profile_sidebar_boxes' action.

No longer used in BuddyPress.


bp_form_field_attributes( $name = '', $attributes = array()   X-Ref
Output the attributes for a form field.

since: 2.2.0
param: string $name       The field name to output attributes for.
param: array  $attributes Array of existing attributes to add.

bp_get_form_field_attributes( $name = '', $attributes = array()   X-Ref
Get the attributes for a form field.

Primarily to add better support for touchscreen devices, but plugin devs
can use the 'bp_get_form_field_extra_attributes' filter for further
manipulation.

since: 2.2.0
return: string
param: string $name       The field name to get attributes for.
param: array  $attributes Array of existing attributes to add.

bp_button( $args = '' )   X-Ref
Create and output a button.

since: 1.2.6
param: array|string $args See {@link BP_Button}.

bp_get_button( $args = '' )   X-Ref
Create and return a button.

since: 1.2.6
return: string HTML markup for the button.
param: array|string $args See {@link BP_Button}.

bp_create_excerpt( $text, $length = 225, $options = array()   X-Ref
Truncate text.

Cuts a string to the length of $length and replaces the last characters
with the ending if the text is longer than length.

This function is borrowed from CakePHP v2.0, under the MIT license. See
http://book.cakephp.org/view/1469/Text#truncate-1625

since: 1.0.0
since: 2.6.0 Added 'strip_tags' and 'remove_links' as $options args.
return: string Trimmed string.
param: string $text   String to truncate.
param: int    $length Optional. Length of returned string, including ellipsis.
param: array  $options {

bp_total_member_count()   X-Ref
Output the total member count for the site.

since: 1.2.0

bp_get_total_member_count()   X-Ref
Return the total member count in your BP instance.

Since BuddyPress 1.6, this function has used bp_core_get_active_member_count(),
which counts non-spam, non-deleted users who have last_activity.
This value will correctly match the total member count number used
for pagination on member directories.

Before BuddyPress 1.6, this function used bp_core_get_total_member_count(),
which did not take into account last_activity, and thus often
resulted in higher counts than shown by member directory pagination.

since: 1.2.0
return: int Member count.

bp_blog_signup_allowed()   X-Ref
Output whether blog signup is allowed.


bp_get_blog_signup_allowed()   X-Ref
Is blog signup allowed?

Returns true if is_multisite() and blog creation is enabled at
Network Admin > Settings.

since: 1.2.0
return: bool True if blog signup is allowed, otherwise false.

bp_account_was_activated()   X-Ref
Check whether an activation has just been completed.

since: 1.1.0
return: bool True if the activation_complete global flag has been set,

bp_registration_needs_activation()   X-Ref
Check whether registrations require activation on this installation.

On a normal BuddyPress installation, all registrations require email
activation. This filter exists so that customizations that omit activation
can remove certain notification text from the registration screen.

since: 1.2.0
return: bool True by default.

bp_get_email_subject( $args = array()   X-Ref
Retrieve a client friendly version of the root blog name.

The blogname option is escaped with esc_html on the way into the database in
sanitize_option, we want to reverse this for the plain text arena of emails.

since: 1.7.0
since: 2.5.0 No longer used by BuddyPress, but not deprecated in case any existing plugins use it.
return: string Sanitized email subject.
param: array $args {

bp_ajax_querystring( $object = false )   X-Ref
Allow templates to pass parameters directly into the template loops via AJAX.

For the most part this will be filtered in a theme's functions.php for
example in the default theme it is filtered via bp_dtheme_ajax_querystring().

By using this template tag in the templates it will stop them from showing
errors if someone copies the templates from the default theme into another
WordPress theme without coping the functions from functions.php.

since: 1.2.0
return: string The AJAX querystring.
param: string|bool $object Current template component.

bp_current_component()   X-Ref
Return the name of the current component.

since: 1.0.0
return: string Component name.

bp_current_action()   X-Ref
Return the name of the current action.

since: 1.0.0
return: string Action name.

bp_current_item()   X-Ref
Return the name of the current item.

since: 1.1.0
return: string|bool

bp_action_variables()   X-Ref
Return the value of $bp->action_variables.

since: 1.0.0
return: array|bool $action_variables The action variables array, or false

bp_action_variable( $position = 0 )   X-Ref
Return the value of a given action variable.

since: 1.5.0
return: string|bool $action_variable The value of that position in the
param: int $position The key of the action_variables array that you want.

bp_root_domain()   X-Ref
Output the "root domain", the URL of the BP root blog.

since: 1.1.0

bp_get_root_domain()   X-Ref
Return the "root domain", the URL of the BP root blog.

since: 1.1.0
return: string URL of the BP root blog.

bp_root_slug( $component = '' )   X-Ref
Output the root slug for a given component.

since: 1.5.0
param: string $component The component name.

bp_get_root_slug( $component = '' )   X-Ref
Get the root slug for given component.

The "root slug" is the string used when concatenating component
directory URLs. For example, on an installation where the Groups
component's directory is located at http://example.com/groups/, the
root slug for the Groups component is 'groups'. This string
generally corresponds to page_name of the component's directory
page.

In order to maintain backward compatibility, the following procedure
is used:
1) Use the short slug to get the canonical component name from the
active component array.
2) Use the component name to get the root slug out of the
appropriate part of the $bp global.
3) If nothing turns up, it probably means that $component is itself
a root slug.

Example: If your groups directory is at /community/companies, this
function first uses the short slug 'companies' (ie the current
component) to look up the canonical name 'groups' in
$bp->active_components. Then it uses 'groups' to get the root slug,
from $bp->groups->root_slug.

since: 1.5.0
return: string $root_slug The root slug.
param: string $component Optional. Defaults to the current component.

bp_get_name_from_root_slug( $root_slug = '' )   X-Ref
Return the component name based on a root slug.

since: 1.5.0
return: mixed False if none found, component name if found.
param: string $root_slug Needle to our active component haystack.

bp_user_has_access()   X-Ref
Returns whether or not a user has access.

since: 1.2.4
return: bool

bp_search_slug()   X-Ref
Output the search slug.

since: 1.5.0

bp_get_search_slug()   X-Ref
Return the search slug.

since: 1.5.0
return: string The search slug. Default: 'search'.

bp_displayed_user_id()   X-Ref
Get the ID of the currently displayed user.

since: 1.0.0
return: int $id ID of the currently displayed user.

bp_loggedin_user_id()   X-Ref
Get the ID of the currently logged-in user.

since: 1.0.0
return: int ID of the logged-in user.

bp_is_current_component( $component = '' )   X-Ref
Check to see whether the current page belongs to the specified component.

This function is designed to be generous, accepting several different kinds
of value for the $component parameter. It checks $component_name against:
- the component's root_slug, which matches the page slug in $bp->pages.
- the component's regular slug.
- the component's id, or 'canonical' name.

since: 1.5.0
return: bool Returns true if the component matches, or else false.
param: string $component Name of the component being checked.

bp_is_current_action( $action = '' )   X-Ref
Check to see whether the current page matches a given action.

Along with bp_is_current_component() and bp_is_action_variable(), this
function is mostly used to help determine when to use a given screen
function.

In BP parlance, the current_action is the URL chunk that comes directly
after the current item slug. E.g., in
http://example.com/groups/my-group/members
the current_action is 'members'.

since: 1.5.0
return: bool True if the current action matches $action.
param: string $action The action being tested against.

bp_is_action_variable( $action_variable = '', $position = false )   X-Ref
Check to see whether the current page matches a given action_variable.

Along with bp_is_current_component() and bp_is_current_action(), this
function is mostly used to help determine when to use a given screen
function.

In BP parlance, action_variables are an array made up of the URL chunks
appearing after the current_action in a URL. For example,
http://example.com/groups/my-group/admin/group-settings
$action_variables[0] is 'group-settings'.

since: 1.5.0
return: bool True if $action_variable matches at the $position provided.
param: string   $action_variable The action_variable being tested against.
param: int|bool $position        Optional. The array key you're testing against. If you

bp_is_current_item( $item = '' )   X-Ref
Check against the current_item.

since: 1.5.0
return: bool True if $item is the current item.
param: string $item The item being checked.

bp_is_single_item()   X-Ref
Are we looking at a single item? (group, user, etc).

since: 1.1.0
return: bool True if looking at a single item, otherwise false.

bp_is_item_admin()   X-Ref
Is the logged-in user an admin for the current item?

since: 1.5.0
return: bool True if the current user is an admin for the current item,

bp_is_item_mod()   X-Ref
Is the logged-in user a mod for the current item?

since: 1.5.0
return: bool True if the current user is a mod for the current item,

bp_is_directory()   X-Ref
Is this a component directory page?

since: 1.0.0
return: bool True if the current page is a component directory, otherwise false.

bp_is_root_component( $component_name = '' )   X-Ref
Check to see if a component's URL should be in the root, not under a member page.

- Yes ('groups' is root)    : http://example.com/groups/the-group
- No  ('groups' is not-root): http://example.com/members/andy/groups/the-group

This function is on the chopping block. It's currently only used by a few
already deprecated functions.

since: 1.5.0
return: bool True if root component, else false.
param: string $component_name Component name to check.

bp_is_component_front_page( $component = '' )   X-Ref
Check if the specified BuddyPress component directory is set to be the front page.

Corresponds to the setting in wp-admin's Settings > Reading screen.

since: 1.5.0
return: bool True if the specified component is set to be the site's front
param: string $component Optional. Name of the component to check for.

bp_is_blog_page()   X-Ref
Is this a blog page, ie a non-BP page?

You can tell if a page is displaying BP content by whether the
current_component has been defined.

since: 1.0.0
return: bool True if it's a non-BP page, false otherwise.

is_buddypress()   X-Ref
Is this a BuddyPress component?

You can tell if a page is displaying BP content by whether the
current_component has been defined.

Generally, we can just check to see that there's no current component.
The one exception is single user home tabs, where $bp->current_component
is unset. Thus the addition of the bp_is_user() check.

since: 1.7.0
return: bool True if it's a BuddyPress page, false otherwise.

bp_is_active( $component = '', $feature = '' )   X-Ref
Check whether a given component (or feature of a component) is active.

since: 1.2.0 See r2539.
since: 2.3.0 Added $feature as a parameter.
return: bool
param: string $component The component name.
param: string $feature   The feature name.

bp_is_members_component()   X-Ref
Check whether the current page is part of the Members component.

since: 1.5.0
return: bool True if the current page is part of the Members component.

bp_is_profile_component()   X-Ref
Check whether the current page is part of the Profile component.

since: 1.1.0
return: bool True if the current page is part of the Profile component.

bp_is_activity_component()   X-Ref
Check whether the current page is part of the Activity component.

since: 1.1.0
return: bool True if the current page is part of the Activity component.

bp_is_blogs_component()   X-Ref
Check whether the current page is part of the Blogs component.

since: 1.1.0
return: bool True if the current page is part of the Blogs component.

bp_is_messages_component()   X-Ref
Check whether the current page is part of the Messages component.

since: 1.1.0
return: bool True if the current page is part of the Messages component.

bp_is_friends_component()   X-Ref
Check whether the current page is part of the Friends component.

since: 1.1.0
return: bool True if the current page is part of the Friends component.

bp_is_groups_component()   X-Ref
Check whether the current page is part of the Groups component.

since: 1.1.0
return: bool True if the current page is part of the Groups component.

bp_is_forums_component()   X-Ref
Check whether the current page is part of the Forums component.

since: 1.5.0
since: 3.0.0 Required for bbPress 2 integration.
return: bool True if the current page is part of the Forums component.

bp_is_notifications_component()   X-Ref
Check whether the current page is part of the Notifications component.

since: 1.9.0
return: bool True if the current page is part of the Notifications component.

bp_is_settings_component()   X-Ref
Check whether the current page is part of the Settings component.

since: 1.1.0
return: bool True if the current page is part of the Settings component.

bp_is_current_component_core()   X-Ref
Is the current component an active core component?

Use this function when you need to check if the current component is an
active core component of BuddyPress. If the current component is inactive, it
will return false. If the current component is not part of BuddyPress core,
it will return false. If the current component is active, and is part of
BuddyPress core, it will return true.

since: 1.7.0
return: bool True if the current component is active and is one of BP's

bp_is_activity_directory()   X-Ref
Is the current page the activity directory?

since: 2.0.0
return: bool True if the current page is the activity directory.

bp_is_single_activity()   X-Ref
Is the current page a single activity item permalink?

since: 1.5.0
return: bool True if the current page is a single activity item permalink.

bp_is_members_directory()   X-Ref
Is the current page the members directory?

since: 2.0.0
return: bool True if the current page is the members directory.

bp_is_my_profile()   X-Ref
Is the current page part of the profile of the logged-in user?

Will return true for any subpage of the logged-in user's profile, eg
http://example.com/members/joe/friends/.

since: 1.2.0
return: bool True if the current page is part of the profile of the logged-in user.

bp_is_user()   X-Ref
Is the current page a user page?

Will return true anytime there is a displayed user.

since: 1.5.0
return: bool True if the current page is a user page.

bp_is_user_front()   X-Ref
Is the current page a user custom front page?

Will return true anytime there is a custom front page for the displayed user.

since: 2.6.0
return: bool True if the current page is a user custom front page.

bp_is_user_activity()   X-Ref
Is the current page a user's activity stream page?

Eg http://example.com/members/joe/activity/ (or any subpages thereof).

since: 1.1.0
return: bool True if the current page is a user's activity stream page.

bp_is_user_friends_activity()   X-Ref
Is the current page a user's Friends activity stream?

Eg http://example.com/members/joe/friends/

since: 1.1.0
return: bool True if the current page is a user's Friends activity stream.

bp_is_user_groups_activity()   X-Ref
Is the current page a user's Groups activity stream?

Eg http://example.com/members/joe/groups/

since: 1.5.0
return: bool True if the current page is a user's Groups activity stream.

bp_is_user_profile()   X-Ref
Is the current page part of a user's extended profile?

Eg http://example.com/members/joe/profile/ (or a subpage thereof).

since: 1.1.0
return: bool True if the current page is part of a user's extended profile.

bp_is_user_profile_edit()   X-Ref
Is the current page part of a user's profile editing section?

Eg http://example.com/members/joe/profile/edit/ (or a subpage thereof).

since: 1.5.0
return: bool True if the current page is a user's profile edit page.

bp_is_user_change_avatar()   X-Ref
Is the current page part of a user's profile avatar editing section?

Eg http://example.com/members/joe/profile/change-avatar/ (or a subpage thereof).

since: 1.5.0
return: bool True if the current page is the user's avatar edit page.

bp_is_user_change_cover_image()   X-Ref
Is the current page the a user's change cover image profile page?

Eg http://example.com/members/joe/profile/change-cover-image/ (or a subpage thereof).

since: 2.4.0
return: bool True if the current page is a user's profile edit cover image page.

bp_is_user_groups()   X-Ref
Is the current page part of a user's Groups page?

Eg http://example.com/members/joe/groups/ (or a subpage thereof).

since: 1.1.0
return: bool True if the current page is a user's Groups page.

bp_is_user_blogs()   X-Ref
Is the current page part of a user's Blogs page?

Eg http://example.com/members/joe/blogs/ (or a subpage thereof).

since: 1.1.0
return: bool True if the current page is a user's Blogs page.

bp_is_user_recent_posts()   X-Ref
Is the current page a user's Recent Blog Posts page?

Eg http://example.com/members/joe/blogs/recent-posts/.

since: 1.1.0
return: bool True if the current page is a user's Recent Blog Posts page.

bp_is_user_recent_commments()   X-Ref
Is the current page a user's Recent Blog Comments page?

Eg http://example.com/members/joe/blogs/recent-comments/.

since: 1.1.0
return: bool True if the current page is a user's Recent Blog Comments page.

bp_is_user_friends()   X-Ref
Is the current page a user's Friends page?

Eg http://example.com/members/joe/blogs/friends/ (or a subpage thereof).

since: 1.1.0
return: bool True if the current page is a user's Friends page.

bp_is_user_friend_requests()   X-Ref
Is the current page a user's Friend Requests page?

Eg http://example.com/members/joe/friends/requests/.

since: 1.5.0
return: bool True if the current page is a user's Friends Requests page.

bp_is_user_notifications()   X-Ref
Is this a user's notifications page?

Eg http://example.com/members/joe/notifications/ (or a subpage thereof).

since: 1.9.0
return: bool True if the current page is a user's Notifications page.

bp_is_user_settings()   X-Ref
Is this a user's settings page?

Eg http://example.com/members/joe/settings/ (or a subpage thereof).

since: 1.5.0
return: bool True if the current page is a user's Settings page.

bp_is_user_settings_general()   X-Ref
Is this a user's General Settings page?

Eg http://example.com/members/joe/settings/general/.

since: 1.5.0
return: bool True if the current page is a user's General Settings page.

bp_is_user_settings_notifications()   X-Ref
Is this a user's Notification Settings page?

Eg http://example.com/members/joe/settings/notifications/.

since: 1.5.0
return: bool True if the current page is a user's Notification Settings page.

bp_is_user_settings_account_delete()   X-Ref
Is this a user's Account Deletion page?

Eg http://example.com/members/joe/settings/delete-account/.

since: 1.5.0
return: bool True if the current page is a user's Delete Account page.

bp_is_user_settings_profile()   X-Ref
Is this a user's profile settings?

Eg http://example.com/members/joe/settings/profile/.

since: 2.0.0
return: bool True if the current page is a user's Profile Settings page.

bp_is_groups_directory()   X-Ref
Is the current page the groups directory?

since: 2.0.0
return: bool True if the current page is the groups directory.

bp_is_group()   X-Ref
Does the current page belong to a single group?

Will return true for any subpage of a single group.

since: 1.2.0
return: bool True if the current page is part of a single group.

bp_is_group_home()   X-Ref
Is the current page a single group's home page?

URL will vary depending on which group tab is set to be the "home". By
default, it's the group's recent activity.

since: 1.1.0
return: bool True if the current page is a single group's home page.

bp_is_group_create()   X-Ref
Is the current page part of the group creation process?

since: 1.1.0
return: bool True if the current page is part of the group creation process.

bp_is_group_admin_page()   X-Ref
Is the current page part of a single group's admin screens?

Eg http://example.com/groups/mygroup/admin/settings/.

since: 1.1.0
return: bool True if the current page is part of a single group's admin.

bp_is_group_activity()   X-Ref
Is the current page a group's activity page?

since: 1.2.1
return: bool True if the current page is a group's activity page.

bp_is_group_forum_topic()   X-Ref
Is the current page a group forum topic?

since: 1.1.0
since: 3.0.0 Required for bbPress 2 integration.
return: bool True if the current page is part of a group forum topic.

bp_is_group_forum_topic_edit()   X-Ref
Is the current page a group forum topic edit page?

since: 1.2.0
since: 3.0.0 Required for bbPress 2 integration.
return: bool True if the current page is part of a group forum topic edit page.

bp_is_group_members()   X-Ref
Is the current page a group's Members page?

Eg http://example.com/groups/mygroup/members/.

since: 1.1.0
return: bool True if the current page is part of a group's Members page.

bp_is_group_invites()   X-Ref
Is the current page a group's Invites page?

Eg http://example.com/groups/mygroup/send-invites/.

since: 1.1.0
return: bool True if the current page is a group's Send Invites page.

bp_is_group_membership_request()   X-Ref
Is the current page a group's Request Membership page?

Eg http://example.com/groups/mygroup/request-membership/.

since: 1.2.0
return: bool True if the current page is a group's Request Membership page.

bp_is_group_leave()   X-Ref
Is the current page a leave group attempt?

since: 1.1.0
return: bool True if the current page is a Leave Group attempt.

bp_is_group_single()   X-Ref
Is the current page part of a single group?

Not currently used by BuddyPress.

return: bool True if the current page is part of a single group.

bp_is_group_custom_front()   X-Ref
Is the current group page a custom front?

since: 2.4.0
return: bool True if the current group page is a custom front.

bp_is_create_blog()   X-Ref
Is the current page the Create a Blog page?

Eg http://example.com/sites/create/.

since: 1.1.0
return: bool True if the current page is the Create a Blog page.

bp_is_blogs_directory()   X-Ref
Is the current page the blogs directory ?

since: 2.0.0
return: bool True if the current page is the blogs directory.

bp_is_user_messages()   X-Ref
Is the current page part of a user's Messages pages?

Eg http://example.com/members/joe/messages/ (or a subpage thereof).

since: 1.2.0
return: bool True if the current page is part of a user's Messages pages.

bp_is_messages_inbox()   X-Ref
Is the current page a user's Messages Inbox?

Eg http://example.com/members/joe/messages/inbox/.

since: 1.1.0
return: bool True if the current page is a user's Messages Inbox.

bp_is_messages_sentbox()   X-Ref
Is the current page a user's Messages Sentbox?

Eg http://example.com/members/joe/messages/sentbox/.

since: 1.1.0
return: bool True if the current page is a user's Messages Sentbox.

bp_is_messages_compose_screen()   X-Ref
Is the current page a user's Messages Compose screen??

Eg http://example.com/members/joe/messages/compose/.

since: 1.1.0
return: bool True if the current page is a user's Messages Compose screen.

bp_is_notices()   X-Ref
Is the current page the Notices screen?

Eg http://example.com/members/joe/messages/notices/.

since: 1.1.0
return: bool True if the current page is the Notices screen.

bp_is_messages_conversation()   X-Ref
Is the current page a single Messages conversation thread?

since: 1.6.0
return: bool True if the current page a single Messages conversation thread?

bp_is_single( $component, $callback )   X-Ref
Not currently used by BuddyPress.

return: bool
param: string $component Current component to check for.
param: string $callback  Callback to invoke.

bp_is_activation_page()   X-Ref
Is the current page the Activate page?

Eg http://example.com/activate/.

since: 1.1.0
return: bool True if the current page is the Activate page.

bp_is_register_page()   X-Ref
Is the current page the Register page?

Eg http://example.com/register/.

since: 1.1.0
return: bool True if the current page is the Register page.

bp_get_title_parts( $seplocation = 'right' )   X-Ref
Get the title parts of the BuddyPress displayed page

since: 2.4.3
return: array the title parts
param: string $seplocation Location for the separator.

bp_the_body_class()   X-Ref
Customize the body class, according to the currently displayed BP content.

since: 1.1.0

bp_get_the_body_class( $wp_classes = array()   X-Ref
Customize the body class, according to the currently displayed BP content.

Uses the above is_() functions to output a body class for each scenario.

since: 1.1.0
return: array $classes The BP-adjusted body classes.
param: array      $wp_classes     The body classes coming from WP.
param: array|bool $custom_classes Classes that were passed to get_body_class().

bp_get_the_post_class( $wp_classes = array()   X-Ref
Customizes the post CSS class according to BuddyPress content.

Hooked to the 'post_class' filter.

since: 2.1.0
return: array
param: array $wp_classes The post classes coming from WordPress.

_bp_nav_menu_sort( $a, $b )   X-Ref
Sort BuddyPress nav menu items by their position property.

This is an internal convenience function and it will probably be removed in
a later release. Do not use.

since: 1.7.0
return: int Returns an integer less than, equal to, or greater than zero if
param: array $a First item.
param: array $b Second item.

bp_get_nav_menu_items( $component = 'members' )   X-Ref
Get the items registered in the primary and secondary BuddyPress navigation menus.

since: 1.7.0
since: 2.6.0 Introduced the `$component` parameter.
return: array A multidimensional array of all navigation items.
param: string $component Optional. Component whose nav items are being fetched.

bp_nav_menu( $args = array()   X-Ref
Display a navigation menu.

since: 1.7.0
return: string|null If $echo is false, returns a string containing the nav
param: string|array $args {

bp_email_the_salutation( $settings = array()   X-Ref
Prints the Recipient Salutation.

since: 2.5.0
param: array $settings Email Settings.

bp_email_get_salutation( $settings = array()   X-Ref
Gets the Recipient Salutation.

since: 2.5.0
return: string The Recipient Salutation.
param: array $settings Email Settings.



Generated: Sat Sep 21 01:01:46 2019 Cross-referenced by PHPXref 0.7.1