Automattic\WooCommerce\Admin\API

Leaderboards::get_allowed_items │ public │ WC 1.0

Returns a list of allowed leaderboards.

Method of the class: Leaderboards{}

No Hooks.

Returns

Array|WP_Error.

Usage

$Leaderboards = new Leaderboards();
$Leaderboards->get_allowed_items( $request );

$request(WP_REST_Request) (required)

Request data.

Leaderboards::get_allowed_items() Leaderboards::get allowed items code ^{WC 10.3.6}

public function get_allowed_items( $request ) {
	$leaderboards = $this->get_leaderboards( 0, null, null, null );

	$data = array();
	foreach ( $leaderboards as $leaderboard ) {
		$data[] = (object) array(
			'id'      => $leaderboard['id'],
			'label'   => $leaderboard['label'],
			'headers' => $leaderboard['headers'],
		);
	}

	$objects = array();
	foreach ( $data as $item ) {
		$prepared  = $this->prepare_item_for_response( $item, $request );
		$objects[] = $this->prepare_response_for_collection( $prepared );
	}

	$response = rest_ensure_response( $objects );
	$response->header( 'X-WP-Total', count( $data ) );
	$response->header( 'X-WP-TotalPages', 1 );

	$base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );

	return $response;
}