Contents

Code Reference Classes BP_Members_Theme_Compat

BP_Members_Theme_Compat

The main theme compat class for BuddyPress Members.

Description

This class sets up the necessary theme compatibility actions to safely output member template parts to the_title and the_content areas of a theme.

Source

File: bp-members/classes/class-bp-members-theme-compat.php

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
class BP_Members_Theme_Compat {
 
    /**
     * Set up the members component theme compatibility.
     *
     * @since BuddyPress 1.7.0
     */
    public function __construct() {
        add_action( 'bp_setup_theme_compat', array( $this, 'is_members' ) );
    }
 
    /**
     * Are we looking at something that needs members theme compatibility?
     *
     * @since BuddyPress 1.7.0
     */
    public function is_members() {
 
        // Bail if not looking at the members component or a user's page.
        if ( ! bp_is_members_component() && ! bp_is_user() ) {
            return;
        }
 
        // User page.
        if ( bp_is_user() ) {
 
            // If we're on a single activity permalink page, we shouldn't use the members
            // template, so stop here!
            if ( bp_is_active( 'activity' ) && bp_is_single_activity() ) {
                return;
            }
 
            /**
             * Fires if looking at Members user page when needing theme compat.
             *
             * @since BuddyPress 1.5.0
             */
            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' ) );
 
        // Members Directory.
        } elseif ( ! bp_current_action() && ! bp_current_item() ) {
            bp_update_is_directory( true, 'members' );
 
            /**
             * Fires if looking at Members directory when needing theme compat.
             *
             * @since BuddyPress 1.5.0
             */
            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'    ) );
        }
    }
 
    /** 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.0
     *
     * @param array $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 = array() ) {
 
        // Set up the template hierarchy.
        $new_templates = array();
        if ( '' !== bp_get_current_member_type() ) {
            $new_templates[] = 'members/index-directory-type-' . sanitize_file_name( bp_get_current_member_type() ) . '.php';
        }
        $new_templates[] = 'members/index-directory.php';
 
        /**
         * Filters the template hierarchy for theme compat and members directory page.
         *
         * @since BuddyPress 1.8.0
         *
         * @param array $value Array of template paths to add to hierarchy.
         */
        $new_templates = apply_filters( 'bp_template_hierarchy_members_directory', $new_templates );
 
        // 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 directory data.
     *
     * @since BuddyPress 1.7.0
     */
    public function directory_dummy_post() {
        bp_theme_compat_reset_post( array(
            'ID'             => 0,
            'post_title'     => bp_get_directory_title( 'members' ),
            'post_author'    => 0,
            'post_date'      => 0,
            'post_content'   => '',
            'post_type'      => 'page',
            'post_status'    => 'publish',
            'is_page'        => true,
            'comment_status' => 'closed'
        ) );
    }
 
    /**
     * Filter the_content with the members index template part.
     *
     * @since BuddyPress 1.7.0
     */
    public function directory_content() {
        return bp_buffer_template_part( 'members/index', null, false );
    }
 
    /** Single ****************************************************************/
 
    /**
     * 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.0
     *
     * @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;
 
        /**
         * Filters the template hierarchy for theme compat and member pages.
         *
         * @since BuddyPress 1.8.0
         *
         * @param array $value Array of template paths to add to hierarchy.
         */
        $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.
     *
     * @since BuddyPress 1.7.0
     */
    public function single_dummy_post() {
        bp_theme_compat_reset_post( array(
            'ID'             => 0,
            'post_title'     => bp_get_displayed_user_fullname(),
            'post_author'    => 0,
            'post_date'      => 0,
            'post_content'   => '',
            'post_type'      => 'page',
            'post_status'    => 'publish',
            'is_page'        => true,
            'comment_status' => 'closed'
        ) );
    }
 
    /**
     * Filter the_content with the members' single home template part.
     *
     * @since BuddyPress 1.7.0
     */
    public function single_dummy_content() {
        return bp_buffer_template_part( 'members/single/home', null, false );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.7.0 Introduced.

Methods

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.