wppaste
WordPress

wp_oembed_add_host_js()

Since
4.4.0
Source
wp-includes/embed.php:387
Adds the necessary JavaScript to communicate with the embedded iframes.

Description

This function is no longer used directly. For back-compat it exists exclusively as a way to indicate that the oEmbed host JS should be added. In default-filters.php there remains this code:

add_action( 'wp_head', 'wp_oembed_add_host_js' )

Historically a site has been able to disable adding the oEmbed host script by doing:

remove_action( 'wp_head', 'wp_oembed_add_host_js' )

In order to ensure that such code still works as expected, this function remains. There is now a has_action() check in wp_maybe_enqueue_oembed_host_js() to see if wp_oembed_add_host_js() has not been unhooked from running at the wp_head action.

Performance profile

How much work a call to wp_oembed_add_host_js() 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
1

Executed per call on PHP 8.4. The body compiles to 1.

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_oembed_add_host_js() can have, taken from its control-flow graph on PHP 8.4.

WhenInstructionsCalls it makes
always1none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3 and 8.4: 1 instruction, 1 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

function wp_oembed_add_host_js() {}

Changelog

Introduced in 4.4.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.

5.9.0
Deprecated. Use wp_maybe_enqueue_oembed_host_js() instead.from the docblock
4.4.0
Introduced.from the docblock

About this page

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