Contents

Code Reference Functions bp_set_theme_compat_feature()

bp_set_theme_compat_feature( string $theme_id, array $feature = array() )

Set a theme compat feature

Description

Parameters

$theme_id

(Required) The theme id (eg: legacy).

$feature

(Optional) An associative array (eg: array( name => 'feature_name', 'settings' => array() )).

Default value: array()

Source

File: bp-core/bp-core-theme-compatibility.php

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
function bp_set_theme_compat_feature( $theme_id, $feature = array() ) {
    if ( empty( $theme_id ) || empty( $feature['name'] ) ) {
        return;
    }
 
    // Get BuddyPress instance.
    $bp = buddypress();
 
    // Get current theme compat theme.
    $theme_compat_theme = $bp->theme_compat->theme;
 
    // Bail if the Theme Compat theme is not in use.
    if ( $theme_id !== bp_get_theme_compat_id() ) {
        return;
    }
 
    $features = $theme_compat_theme->__get( 'features' );
    if ( empty( $features ) ) {
        $features = array();
    }
 
    // Bail if the feature is already registered or no settings were provided.
    if ( isset( $features[ $feature['name'] ] ) || empty( $feature['settings'] ) ) {
        return;
    }
 
    // Add the feature.
    $features[ $feature['name'] ] = (object) $feature['settings'];
 
    // The feature is attached to components.
    if ( isset( $features[ $feature['name'] ]->components ) ) {
        // Set the feature for each concerned component.
        foreach ( (array) $features[ $feature['name'] ]->components as $component ) {
            // The xProfile component is specific.
            if ( 'xprofile' === $component ) {
                $component = 'profile';
            }
 
            if ( isset( $bp->{$component} ) ) {
                if ( isset( $bp->{$component}->features ) ) {
                    $bp->{$component}->features[] = $feature['name'];
                } else {
                    $bp->{$component}->features = array( $feature['name'] );
                }
            }
        }
    }
 
    // Finally update the theme compat features.
    $theme_compat_theme->__set( 'features', $features );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.4.0 Introduced.

Uses

Uses
Uses Description
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-core/bp-core-theme-compatibility.php: bp_get_theme_compat_id()

Get the ID of the theme package being used.

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.