BP_Group_Extension::is_screen_enabled( string $context = '' )

Is the specified screen enabled?

Description

To be enabled, a screen must both have the ‘enabled’ key set to true (legacy: $this->enable_create_step, etc), and its screen_callback must also exist and be callable.

Parameters

$context

(Optional) Screen context. 'create', 'edit', or 'admin'.

Default value: ''

Return

(bool) True if the screen is enabled, otherwise false.

Source

File: bp-groups/classes/class-bp-group-extension.php

public function is_screen_enabled( $context = '' ) {
    $enabled = false;
 
    if ( isset( $this->screens[ $context ] ) ) {
        $enabled = $this->screens[ $context ]['enabled'] && is_callable( $this->screens[ $context ]['screen_callback'] );
    }
 
    return (bool) $enabled;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.8.0	Introduced.

Used By
Used By	Description
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::setup_admin_hooks()	Hook this extension’s Admin metabox into BuddyPress, if necessary.
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::setup_create_hooks()	Hook this extension’s Create step into BuddyPress, if necessary.
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::setup_edit_hooks()	Hook this extension’s Edit panel into BuddyPress, if necessary.

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.

Contents