WP_REST_Controller::get_context_param() │ public │ WP 4.7.0

Retrieves the magical context param.

Ensures consistent descriptions between endpoints, and populates enum from schema.

Method of the class: WP_REST_Controller{}

No Hooks.

Return

Array. Context parameter details.

Usage

$WP_REST_Controller = new WP_REST_Controller();
$WP_REST_Controller->get_context_param( $args );

$args(array)

Additional arguments for context parameter.
Default: empty array

Changelog

WP_REST_Controller::get_context_param() WP REST Controller::get context param code ^{WP 6.7.1}

public function get_context_param( $args = array() ) {
	$param_details = array(
		'description'       => __( 'Scope under which the request is made; determines fields present in response.' ),
		'type'              => 'string',
		'sanitize_callback' => 'sanitize_key',
		'validate_callback' => 'rest_validate_request_arg',
	);

	$schema = $this->get_item_schema();

	if ( empty( $schema['properties'] ) ) {
		return array_merge( $param_details, $args );
	}

	$contexts = array();

	foreach ( $schema['properties'] as $attributes ) {
		if ( ! empty( $attributes['context'] ) ) {
			$contexts = array_merge( $contexts, $attributes['context'] );
		}
	}

	if ( ! empty( $contexts ) ) {
		$param_details['enum'] = array_unique( $contexts );
		rsort( $param_details['enum'] );
	}

	return array_merge( $param_details, $args );
}