Contents

Code Reference Classes BP_REST_Components_Endpoint BP_REST_Components_Endpoint::get_items()

BP_REST_Components_Endpoint::get_items( WP_REST_Request $request )

Retrieve components.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
public function get_items( $request ) {
    $args = array(
        'type'     => $request['type'],
        'status'   => $request['status'],
        'per_page' => $request['per_page'],
    );
 
    /**
     * Filter the query arguments for the request.
     *
     * @param array $args Key value array of query var to query value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    $args = apply_filters( 'bp_rest_components_get_items_query_args', $args, $request );
 
    $type = $args['type'];
 
    // Get all components based on type.
    $components = bp_core_get_components( $type );
 
    // Active components.
    $active_components = apply_filters( 'bp_active_components', bp_get_option( 'bp-active-components' ) );
 
    // Core component is always active.
    if ( 'optional' !== $type && array_key_exists( 'core', $components ) ) {
        $active_components['core'] = $components['core'];
    }
 
    // Inactive components.
    $inactive_components = array_diff( array_keys( $components ), array_keys( $active_components ) );
 
    $current_components = array();
    switch ( $args['status'] ) {
        case 'all':
            foreach ( $components as $name => $labels ) {
                $current_components[] = $this->get_component_info( $name );
            }
            break;
 
        case 'active':
            foreach ( array_keys( $active_components ) as $component ) {
                $current_components[] = $this->get_component_info( $component );
            }
            break;
 
        case 'inactive':
            foreach ( $inactive_components as $component ) {
                $current_components[] = $this->get_component_info( $component );
            }
            break;
    }
 
    $retval = array();
    foreach ( $current_components as $component ) {
        $retval[] = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $component, $request )
        );
    }
 
    $response = rest_ensure_response( $retval );
    $response = bp_rest_response_add_total_headers( $response, count( $current_components ), $args['per_page'] );
 
    /**
     * Fires after a list of components is fetched via the REST API.
     *
     * @param array $current_components Fetched components.
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_components_get_items', $current_components, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-rest-api.php: bp_rest_response_add_total_headers()

Set headers to let the Client Script be aware of the pagination.
bp-core/classes/class-bp-rest-components-endpoint.php: BP_REST_Components_Endpoint::get_component_info()

Get component info helper.
bp-core/classes/class-bp-rest-components-endpoint.php: BP_REST_Components_Endpoint::prepare_item_for_response()

Prepares component data for return as an object.
bp-core/classes/class-bp-rest-components-endpoint.php: bp_rest_components_get_items_query_args

Filter the query arguments for the request.
bp-core/classes/class-bp-rest-components-endpoint.php: bp_rest_components_get_items

Fires after a list of components is fetched via the REST API.
bp-core/admin/bp-core-admin-components.php: bp_active_components

Filters the array of available components.
bp-core/bp-core-functions.php: bp_core_get_components()

Return a list of component information.
bp-core/bp-core-options.php: bp_get_option()

Retrieve an option.
Show 3 more uses Hide more uses

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.