BP_REST_Attachments_Group_Avatar_Endpoint::prepare_item_for_response( stdClass|string $avatar, WP_REST_Request $request )

Prepares avatar data to return as an object.

Description

Parameters

$avatar

(stdClass|string) (Required) Avatar object or string with url or image with html.

$request

(WP_REST_Request) (Required) Full details about the request.

Return

(WP_REST_Response)

Source

File: bp-groups/classes/class-bp-rest-attachments-group-avatar-endpoint.php

	public function prepare_item_for_response( $avatar, $request ) {
		$data = array(
			'full'  => $avatar->full,
			'thumb' => $avatar->thumb,
		);

		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
		$data    = $this->add_additional_fields_to_object( $data, $request );
		$data    = $this->filter_response_by_context( $data, $context );

		// @todo add prepare_links
		$response = rest_ensure_response( $data );

		/**
		 * Filter a group avatar value returned from the API.
		 *
		 * @param WP_REST_Response $response Response.
		 * @param WP_REST_Request $request Request used to generate the response.
		 * @param stdClass|string $avatar Avatar object or string with url or image with html.
		 *
		 * @since 0.1.0
		 */
		return apply_filters( 'bp_rest_attachments_group_avatar_prepare_value', $response, $request, $avatar );
	}

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.