rest_response_link_curies WordPress Filter Hook
The rest_response_link_curies is a WordPress hook that allows you to modify the links in the REST API response. This can be used to add your own custom links or to change the format of the links.
apply_filters( 'rest_response_link_curies', array $additional ) #
Filters extra CURIEs available on REST API responses.
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 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.
Parameters
- $additional
(array)Additional CURIEs to register with the REST API.
Source
Changelog
| Version | Description |
|---|---|
| 4.5.0 | Introduced. |