Contents

Code Reference Classes BP_Component BP_Component::start()

BP_Component::start( string $id = '', string $name = '', string $path = '', array $params = array() )

Component loader.

Description

Parameters

$id

(Optional) Unique ID. Letters, numbers, and underscores only.

Default value: ''

$name

(Optional) Unique name. This should be a translatable name, eg. __( 'Groups', 'buddyboss' ).

Default value: ''

$path

(Optional) The file path for the component's files. Used by BP_Component::includes().

Default value: ''

$params

(Optional) Additional parameters used by the component.

  • 'adminbar_myaccount_order'
    (int) Set the position for our menu under the WP Toolbar's "My Account menu".
  • 'features'
    (array) An array of feature names. This is used to load additional files from your component directory and for feature active checks. eg. array( 'awesome' ) would look for a file called "bp-{$this->id}-awesome.php" and you could use bp_is_active( $this->id, 'awesome' ) to determine if the feature is active.
  • 'search_query_arg'
    (string) String to be used as the query argument in component search URLs.

Default value: array()

Source

File: bp-core/classes/class-bp-component.php

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
public function start( $id = '', $name = '', $path = '', $params = array() ) {
 
    // Internal identifier of component.
    $this->id   = $id;
 
    // Internal component name.
    $this->name = $name;
 
    // Path for includes.
    $this->path = $path;
 
    // Miscellaneous component parameters that need to be set early on.
    if ( ! empty( $params ) ) {
        // Sets the position for our menu under the WP Toolbar's "My Account" menu.
        if ( ! empty( $params['adminbar_myaccount_order'] ) ) {
            $this->adminbar_myaccount_order = (int) $params['adminbar_myaccount_order'];
        }
 
        // Register features.
        if ( ! empty( $params['features'] ) ) {
            $this->features = array_map( 'sanitize_title', (array) $params['features'] );
        }
 
        if ( ! empty( $params['search_query_arg'] ) ) {
            $this->search_query_arg = sanitize_title( $params['search_query_arg'] );
        }
 
    // Set defaults if not passed.
    } else {
        // New component menus are added before the settings menu if not set.
        $this->adminbar_myaccount_order = 90;
    }
 
    // Move on to the next step.
    $this->setup_actions();
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.4.0 Added $params['search_query_arg'] as a configurable value. BuddyPress 2.4.0 Added $params['search_query_arg'] as a configurable value.
BuddyPress 2.3.0 Added $params['features'] as a configurable value. BuddyPress 2.3.0 Added $params['features'] as a configurable value.
BuddyPress 1.9.0 Added $params as a parameter. BuddyPress 1.9.0 Added $params as a parameter.
BuddyPress 1.5.0 Introduced.
Used By
Used By Description
bp-document/classes/class-bp-document-component.php: BP_Document_Component::__construct()

Start the document component creation process.
bp-settings/classes/class-bp-settings-component.php: BP_Settings_Component::__construct()

Start the settings component creation process.
bp-forums/classes/class-bp-forums-component.php: BP_Forums_Component::__construct()

Start the forums component creation process
bp-media/classes/class-bp-media-component.php: BP_Media_Component::__construct()

Start the media component creation process.
bp-notifications/classes/class-bp-notifications-component.php: BP_Notifications_Component::__construct()

Start the notifications component creation process.
bp-blogs/classes/class-bp-blogs-component.php: BP_Blogs_Component::__construct()

Start the blogs component creation process.
bp-xprofile/classes/class-bp-xprofile-component.php: BP_XProfile_Component::__construct()

Start the xprofile component creation process.
bp-messages/classes/class-bp-messages-component.php: BP_Messages_Component::__construct()

Start the messages component creation process.
bp-groups/classes/class-bp-groups-component.php: BP_Groups_Component::__construct()

Start the groups component creation process.
bp-members/classes/class-bp-members-component.php: BP_Members_Component::__construct()

Start the members component creation process.
bp-invites/classes/class-bp-invites-component.php: BP_Invites_Component::__construct()

Start the invites component creation process.
bp-friends/classes/class-bp-friends-component.php: BP_Friends_Component::__construct()

Start the friends component creation process.
bp-search/classes/class-bp-search-component.php: BP_Search_Component::__construct()

Start the search component creation process
bp-core/classes/class-bp-core.php: BP_Core::__construct()

Start the members component creation process.
bp-activity/classes/class-bp-activity-component.php: BP_Activity_Component::__construct()

Start the activity component setup process.
Show 10 more used by Hide more used by

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.