rest_response_link_curies │ filter-hook │ WP 4.5.0

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 http://w.org/{rel} would transform a http://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.

Usage

add_filter( 'rest_response_link_curies', 'wp_kama_rest_response_link_curies_filter' );

/**
 * Function for `rest_response_link_curies` filter-hook.
 * 
 * @param array $additional Additional CURIEs to register with the REST API.
 *
 * @return array
 */
function wp_kama_rest_response_link_curies_filter( $additional ){

	// filter...
	return $additional;
}

$additional(array)

Additional CURIEs to register with the REST API.

Changelog

Where the hook is called

$additional = apply_filters( 'rest_response_link_curies', array() );

Where the hook is used in WordPress