WP_Ability::validate_output( mixed $output ): true|WP_Error

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$outputmixed

The output data to validate.

Return value

true|WP_Error

Returns true if valid, or a WP_Error object if validation fails.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

24–52

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

Plugin surface

1 hook

Third-party callbacks on 'wp_ability_validate_output' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()called directly

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

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

Hooks and filters fired · 1

One hook fires while WP_Ability::validate_output() runs, in this order:

1. 1
   apply_filters( wp_ability_validate_output )filterline 748 (+36 into the body)

   Filters the output validation result for an ability.

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.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Ability::get_output_schema()Retrieves the output schema for the ability.
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_Ability::execute()Executes the ability after input validation and running a permission check.

Source code

View on Trac ↗View on GitHub ↗

712	protected function validate_output( $output ) {713		$output_schema = $this->get_output_schema();714		if ( empty( $output_schema ) ) {715			$is_valid = true;716		} else {717			$valid_output = rest_validate_value_from_schema( $output, $output_schema, 'output' );718			if ( is_wp_error( $valid_output ) ) {719				$is_valid = new WP_Error(720					'ability_invalid_output',721					sprintf(722						/* translators: %1$s ability name, %2$s error message. */723						__( 'Ability "%1$s" has invalid output. Reason: %2$s' ),724						$this->name,725						$valid_output->get_error_message()726					)727				);728			} else {729				$is_valid = true;730			}731		}732 733		/**734		 * Filters the output validation result for an ability.735		 *736		 * Allows developers to add custom validation logic on top of the default737		 * JSON Schema validation. If default validation already failed, the filter738		 * receives the WP_Error object and can add additional error information or739		 * override it. If default validation passed, the filter can add additional740		 * validation checks and return a WP_Error if those checks fail.741		 *742		 * @since 7.1.0743		 *744		 * @param true|WP_Error $is_valid     The validation result from default validation.745		 * @param mixed         $output       The output data being validated.746		 * @param string        $ability_name The name of the ability.747		 */748		$validity = apply_filters( 'wp_ability_validate_output', $is_valid, $output, $this->name );749		if ( false === $validity ) {750			return new WP_Error( 'ability_invalid_output', __( 'Invalid output.' ) );751		}752		if ( is_wp_error( $validity ) && $validity->has_errors() ) {753			return $validity;754		}755		return true;756	}

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/abilities-api/class-wp-ability.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.