Function Reference

DescriptionBuddypress snippet by - 07/21/10

This is a list of functions or template tags for buddypress, this is a partial list from bp-core-templatetags.php, I will be adding to this buddypress function reference when time.

Tags ,

<?php
/*
Functions from  bp-core-templatetags.php
This code is in <?php ?> tags only for syntax coloring, dont run this file
*/

bp_core_members_template( $type, $page_number, $per_page, $max, $user_id, $search_terms, $include, $populate_extras )
//Loop functions
has_members()
next_member()
rewind_members()
members()
the_member()
bp_rewind_members()
bp_has_members( $args = '' )
'type' => $type,
'page' => $page,
'per_page' => 20,
'max' => false,
'include' => false, // Pass a user_id or comma separated list of user_ids to only show these users
'user_id' => $user_id, // Pass a user_id to only show friends of this user
'search_terms' => $search_terms, // Pass search_terms to filter users by their profile data
'populate_extras' => true // Fetch usermeta? Friend count, last active etc.

bp_the_member()
bp_members()
//Misc
bp_members_pagination_count()
bp_members_pagination_links()
bp_member_user_id()
bp_get_member_user_id()
bp_member_user_nicename()
bp_get_member_user_nicename()
bp_member_user_login()
bp_get_member_user_login()
bp_member_user_email()
bp_get_member_user_email()
bp_member_is_loggedin_user()
bp_member_avatar( $args = '' )
bp_get_member_avatar( $args = '' )
'type' => 'thumb',
'width' => false,
'height' => false,
'class' => 'avatar',
'id' => false,
'alt' => __( 'Member avatar', 'buddypress' )

bp_member_permalink()
bp_member_link()
bp_get_member_link()
bp_member_name()
bp_get_member_name()
bp_member_last_active()
bp_get_member_last_active()
bp_member_latest_update( $args = '' )
bp_get_member_latest_update( $args = '' ) {
'length' => 15

bp_member_profile_data( $args = '' )
'field' => false, // Field name
bp_member_registered()
bp_get_member_registered()
bp_member_add_friend_button()
bp_add_friend_button( $members_template->member->id, $friend_status )
bp_member_total_friend_count()
bp_get_member_total_friend_count()
bp_member_random_profile_data()
bp_member_hidden_fields()
bp_directory_members_search_form()
bp_total_site_member_count()
bp_get_total_site_member_count()
//Check bp-core-templatetags.php for comments about nav tags
bp_get_loggedin_user_nav()
bp_get_displayed_user_nav()
bp_get_options_nav()
bp_get_options_title()
//Avatar Tags
bp_has_options_avatar()
bp_get_options_avatar()
bp_comment_author_avatar()
bp_post_author_avatar()
bp_loggedin_user_avatar( $args = '' )
bp_get_loggedin_user_avatar( $args = '' ) {
'type'=> 'thumb',
'width'=> false,
'height'=> false,
'html'=> true

bp_displayed_user_avatar( $args = '' )
bp_get_displayed_user_avatar( $args = '' )
'type'=> 'thumb',
'width'=> false,
'height'=> false,
'html'=> true

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()
//Other
bp_site_name()
bp_core_get_wp_profile()
bp_get_profile_header()
bp_exists( $component_name )
bp_format_time( $time, $just_date = false )
bp_word_or_name( $youtext, $nametext, $capitalize = true, $echo = true )
bp_your_or_their( $capitalize = true, $echo = true )
bp_get_plugin_sidebar()
bp_page_title()
bp_get_page_title()
bp_styles()
bp_has_custom_signup_page()
bp_signup_page()
bp_get_signup_page()
bp_has_custom_activation_page()
bp_activation_page()
bp_get_activation_page()
bp_search_form_enabled()
bp_search_form_action()
bp_search_form_type_select()
bp_search_form()
bp_log_out_link()
bp_custom_profile_boxes()
bp_custom_profile_sidebar_boxes()
bp_create_excerpt( $text, $excerpt_length = 55, $filter_shortcodes = true )
bp_is_serialized( $data )
bp_total_member_count()
bp_get_total_member_count()
bp_signup_username_value()
bp_get_signup_username_value()
bp_signup_email_value()
bp_get_signup_email_value()
bp_signup_with_blog_value()
bp_get_signup_with_blog_value()
bp_signup_blog_url_value()
bp_get_signup_blog_url_value()
bp_signup_blog_title_value()
bp_get_signup_blog_title_value()
bp_signup_blog_privacy_value()
bp_get_signup_blog_privacy_value()
bp_signup_avatar_dir_value()
bp_get_signup_avatar_dir_value()
bp_current_signup_step()
bp_get_current_signup_step()
bp_signup_avatar( $args = '' )
bp_get_signup_avatar( $args = '' ) {
'size' => BP_AVATAR_FULL_WIDTH,
'class' => 'avatar',
'alt' => __( 'Your Avatar', 'buddypress' )
bp_signup_allowed()
bp_get_signup_allowed()
bp_blog_signup_allowed()
bp_get_blog_signup_allowed()
bp_account_was_activated()
bp_registration_needs_activation()
bp_mentioned_user_display_name( $user_id_or_username )
bp_get_mentioned_user_display_name( $user_id_or_username )
bp_get_option( $option_name )
bp_ajax_querystring( $object = false )
bp_last_activity( $user_id = false, $echo = true )
bp_user_has_access()
bp_user_firstname()
bp_get_user_firstname()
bp_loggedin_user_link()
bp_get_loggedin_user_link()
bp_loggedinuser_link()
bp_displayed_user_link()
bp_get_displayed_user_link()
bp_user_link()
bp_displayed_user_id()
bp_current_user_id()
bp_loggedin_user_id()
bp_displayed_user_domain()
bp_loggedin_user_domain()
bp_displayed_user_fullname()
bp_get_displayed_user_fullname()
bp_user_fullname() { echo bp_get_displayed_user_fullname()
bp_loggedin_user_fullname()
bp_get_loggedin_user_fullname()
bp_displayed_user_username()
bp_get_displayed_user_username()
bp_loggedin_user_username()
bp_get_loggedin_user_username()
bp_current_component()
bp_current_action()
bp_current_item()
bp_action_variables()
bp_root_domain()
bp_get_root_domain()
//Conditionals
bp_is_blog_page()
bp_is_my_profile()
bp_is_home()
bp_is_front_page()
bp_is_activity_front_page()
bp_is_directory()
bp_is_page($page)
bp_is_active( $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_settings_component()
bp_is_member()
bp_is_user_activity()
bp_is_user_friends_activity()
bp_is_activity_permalink()
bp_is_user_profile()
bp_is_profile_edit()
bp_is_change_avatar()
bp_is_user_groups()
bp_is_group()
bp_is_group_home()
bp_is_group_create()
bp_is_group_admin_page()
bp_is_group_forum()
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_user_blogs()
bp_is_user_recent_posts()
bp_is_user_recent_commments()
bp_is_create_blog()
bp_is_user_friends()
bp_is_friend_requests()
bp_is_user_messages()
bp_is_messages_inbox()
bp_is_messages_sentbox()
bp_is_notices()
bp_is_messages_compose_screen()
bp_is_single_item()
bp_is_activation_page()
bp_is_register_page()
bp_the_body_class()
bp_get_the_body_class( $wp_classes, $custom_classes = false )
?>
  • Share
Authored by: Adam J Nowak
http://hyperspatial.com

Comments and Feedback