wppaste
WordPress

rest_get_endpoint_args_for_schema( array $schema, string $method = WP_REST_Server::CREATABLE ): array

Since
5.6.0
Source
wp-includes/rest-api.php:3396
Retrieves an array of endpoint arguments from the item schema and endpoint method.

Compatibility

WordPress
since 5.6.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.

Parameters

$schemaarray
The full JSON schema for the endpoint.
$methodstringoptional
HTTP method of the endpoint. The arguments for CREATABLE endpoints are checked for required values and may fall-back to a given default, this is not done on EDITABLE endpoints. Default WP_REST_Server::CREATABLE.Default: WP_REST_Server::CREATABLE

Return value

array
The endpoint arguments.

Performance profile

How much work a call to rest_get_endpoint_args_for_schema() 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
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
18–20

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 74.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

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 rest_get_endpoint_args_for_schema() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always18–20rest_get_allowed_schema_keywords(), array_diff()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev7418–2013
8.57418–2013
8.47418–2013
8.37418–2013
8.27418–2013
8.17418–20131 fewer instruction than PHP 7.4
7.47518–2113

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.

Uses · 1

Used by · 1

Source code

View on Trac View on GitHub 

function rest_get_endpoint_args_for_schema( $schema, $method = WP_REST_Server::CREATABLE ) { 	$schema_properties       = ! empty( $schema['properties'] ) ? $schema['properties'] : array();	$endpoint_args           = array();	$valid_schema_properties = rest_get_allowed_schema_keywords();	$valid_schema_properties = array_diff( $valid_schema_properties, array( 'default', 'required' ) ); 	foreach ( $schema_properties as $field_id => $params ) { 		// Arguments specified as `readonly` are not allowed to be set.		if ( ! empty( $params['readonly'] ) ) {			continue;		} 		$endpoint_args[ $field_id ] = array(			'validate_callback' => 'rest_validate_request_arg',			'sanitize_callback' => 'rest_sanitize_request_arg',		); 		if ( WP_REST_Server::CREATABLE === $method && isset( $params['default'] ) ) {			$endpoint_args[ $field_id ]['default'] = $params['default'];		} 		if ( WP_REST_Server::CREATABLE === $method && ! empty( $params['required'] ) ) {			$endpoint_args[ $field_id ]['required'] = true;		} 		foreach ( $valid_schema_properties as $schema_prop ) {			if ( isset( $params[ $schema_prop ] ) ) {				$endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];			}		} 		// Merge in any options provided by the schema property.		if ( isset( $params['arg_options'] ) ) { 			// Only use required / default from arg_options on CREATABLE endpoints.			if ( WP_REST_Server::CREATABLE !== $method ) {				$params['arg_options'] = array_diff_key(					$params['arg_options'],					array(						'required' => '',						'default'  => '',					)				);			} 			$endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params['arg_options'] );		}	} 	return $endpoint_args;}

Changelog

Introduced in 5.6.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.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.