BP_REST_Components_Endpoint::update_item( WP_REST_Request $request )
Activate/Deactivate a component.
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
public function update_item( $request ) { $component = $request['name']; if ( ! $this->component_exists( $component ) ) { return new WP_Error( 'bp_rest_component_nonexistent', __( 'Sorry, this component does not exist.', 'buddyboss' ), array( 'status' => 404, ) ); } $action = $request['action']; if ( empty( $action ) || ! in_array( $action, array( 'activate', 'deactivate' ), true ) ) { return new WP_Error( 'bp_rest_component_invalid_action', __( 'Sorry, this is not a valid action.', 'buddyboss' ), array( 'status' => 500, ) ); } if ( 'activate' === $action ) { if ( bp_is_active( $component ) ) { return new WP_Error( 'bp_rest_component_already_active', __( 'Sorry, this component is already active.', 'buddyboss' ), array( 'status' => 400, ) ); } $component_info = $this->activate_helper( $component ); } else { if ( ! bp_is_active( $component ) ) { return new WP_Error( 'bp_rest_component_inactive', __( 'Sorry, this component is not active.', 'buddyboss' ), array( 'status' => 400, ) ); } if ( array_key_exists( $component, bp_core_get_components( 'required' ) ) ) { return new WP_Error( 'bp_rest_required_component', __( 'Sorry, you cannot deactivate a required component.', 'buddyboss' ), array( 'status' => 400, ) ); } $component_info = $this->deactivate_helper( $component ); } $request->set_param( 'context', 'edit' ); $retval = array( $this->prepare_response_for_collection( $this->prepare_item_for_response( $component_info, $request ) ), ); $response = rest_ensure_response( $retval ); /** * Fires after a component is updated via the REST API. * * @param array $component_info Component info. * @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_update_item', $component_info, $response, $request ); return $response; }
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.