WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Users_Controller::prepare_links()

WP_REST_Users_Controller::prepare_links( WP_User $user ): array

In this article

Back to top

Prepares links for the user request.

Parameters

$userWP_Userrequired
User object.

Return

array Links for the given user.

Source

protected function prepare_links( $user ) {
	$links = array(
		'self'       => array(
			'href' => rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $user->ID ) ),
		),
		'collection' => array(
			'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
		),
	);

	return $links;
}

View all references View on Trac View on GitHub

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

Retrieves the URL to a REST endpoint.

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

Prepares a single user output for response.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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