Contents

Code Reference Functions bp_core_load_template()

bp_core_load_template( array $templates )

Load a specific template file with fallback support.

Description

Example: bp_core_load_template( ‘members/index’ ); Loads: wp-content/themes/[activated_theme]/members/index.php

Parameters

$templates

(Required) Array of templates to attempt to load.

Source

File: bp-core/bp-core-catchuri.php 

function bp_core_load_template( $templates ) {
	global $wp_query;

	// Reset the post.
	bp_theme_compat_reset_post( array(
		'ID'          => 0,
		'is_404'      => true,
		'post_status' => 'publish',
	) );

	// Set theme compat to false since the reset post function automatically sets
	// theme compat to true.
	bp_set_theme_compat_active( false );

	// Fetch each template and add the php suffix.
	$filtered_templates = array();
	foreach ( (array) $templates as $template ) {
		$filtered_templates[] = $template . '.php';
	}

	// Only perform template lookup for bp-default themes.
	if ( ! bp_use_theme_compat_with_current_theme() ) {
		$template = locate_template( (array) $filtered_templates, false );

	// Theme compat doesn't require a template lookup.
	} else {
		$template = '';
	}

	/**
	 * Filters the template locations.
	 *
	 * Allows plugins to alter where the template files are located.
	 *
	 * @since BuddyPress 1.1.0
	 *
	 * @param string $template           Located template path.
	 * @param array  $filtered_templates Array of templates to attempt to load.
	 */
	$located_template = apply_filters( 'bp_located_template', $template, $filtered_templates );

	/*
	 * If current page is an embed, wipe out bp-default template.
	 *
	 * Wiping out the bp-default template allows WordPress to use their special
	 * embed template, which is what we want.
	 */
	if ( function_exists( 'is_embed' ) && is_embed() ) {
		$located_template = '';
	}

	if ( !empty( $located_template ) ) {
		// Template was located, lets set this as a valid page and not a 404.
		status_header( 200 );
		$wp_query->is_page     = true;
		$wp_query->is_singular = true;
		$wp_query->is_404      = false;

		/**
		 * Fires before the loading of a located template file.
		 *
		 * @since BuddyPress 1.6.0
		 *
		 * @param string $located_template Template found to be loaded.
		 */
		do_action( 'bp_core_pre_load_template', $located_template );

		/**
		 * Filters the selected template right before loading.
		 *
		 * @since BuddyPress 1.1.0
		 *
		 * @param string $located_template Template found to be loaded.
		 */
		load_template( apply_filters( 'bp_load_template', $located_template ) );

		/**
		 * Fires after the loading of a located template file.
		 *
		 * @since BuddyPress 1.6.0
		 *
		 * @param string $located_template Template found that was loaded.
		 */
		do_action( 'bp_core_post_load_template', $located_template );

		// Kill any other output after this.
		exit();

	// No template found, so setup theme compatibility.
	// @todo Some other 404 handling if theme compat doesn't kick in.
	} else {

		// We know where we are, so reset important $wp_query bits here early.
		// The rest will be done by bp_theme_compat_reset_post() later.
		if ( is_buddypress() ) {
			status_header( 200 );
			$wp_query->is_page     = true;
			$wp_query->is_singular = true;
			$wp_query->is_404      = false;
		}

		/**
		 * Fires if there are no found templates to load and theme compat is needed.
		 *
		 * @since BuddyPress 1.7.0
		 */
		do_action( 'bp_setup_theme_compat' );
	}
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-theme-compatibility.php: bp_theme_compat_reset_post()

Populate various WordPress globals with dummy data to prevent errors.
bp-core/bp-core-theme-compatibility.php: bp_set_theme_compat_active()

Set the flag that tells whether the current page is using theme compatibility.
bp-core/bp-core-theme-compatibility.php: bp_use_theme_compat_with_current_theme()

Should we use theme compat for this theme?
bp-core/bp-core-template.php: is_buddypress()

Is this a BuddyPress component?
bp-core/bp-core-catchuri.php: bp_load_template

Filters the selected template right before loading.
bp-core/bp-core-catchuri.php: bp_core_post_load_template

Fires after the loading of a located template file.
bp-core/bp-core-catchuri.php: bp_setup_theme_compat

Fires if there are no found templates to load and theme compat is needed.
bp-core/bp-core-catchuri.php: bp_located_template

Filters the template locations.
bp-core/bp-core-catchuri.php: bp_core_pre_load_template

Fires before the loading of a located template file.
Show 4 more uses Hide more uses
Used By
Used By Description
bp-document/screens/directory.php: bp_document_screen_index()

Load the Document directory.
bp-document/screens/document.php: document_screen()

Load the Document screen.
bp-document/screens/folders.php: document_screen_single_folder()

Load an individual folder screen.
bp-integrations/learndash/core/Core.php: Core::certificates_page()

Display Certificates Page Content in Profile course menu
bp-integrations/learndash/core/Core.php: Core::course_page()

Display Course Page Content in Profile course menu
bp-groups/screens/single/documents.php: groups_screen_group_document()

Handle the loading of a single group’s documents.
bp-groups/screens/single/folders.php: document_screen_group_single_folder()

Load an individual folder screen.
bp-groups/screens/single/messages.php: groups_screen_group_messages()

Handle the display of a group’s Group Messages page.
bp-activity/screens/following.php: bp_activity_screen_following()

Load the ‘My Following’ activity page.
bp-settings/screens/capabilities.php: bp_settings_screen_capabilities()

Show the capabilities settings template.
bp-settings/screens/delete-account.php: bp_settings_screen_delete_account()

Show the delete-account settings template.
bp-settings/screens/export.php: bp_settings_screen_export_data()

Show the notifications settings template.
bp-settings/screens/general.php: bp_settings_screen_general()

Show the general settings template.
bp-settings/screens/notifications.php: bp_settings_screen_notification()

Show the notifications settings template.
bp-forums/functions.php: bbp_member_forums_screen_topics()

Hook Forums topics template into plugins template
bp-forums/functions.php: bbp_member_forums_screen_replies()

Hook Forums replies template into plugins template
bp-forums/functions.php: bbp_member_forums_screen_favorites()

Hook Forums favorites template into plugins template
bp-forums/functions.php: bbp_member_forums_screen_subscriptions()

Hook Forums subscriptions template into plugins template
bp-media/screens/directory.php: bp_media_screen_index()

Load the Media directory.
bp-media/screens/media.php: media_screen()

Load the Media screen.
bp-media/screens/albums.php: media_screen_single_album()

Load an individual album screen.
bp-notifications/screens/read.php: bp_notifications_screen_read()

Catch and route the ‘read’ notifications screen.
bp-notifications/screens/unread.php: bp_notifications_screen_unread()

Catch and route the ‘unread’ notifications screen.
bp-blogs/screens/create.php: bp_blogs_screen_create_a_blog()

Load the “Create a Blog” screen.
bp-blogs/screens/directory.php: bp_blogs_screen_index()

Load the top-level Blogs directory.
bp-blogs/screens/my-blogs.php: bp_blogs_screen_my_blogs()

Load the “My Blogs” screen.
bp-xprofile/screens/change-avatar.php: xprofile_screen_change_avatar()

Handles the uploading and cropping of a user avatar. Displays the change avatar page.
bp-xprofile/screens/change-cover-image.php: xprofile_screen_change_cover_image()

Displays the change cover photo page.
bp-xprofile/screens/edit.php: xprofile_screen_edit_profile()

Handles the display of the profile edit page by loading the correct template file.
bp-xprofile/screens/settings-profile.php: bp_xprofile_screen_settings()

Show the xprofile settings template.
bp-xprofile/screens/public.php: xprofile_screen_display_profile()

Handles the display of the profile page by loading the correct template file.
bp-messages/screens/notices.php: messages_screen_notices()

Load the Messages > Notices screen.
bp-messages/screens/starred.php: bp_messages_star_screen()

Screen handler to display a user’s “Starred” private messages page.
bp-messages/screens/compose.php: messages_screen_compose()

Load the Messages > Compose screen.
bp-messages/screens/inbox.php: messages_screen_inbox()

Load the Messages > Inbox screen.
bp-messages/screens/view.php: messages_screen_conversation()

Load an individual conversation screen.
bp-groups/screens/single/admin/delete-group.php: groups_screen_group_admin_delete_group()

Handle the display of the Delete Group page.
bp-groups/screens/single/admin/group-cover-image.php: groups_screen_group_admin_cover_image()

Handle the display of a group’s Change cover photo page.
bp-groups/screens/user/invites.php: groups_screen_group_invites()

Handle the loading of a user’s Groups > Invites page.
bp-groups/screens/user/my-groups.php: groups_screen_my_groups()

Handle the loading of the My Groups page.
bp-groups/screens/directory.php: groups_directory_groups_setup()

Handle the display of the Groups directory index.
bp-groups/screens/single/admin/edit-details.php: groups_screen_group_admin_edit_details()

Handle the display of a group’s admin/edit-details page.
bp-groups/screens/single/admin/group-settings.php: groups_screen_group_admin_settings()

Handle the display of a group’s admin/group-settings page.
bp-groups/screens/single/admin/manage-members.php: groups_screen_group_admin_manage_members()

This function handles actions related to member management on the group admin.
bp-groups/screens/single/admin/group-avatar.php: groups_screen_group_admin_avatar()

Handle the display of a group’s Change Avatar page.
bp-groups/screens/single/admin/membership-requests.php: groups_screen_group_admin_requests()

Handle the display of Admin > Membership Requests.
bp-groups/screens/single/members/all-members.php: groups_screen_group_members_all_members()

Handle the display of a group’s members/all-members page.
bp-groups/screens/single/members/leaders.php: groups_screen_group_members_leaders()

Handle the display of a group’s members/leaders page.
bp-groups/screens/single/subgroups.php: groups_screen_group_subgroups()

Handle the loading of a single group’s subgroups.
bp-groups/screens/single/activity.php: groups_screen_group_activity()

Handle the loading of a single group’s activity.
bp-groups/screens/single/home.php: groups_screen_group_home()

Handle the loading of a single group’s page.
bp-groups/screens/single/invite.php: groups_screen_group_invite()

Handle the display of a group’s Send Invites page.
bp-groups/screens/single/photos.php: groups_screen_group_media()

Handle the loading of a single group’s photos.
bp-groups/actions/join.php: groups_action_join_group()

Catch and process “Join Group” button clicks.
bp-groups/screens/single/activity-permalink.php: groups_screen_group_activity_permalink()

Handle the display of a single group activity item.
bp-groups/screens/single/albums.php: groups_screen_group_albums()

Handle the loading of a single group’s albums.
bp-groups/screens/single/request-membership.php: groups_screen_group_request_membership()

Handle the display of a group’s Request Membership page.
bp-groups/actions/create.php: groups_action_create_group()

Catch and process group creation form submissions.
bp-groups/actions/leave-group.php: groups_action_leave_group()

Catch and process “Leave Group” button clicks.
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::call_edit_screen_template_loader()

Load the template that houses the Edit screen.
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::_display_hook()

Hook the main display method, and loads the template file.
bp-members/screens/activate.php: bp_core_screen_activation()

Handle the loading of the Activate screen.
bp-members/screens/directory.php: bp_members_screen_index()

Handle the display of the members directory index.
bp-members/screens/profile.php: bp_members_screen_display_profile()

Handle the display of the profile page by loading the correct template file.
bp-members/screens/register.php: bp_core_screen_signup()

Handle the loading of the signup screen.
bp-invites/screens/send-invites.php: bp_invites_screen_send_invite()

Handle the loading of the Invites > Sent Invites page.
bp-invites/screens/sent-invites.php: bp_invites_screen_sent_invite()

Handle the loading of a user’s Invites > Invite by Email page.
bp-friends/screens/mutual-friends.php: friends_screen_mutual_friends()

Catch and process the Mutual Connections page.
bp-friends/screens/my-friends.php: friends_screen_my_friends()

Catch and process the My Connections page.
bp-friends/screens/requests.php: friends_screen_requests()

Catch and process the Requests page.
bp-templates/bp-nouveau/includes/groups/functions.php: bp_nouveau_groups_screen_invites_restriction()

Group invites restriction screen.
bp-core/deprecated/buddyboss/1.0.php: messages_screen_sentbox()

Load the Messages > Sent screen.
bp-core/bp-core-catchuri.php: bp_core_catch_profile_uri()

Redirect away from /profile URIs if XProfile is not enabled.
bp-activity/screens/favorites.php: bp_activity_screen_favorites()

Load the ‘Favorites’ activity page.
bp-activity/screens/just-me.php: bp_activity_screen_my_activity()

Load the ‘My Activity’ page.
bp-activity/screens/mentions.php: bp_activity_screen_mentions()

Load the ‘Mentions’ activity page.
bp-activity/screens/directory.php: bp_activity_screen_index()

Load the Activity directory.
bp-activity/screens/friends.php: bp_activity_screen_friends()

Load the ‘My Connections’ activity page.
bp-activity/screens/groups.php: bp_activity_screen_groups()

Load the ‘My Groups’ activity page.
bp-activity/screens/permalink.php: bp_activity_screen_single_activity_permalink()

Load the page for a single activity item.
Show 75 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.