WP_REST_Font_Faces_Controller::validate_create_font_face_settings( string $value, WP_REST_Request $request ): true|WP_Error

Compatibility

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

Parameters

$valuestring

Encoded JSON string of font face settings.

$requestWP_REST_Request

Request object.

Return value

true|WP_Error

True if the settings are valid, otherwise a WP_Error object.

Performance profile

How much work a call to WP_REST_Font_Faces_Controller::validate_create_font_face_settings() 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

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

18–81

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• serializeserialisationjson_decode()called directly
• hookthird-party callbacksdo_action()one call below WP_REST_Font_Faces_Controller::validate_create_font_face_settings()
• optionoption read or writeget_option()one call below WP_REST_Font_Faces_Controller::validate_create_font_face_settings()

Further down the call graph this can also reach cache, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 8 distinct outcomes

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

Uses · 7

• rest_validate_value_from_schema()Validate a value based on a schema.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• wp_http_validate_url()Validates a URL as safe for use in the HTTP API.
• WP_REST_Font_Faces_Controller::get_create_params()Get the params used when creating a new font face.
• WP_Error::__construct()Initializes the error.
• WP_REST_Font_Faces_Controller::get_item_schema()Retrieves the post's schema, conforming to JSON Schema.

Source code

View on Trac ↗View on GitHub ↗

163	public function validate_create_font_face_settings( $value, $request ) {164		// Enforce JSON Schema validity for field before applying custom validation logic.165		$args     = $this->get_create_params();166		$validity = rest_validate_value_from_schema( $value, $args['font_face_settings'], 'font_face_settings' );167 168		if ( is_wp_error( $validity ) ) {169			return $validity;170		}171 172		$settings = json_decode( $value, true );173 174		// Check settings string is valid JSON.175		if ( null === $settings ) {176			return new WP_Error(177				'rest_invalid_param',178				__( 'font_face_settings parameter must be a valid JSON string.' ),179				array( 'status' => 400 )180			);181		}182 183		// Check that the font face settings match the theme.json schema.184		$schema             = $this->get_item_schema()['properties']['font_face_settings'];185		$has_valid_settings = rest_validate_value_from_schema( $settings, $schema, 'font_face_settings' );186 187		if ( is_wp_error( $has_valid_settings ) ) {188			$has_valid_settings->add_data( array( 'status' => 400 ) );189			return $has_valid_settings;190		}191 192		// Check that none of the required settings are empty values.193		$required = $schema['required'];194		foreach ( $required as $key ) {195			if ( isset( $settings[ $key ] ) && ! $settings[ $key ] ) {196				return new WP_Error(197					'rest_invalid_param',198					/* translators: %s: Name of the missing font face settings parameter, e.g. "font_face_settings[src]". */199					sprintf( __( '%s cannot be empty.' ), "font_face_setting[ $key ]" ),200					array( 'status' => 400 )201				);202			}203		}204 205		$srcs  = is_array( $settings['src'] ) ? $settings['src'] : array( $settings['src'] );206		$files = $request->get_file_params();207 208		foreach ( $srcs as $src ) {209			// Check that each src is a non-empty string.210			$src = ltrim( $src );211			if ( empty( $src ) ) {212				return new WP_Error(213					'rest_invalid_param',214					/* translators: %s: Font face source parameter name: "font_face_settings[src]". */215					sprintf( __( '%s values must be non-empty strings.' ), 'font_face_settings[src]' ),216					array( 'status' => 400 )217				);218			}219 220			// Check that srcs are valid URLs or file references.221			if ( false === wp_http_validate_url( $src ) && ! isset( $files[ $src ] ) ) {222				return new WP_Error(223					'rest_invalid_param',224					/* translators: 1: Font face source parameter name: "font_face_settings[src]", 2: The invalid src value. */225					sprintf( __( '%1$s value "%2$s" must be a valid URL or file reference.' ), 'font_face_settings[src]', $src ),226					array( 'status' => 400 )227				);228			}229		}230 231		// Check that each file in the request references a src in the settings.232		foreach ( array_keys( $files ) as $file ) {233			if ( ! in_array( $file, $srcs, true ) ) {234				return new WP_Error(235					'rest_invalid_param',236					/* translators: 1: File key (e.g. "file-0") in the request data, 2: Font face source parameter name: "font_face_settings[src]". */237					sprintf( __( 'File %1$s must be used in %2$s.' ), $file, 'font_face_settings[src]' ),238					array( 'status' => 400 )239				);240			}241		}242

Changelog

Introduced in 6.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/endpoints/class-wp-rest-font-faces-controller.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.