wppaste
WordPress

WP_REST_Response::get_curies(): array

Since
4.5.0
Source
wp-includes/rest-api/class-wp-rest-response.php:255
Retrieves the CURIEs (compact URIs) used for relations.

Compatibility

WordPress
since 4.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

array
Compact URIs.

Performance profile

How much work a call to WP_REST_Response::get_curies() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
1 hook

Third-party callbacks on 'rest_response_link_curies' run inside this call, and their cost is not bounded by anything here.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Response::get_curies() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always10apply_filters(), array_merge()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while WP_REST_Response::get_curies() runs, in this order:

  1. apply_filters( rest_response_link_curies )filterline 289 (+34 into the body)

    Filters extra CURIEs available on REST API responses.

Uses · 1

  • apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

	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		 * `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.		 *		 * @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 );	}

Changelog

Introduced in 4.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/class-wp-rest-response.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.