WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Sidebars_Controller::prepare_links()

WP_REST_Sidebars_Controller::prepare_links( array $sidebar ): array

In this article

Back to top

Prepares links for the sidebar.

Parameters

$sidebararrayrequired
Sidebar.

Return

array Links for the given widget.

Source

protected function prepare_links( $sidebar ) {
	return array(
		'collection'               => array(
			'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
		),
		'self'                     => array(
			'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, $sidebar['id'] ) ),
		),
		'https://api.w.org/widget' => array(
			'href'       => add_query_arg( 'sidebar', $sidebar['id'], rest_url( '/wp/v2/widgets' ) ),
			'embeddable' => true,
		),
	);
}

View all references View on Trac View on GitHub

UsesDescription
rest_url()wp-includes/rest-api.php

Retrieves the URL to a REST endpoint.

add_query_arg()wp-includes/functions.php

Retrieves a modified URL query string.

Used byDescription
WP_REST_Sidebars_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

Prepares a single sidebar output for response.

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.