WP_Embed::cache_oembed( int $post_id )
- Source
wp-includes/class-wp-embed.php:404
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
$post_idint- Post ID to do the caching for.
Performance profile
How much work a call to WP_Embed::cache_oembed() 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
- Heavy
- Scaling
- Constant
- Instructions
- 17–39
- Plugin surface
- 1 hook
- Called by
- 0
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 40.
Third-party callbacks on 'embed_cache_oembed_types' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Embed::cache_oembed() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 17–23 | get_post(), get_post_types(), apply_filters() |
!empty($post) && $cache_oembed_types | 39 | get_post(), get_post_types(), apply_filters(), ->run_shortcode(), ->autoembed() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 40 | 17–39 | 3 | |
| 8.5 | 40 | 17–39 | 3 | |
| 8.4 | 40 | 17–39 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 43 | 17–42 | 3 | |
| 8.2 | 43 | 17–42 | 3 | |
| 8.1 | 43 | 17–42 | 3 | |
| 7.4 | 43 | 17–42 | 3 |
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.
Hooks and filters fired · 1
One hook fires while WP_Embed::cache_oembed() runs, in this order:
- apply_filters( embed_cache_oembed_types )filterline 416 (+12 into the body)
Filters the array of post types to cache oEmbed results for.
Uses · 5
- get_post()Retrieves post data given a post ID or post object.
- get_post_types()Gets a list of all registered post type objects.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- WP_Embed::run_shortcode()Processes the [embed] shortcode.
- WP_Embed::autoembed()Passes any unlinked URLs that are on their own line to WP_Embed::shortcode() for potential embedding.
Source code
public function cache_oembed( $post_id ) { $post = get_post( $post_id ); $post_types = get_post_types( array( 'show_ui' => true ) ); /** * Filters the array of post types to cache oEmbed results for. * * @since 2.9.0 * * @param string[] $post_types Array of post type names to cache oEmbed results for. Defaults to post types with `show_ui` set to true. */ $cache_oembed_types = apply_filters( 'embed_cache_oembed_types', $post_types ); if ( empty( $post->ID ) || ! in_array( $post->post_type, $cache_oembed_types, true ) ) { return; } // Trigger a caching. if ( ! empty( $post->post_content ) ) { $this->post_ID = $post->ID; $this->usecache = false; $content = $this->run_shortcode( $post->post_content ); $this->autoembed( $content ); $this->usecache = true; } }Changelog
Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 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.