wppaste
WordPress

WP_oEmbed::sanitize_provider( array-key $match_mask, mixed $data ): array{

Since
7.1.0
Source
wp-includes/class-wp-oembed.php:285
Sanitizes and normalizes a single oEmbed provider entry.

Description

Validates that the match mask is a non-empty string and that the provider data is an array with a non-empty string endpoint URL at index 0. Normalizes the optional regex flag at index 1 to a boolean.

Compatibility

WordPress
since 7.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$match_maskarray-key
The URL pattern used to match against URLs.
$datamixed
The raw provider data to sanitize.

Return value

array{
match_mask: non-empty-string, endpoint: non-empty-string, is_regex: bool }|null Normalized provider array, or null if malformed.

Performance profile

How much work a call to WP_oEmbed::sanitize_provider() 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
5–25

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always5–25none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 26 instructions, 5–25 executed per call, 7 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Used by · 2

Source code

View on Trac View on GitHub 

	private function sanitize_provider( $match_mask, $data ): ?array {		if (			is_string( $match_mask ) &&			'' !== $match_mask &&			is_array( $data ) &&			isset( $data[0] ) &&			is_string( $data[0] ) &&			'' !== $data[0]		) {			return array(				'match_mask' => $match_mask,				'endpoint'   => $data[0],				'is_regex'   => (bool) ( $data[1] ?? false ),			);		}		return null;	}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-oembed.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.