W3cubDocs

/WordPress

WP_REST_Block_Directory_Controller::get_items( WP_REST_Request $request )

Search and retrieve blocks metadata

Parameters

$request

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

Return

(WP_Error|WP_REST_Response) Response object on success, or WP_Error object on failure.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php 

public function get_items( $request ) {
		require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
		require_once ABSPATH . 'wp-admin/includes/plugin.php';

		$response = plugins_api(
			'query_plugins',
			array(
				'block'    => $request['term'],
				'per_page' => $request['per_page'],
				'page'     => $request['page'],
			)
		);

		if ( is_wp_error( $response ) ) {
			$response->add_data( array( 'status' => 500 ) );

			return $response;
		}

		$result = array();

		foreach ( $response->plugins as $plugin ) {
			// If the API returned a plugin with empty data for 'blocks', skip it.
			if ( empty( $plugin['blocks'] ) ) {
				continue;
			}

			$data     = $this->prepare_item_for_response( $plugin, $request );
			$result[] = $this->prepare_response_for_collection( $data );
		}

		return rest_ensure_response( $result );
	}

Uses

Uses Description
wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php: WP_REST_Block_Directory_Controller::prepare_item_for_response()

Parse block metadata for a block, and prepare it for an API repsonse.
wp-includes/rest-api.php: rest_ensure_response()

Ensures a REST response is a response object (for consistency).
wp-admin/includes/plugin-install.php: plugins_api()

Retrieves plugin installer pages from the WordPress.org Plugins API.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
5.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_block_directory_controller/get_items