bp_options_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.
*
* @uses bp_get_user_nav() Renders the navigation for a profile of a currently
* viewed user.
*/
function bp_get_options_nav( $parent_slug = '' ) {
$bp = buddypress();
// If we are looking at a member profile, then the we can use the current
// component as an index. Otherwise we need to use the component's root_slug
$component_index = !empty( $bp->displayed_user ) ? bp_current_component() : bp_get_root_slug( bp_current_component() );
$selected_item = bp_current_action();
if ( ! bp_is_single_item() ) {
if ( !isset( $bp->bp_options_nav[$component_index] ) || count( $bp->bp_options_nav[$component_index] ) < 1 ) {
return false;
} else {
$the_index = $component_index;
}
} else {
$current_item = bp_current_item();
if ( ! empty( $parent_slug ) ) {
$current_item = $parent_slug;
$selected_item = bp_action_variable( 0 );
}
if ( !isset( $bp->bp_options_nav[$current_item] ) || count( $bp->bp_options_nav[$current_item] ) < 1 ) {
return false;
} else {
$the_index = $current_item;
}
}
// Loop through each navigation item
foreach ( (array) $bp->bp_options_nav[$the_index] as $subnav_item ) {
if ( empty( $subnav_item['user_has_access'] ) ) {
continue;
}
// If the current action or an action variable matches the nav item id, then add a highlight CSS class.
if ( $subnav_item['slug'] == $selected_item ) {
$selected = ' class="current selected"';
} else {
$selected = '';
}
// List type depends on our current component
$list_type = bp_is_group() ? 'groups' : 'personal';
/**
* Filters the "options nav", the secondary-level single item navigation menu.
*
* This is a dynamic filter that is dependent on the provided css_id value.
*
* @since BuddyPress (1.1.0)
*
* @param string $value HTML list item for the submenu item.
* @param array $subnav_item Submenu array item being displayed.
* @param string $selected_item Current action.
*/
echo apply_filters( 'bp_get_options_nav_' . $subnav_item['css_id'], '' . $subnav_item['name'] . '', $subnav_item, $selected_item );
}
}
/**
* Get the 'bp_options_title' property from the BP global.
*
* Not currently used in BuddyPress.
* @todo Deprecate.
*/
function bp_get_options_title() {
$bp = buddypress();
if ( empty( $bp->bp_options_title ) ) {
$bp->bp_options_title = __( 'Options', 'buddypress' );
}
echo apply_filters( 'bp_get_options_title', esc_attr( $bp->bp_options_title ) );
}
/**
* Get the directory title for a component.
*
* Used for the element and the page header on the component directory
* page.
*
* @since BuddyPress (2.0.0)
*
* @return string
*/
function bp_get_directory_title( $component = '' ) {
$title = '';
// Use the string provided by the component
if ( ! empty( buddypress()->{$component}->directory_title ) ) {
$title = buddypress()->{$component}->directory_title;
// If none is found, concatenate
} elseif ( isset( buddypress()->{$component}->name ) ) {
$title = sprintf( __( '%s Directory', 'buddypress' ), buddypress()->{$component}->name );
}
/**
* Filters the directory title for a component.
*
* @since BuddyPress (2.0.0)
*
* @param string $title Text to be used in <title> tag.
* @param string $component Current componet being displayed.
*/
return apply_filters( 'bp_get_directory_title', $title, $component );
}
/** Avatars *******************************************************************/
/**
* 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 Returns true if an options avatar has been set, otherwise false.
*/
function bp_has_options_avatar() {
return (bool) buddypress()->bp_options_avatar;
}
/**
* Output the options avatar.
*
* Not currently used in BuddyPress.
*
* @todo Deprecate.
*/
function bp_get_options_avatar() {
echo apply_filters( 'bp_get_options_avatar', buddypress()->bp_options_avatar );
}
/**
* Output a comment author's avatar.
*
* Not currently used in BuddyPress.
*/
function bp_comment_author_avatar() {
global $comment;
if ( function_exists( 'bp_core_fetch_avatar' ) ) {
echo apply_filters( 'bp_comment_author_avatar', bp_core_fetch_avatar( array(
'item_id' => $comment->user_id,
'type' => 'thumb',
'alt' => sprintf( __( 'Profile photo of %s', 'buddypress' ), bp_core_get_user_displayname( $comment->user_id ) )
) ) );
} elseif ( function_exists( 'get_avatar' ) ) {
get_avatar();
}
}
/**
* Output a post author's avatar.
*
* Not currently used in BuddyPress.
*/
function bp_post_author_avatar() {
global $post;
if ( function_exists( 'bp_core_fetch_avatar' ) ) {
echo apply_filters( 'bp_post_author_avatar', bp_core_fetch_avatar( array(
'item_id' => $post->post_author,
'type' => 'thumb',
'alt' => sprintf( __( 'Profile photo of %s', 'buddypress' ), bp_core_get_user_displayname( $post->post_author ) )
) ) );
} elseif ( function_exists( 'get_avatar' ) ) {
get_avatar();
}
}
/**
* Output the current avatar upload step.
*/
function bp_avatar_admin_step() {
echo bp_get_avatar_admin_step();
}
/**
* Return the current avatar upload step.
*
* @return string The current avatar upload step. Returns 'upload-image'
* if none is found.
*/
function bp_get_avatar_admin_step() {
$bp = buddypress();
$step = isset( $bp->avatar_admin->step )
? $step = $bp->avatar_admin->step
: 'upload-image';
/**
* Filters the current avatar upload step.
*
* @since BuddyPress (1.1.0)
*
* @param string $step The current avatar upload step.
*/
return apply_filters( 'bp_get_avatar_admin_step', $step );
}
/**
* Output the URL of the avatar to crop.
*/
function bp_avatar_to_crop() {
echo bp_get_avatar_to_crop();
}
/**
* Return the URL of the avatar to crop.
*
* @return string URL of the avatar awaiting cropping.
*/
function bp_get_avatar_to_crop() {
$bp = buddypress();
$url = isset( $bp->avatar_admin->image->url )
? $bp->avatar_admin->image->url
: '';
/**
* Filters the URL of the avatar to crop.
*
* @since BuddyPress (1.1.0)
*
* @param string $url URL for the avatar.
*/
return apply_filters( 'bp_get_avatar_to_crop', $url );
}
/**
* Output the relative file path to the avatar to crop.
*/
function bp_avatar_to_crop_src() {
echo bp_get_avatar_to_crop_src();
}
/**
* Return the relative file path to the avatar to crop.
*
* @return string Relative file path to the avatar.
*/
function bp_get_avatar_to_crop_src() {
$bp = buddypress();
$src = isset( $bp->avatar_admin->image->dir )
? str_replace( WP_CONTENT_DIR, '', $bp->avatar_admin->image->dir )
: '';
/**
* Filters the relative file path to the avatar to crop.
*
* @since BuddyPress (1.1.0)
*
* @param string $src Relative file path for the avatar.
*/
return apply_filters( 'bp_get_avatar_to_crop_src', $src );
}
/**
* Output the avatar cropper <img> markup.
*
* No longer used in BuddyPress.
*
* @todo Deprecate.
*/
function bp_avatar_cropper() {
?>
<img id="avatar-to-crop" class="avatar" src="<?php echo esc_url( buddypress()->avatar_admin->image ); ?>" />
<?php
}
/**
* Output the name of the BP site. Used in RSS headers.
*/
function bp_site_name() {
echo bp_get_site_name();
}
/**
* Returns the name of the BP site. Used in RSS headers.
*
* @since BuddyPress (1.6.0)
*/
function bp_get_site_name() {
/**
* Filters the name of the BP site. Used in RSS headers.
*
* @since BuddyPress (1.0.0)
*
* @param string $value Current BP site name.
*/
return apply_filters( 'bp_site_name', get_bloginfo( 'name', 'display' ) );
}
/**
* 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 BuddyPress (1.1.0)
*
* @param int $time The UNIX timestamp to be formatted.
* @param bool $exclude_time Optional. True to return only the month + day, false
* to return month, day, and time. Default: false.
* @param bool $gmt Optional. True to display in local time, false to
* leave in GMT. Default: true.
*
* @return mixed A string representation of $time, in the format
* "March 18, 2014 at 2:00 pm" (or whatever your
* 'date_format' and 'time_format' settings are
* on your root blog). False on failure.
*/
function bp_format_time( $time = '', $exclude_time = false, $gmt = true ) {
// Bail if time is empty or not numeric
// @todo We should output something smarter here
if ( empty( $time ) || ! is_numeric( $time ) ) {
return false;
}
// Get GMT offset from root blog
if ( true === $gmt ) {
// Use Timezone string if set
$timezone_string = bp_get_option( 'timezone_string' );
if ( ! empty( $timezone_string ) ) {
$timezone_object = timezone_open( $timezone_string );
$datetime_object = date_create( "@{$time}" );
$timezone_offset = timezone_offset_get( $timezone_object, $datetime_object ) / HOUR_IN_SECONDS;
// Fall back on less reliable gmt_offset
} else {
$timezone_offset = bp_get_option( 'gmt_offset' );
}
// Calculate time based on the offset
$calculated_time = $time + ( $timezone_offset * HOUR_IN_SECONDS );
// No localizing, so just use the time that was submitted
} else {
$calculated_time = $time;
}
// Formatted date: "March 18, 2014"
$formatted_date = date_i18n( bp_get_option( 'date_format' ), $calculated_time, $gmt );
// Should we show the time also?
if ( true !== $exclude_time ) {
// Formatted time: "2:00 pm"
$formatted_time = date_i18n( bp_get_option( 'time_format' ), $calculated_time, $gmt );
// Return string formatted with date and time
$formatted_date = sprintf( esc_html__( '%1$s at %2$s', 'buddypress' ), $formatted_date, $formatted_time );
}
/**
* Filters the date based on a UNIX timestamp.
*
* @since BuddyPress (1.0.0)
*
* @param string $formatted_date Formatted date from the timestamp.
*/
return apply_filters( 'bp_format_time', $formatted_date );
}
/**
* 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.
*
* @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
* a format appropriate for sprintf() - use %s in place of the displayed
* user's name (eg "%'s Friends").
* @param bool $capitalize Optional. Force into title case. Default: true.
* @param bool $echo Optional. True to echo the results, false to return them.
* Default: true.
* @return string|null If ! $echo, returns the appropriate string.
*/
function bp_word_or_name( $youtext, $nametext, $capitalize = true, $echo = true ) {
if ( ! empty( $capitalize ) ) {
$youtext = bp_core_ucfirst( $youtext );
}
if ( bp_displayed_user_id() == bp_loggedin_user_id() ) {
if ( true == $echo ) {
/**
* Filters the text used based on context of own profile or someone else's profile.
*
* @since BuddyPress (1.0.0)
*
* @param string $youtext Context-determined string to display.
*/
echo apply_filters( 'bp_word_or_name', $youtext );
} else {
/** This filter is documented in bp-core/bp-core-template.php */
return apply_filters( 'bp_word_or_name', $youtext );
}
} else {
$fullname = bp_get_displayed_user_fullname();
$fullname = (array) explode( ' ', $fullname );
$nametext = sprintf( $nametext, $fullname[0] );
if ( true == $echo ) {
/** This filter is documented in bp-core/bp-core-template.php */
echo apply_filters( 'bp_word_or_name', $nametext );
} else {
/** This filter is documented in bp-core/bp-core-template.php */
return apply_filters( 'bp_word_or_name', $nametext );
}
}
}
/**
* Do the 'bp_styles' action, and call wp_print_styles().
*
* No longer used in BuddyPress.
*
* @todo Deprecate.
*/
function bp_styles() {
do_action( 'bp_styles' );
wp_print_styles();
}
/** Search Form ***************************************************************/
/**
* Return the "action" attribute for search forms.
*
* @return string URL action attribute for search forms, eg example.com/search/.
*/
function bp_search_form_action() {
/**
* Filters the "action" attribute for search forms.
*
* @since BuddyPress (1.0.0)
*
* @param string $value Search form action url.
*/
return apply_filters( 'bp_search_form_action', trailingslashit( bp_get_root_domain() . '/' . bp_get_search_slug() ) );
}
/**
* Generate the basic search form as used in BP-Default's header.
*
* @since BuddyPress (1.0.0)
*
* @return string HTML <select> element.
*/
function bp_search_form_type_select() {
$options = array();
if ( bp_is_active( 'xprofile' ) ) {
$options['members'] = _x( 'Members', 'search form', 'buddypress' );
}
if ( bp_is_active( 'groups' ) ) {
$options['groups'] = _x( 'Groups', 'search form', 'buddypress' );
}
if ( bp_is_active( 'blogs' ) && is_multisite() ) {
$options['blogs'] = _x( 'Blogs', 'search form', 'buddypress' );
}
if ( bp_is_active( 'forums' ) && bp_forums_is_installed_correctly() && bp_forums_has_directory() ) {
$options['forums'] = _x( 'Forums', 'search form', 'buddypress' );
}
$options['posts'] = _x( 'Posts', 'search form', 'buddypress' );
// Eventually this won't be needed and a page will be built to integrate all search results.
$selection_box = '<label for="search-which" class="accessibly-hidden">' . _x( 'Search these:', 'search form', 'buddypress' ) . '</label>';
$selection_box .= '<select name="search-which" id="search-which" style="width: auto">';
/**
* Filters all of the component options available for search scope.
*
* @since BuddyPress (1.5.0)
*
* @param array $options Array of options to add to select field.
*/
$options = apply_filters( 'bp_search_form_type_select_options', $options );
foreach( (array) $options as $option_value => $option_title ) {
$selection_box .= sprintf( '<option value="%s">%s</option>', $option_value, $option_title );
}
$selection_box .= '</select>';
/**
* Filters the complete <select> input used for search scope.
*
* @since BuddyPress (1.0.0)
*
* @param string $selection_box <select> input for selecting search scope.
*/
return apply_filters( 'bp_search_form_type_select', $selection_box );
}
/**
* Output the default text for the search box for a given component.
*
* @since BuddyPress (1.5.0)
*
* @see bp_get_search_default_text()
*
* @param string $component See {@link bp_get_search_default_text()}.
*/
function bp_search_default_text( $component = '' ) {
echo bp_get_search_default_text( $component );
}
/**
* Return the default text for the search box for a given component.
*
* @since BuddyPress (1.5.0)
*
* @param string $component Component name. Default: current component.
* @return string Placeholder text for search field.
*/
function bp_get_search_default_text( $component = '' ) {
$bp = buddypress();
if ( empty( $component ) ) {
$component = bp_current_component();
}
$default_text = __( 'Search anything...', 'buddypress' );
// Most of the time, $component will be the actual component ID
if ( !empty( $component ) ) {
if ( !empty( $bp->{$component}->search_string ) ) {
$default_text = $bp->{$component}->search_string;
} else {
// When the request comes through AJAX, we need to get the component
// name out of $bp->pages
if ( !empty( $bp->pages->{$component}->slug ) ) {
$key = $bp->pages->{$component}->slug;
if ( !empty( $bp->{$key}->search_string ) ) {
$default_text = $bp->{$key}->search_string;
}
}
}
}
/**
* Filters the default text for the search box for a given component.
*
* @since BuddyPress (1.5.0)
*
* @param string $default_text Default text for search box.
* @param string $component Current component displayed.
*/
return apply_filters( 'bp_get_search_default_text', $default_text, $component );
}
/**
* Fire the 'bp_custom_profile_boxes' action.
*
* No longer used in BuddyPress.
*
* @todo Deprecate.
*/
function bp_custom_profile_boxes() {
do_action( 'bp_custom_profile_boxes' );
}
/**
* Fire the 'bp_custom_profile_sidebar_boxes' action.
*
* No longer used in BuddyPress.
*
* @todo Deprecate.
*/
function bp_custom_profile_sidebar_boxes() {
do_action( 'bp_custom_profile_sidebar_boxes' );
}
/**
* Output the attributes for a form field.
*
* @since BuddyPress (2.2.0)
*
* @param string $name The field name to output attributes for.
* @param array $attributes Array of existing attributes to add.
*/
function bp_form_field_attributes( $name = '', $attributes = array() ) {
echo bp_get_form_field_attributes( $name, $attributes );
}
/**
* 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 BuddyPress (2.2.0)
*
* @param string $name The field name to get attributes for.
* @param array $attributes Array of existing attributes to add.
* @return string
*/
function bp_get_form_field_attributes( $name = '', $attributes = array() ) {
$retval = '';
if ( empty( $attributes ) ) {
$attributes = array();
}
$name = strtolower( $name );
switch ( $name ) {
case 'username' :
case 'blogname' :
$attributes['autocomplete'] = 'off';
$attributes['autocapitalize'] = 'none';
break;
case 'email' :
if ( wp_is_mobile() ) {
$attributes['autocapitalize'] = 'none';
}
break;
case 'password' :
$attributes['spellcheck'] = 'false';
$attributes['autocomplete'] = 'off';
if ( wp_is_mobile() ) {
$attributes['autocorrect'] = 'false';
$attributes['autocapitalize'] = 'none';
}
break;
}
/**
* Filter the attributes for a field before rendering output.
*
* @since BuddyPress (2.2.0)
*
* @param array $attributes The field attributes
* @param string $name The field name
*/
$attributes = (array) apply_filters( 'bp_get_form_field_attributes', $attributes, $name );
foreach( $attributes as $attr => $value ) {
$retval .= sprintf( ' %s="%s"', sanitize_key( $attr ), esc_attr( $value ) );
}
return $retval;
}
/**
* Create and output a button.
*
* @see bp_get_button()
*
* @param array $args See {@link BP_Button}.
*/
function bp_button( $args = '' ) {
echo bp_get_button( $args );
}
/**
* Create and return a button.
*
* @see BP_Button for a description of arguments and return value.
*
* @param array $args See {@link BP_Button}.
* @return string HTML markup for the button.
*/
function bp_get_button( $args = '' ) {
$button = new BP_Button( $args );
/**
* Filters the requested button output.
*
* @since BuddyPress (1.2.6)
*
* @param string $contents Button context to be used.
* @param array $args Array of args for the button.
* @param BP_Button $button BP_Button object.
*/
return apply_filters( 'bp_get_button', $button->contents, $args, $button );
}
/**
* 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
*
* ### Options:
*
* - `ending` Will be used as Ending and appended to the trimmed string
* - `exact` If false, $text will not be cut mid-word
* - `html` If true, HTML tags would be handled correctly
* - `filter_shortcodes` If true, shortcodes will be stripped before truncating
*
* @param string $text String to truncate.
* @param int $length Optional. Length of returned string, including ellipsis.
* Default: 225.
* @param array $options {
* An array of HTML attributes and options. Each item is optional.
* @type string $ending The string used after truncation.
* Default: ' […]'.
* @type bool $exact If true, $text will be trimmed to exactly $length.
* If false, $text will not be cut mid-word. Default: false.
* @type bool $html If true, don't include HTML tags when calculating
* excerpt length. Default: true.
* @type bool $filter_shortcodes If true, shortcodes will be stripped.
* Default: true.
* }
* @return string Trimmed string.
*/
function bp_create_excerpt( $text, $length = 225, $options = array() ) {
// Backward compatibility. The third argument used to be a boolean $filter_shortcodes
$filter_shortcodes_default = is_bool( $options ) ? $options : true;
$r = bp_parse_args( $options, array(
'ending' => __( ' […]', 'buddypress' ),
'exact' => false,
'html' => true,
'filter_shortcodes' => $filter_shortcodes_default
), 'create_excerpt' );
// Save the original text, to be passed along to the filter
$original_text = $text;
/**
* Filters the excerpt length to trim text to.
*
* @since BuddyPress (1.5.0)
*
* @param int $length Length of returned string, including ellipsis.
*/
$length = apply_filters( 'bp_excerpt_length', $length );
/**
* Filters the excerpt appended text value.
*
* @since BuddyPress (1.5.0)
*
* @param string $value Text to append to the end of the excerpt.
*/
$ending = apply_filters( 'bp_excerpt_append_text', $r['ending'] );
// Remove shortcodes if necessary
if ( ! empty( $r['filter_shortcodes'] ) ) {
$text = strip_shortcodes( $text );
}
// When $html is true, the excerpt should be created without including HTML tags in the
// excerpt length
if ( ! empty( $r['html'] ) ) {
// The text is short enough. No need to truncate
if ( mb_strlen( preg_replace( '/<.*?>/', '', $text ) ) <= $length ) {
return $text;
}
$totalLength = mb_strlen( strip_tags( $ending ) );
$openTags = array();
$truncate = '';
// Find all the tags and HTML comments and put them in a stack for later use
preg_match_all( '/(<\/?([\w+!]+)[^>]*>)?([^<>]*)/', $text, $tags, PREG_SET_ORDER );
foreach ( $tags as $tag ) {
// Process tags that need to be closed
if ( !preg_match( '/img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param/s', $tag[2] ) ) {
if ( preg_match( '/<[\w]+[^>]*>/s', $tag[0] ) ) {
array_unshift( $openTags, $tag[2] );
} elseif ( preg_match('/<\/([\w]+)[^>]*>/s', $tag[0], $closeTag ) ) {
$pos = array_search( $closeTag[1], $openTags );
if ( $pos !== false ) {
array_splice( $openTags, $pos, 1 );
}
}
}
$truncate .= $tag[1];
$contentLength = mb_strlen( preg_replace( '/&[0-9a-z]{2,8};|&#[0-9]{1,7};|&#x[0-9a-f]{1,6};/i', ' ', $tag[3] ) );
if ( $contentLength + $totalLength > $length ) {
$left = $length - $totalLength;
$entitiesLength = 0;
if ( preg_match_all( '/&[0-9a-z]{2,8};|&#[0-9]{1,7};|&#x[0-9a-f]{1,6};/i', $tag[3], $entities, PREG_OFFSET_CAPTURE ) ) {
foreach ( $entities[0] as $entity ) {
if ( $entity[1] + 1 - $entitiesLength <= $left ) {
$left--;
$entitiesLength += mb_strlen( $entity[0] );
} else {
break;
}
}
}
$truncate .= mb_substr( $tag[3], 0 , $left + $entitiesLength );
break;
} else {
$truncate .= $tag[3];
$totalLength += $contentLength;
}
if ( $totalLength >= $length ) {
break;
}
}
} else {
if ( mb_strlen( $text ) <= $length ) {
return $text;
} else {
$truncate = mb_substr( $text, 0, $length - mb_strlen( $ending ) );
}
}
// If $exact is false, we can't break on words
if ( empty( $r['exact'] ) ) {
// Find the position of the last space character not part of a tag.
preg_match_all( '/<[a-z\!\/][^>]*>/', $truncate, $_truncate_tags, PREG_OFFSET_CAPTURE );
// Rekey tags by the string index of their last character.
$truncate_tags = array();
if ( ! empty( $_truncate_tags[0] ) ) {
foreach ( $_truncate_tags[0] as $_tt ) {
$_tt['start'] = $_tt[1];
$_tt['end'] = $_tt[1] + strlen( $_tt[0] );
$truncate_tags[ $_tt['end'] ] = $_tt;
}
}
$truncate_length = mb_strlen( $truncate );
$spacepos = $truncate_length + 1;
for ( $pos = $truncate_length - 1; $pos >= 0; $pos-- ) {
// Word boundaries are spaces and the close of HTML tags, when the tag is preceded by a space.
$is_word_boundary = ' ' === $truncate[ $pos ];
if ( ! $is_word_boundary && isset( $truncate_tags[ $pos - 1 ] ) ) {
$preceding_tag = $truncate_tags[ $pos - 1 ];
if ( ' ' === $truncate[ $preceding_tag['start'] - 1 ] ) {
$is_word_boundary = true;
break;
}
}
if ( ! $is_word_boundary ) {
continue;
}
// If there are no tags in the string, the first space found is the right one.
if ( empty( $truncate_tags ) ) {
$spacepos = $pos;
break;
}
// Look at each tag to see if the space is inside of it.
$intag = false;
foreach ( $truncate_tags as $tt ) {
if ( $pos > $tt['start'] && $pos < $tt['end'] ) {
$intag = true;
break;
}
}
if ( ! $intag ) {
$spacepos = $pos;
break;
}
}
if ( $r['html'] ) {
$bits = mb_substr( $truncate, $spacepos );
preg_match_all( '/<\/([a-z]+)>/', $bits, $droppedTags, PREG_SET_ORDER );
if ( !empty( $droppedTags ) ) {
foreach ( $droppedTags as $closingTag ) {
if ( !in_array( $closingTag[1], $openTags ) ) {
array_unshift( $openTags, $closingTag[1] );
}
}
}
}
$truncate = rtrim( mb_substr( $truncate, 0, $spacepos ) );
}
$truncate .= $ending;
if ( !empty( $r['html'] ) ) {
foreach ( $openTags as $tag ) {
$truncate .= '</' . $tag . '>';
}
}
/**
* Filters the final generated excerpt.
*
* @since BuddyPress (1.1.0)
*
* @param string $truncate Generated excerpt.
* @param string $original_text Original text provided.
* @param int $length Length of returned string, including ellipsis.
* @param array $options Array of HTML attributes and options.
*/
return apply_filters( 'bp_create_excerpt', $truncate, $original_text, $length, $options );
}
add_filter( 'bp_create_excerpt', 'stripslashes_deep' );
add_filter( 'bp_create_excerpt', 'force_balance_tags' );
/**
* Output the total member count for the site.
*/
function bp_total_member_count() {
echo bp_get_total_member_count();
}
/**
* 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.
*
* @return int Member count.
*/
function bp_get_total_member_count() {
/**
* Filters the total member count in your BP instance.
*
* @since BuddyPress (1.2.0)
*
* @param int $value Member count.
*/
return apply_filters( 'bp_get_total_member_count', bp_core_get_active_member_count() );
}
add_filter( 'bp_get_total_member_count', 'bp_core_number_format' );
/**
* Output whether blog signup is allowed.
*
* @todo Deprecate. It doesn't make any sense to echo a boolean.
*/
function bp_blog_signup_allowed() {
echo bp_get_blog_signup_allowed();
}
/**
* Is blog signup allowed?
*
* Returns true if is_multisite() and blog creation is enabled at
* Network Admin > Settings.
*
* @return bool True if blog signup is allowed, otherwise false.
*/
function bp_get_blog_signup_allowed() {
if ( ! is_multisite() ) {
return false;
}
$status = bp_core_get_root_option( 'registration' );
if ( ( 'none' !== $status ) && ( 'user' !== $status ) ) {
return true;
}
return false;
}
/**
* Check whether an activation has just been completed.
*
* @return bool True if the activation_complete global flag has been set,
* otherwise false.
*/
function bp_account_was_activated() {
$bp = buddypress();
$activation_complete = !empty( $bp->activation_complete )
? $bp->activation_complete
: false;
return $activation_complete;
}
/**
* 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.
*
* @return bool True by default.
*/
function bp_registration_needs_activation() {
/**
* Filters whether registrations require activation on this installation.
*
* @since BuddyPress (1.2.0)
*
* @param bool $value Whether registrations require activation. Default true.
*/
return apply_filters( 'bp_registration_needs_activation', true );
}
/**
* 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 BuddyPress (1.7.0)
*
* @see https://buddypress.trac.wordpress.org/ticket/4401
*
* @param array $args {
* Array of optional parameters.
* @type string $before String to appear before the site name in the
* email subject. Default: '['.
* @type string $after String to appear after the site name in the
* email subject. Default: ']'.
* @type string $default The default site name, to be used when none is
* found in the database. Default: 'Community'.
* @type string $text Text to append to the site name (ie, the main text of
* the email subject).
* }
* @return string Sanitized email subject.
*/
function bp_get_email_subject( $args = array() ) {
$r = bp_parse_args( $args, array(
'before' => '[',
'after' => ']',
'default' => __( 'Community', 'buddypress' ),
'text' => ''
), 'get_email_subject' );
$subject = $r['before'] . wp_specialchars_decode( bp_get_option( 'blogname', $r['default'] ), ENT_QUOTES ) . $r['after'] . ' ' . $r['text'];
/**
* Filters a client friendly version of the root blog name.
*
* @since BuddyPress (1.7.0)
*
* @param string $subject Client friendy version of the root blog name.
* @param array $r Array of arguments for the email subject.
*/
return apply_filters( 'bp_get_email_subject', $subject, $r );
}
/**
* 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.
*
* @param string $object
* @return string The AJAX querystring.
*/
function bp_ajax_querystring( $object = false ) {
$bp = buddypress();
if ( ! isset( $bp->ajax_querystring ) ) {
$bp->ajax_querystring = '';
}
/**
* Filters the template paramenters to be used in the query string.
*
* Allows templates to pass parameters into the template loops via AJAX.
*
* @since BuddyPress (1.2.0)
*
* @param string $ajax_querystring Current query string.
* @param string $object Current template component.
*/
return apply_filters( 'bp_ajax_querystring', $bp->ajax_querystring, $object );
}
/** Template Classes and _is functions ****************************************/
/**
* Return the name of the current component.
*
* @return string Component name.
*/
function bp_current_component() {
$bp = buddypress();
$current_component = !empty( $bp->current_component )
? $bp->current_component
: false;
/**
* Filters the name of the current component.
*
* @since BuddyPress (1.0.0)
*
* @param string|bool $current_component Current component if available or false.
*/
return apply_filters( 'bp_current_component', $current_component );
}
/**
* Return the name of the current action.
*
* @return string Action name.
*/
function bp_current_action() {
$bp = buddypress();
$current_action = !empty( $bp->current_action )
? $bp->current_action
: '';
/**
* Filters the name of the current action.
*
* @since BuddyPress (1.0.0)
*
* @param string $current_action Current action.
*/
return apply_filters( 'bp_current_action', $current_action );
}
/**
* Return the name of the current item.
*
* @return unknown
*/
function bp_current_item() {
$bp = buddypress();
$current_item = !empty( $bp->current_item )
? $bp->current_item
: false;
/**
* Filters the name of the current item.
*
* @since BuddyPress (1.1.0)
*
* @param string|bool $current_item Current item if available or false.
*/
return apply_filters( 'bp_current_item', $current_item );
}
/**
* Return the value of $bp->action_variables.
*
* @return array|bool $action_variables The action variables array, or false
* if the array is empty.
*/
function bp_action_variables() {
$bp = buddypress();
$action_variables = !empty( $bp->action_variables )
? $bp->action_variables
: false;
/**
* Filters the value of $bp->action_variables.
*
* @since BuddyPress (1.0.0)
*
* @param array|bool $action_variables Available action variables.
*/
return apply_filters( 'bp_action_variables', $action_variables );
}
/**
* Return the value of a given action variable.
*
* @since BuddyPress (1.5.0)
*
* @param int $position The key of the action_variables array that you want.
* @return string|bool $action_variable The value of that position in the
* array, or false if not found.
*/
function bp_action_variable( $position = 0 ) {
$action_variables = bp_action_variables();
$action_variable = isset( $action_variables[ $position ] )
? $action_variables[ $position ]
: false;
/**
* Filters the value of a given action variable.
*
* @since BuddyPress (1.5.0)
*
* @param string|bool $action_variable Requested action variable based on position.
* @param int $position The key of the action variable requested.
*/
return apply_filters( 'bp_action_variable', $action_variable, $position );
}
/**
* Output the "root domain", the URL of the BP root blog.
*/
function bp_root_domain() {
echo bp_get_root_domain();
}
/**
* Return the "root domain", the URL of the BP root blog.
*
* @return string URL of the BP root blog.
*/
function bp_get_root_domain() {
$bp = buddypress();
if ( ! empty( $bp->root_domain ) ) {
$domain = $bp->root_domain;
} else {
$domain = bp_core_get_root_domain();
$bp->root_domain = $domain;
}
/**
* Filters the "root domain", the URL of the BP root blog.
*
* @since BuddyPress (1.2.4)
*
* @param string $domain URL of the BP root blog.
*/
return apply_filters( 'bp_get_root_domain', $domain );
}
/**
* Output the root slug for a given component.
*
* @since BuddyPress (1.5.0)
*
* @param string $component The component name.
*/
function bp_root_slug( $component = '' ) {
echo bp_get_root_slug( $component );
}
/**
* 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 BuddyPress (1.5.0)
*
* @param string $component Optional. Defaults to the current component.
* @return string $root_slug The root slug.
*/
function bp_get_root_slug( $component = '' ) {
$bp = buddypress();
$root_slug = '';
// Use current global component if none passed
if ( empty( $component ) ) {
$component = bp_current_component();
}
// Component is active
if ( ! empty( $bp->active_components[ $component ] ) ) {
// Backward compatibility: in legacy plugins, the canonical component id
// was stored as an array value in $bp->active_components
$component_name = ( '1' == $bp->active_components[ $component ] )
? $component
: $bp->active_components[$component];
// Component has specific root slug
if ( ! empty( $bp->{$component_name}->root_slug ) ) {
$root_slug = $bp->{$component_name}->root_slug;
}
}
// No specific root slug, so fall back to component slug
if ( empty( $root_slug ) ) {
$root_slug = $component;
}
/**
* Filters the root slug for given component.
*
* @since BuddyPress (1.5.0)
*
* @param string $root_slug Root slug for given component.
* @param string $component Current component.
*/
return apply_filters( 'bp_get_root_slug', $root_slug, $component );
}
/**
* Return the component name based on a root slug.
*
* @since BuddyPress (1.5.0)
*
* @param string $root_slug Needle to our active component haystack.
* @return mixed False if none found, component name if found.
*/
function bp_get_name_from_root_slug( $root_slug = '' ) {
$bp = buddypress();
// If no slug is passed, look at current_component
if ( empty( $root_slug ) ) {
$root_slug = bp_current_component();
}
// No current component or root slug, so flee
if ( empty( $root_slug ) ) {
return false;
}
// Loop through active components and look for a match
foreach ( array_keys( $bp->active_components ) as $component ) {
if ( ( ! empty( $bp->{$component}->slug ) && ( $bp->{$component}->slug == $root_slug ) ) || ( ! empty( $bp->{$component}->root_slug ) && ( $bp->{$component}->root_slug === $root_slug ) ) ) {
return $bp->{$component}->name;
}
}
return false;
}
function bp_user_has_access() {
$has_access = ( bp_current_user_can( 'bp_moderate' ) || bp_is_my_profile() )
? true
: false;
/**
* Filters whether or not a user has access.
*
* @since BuddyPress (1.2.4)
*
* @param bool $has_access Whether or not user has access.
*/
return (bool) apply_filters( 'bp_user_has_access', $has_access );
}
/**
* Output the search slug.
*
* @since BuddyPress (1.5.0)
*
* @uses bp_get_search_slug()
*/
function bp_search_slug() {
echo bp_get_search_slug();
}
/**
* Return the search slug.
*
* @since BuddyPress (1.5.0)
*
* @return string The search slug. Default: 'search'.
*/
function bp_get_search_slug() {
/**
* Filters the search slug.
*
* @since BuddyPress (1.5.0)
*
* @param string BP_SEARCH_SLUG The search slug. Default "search".
*/
return apply_filters( 'bp_get_search_slug', BP_SEARCH_SLUG );
}
/**
* Get the ID of the currently displayed user.
*
* @uses apply_filters() Filter 'bp_displayed_user_id' to change this value.
*
* @return int ID of the currently displayed user.
*/
function bp_displayed_user_id() {
$bp = buddypress();
$id = !empty( $bp->displayed_user->id )
? $bp->displayed_user->id
: 0;
/**
* Filters the ID of the currently displayed user.
*
* @since BuddyPress (1.0.0)
*
* @param int $id ID of the currently displayed user.
*/
return (int) apply_filters( 'bp_displayed_user_id', $id );
}
/**
* Get the ID of the currently logged-in user.
*
* @uses apply_filters() Filter 'bp_loggedin_user_id' to change this value.
*
* @return int ID of the logged-in user.
*/
function bp_loggedin_user_id() {
$bp = buddypress();
$id = !empty( $bp->loggedin_user->id )
? $bp->loggedin_user->id
: 0;
/**
* Filters the ID of the currently logged-in user.
*
* @since BuddyPress (1.0.0)
*
* @param int $id ID of the currently logged-in user.
*/
return (int) apply_filters( 'bp_loggedin_user_id', $id );
}
/** is_() functions to determine the current page *****************************/
/**
* 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 BuddyPress (1.5.0)
*
* @param string $component Name of the component being checked.
* @return bool Returns true if the component matches, or else false.
*/
function bp_is_current_component( $component = '' ) {
// Default is no match. We'll check a few places for matches
$is_current_component = false;
// Always return false if a null value is passed to the function
if ( empty( $component ) ) {
return false;
}
// Backward compatibility: 'xprofile' should be read as 'profile'
if ( 'xprofile' === $component ) {
$component = 'profile';
}
$bp = buddypress();
// Only check if BuddyPress found a current_component
if ( ! empty( $bp->current_component ) ) {
// First, check to see whether $component_name and the current
// component are a simple match
if ( $bp->current_component == $component ) {
$is_current_component = true;
// Since the current component is based on the visible URL slug let's
// check the component being passed and see if its root_slug matches
} elseif ( isset( $bp->{$component}->root_slug ) && $bp->{$component}->root_slug == $bp->current_component ) {
$is_current_component = true;
// Because slugs can differ from root_slugs, we should check them too
} elseif ( isset( $bp->{$component}->slug ) && $bp->{$component}->slug == $bp->current_component ) {
$is_current_component = true;
// Next, check to see whether $component is a canonical,
// non-translatable component name. If so, we can return its
// corresponding slug from $bp->active_components.
} elseif ( $key = array_search( $component, $bp->active_components ) ) {
if ( strstr( $bp->current_component, $key ) ) {
$is_current_component = true;
}
// If we haven't found a match yet, check against the root_slugs
// created by $bp->pages, as well as the regular slugs
} else {
foreach ( $bp->active_components as $id ) {
// If the $component parameter does not match the current_component,
// then move along, these are not the droids you are looking for
if ( empty( $bp->{$id}->root_slug ) || $bp->{$id}->root_slug != $bp->current_component ) {
continue;
}
if ( $id == $component ) {
$is_current_component = true;
break;
}
}
}
}
/**
* Filters whether the current page belongs to the specified component.
*
* @since BuddyPress (1.5.0)
*
* @param bool $is_current_component Whether or not the current page belongs to specified component.
* @param string $component Name of the component being checked.
*/
return apply_filters( 'bp_is_current_component', $is_current_component, $component );
}
/**
* 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 BuddyPress (1.5.0)
*
* @param string $action The action being tested against.
* @return bool True if the current action matches $action.
*/
function bp_is_current_action( $action = '' ) {
return (bool) ( $action === bp_current_action() );
}
/**
* 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 BuddyPress (1.5.0)
*
* @param string $action_variable The action_variable being tested against.
* @param int $position Optional. The array key you're testing against. If you
* don't provide a $position, the function will return true if the
* $action_variable is found *anywhere* in the action variables array.
* @return bool True if $action_variable matches at the $position provided.
*/
function bp_is_action_variable( $action_variable = '', $position = false ) {
$is_action_variable = false;
if ( false !== $position ) {
// When a $position is specified, check that slot in the action_variables array
if ( $action_variable ) {
$is_action_variable = $action_variable == bp_action_variable( $position );
} else {
// If no $action_variable is provided, we are essentially checking to see
// whether the slot is empty
$is_action_variable = !bp_action_variable( $position );
}
} else {
// When no $position is specified, check the entire array
$is_action_variable = in_array( $action_variable, (array)bp_action_variables() );
}
/**
* Filters whether the current page matches a given action_variable.
*
* @since BuddyPress (1.5.0)
*
* @param bool $is_action_variable Whether the current page matches a given action_variable.
* @param string $action_variable The action_variable being tested against.
* @param int $position The array key tested against.
*/
return apply_filters( 'bp_is_action_variable', $is_action_variable, $action_variable, $position );
}
/**
* Check against the current_item.
*
* @param string $item The item being checked.
* @return bool True if $item is the current item.
*/
function bp_is_current_item( $item = '' ) {
$retval = ( $item === bp_current_item() );
/**
* Filters whether or not an item is the current item.
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not an item is the current item.
* @param string $item The item being checked.
*/
return (bool) apply_filters( 'bp_is_current_item', $retval, $item );
}
/**
* Are we looking at a single item? (group, user, etc)
*
* @return bool True if looking at a single item, otherwise false.
*/
function bp_is_single_item() {
$bp = buddypress();
$retval = false;
if ( isset( $bp->is_single_item ) ) {
$retval = $bp->is_single_item;
}
/**
* Filters whether or not an item is the a single item. (group, user, etc)
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not an item is a single item.
*/
return (bool) apply_filters( 'bp_is_single_item', $retval );
}
/**
* Is the logged-in user an admin for the current item?
*
* @return bool True if the current user is an admin for the current item,
* otherwise false.
*/
function bp_is_item_admin() {
$bp = buddypress();
$retval = false;
if ( isset( $bp->is_item_admin ) ) {
$retval = $bp->is_item_admin;
}
/**
* Filters whether or not the logged-in user is an admin for the current item.
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not the logged-in user is an admin.
*/
return (bool) apply_filters( 'bp_is_item_admin', $retval );
}
/**
* Is the logged-in user a mod for the current item?
*
* @return bool True if the current user is a mod for the current item,
* otherwise false.
*/
function bp_is_item_mod() {
$bp = buddypress();
$retval = false;
if ( isset( $bp->is_item_mod ) ) {
$retval = $bp->is_item_mod;
}
/**
* Filters whether or not the logged-in user is a mod for the current item.
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not the logged-in user is a mod.
*/
return (bool) apply_filters( 'bp_is_item_mod', $retval );
}
/**
* Is this a component directory page?
*
* @return bool True if the current page is a component directory, otherwise
* false.
*/
function bp_is_directory() {
$bp = buddypress();
$retval = false;
if ( isset( $bp->is_directory ) ) {
$retval = $bp->is_directory;
}
/**
* Filters whether or not user is on a component directory page.
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not user is on a component directory page.
*/
return (bool) apply_filters( 'bp_is_directory', $retval );
}
/**
* 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.
*
* @return bool True if root component, else false.
*/
function bp_is_root_component( $component_name = '' ) {
$bp = buddypress();
$retval = false;
// Default to the current component if none is passed
if ( empty( $component_name ) ) {
$component_name = bp_current_component();
}
// Loop through active components and check for key/slug matches
if ( ! empty( $bp->active_components ) ) {
foreach ( (array) $bp->active_components as $key => $slug ) {
if ( ( $key === $component_name ) || ( $slug === $component_name ) ) {
$retval = true;
break;
}
}
}
/**
* Filters whether or not a component's URL should be in the root, not under a member page.
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not URL should be in the root.
*/
return (bool) apply_filters( 'bp_is_root_component', $retval );
}
/**
* 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 BuddyPress (1.5.0)
*
* @global $current_blog WordPress global for the current blog.
*
* @param string $component Optional. Name of the component to check for.
* Default: current component.
* @return bool True if the specified component is set to be the site's front
* page, otherwise false.
*/
function bp_is_component_front_page( $component = '' ) {
global $current_blog;
$bp = buddypress();
// Default to the current component if none is passed
if ( empty( $component ) ) {
$component = bp_current_component();
}
// Get the path for the current blog/site
$path = is_main_site()
? bp_core_get_site_path()
: $current_blog->path;
// Get the front page variables
$show_on_front = get_option( 'show_on_front' );
$page_on_front = get_option( 'page_on_front' );
if ( ( 'page' !== $show_on_front ) || empty( $component ) || empty( $bp->pages->{$component} ) || ( $_SERVER['REQUEST_URI'] !== $path ) ) {
return false;
}
/**
* Filters whether or not the specified BuddyPress component directory is set to be the front page.
*
* @since BuddyPress (1.5.0)
*
* @param bool $value Whether or not the specified component directory is set as front page.
* @param string $component Current component being checked.
*/
return (bool) apply_filters( 'bp_is_component_front_page', ( $bp->pages->{$component}->id == $page_on_front ), $component );
}
/**
* 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.
*
* @return bool True if it's a non-BP page, false otherwise.
*/
function bp_is_blog_page() {
$is_blog_page = false;
// 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.
if ( ! bp_current_component() && ! bp_is_user() ) {
$is_blog_page = true;
}
/**
* Filters whether or not current page is a blog page or not.
*
* @since BuddyPress (1.5.0)
*
* @param bool $is_blog_page Whether or not current page is a blog page.
*/
return (bool) apply_filters( 'bp_is_blog_page', $is_blog_page );
}
/**
* 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 BuddyPress (1.7.0)
*
* @return bool True if it's a BuddyPress page, false otherwise.
*/
function is_buddypress() {
$retval = (bool) ( bp_current_component() || bp_is_user() );
/**
* Filters whether or not this is a BuddyPress component.
*
* @since BuddyPress (1.7.0)
*
* @param bool $retval Whether or not this is a BuddyPress component.
*/
return apply_filters( 'is_buddypress', $retval );
}
/** Components ****************************************************************/
/**
* Check whether a given component (or feature of a component) is active.
*
* @since BuddyPress (1.2.0) See r2539.
* @since BuddyPress (2.3.0) Added $feature as a parameter.
*
* @param string $component The component name.
* @param string $feature The feature name.
* @return bool
*/
function bp_is_active( $component = '', $feature = '' ) {
$retval = false;
// Default to the current component if none is passed
if ( empty( $component ) ) {
$component = bp_current_component();
}
// Is component in either the active or required components arrays
if ( isset( buddypress()->active_components[ $component ] ) || isset( buddypress()->required_components[ $component ] ) ) {
$retval = true;
// Is feature active?
if ( ! empty( $feature ) ) {
if ( empty( buddypress()->$component->features ) || false === in_array( $feature, buddypress()->$component->features, true ) ) {
$retval = false;
}
/**
* Filters whether or not a given feature for a component is active.
*
* @since BuddyPress (2.3.0)
*
* @param bool $retval
*/
$retval = apply_filters( "bp_is_{$component}_{$feature}_active", $retval );
}
}
/**
* Filters whether or not a given component has been activated by the admin.
*
* @since BuddyPress (2.1.0)
*
* @param bool $retval Whether or not a given component has been activated by the admin.
* @param string $component Current component being checked.
*/
return apply_filters( 'bp_is_active', $retval, $component );
}
/**
* Check whether the current page is part of the Members component.
*
* @return bool True if the current page is part of the Members component.
*/
function bp_is_members_component() {
return (bool) bp_is_current_component( 'members' );
}
/**
* Check whether the current page is part of the Profile component.
*
* @return bool True if the current page is part of the Profile component.
*/
function bp_is_profile_component() {
return (bool) bp_is_current_component( 'xprofile' );
}
/**
* Check whether the current page is part of the Activity component.
*
* @return bool True if the current page is part of the Activity component.
*/
function bp_is_activity_component() {
return (bool) bp_is_current_component( 'activity' );
}
/**
* Check whether the current page is part of the Blogs component.
*
* @return bool True if the current page is part of the Blogs component.
*/
function bp_is_blogs_component() {
return (bool) ( is_multisite() && bp_is_current_component( 'blogs' ) );
}
/**
* Check whether the current page is part of the Messages component.
*
* @return bool True if the current page is part of the Messages component.
*/
function bp_is_messages_component() {
return (bool) bp_is_current_component( 'messages' );
}
/**
* Check whether the current page is part of the Friends component.
*
* @return bool True if the current page is part of the Friends component.
*/
function bp_is_friends_component() {
return (bool) bp_is_current_component( 'friends' );
}
/**
* Check whether the current page is part of the Groups component.
*
* @return bool True if the current page is part of the Groups component.
*/
function bp_is_groups_component() {
return (bool) bp_is_current_component( 'groups' );
}
/**
* Check whether the current page is part of the Forums component.
*
* @return bool True if the current page is part of the Forums component.
*/
function bp_is_forums_component() {
return (bool) bp_is_current_component( 'forums' );
}
/**
* Check whether the current page is part of the Notifications component.
*
* @since BuddyPress (1.9.0)
*
* @return bool True if the current page is part of the Notifications component.
*/
function bp_is_notifications_component() {
return (bool) bp_is_current_component( 'notifications' );
}
/**
* Check whether the current page is part of the Settings component.
*
* @return bool True if the current page is part of the Settings component.
*/
function bp_is_settings_component() {
return (bool) bp_is_current_component( 'settings' );
}
/**
* 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.
*
* @return bool True if the current component is active and is one of BP's
* packaged components.
*/
function bp_is_current_component_core() {
$retval = false;
foreach ( bp_core_get_packaged_component_ids() as $active_component ) {
if ( bp_is_current_component( $active_component ) ) {
$retval = true;
break;
}
}
return $retval;
}
/** Activity ******************************************************************/
/**
* Is the current page the activity directory ?
*
* @since BuddyPress (2.0.0)
*
* @return True if the current page is the activity directory.
*/
function bp_is_activity_directory() {
if ( ! bp_displayed_user_id() && bp_is_activity_component() && ! bp_current_action() ) {
return true;
}
return false;
}
/**
* Is the current page a single activity item permalink?
*
* @return True if the current page is a single activity item permalink.
*/
function bp_is_single_activity() {
return (bool) ( bp_is_activity_component() && is_numeric( bp_current_action() ) );
}
/** User **********************************************************************/
/**
* Is the current page the members directory ?
*
* @since BuddyPress (2.0.0)
*
* @return True if the current page is the members directory.
*/
function bp_is_members_directory() {
if ( ! bp_is_user() && bp_is_members_component() ) {
return true;
}
return false;
}
/**
* 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/.
*
* @return True if the current page is part of the profile of the logged-in user.
*/
function bp_is_my_profile() {
if ( is_user_logged_in() && bp_loggedin_user_id() == bp_displayed_user_id() ) {
$my_profile = true;
} else {
$my_profile = false;
}
/**
* Filters whether or not current page is part of the profile for the logged-in user.
*
* @since BuddyPress (1.2.4)
*
* @param bool $my_profile Whether or not current page is part of the profile for the logged-in user.
*/
return apply_filters( 'bp_is_my_profile', $my_profile );
}
/**
* Is the current page a user page?
*
* Will return true anytime there is a displayed user.
*
* @return True if the current page is a user page.
*/
function bp_is_user() {
return (bool) bp_displayed_user_id();
}
/**
* Is the current page a user's activity stream page?
*
* Eg http://example.com/members/joe/activity/ (or any subpages thereof).
*
* @return True if the current page is a user's activity stream page.
*/
function bp_is_user_activity() {
return (bool) ( bp_is_user() && bp_is_activity_component() );
}
/**
* Is the current page a user's Friends activity stream?
*
* Eg http://example.com/members/joe/friends/
*
* @return True if the current page is a user's Friends activity stream.
*/
function bp_is_user_friends_activity() {
if ( ! bp_is_active( 'friends' ) ) {
return false;
}
$slug = bp_get_friends_slug();
if ( empty( $slug ) ) {
$slug = 'friends';
}
if ( bp_is_user_activity() && bp_is_current_action( $slug ) ) {
return true;
}
return false;
}
/**
* Is the current page a user's Groups activity stream?
*
* Eg http://example.com/members/joe/groups/
*
* @return True if the current page is a user's Groups activity stream.
*/
function bp_is_user_groups_activity() {
if ( ! bp_is_active( 'groups' ) ) {
return false;
}
$slug = ( bp_get_groups_slug() )
? bp_get_groups_slug()
: 'groups';
if ( bp_is_user_activity() && bp_is_current_action( $slug ) ) {
return true;
}
return false;
}
/**
* Is the current page part of a user's extended profile?
*
* Eg http://example.com/members/joe/profile/ (or a subpage thereof).
*
* @return True if the current page is part of a user's extended profile.
*/
function bp_is_user_profile() {
return (bool) ( bp_is_profile_component() || bp_is_current_component( 'profile' ) );
}
/**
* Is the current page part of a user's profile editing section?
*
* Eg http://example.com/members/joe/profile/edit/ (or a subpage thereof).
*
* @return True if the current page is a user's profile edit page.
*/
function bp_is_user_profile_edit() {
return (bool) ( bp_is_profile_component() && bp_is_current_action( 'edit' ) );
}
function bp_is_user_change_avatar() {
return (bool) ( bp_is_profile_component() && bp_is_current_action( 'change-avatar' ) );
}
/**
* Is this a user's forums page?
*
* Eg http://example.com/members/joe/forums/ (or a subpage thereof).
*
* @return bool True if the current page is a user's forums page.
*/
function bp_is_user_forums() {
if ( ! bp_is_active( 'forums' ) ) {
return false;
}
if ( bp_is_user() && bp_is_forums_component() ) {
return true;
}
return false;
}
/**
* Is this a user's "Topics Started" page?
*
* Eg http://example.com/members/joe/forums/topics/.
*
* @since BuddyPress (1.5.0)
*
* @return bool True if the current page is a user's Topics Started page.
*/
function bp_is_user_forums_started() {
return (bool) ( bp_is_user_forums() && bp_is_current_action( 'topics' ) );
}
/**
* Is this a user's "Replied To" page?
*
* Eg http://example.com/members/joe/forums/replies/.
*
* @since BuddyPress (1.5.0)
*
* @return bool True if the current page is a user's Replied To forums page.
*/
function bp_is_user_forums_replied_to() {
return (bool) ( bp_is_user_forums() && bp_is_current_action( 'replies' ) );
}
/**
* Is the current page part of a user's Groups page?
*
* Eg http://example.com/members/joe/groups/ (or a subpage thereof).
*
* @return bool True if the current page is a user's Groups page.
*/
function bp_is_user_groups() {
return (bool) ( bp_is_user() && bp_is_groups_component() );
}
/**
* Is the current page part of a user's Blogs page?
*
* Eg http://example.com/members/joe/blogs/ (or a subpage thereof).
*
* @return bool True if the current page is a user's Blogs page.
*/
function bp_is_user_blogs() {
return (bool) ( bp_is_user() && bp_is_blogs_component() );
}
/**
* Is the current page a user's Recent Blog Posts page?
*
* Eg http://example.com/members/joe/blogs/recent-posts/.
*
* @return bool True if the current page is a user's Recent Blog Posts page.
*/
function bp_is_user_recent_posts() {
return (bool) ( bp_is_user_blogs() && bp_is_current_action( 'recent-posts' ) );
}
/**
* Is the current page a user's Recent Blog Comments page?
*
* Eg http://example.com/members/joe/blogs/recent-comments/.
*
* @return bool True if the current page is a user's Recent Blog Comments page.
*/
function bp_is_user_recent_commments() {
return (bool) ( bp_is_user_blogs() && bp_is_current_action( 'recent-comments' ) );
}
/**
* Is the current page a user's Friends page?
*
* Eg http://example.com/members/joe/blogs/friends/ (or a subpage thereof).
*
* @return bool True if the current page is a user's Friends page.
*/
function bp_is_user_friends() {
return (bool) ( bp_is_user() && bp_is_friends_component() );
}
/**
* Is the current page a user's Friend Requests page?
*
* Eg http://example.com/members/joe/friends/requests/.
*
* @return bool True if the current page is a user's Friends Requests page.
*/
function bp_is_user_friend_requests() {
return (bool) ( bp_is_user_friends() && bp_is_current_action( 'requests' ) );
}
/**
* Is this a user's notifications page?
*
* Eg http://example.com/members/joe/notifications/ (or a subpage thereof).
*
* @since BuddyPress (1.9.0)
*
* @return bool True if the current page is a user's Notifications page.
*/
function bp_is_user_notifications() {
return (bool) ( bp_is_user() && bp_is_notifications_component() );
}
/**
* Is this a user's settings page?
*
* Eg http://example.com/members/joe/settings/ (or a subpage thereof).
*
* @return bool True if the current page is a user's Settings page.
*/
function bp_is_user_settings() {
return (bool) ( bp_is_user() && bp_is_settings_component() );
}
/**
* Is this a user's General Settings page?
*
* Eg http://example.com/members/joe/settings/general/.
*
* @since BuddyPress (1.5.0)
*
* @return bool True if the current page is a user's General Settings page.
*/
function bp_is_user_settings_general() {
return (bool) ( bp_is_user_settings() && bp_is_current_action( 'general' ) );
}
/**
* Is this a user's Notification Settings page?
*
* Eg http://example.com/members/joe/settings/notifications/.
*
* @since BuddyPress (1.5.0)
*
* @return bool True if the current page is a user's Notification Settings page.
*/
function bp_is_user_settings_notifications() {
return (bool) ( bp_is_user_settings() && bp_is_current_action( 'notifications' ) );
}
/**
* Is this a user's Account Deletion page?
*
* Eg http://example.com/members/joe/settings/delete-account/.
*
* @since BuddyPress (1.5.0)
*
* @return bool True if the current page is a user's Delete Account page.
*/
function bp_is_user_settings_account_delete() {
return (bool) ( bp_is_user_settings() && bp_is_current_action( 'delete-account' ) );
}
/**
* Is this a user's profile settings?
*
* Eg http://example.com/members/joe/settings/profile/.
*
* @since BuddyPress (2.0.0)
*
* @return bool True if the current page is a user's Profile Settings page.
*/
function bp_is_user_settings_profile() {
return (bool) ( bp_is_user_settings() && bp_is_current_action( 'profile' ) );
}
/** Groups ********************************************************************/
/**
* Is the current page the groups directory ?
*
* @since BuddyPress (2.0.0)
*
* @return True if the current page is the groups directory.
*/
function bp_is_groups_directory() {
if ( bp_is_groups_component() && ! bp_current_action() && ! bp_current_item() ) {
return true;
}
return false;
}
/**
* Does the current page belong to a single group?
*
* Will return true for any subpage of a single group.
*
* @return bool True if the current page is part of a single group.
*/
function bp_is_group() {
$retval = bp_is_active( 'groups' );
if ( ! empty( $retval ) ) {
$retval = bp_is_groups_component() && groups_get_current_group();
}
return (bool) $retval;
}
/**
* 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.
*
* @return bool True if the current page is a single group's home page.
*/
function bp_is_group_home() {
if ( bp_is_single_item() && bp_is_groups_component() && ( ! bp_current_action() || bp_is_current_action( 'home' ) ) ) {
return true;
}
return false;
}
/**
* Is the current page part of the group creation process?
*
* @return bool True if the current page is part of the group creation process.
*/
function bp_is_group_create() {
return (bool) ( bp_is_groups_component() && bp_is_current_action( 'create' ) );
}
/**
* Is the current page part of a single group's admin screens?
*
* Eg http://example.com/groups/mygroup/admin/settings/.
*
* @return bool True if the current page is part of a single group's admin.
*/
function bp_is_group_admin_page() {
return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'admin' ) );
}
/**
* Is the current page a group's forum page?
*
* Only applies to legacy bbPress forums.
*
* @return bool True if the current page is a group forum page.
*/
function bp_is_group_forum() {
$retval = false;
// At a forum URL
if ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'forum' ) ) {
$retval = true;
// If at a forum URL, set back to false if forums are inactive, or not
// installed correctly.
if ( ! bp_is_active( 'forums' ) || ! bp_forums_is_installed_correctly() ) {
$retval = false;
}
}
return $retval;
}
/**
* Is the current page a group's activity page?
*
* @return True if the current page is a group's activity page.
*/
function bp_is_group_activity() {
return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'activity' ) );
}
/**
* Is the current page a group forum topic?
*
* Only applies to legacy bbPress (1.x) forums.
*
* @return bool True if the current page is part of a group forum topic.
*/
function bp_is_group_forum_topic() {
return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'forum' ) && bp_is_action_variable( 'topic', 0 ) );
}
/**
* Is the current page a group forum topic edit page?
*
* Only applies to legacy bbPress (1.x) forums.
*
* @return bool True if the current page is part of a group forum topic edit page.
*/
function bp_is_group_forum_topic_edit() {
return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'forum' ) && bp_is_action_variable( 'topic', 0 ) && bp_is_action_variable( 'edit', 2 ) );
}
/**
* Is the current page a group's Members page?
*
* Eg http://example.com/groups/mygroup/members/.
*
* @return bool True if the current page is part of a group's Members page.
*/
function bp_is_group_members() {
return (bool) ( bp_is_single_item() && bp_is_groups_component() && bp_is_current_action( 'members' ) );
}
/**
* Is the current page a group's Invites page?
*
* Eg http://example.com/groups/mygroup/send-invites/.
*
* @return bool True if the current page is a group's Send Invites page.
*/
function bp_is_group_invites() {
return (bool) ( bp_is_groups_component() && bp_is_current_action( 'send-invites' ) );
}
/**
* Is the current page a group's Request Membership page?
*
* Eg http://example.com/groups/mygroup/request-membership/.
*
* @return bool True if the current page is a group's Request Membership page.
*/
function bp_is_group_membership_request() {
return (bool) ( bp_is_groups_component() && bp_is_current_action( 'request-membership' ) );
}
/**
* Is the current page a leave group attempt?
*
* @return bool True if the current page is a Leave Group attempt.
*/
function bp_is_group_leave() {
return (bool) ( bp_is_groups_component() && bp_is_single_item() && bp_is_current_action( 'leave-group' ) );
}
/**
* Is the current page part of a single group?
*
* Not currently used by BuddyPress.
*
* @todo How is this functionally different from bp_is_group()?
*
* @return bool True if the current page is part of a single group.
*/
function bp_is_group_single() {
return (bool) ( bp_is_groups_component() && bp_is_single_item() );
}
/**
* Is the current page the Create a Blog page?
*
* Eg http://example.com/sites/create/.
*
* @return bool True if the current page is the Create a Blog page.
*/
function bp_is_create_blog() {
return (bool) ( bp_is_blogs_component() && bp_is_current_action( 'create' ) );
}
/**
* Is the current page the blogs directory ?
*
* @since BuddyPress (2.0.0)
*
* @return True if the current page is the blogs directory.
*/
function bp_is_blogs_directory() {
if ( is_multisite() && bp_is_blogs_component() && ! bp_current_action() ) {
return true;
}
return false;
}
/** Messages ******************************************************************/
/**
* Is the current page part of a user's Messages pages?
*
* Eg http://example.com/members/joe/messages/ (or a subpage thereof).
*
* @return bool True if the current page is part of a user's Messages pages.
*/
function bp_is_user_messages() {
return (bool) ( bp_is_user() && bp_is_messages_component() );
}
/**
* Is the current page a user's Messages Inbox?
*
* Eg http://example.com/members/joe/messages/inbox/.
*
* @return bool True if the current page is a user's Messages Inbox.
*/
function bp_is_messages_inbox() {
if ( bp_is_user_messages() && ( ! bp_current_action() || bp_is_current_action( 'inbox' ) ) ) {
return true;
}
return false;
}
/**
* Is the current page a user's Messages Sentbox?
*
* Eg http://example.com/members/joe/messages/sentbox/.
*
* @return bool True if the current page is a user's Messages Sentbox.
*/
function bp_is_messages_sentbox() {
return (bool) ( bp_is_user_messages() && bp_is_current_action( 'sentbox' ) );
}
/**
* Is the current page a user's Messages Compose screen??
*
* Eg http://example.com/members/joe/messages/compose/.
*
* @return bool True if the current page is a user's Messages Compose screen.
*/
function bp_is_messages_compose_screen() {
return (bool) ( bp_is_user_messages() && bp_is_current_action( 'compose' ) );
}
/**
* Is the current page the Notices screen?
*
* Eg http://example.com/members/joe/messages/notices/.
*
* @return bool True if the current page is the Notices screen.
*/
function bp_is_notices() {
return (bool) ( bp_is_user_messages() && bp_is_current_action( 'notices' ) );
}
/**
* Is the current page a single Messages conversation thread?
*
* @return bool True if the current page a single Messages conversation thread?
*/
function bp_is_messages_conversation() {
return (bool) ( bp_is_user_messages() && ( bp_is_current_action( 'view' ) ) );
}
/**
* Not currently used by BuddyPress.
*
* @return bool
*/
function bp_is_single( $component, $callback ) {
return (bool) ( bp_is_current_component( $component ) && ( true === call_user_func( $callback ) ) );
}
/** Registration **************************************************************/
/**
* Is the current page the Activate page?
*
* Eg http://example.com/activate/.
*
* @return bool True if the current page is the Activate page.
*/
function bp_is_activation_page() {
return (bool) bp_is_current_component( 'activate' );
}
/**
* Is the current page the Register page?
*
* Eg http://example.com/register/.
*
* @return bool True if the current page is the Register page.
*/
function bp_is_register_page() {
return (bool) bp_is_current_component( 'register' );
}
/**
* Customize the body class, according to the currently displayed BP content.
*
* Uses the above is_() functions to output a body class for each scenario.
*
* @param array $wp_classes The body classes coming from WP.
* @param array $custom_classes Classes that were passed to get_body_class().
* @return array $classes The BP-adjusted body classes.
*/
function bp_the_body_class() {
echo bp_get_the_body_class();
}
function bp_get_the_body_class( $wp_classes = array(), $custom_classes = false ) {
$bp_classes = array();
/** Pages *************************************************************/
if ( is_front_page() ) {
$bp_classes[] = 'home-page';
}
if ( bp_is_directory() ) {
$bp_classes[] = 'directory';
}
if ( bp_is_single_item() ) {
$bp_classes[] = 'single-item';
}
/** Components ********************************************************/
if ( ! bp_is_blog_page() ) {
if ( bp_is_user_profile() ) {
$bp_classes[] = 'xprofile';
}
if ( bp_is_activity_component() ) {
$bp_classes[] = 'activity';
}
if ( bp_is_blogs_component() ) {
$bp_classes[] = 'blogs';
}
if ( bp_is_messages_component() ) {
$bp_classes[] = 'messages';
}
if ( bp_is_friends_component() ) {
$bp_classes[] = 'friends';
}
if ( bp_is_groups_component() ) {
$bp_classes[] = 'groups';
}
if ( bp_is_settings_component() ) {
$bp_classes[] = 'settings';
}
}
/** User **************************************************************/
if ( bp_is_user() ) {
$bp_classes[] = 'bp-user';
}
if ( ! bp_is_directory() ) {
if ( bp_is_user_blogs() ) {
$bp_classes[] = 'my-blogs';
}
if ( bp_is_user_groups() ) {
$bp_classes[] = 'my-groups';
}
if ( bp_is_user_activity() ) {
$bp_classes[] = 'my-activity';
}
}
if ( bp_is_my_profile() ) {
$bp_classes[] = 'my-account';
}
if ( bp_is_user_profile() ) {
$bp_classes[] = 'my-profile';
}
if ( bp_is_user_friends() ) {
$bp_classes[] = 'my-friends';
}
if ( bp_is_user_messages() ) {
$bp_classes[] = 'my-messages';
}
if ( bp_is_user_recent_commments() ) {
$bp_classes[] = 'recent-comments';
}
if ( bp_is_user_recent_posts() ) {
$bp_classes[] = 'recent-posts';
}
if ( bp_is_user_change_avatar() ) {
$bp_classes[] = 'change-avatar';
}
if ( bp_is_user_profile_edit() ) {
$bp_classes[] = 'profile-edit';
}
if ( bp_is_user_friends_activity() ) {
$bp_classes[] = 'friends-activity';
}
if ( bp_is_user_groups_activity() ) {
$bp_classes[] = 'groups-activity';
}
/** Messages **********************************************************/
if ( bp_is_messages_inbox() ) {
$bp_classes[] = 'inbox';
}
if ( bp_is_messages_sentbox() ) {
$bp_classes[] = 'sentbox';
}
if ( bp_is_messages_compose_screen() ) {
$bp_classes[] = 'compose';
}
if ( bp_is_notices() ) {
$bp_classes[] = 'notices';
}
if ( bp_is_user_friend_requests() ) {
$bp_classes[] = 'friend-requests';
}
if ( bp_is_create_blog() ) {
$bp_classes[] = 'create-blog';
}
/** Groups ************************************************************/
if ( bp_is_group() ) {
$bp_classes[] = 'group-' . groups_get_current_group()->slug;
}
if ( bp_is_group_leave() ) {
$bp_classes[] = 'leave-group';
}
if ( bp_is_group_invites() ) {
$bp_classes[] = 'group-invites';
}
if ( bp_is_group_members() ) {
$bp_classes[] = 'group-members';
}
if ( bp_is_group_forum_topic() ) {
$bp_classes[] = 'group-forum-topic';
}
if ( bp_is_group_forum_topic_edit() ) {
$bp_classes[] = 'group-forum-topic-edit';
}
if ( bp_is_group_forum() ) {
$bp_classes[] = 'group-forum';
}
if ( bp_is_group_admin_page() ) {
$bp_classes[] = 'group-admin';
$bp_classes[] = bp_get_group_current_admin_tab();
}
if ( bp_is_group_create() ) {
$bp_classes[] = 'group-create';
$bp_classes[] = bp_get_groups_current_create_step();
}
if ( bp_is_group_home() ) {
$bp_classes[] = 'group-home';
}
if ( bp_is_single_activity() ) {
$bp_classes[] = 'activity-permalink';
}
/** Registration ******************************************************/
if ( bp_is_register_page() ) {
$bp_classes[] = 'registration';
}
if ( bp_is_activation_page() ) {
$bp_classes[] = 'activation';
}
/** Current Component & Action ****************************************/
if ( ! bp_is_blog_page() ) {
$bp_classes[] = bp_current_component();
$bp_classes[] = bp_current_action();
}
/** Clean up ***********************************************************/
// Add BuddyPress class if we are within a BuddyPress page
if ( ! bp_is_blog_page() ) {
$bp_classes[] = 'buddypress';
}
// Merge WP classes with BuddyPress classes and remove any duplicates
$classes = array_unique( array_merge( (array) $bp_classes, (array) $wp_classes ) );
/**
* Filters the BuddyPress classes to be added to body_class()
*
* @since BuddyPress (1.1.0)
*
* @param array $classes Array of body classes to add.
* @param array $bp_classes Array of BuddyPress-based classes.
* @param array $wp_classes Array of WordPress-based classes.
* @param array $custom_classes Array of classes that were passed to get_body_class().
*/
return apply_filters( 'bp_get_the_body_class', $classes, $bp_classes, $wp_classes, $custom_classes );
}
add_filter( 'body_class', 'bp_get_the_body_class', 10, 2 );
/**
* Customizes the post CSS class according to BuddyPress content.
*
* Hooked to the 'post_class' filter.
*
* @since BuddyPress (2.1.0)
*
* @param array $wp_classes The post classes coming from WordPress.
* @return array
*/
function bp_get_the_post_class( $wp_classes = array() ) {
// don't do anything if we're not on a BP page
if ( ! is_buddypress() ) {
return $wp_classes;
}
$bp_classes = array();
if ( bp_is_user() || bp_is_single_activity() ) {
$bp_classes[] = 'bp_members';
} elseif ( bp_is_group() ) {
$bp_classes[] = 'bp_group';
} elseif ( bp_is_activity_component() ) {
$bp_classes[] = 'bp_activity';
} elseif ( bp_is_blogs_component() ) {
$bp_classes[] = 'bp_blogs';
} elseif ( bp_is_register_page() ) {
$bp_classes[] = 'bp_register';
} elseif ( bp_is_activation_page() ) {
$bp_classes[] = 'bp_activate';
} elseif ( bp_is_forums_component() && bp_is_directory() ) {
$bp_classes[] = 'bp_forum';
}
if ( empty( $bp_classes ) ) {
return $wp_classes;
}
// emulate post type css class
foreach ( $bp_classes as $bp_class ) {
$bp_classes[] = "type-{$bp_class}";
}
// removes the 'page' and 'type-page' post classes
// we need to remove these classes since they did not exist before we switched
// theme compat to use the 'page' post type
$page_key = array_search( 'page', $wp_classes );
$page_type_key = array_search( 'type-page', $wp_classes );
unset( $wp_classes[$page_key], $wp_classes[$page_type_key] );
// okay let's merge!
return array_unique( array_merge( $bp_classes, $wp_classes ) );
}
add_filter( 'post_class', 'bp_get_the_post_class' );
/**
* 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.
*
* @access private
* @since BuddyPress (1.7.0)
*
* @param array $a First item.
* @param array $b Second item.
* @return int Returns an integer less than, equal to, or greater than zero if
* the first argument is considered to be respectively less than, equal to, or greater than the second.
*/
function _bp_nav_menu_sort( $a, $b ) {
if ( $a['position'] == $b['position'] ) {
return 0;
} elseif ( $a['position'] < $b['position'] ) {
return -1;
} else {
return 1;
}
}
/**
* Get the items registered in the primary and secondary BuddyPress navigation menus.
*
* @since BuddyPress (1.7.0)
*
* @return array A multidimensional array of all navigation items.
*/
function bp_get_nav_menu_items() {
$menus = $selected_menus = array();
// Get the second level menus
foreach ( (array) buddypress()->bp_options_nav as $parent_menu => $sub_menus ) {
// The root menu's ID is "xprofile", but the Profile submenus are using "profile". See BP_Core::setup_nav().
if ( 'profile' === $parent_menu ) {
$parent_menu = 'xprofile';
}
// Sort the items in this menu's navigation by their position property
$second_level_menus = (array) $sub_menus;
usort( $second_level_menus, '_bp_nav_menu_sort' );
// Iterate through the second level menus
foreach( $second_level_menus as $sub_nav ) {
// Skip items we don't have access to
if ( empty( $sub_nav['user_has_access'] ) ) {
continue;
}
// Add this menu
$menu = new stdClass;
$menu->class = array( 'menu-child' );
$menu->css_id = $sub_nav['css_id'];
$menu->link = $sub_nav['link'];
$menu->name = $sub_nav['name'];
$menu->parent = $parent_menu; // Associate this sub nav with a top-level menu
// If we're viewing this item's screen, record that we need to mark its parent menu to be selected
if ( $sub_nav['slug'] == bp_current_action() ) {
$menu->class[] = 'current-menu-item';
$selected_menus[] = $parent_menu;
}
$menus[] = $menu;
}
}
// Get the top-level menu parts (Friends, Groups, etc) and sort by their position property
$top_level_menus = (array) buddypress()->bp_nav;
usort( $top_level_menus, '_bp_nav_menu_sort' );
// Iterate through the top-level menus
foreach ( $top_level_menus as $nav ) {
// Skip items marked as user-specific if you're not on your own profile
if ( empty( $nav['show_for_displayed_user'] ) && ! bp_core_can_edit_settings() ) {
continue;
}
// Get the correct menu link. See https://buddypress.trac.wordpress.org/ticket/4624
$link = bp_loggedin_user_domain() ? str_replace( bp_loggedin_user_domain(), bp_displayed_user_domain(), $nav['link'] ) : trailingslashit( bp_displayed_user_domain() . $nav['link'] );
// Add this menu
$menu = new stdClass;
$menu->class = array( 'menu-parent' );
$menu->css_id = $nav['css_id'];
$menu->link = $link;
$menu->name = $nav['name'];
$menu->parent = 0;
// Check if we need to mark this menu as selected
if ( in_array( $nav['css_id'], $selected_menus ) ) {
$menu->class[] = 'current-menu-parent';
}
$menus[] = $menu;
}
/**
* Filters the items registered in the primary and secondary BuddyPress navigation menus.
*
* @since BuddyPress (1.7.0)
*
* @param array $menus Array of items registered in the primary and secondary BuddyPress navigation.
*/
return apply_filters( 'bp_get_nav_menu_items', $menus );
}
/**
* Display a navigation menu.
*
* @since BuddyPress (1.7.0)
*
* @param string|array $args {
* An array of optional arguments.
* @type string $after Text after the link text. Default: ''.
* @type string $before Text before the link text. Default: ''.
* @type string $container The name of the element to wrap the navigation
* with. 'div' or 'nav'. Default: 'div'.
* @type string $container_class The class that is applied to the container.
* Default: 'menu-bp-container'.
* @type string $container_id The ID that is applied to the container.
* Default: ''.
* @type int depth How many levels of the hierarchy are to be included. 0
* means all. Default: 0.
* @type bool $echo True to echo the menu, false to return it.
* Default: true.
* @type bool $fallback_cb If the menu doesn't exist, should a callback
* function be fired? Default: false (no fallback).
* @type string $items_wrap How the list items should be wrapped. Should be
* in the form of a printf()-friendly string, using numbered
* placeholders. Default: '<ul id="%1$s" class="%2$s">%3$s</ul>'.
* @type string $link_after Text after the link. Default: ''.
* @type string $link_before Text before the link. Default: ''.
* @type string $menu_class CSS class to use for the <ul> element which
* forms the menu. Default: 'menu'.
* @type string $menu_id The ID that is applied to the <ul> element which
* forms the menu. Default: 'menu-bp', incremented.
* @type string $walker Allows a custom walker class to be specified.
* Default: 'BP_Walker_Nav_Menu'.
* }
* @return string|null If $echo is false, returns a string containing the nav
* menu markup.
*/
function bp_nav_menu( $args = array() ) {
static $menu_id_slugs = array();
$defaults = array(
'after' => '',
'before' => '',
'container' => 'div',
'container_class' => '',
'container_id' => '',
'depth' => 0,
'echo' => true,
'fallback_cb' => false,
'items_wrap' => '<ul id="%1$s" class="%2$s">%3$s</ul>',
'link_after' => '',
'link_before' => '',
'menu_class' => 'menu',
'menu_id' => '',
'walker' => '',
);
$args = wp_parse_args( $args, $defaults );
/**
* Filters the parsed bp_nav_menu arguments.
*
* @since BuddyPress (1.7.0)
*
* @param array $args Array of parsed arguments.
*/
$args = apply_filters( 'bp_nav_menu_args', $args );
$args = (object) $args;
$items = $nav_menu = '';
$show_container = false;
// Create custom walker if one wasn't set
if ( empty( $args->walker ) ) {
$args->walker = new BP_Walker_Nav_Menu;
}
// Sanitise values for class and ID
$args->container_class = sanitize_html_class( $args->container_class );
$args->container_id = sanitize_html_class( $args->container_id );
// Whether to wrap the ul, and what to wrap it with
if ( $args->container ) {
/**
* Filters the allowed tags for the wp_nav_menu_container.
*
* @since BuddyPress (1.7.0)
*
* @param array $value Array of allowed tags. Default 'div' and 'nav'.
*/
$allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', array( 'div', 'nav', ) );
if ( in_array( $args->container, $allowed_tags ) ) {
$show_container = true;
$class = $args->container_class ? ' class="' . esc_attr( $args->container_class ) . '"' : ' class="menu-bp-container"';
$id = $args->container_id ? ' id="' . esc_attr( $args->container_id ) . '"' : '';
$nav_menu .= '<' . $args->container . $id . $class . '>';
}
}
/**
* Filters the BuddyPress menu objects.
*
* @since BuddyPress (1.7.0)
*
* @param array $value Array of nav menu objects.
* @param array $args Array of arguments for the menu.
*/
$menu_items = apply_filters( 'bp_nav_menu_objects', bp_get_nav_menu_items(), $args );
$items = walk_nav_menu_tree( $menu_items, $args->depth, $args );
unset( $menu_items );
// Set the ID that is applied to the ul element which forms the menu.
if ( ! empty( $args->menu_id ) ) {
$wrap_id = $args->menu_id;
} else {
$wrap_id = 'menu-bp';
// If a specific ID wasn't requested, and there are multiple menus on the same screen, make sure the autogenerated ID is unique
while ( in_array( $wrap_id, $menu_id_slugs ) ) {
if ( preg_match( '#-(\d+)$#', $wrap_id, $matches ) ) {
$wrap_id = preg_replace('#-(\d+)$#', '-' . ++$matches[1], $wrap_id );
} else {
$wrap_id = $wrap_id . '-1';
}
}
}
$menu_id_slugs[] = $wrap_id;
/**
* Filters the BuddyPress menu items.
*
* Allow plugins to hook into the menu to add their own <li>'s
*
* @since BuddyPress (1.7.0)
*
* @param array $items Array of nav menu items.
* @param array $args Array of arguments for the menu.
*/
$items = apply_filters( 'bp_nav_menu_items', $items, $args );
// Build the output
$wrap_class = $args->menu_class ? $args->menu_class : '';
$nav_menu .= sprintf( $args->items_wrap, esc_attr( $wrap_id ), esc_attr( $wrap_class ), $items );
unset( $items );
// If we've wrapped the ul, close it
if ( ! empty( $show_container ) ) {
$nav_menu .= '</' . $args->container . '>';
}
/**
* Filters the final BuddyPress menu output.
*
* @since BuddyPress (1.7.0)
*
* @param string $nav_menu Final nav menu output.
* @param array $args Array of arguments for the menu.
*/
$nav_menu = apply_filters( 'bp_nav_menu', $nav_menu, $args );
if ( ! empty( $args->echo ) ) {
echo $nav_menu;
} else {
return $nav_menu;
}
}