Contents

Code Reference Functions bp_get_template_stack()

bp_get_template_stack()

Get the “template stack”, a list of registered directories where templates can be found.

Description

Calls the functions added to the ‘bp_template_stack’ filter hook, and return an array of the template locations.

See also

Return

(array) The filtered value after all hooked functions are applied to it.

Source

File: bp-core/bp-core-template-loader.php

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
    $args = $stack = array();
 
    // Add 'bp_template_stack' to the current filter array.
    $wp_current_filter[] = $tag;
 
    // Sort.
    if ( class_exists( 'WP_Hook' ) ) {
        $filter = $wp_filter[ $tag ]->callbacks;
    } else {
        $filter = &$wp_filter[ $tag ];
 
        if ( ! isset( $merged_filters[ $tag ] ) ) {
            ksort( $filter );
            $merged_filters[ $tag ] = true;
        }
    }
 
    // Ensure we're always at the beginning of the filter array.
    reset( $filter );
 
    // Loop through 'bp_template_stack' filters, and call callback functions.
    do {
        foreach( (array) current( $filter ) as $the_ ) {
            if ( ! is_null( $the_['function'] ) ) {
                $args[1] = $stack;
                $stack[] = call_user_func_array( $the_['function'], array_slice( $args, 1, (int) $the_['accepted_args'] ) );
            }
        }
    } while ( next( $filter ) !== false );
 
    // Remove 'bp_template_stack' from the current filter array.
    array_pop( $wp_current_filter );
 
    // Remove empties and duplicates.
    $stack = array_unique( array_filter( $stack ) );
 
    /**
     * Filters the "template stack" list of registered directories where templates can be found.
     *
     * @since BuddyPress 1.7.0
     *
     * @param array $stack Array of registered directories for template locations.
     */
    return (array) apply_filters( 'bp_get_template_stack', $stack ) ;
}
 
/**
 * Put a template part into an output buffer, and return it.
 *
 * @since BuddyPress 1.7.0

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.7.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-template-loader.php: bp_get_template_stack

Filters the “template stack” list of registered directories where templates can be found.
Used By
Used By Description
bp-core/bp-core-template-loader.php: bp_locate_template()

Retrieve the name of the highest priority template file that exists.

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.