wppaste
WordPress

WP_Embed::register_handler( string $id, string $regex, callable $callback, int $priority = 10 )

Source
wp-includes/class-wp-embed.php:113
Registers an embed handler.

Description

Do not use this function directly, use wp_embed_register_handler() instead.

This function should probably also only be used for sites that do not support oEmbed.

Compatibility

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

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

Parameters

$idstring
An internal ID/name for the handler. Needs to be unique.
$regexstring
The regex that will be used to see if this handler should be used for a URL.
$callbackcallable
The callback function that will be called if the regex is matched.
$priorityintoptional
Used to specify the order in which the registered handlers will be tested.
Lower numbers correspond with earlier testing, and handlers with the same priority are tested in the order in which they were added to the action. Default 10.Default: 10

Performance profile

How much work a call to WP_Embed::register_handler() 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
11

Executed per call on PHP 8.5. The body compiles to 11.

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 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_Embed::register_handler() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always11none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 11 instructions, 11 executed per call, 0 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.

Source code

View on Trac View on GitHub 

	public function register_handler( $id, $regex, $callback, $priority = 10 ) {		$this->handlers[ $priority ][ $id ] = array(			'regex'    => $regex,			'callback' => $callback,		);	}

Changelog

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/class-wp-embed.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.