Changeset 7212 for trunk/bp-members/bp-members-screens.php

Timestamp:

06/13/2013 01:27:01 AM (13 years ago)

Author:

boonebgorges

Message:

Introduces template hierarchy for top-level theme compat templates

The "top-level" template is the outermost template included by theme
compatibility. As of BuddyPress 1.7, a stack of template names is checked when
BP decides which top-level template to use: plugin-buddypres.php,
buddypress.php, community.php, etc. (See bp_get_theme_compat_templates().)

This changeset introduces an additional level of template hierarchy, so that
themes may provide top-level templates that are specific to the current
component, such as blogs/index-directory.php, or specific to the current item,
action, or status, such as groups/single/index-id-{$group_id}.php. In this way,
BP's top-level template hierarchy becomes more flexible for theme devs, and
more closely parallels the template hierarchy used by WordPress.

Note that this changeset only implements hierarchy for the top-level templates.
Inner template parts may receive a parallel hierarchy in a future version of
BuddyPress.

Fixes #4639

Props r-a-y

File:

• trunk/bp-members/bp-members-screens.php (modified) (7 diffs)

trunk/bp-members/bp-members-screens.php

@@ -267 +267 @@
  *
  * This class sets up the necessary theme compatability actions to safely output
- * group template parts to the_title and the_content areas of a theme.
+ * member template parts to the_title and the_content areas of a theme.
  *
  * @since BuddyPress (1.7)
@@ -299 +299 @@
                         do_action( 'bp_members_screen_index' );
 
+                        add_filter( 'bp_get_buddypress_template',                array( $this, 'directory_template_hierarchy' ) );
                         add_action( 'bp_template_include_reset_dummy_post_data', array( $this, 'directory_dummy_post' ) );
                         add_filter( 'bp_replace_the_content',                    array( $this, 'directory_content'    ) );
@@ -311 +312 @@
                         do_action( 'bp_members_screen_display_profile' );
 
+                        add_filter( 'bp_get_buddypress_template',                array( $this, 'single_template_hierarchy' ) );
                         add_action( 'bp_template_include_reset_dummy_post_data', array( $this, 'single_dummy_post'    ) );
                         add_filter( 'bp_replace_the_content',                    array( $this, 'single_dummy_content' ) );
@@ -318 +320 @@
 
         /** Directory *************************************************************/
+
+        /**
+         * Add template hierarchy to theme compat for the members directory page.
+         *
+         * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
+         *
+         * @since BuddyPress (1.8)
+         *
+         * @param string $templates The templates from bp_get_theme_compat_templates()
+         * @return array $templates Array of custom templates to look for.
+         */
+        public function directory_template_hierarchy( $templates ) {
+                // Setup our templates based on priority
+                $new_templates = apply_filters( 'bp_template_hierarchy_members_directory', array(
+                        'members/single/index-directory.php'
+                ) );
+
+                // Merge new templates with existing stack
+                // @see bp_get_theme_compat_templates()
+                $templates = array_merge( (array) $new_templates, $templates );
+
+                return $templates;
+        }
 
         /**
@@ -350 +375 @@
 
         /**
+         * Add custom template hierarchy to theme compat for member pages. 
+         *
+         * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
+         *
+         * @since BuddyPress (1.8)
+         *
+         * @param string $templates The templates from bp_get_theme_compat_templates()
+         * @return array $templates Array of custom templates to look for.
+         */
+        public function single_template_hierarchy( $templates ) {
+                // Setup some variables we're going to reference in our custom templates 
+                $user_nicename = buddypress()->displayed_user->userdata->user_nicename; 
+
+                // Setup our templates based on priority
+                $new_templates = apply_filters( 'bp_template_hierarchy_members_single_item', array(
+                        'members/single/index-id-'        . sanitize_file_name( bp_displayed_user_id() ) . '.php',
+                        'members/single/index-nicename-'  . sanitize_file_name( $user_nicename )         . '.php',
+                        'members/single/index-action-'    . sanitize_file_name( bp_current_action() )    . '.php',
+                        'members/single/index-component-' . sanitize_file_name( bp_current_component() ) . '.php',
+                        'members/single/index.php'
+                ) );
+
+                // Merge new templates with existing stack
+                // @see bp_get_theme_compat_templates()
+                $templates = array_merge( (array) $new_templates, $templates );
+
+                return $templates;
+        }
+
+        /**
          * Update the global $post with the displayed user's data
          *
@@ -414 +469 @@
 
                 // Setup actions
+                add_filter( 'bp_get_buddypress_template',                array( $this, 'template_hierarchy' ) );
                 add_action( 'bp_template_include_reset_dummy_post_data', array( $this, 'dummy_post'    ) );
                 add_filter( 'bp_replace_the_content',                    array( $this, 'dummy_content' ) );
@@ -419 +475 @@
 
         /** Template ***********************************************************/
+
+        /**
+         * Add template hierarchy to theme compat for registration / activation pages.
+         *
+         * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
+         *
+         * @since BuddyPress (1.8)
+         *
+         * @param string $templates The templates from bp_get_theme_compat_templates()
+         * @return array $templates Array of custom templates to look for.
+         */
+        public function template_hierarchy( $templates ) {
+                $component = sanitize_file_name( bp_current_component() );
+
+                // Setup our templates based on priority
+                $new_templates = apply_filters( "bp_template_hierarchy_{$component}", array(
+                        "members/index-{$component}.php"
+                ) );
+
+                // Merge new templates with existing stack
+                // @see bp_get_theme_compat_templates()
+                $templates = array_merge( (array) $new_templates, $templates );
+
+                return $templates;
+        }
 
         /**