WP_REST_Font_Families_Controller::validate_font_family_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 family 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_Families_Controller::validate_font_family_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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

21–70

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

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_Families_Controller::validate_font_family_settings()

Further down the call graph this can also reach option, 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 · 6 distinct outcomes

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

Uses · 6

• 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_REST_Font_Families_Controller::get_endpoint_args_for_item_schema()Get the arguments used when creating or updating a font family.
• WP_Error::__construct()Initializes the error.
• WP_REST_Font_Families_Controller::get_item_schema()Retrieves the post's schema, conforming to JSON Schema.

Source code

View on Trac ↗View on GitHub ↗

89	public function validate_font_family_settings( $value, $request ) {90		// Enforce JSON Schema validity for field before applying custom validation logic.91		$args     = $this->get_endpoint_args_for_item_schema( $request->get_method() );92		$validity = rest_validate_value_from_schema( $value, $args['font_family_settings'], 'font_family_settings' );93 94		if ( is_wp_error( $validity ) ) {95			return $validity;96		}97 98		$settings = json_decode( $value, true );99 100		// Check settings string is valid JSON.101		if ( null === $settings ) {102			return new WP_Error(103				'rest_invalid_param',104				/* translators: %s: Parameter name: "font_family_settings". */105				sprintf( __( '%s parameter must be a valid JSON string.' ), 'font_family_settings' ),106				array( 'status' => 400 )107			);108		}109 110		$schema   = $this->get_item_schema()['properties']['font_family_settings'];111		$required = $schema['required'];112 113		if ( isset( $request['id'] ) ) {114			// Allow sending individual properties if we are updating an existing font family.115			unset( $schema['required'] );116 117			// But don't allow updating the slug, since it is used as a unique identifier.118			if ( isset( $settings['slug'] ) ) {119				return new WP_Error(120					'rest_invalid_param',121					/* translators: %s: Name of parameter being updated: font_family_settings[slug]". */122					sprintf( __( '%s cannot be updated.' ), 'font_family_settings[slug]' ),123					array( 'status' => 400 )124				);125			}126		}127 128		// Check that the font face settings match the theme.json schema.129		$has_valid_settings = rest_validate_value_from_schema( $settings, $schema, 'font_family_settings' );130 131		if ( is_wp_error( $has_valid_settings ) ) {132			$has_valid_settings->add_data( array( 'status' => 400 ) );133			return $has_valid_settings;134		}135 136		// Check that none of the required settings are empty values.137		foreach ( $required as $key ) {138			if ( isset( $settings[ $key ] ) && ! $settings[ $key ] ) {139				return new WP_Error(140					'rest_invalid_param',141					/* translators: %s: Name of the empty font family setting parameter, e.g. "font_family_settings[slug]". */142					sprintf( __( '%s cannot be empty.' ), "font_family_settings[ $key ]" ),143					array( 'status' => 400 )144				);145			}146		}147 148		return true;149	}

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-families-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.