WP_Ability::normalize_input( mixed $input = null ): mixed

Description

Compatibility

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

Parameters

$inputmixedoptional

The raw input provided for the ability. Default null.Default: null

Return value

mixed

The normalized input, or a WP_Error if a filter returned one.

Performance profile

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

13–19

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

Plugin surface

1 hook

Third-party callbacks on 'wp_ability_normalize_input' 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

What one call costs · 2 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( wp_ability_normalize_input )filterline 508 (+25 into the body)

   Filters the normalized input for an ability.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Ability::get_input_schema()Retrieves the input schema for the ability.

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 ↗

483	public function normalize_input( $input = null ) {484		if ( null === $input ) {485			$input_schema = $this->get_input_schema();486			if ( array_key_exists( 'default', $input_schema ) ) {487				$input = $input_schema['default'];488			}489		}490 491		/**492		 * Filters the normalized input for an ability.493		 *494		 * Fires after `normalize_input()` has applied any default value declared in the input schema,495		 * giving plugins a chance to adjust the input before it is consumed downstream. Common uses496		 * include defaulting beyond what JSON Schema can express, prompt enrichment, and injecting497		 * caller metadata.498		 *499		 * Returning a `WP_Error` causes callers that propagate it (such as `execute()`) to halt500		 * before validation, permission checks, and the registered execute callback.501		 *502		 * @since 7.1.0503		 *504		 * @param mixed      $input        The normalized input data.505		 * @param string     $ability_name The name of the ability.506		 * @param WP_Ability $ability      The ability instance.507		 */508		return apply_filters( 'wp_ability_normalize_input', $input, $this->name, $this );509	}

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.