Contents

Code Reference Classes BP_REST_Components_Endpoint BP_REST_Components_Endpoint::get_component_info()

BP_REST_Components_Endpoint::get_component_info( string $component )

Get component info helper.

Description

Parameters

$component

(Required) Component id.

Return

(array)

Source

File: bp-core/classes/class-bp-rest-components-endpoint.php

425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
public function get_component_info( $component ) {
 
    // Get all components.
    $components = bp_core_get_components();
 
    // Get specific component info.
    $info = $components[ $component ];
 
    // Return empty early.
    if ( empty( $info ) ) {
        return array();
    }
 
    return array(
        'name'        => $component,
        'status'      => $this->verify_component_status( $component ),
        'title'       => $info['title'],
        'description' => $info['description'],
    );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

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.