WP_REST_Response::get_curies(): array

In this article

Retrieves the CURIEs (compact URIs) used for relations.

Return

array Compact URIs.

Source

public function get_curies() {
	$curies = array(
		array(
			'name'      => 'wp',
			'href'      => 'https://api.w.org/{rel}',
			'templated' => true,
		),
	);

	/**
	 * Filters extra CURIEs available on REST API responses.
	 *
	 * CURIEs allow a shortened version of URI relations. This allows a more
	 * usable form for custom relations than using the full URI. These work
	 * similarly to how XML namespaces work.
	 *
	 * Registered CURIES need to specify a name and URI template. This will
	 * automatically transform URI relations into their shortened version.
	 * The shortened relation follows the format `{name}:{rel}`. `{rel}` in
	 * the URI template will be replaced with the `{rel}` part of the
	 * shortened relation.
	 *
	 * For example, a CURIE with name `example` and URI template
	 * `https://w.org/{rel}` would transform a `https://w.org/term` relation
	 * into `example:term`.
	 *
	 * Well-behaved clients should expand and normalize these back to their
	 * full URI relation, however some naive clients may not resolve these
	 * correctly, so adding new CURIEs may break backward compatibility.
	 *
	 * @since 4.5.0
	 *
	 * @param array $additional Additional CURIEs to register with the REST API.
	 */
	$additional = apply_filters( 'rest_response_link_curies', array() );

	return array_merge( $curies, $additional );
}

Hooks

apply_filters( ‘rest_response_link_curies’, array $additional )

Filters extra CURIEs available on REST API responses.

Changelog

VersionDescription
4.5.0Introduced.

User Contributed Notes

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