apply_filters( 'rest_response_link_curies', array $additional )

Filters extra CURIEs available on API responses.


Description Description

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 normalise these back to their full URI relation, however some naive clients may not resolve these correctly, so adding new CURIEs may break backward compatibility.


Top ↑

Parameters Parameters

$additional

(array) Additional CURIEs to register with the API.


Top ↑

Source Source

File: wp-includes/rest-api/class-wp-rest-response.php

View on Trac



Top ↑

Changelog Changelog

Changelog
Version Description
4.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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