WP_REST_Controller::get_context_param PHP Method

get_context_param() public method

Ensures consistent description between endpoints, and populates enum from schema.
public get_context_param ( array $args = [] ) : array
$args array
return array
    public function get_context_param($args = array())
    {
        $param_details = array('description' => __('Scope under which the request is made; determines fields present in response.', 'woocommerce'), '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 $key => $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);
    }