WordPress/wp-includes/class-wp-embed.php

535 lines
16 KiB
PHP
Raw Normal View History

<?php
/**
* API for easily embedding rich media such as videos and images into content.
*
* @package WordPress
* @subpackage Embed
* @since 2.9.0
*/
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes. Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0. There are a number of ways to mitigate this: * If it is an accidental typo for a declared property: fix the typo. * For known properties: declare them on the class. * For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in. * For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes. Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1. To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP. The logic used for this commit is as follows: * If a class already has the attribute: no action needed. * If a class does not `extend`: add the attribute. * If a class does `extend`: - If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties). - If it extends a PHP native class: add the attribute. - If it extends a class from one of WP's external dependencies: add the attribute. * In all other cases: no action — the attribute should not be needed as child classes inherit from the parent. Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details. This commit only affects classes in the `src` directory of WordPress core. * Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033. * While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately. Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties]. Follow-up to [53922]. Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath. See #56513, #56034. Built from https://develop.svn.wordpress.org/trunk@54133 git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-12 17:47:14 +02:00
#[AllowDynamicProperties]
class WP_Embed {
public $handlers = array();
public $post_ID;
public $usecache = true;
public $linkifunknown = true;
public $last_attr = array();
public $last_url = '';
/**
* When a URL cannot be embedded, return false instead of returning a link
* or the URL.
*
* Bypasses the {@see 'embed_maybe_make_link'} filter.
*
* @var bool
*/
public $return_false_on_fail = false;
/**
* Constructor
*/
public function __construct() {
// Hack to get the [embed] shortcode to run before wpautop().
add_filter( 'the_content', array( $this, 'run_shortcode' ), 8 );
add_filter( 'widget_text_content', array( $this, 'run_shortcode' ), 8 );
add_filter( 'widget_block_content', array( $this, 'run_shortcode' ), 8 );
// Shortcode placeholder for strip_shortcodes().
add_shortcode( 'embed', '__return_false' );
// Attempts to embed all URLs in a post.
add_filter( 'the_content', array( $this, 'autoembed' ), 8 );
add_filter( 'widget_text_content', array( $this, 'autoembed' ), 8 );
add_filter( 'widget_block_content', array( $this, 'autoembed' ), 8 );
// After a post is saved, cache oEmbed items via Ajax.
add_action( 'edit_form_advanced', array( $this, 'maybe_run_ajax_cache' ) );
add_action( 'edit_page_form', array( $this, 'maybe_run_ajax_cache' ) );
}
/**
* Processes the [embed] shortcode.
*
* Since the [embed] shortcode needs to be run earlier than other shortcodes,
* this function removes all existing shortcodes, registers the [embed] shortcode,
* calls do_shortcode(), and then re-registers the old shortcodes.
*
* @global array $shortcode_tags
*
* @param string $content Content to parse.
* @return string Content with shortcode parsed.
*/
public function run_shortcode( $content ) {
global $shortcode_tags;
// Back up current registered shortcodes and clear them all out.
$orig_shortcode_tags = $shortcode_tags;
remove_all_shortcodes();
add_shortcode( 'embed', array( $this, 'shortcode' ) );
// Do the shortcode (only the [embed] one is registered).
$content = do_shortcode( $content, true );
// Put the original shortcodes back.
$shortcode_tags = $orig_shortcode_tags;
return $content;
}
/**
* If a post/page was saved, then output JavaScript to make
* an Ajax request that will call WP_Embed::cache_oembed().
*/
public function maybe_run_ajax_cache() {
$post = get_post();
if ( ! $post || empty( $_GET['message'] ) ) {
return;
}
?>
<script type="text/javascript">
jQuery( function($) {
$.get("<?php echo esc_url( admin_url( 'admin-ajax.php', 'relative' ) ) . '?action=oembed-cache&post=' . $post->ID; ?>");
} );
</script>
<?php
}
/**
* Registers an embed handler.
*
* 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.
*
* @param string $id An internal ID/name for the handler. Needs to be unique.
* @param string $regex The regex that will be used to see if this handler should be used for a URL.
* @param callable $callback The callback function that will be called if the regex is matched.
* @param int $priority Optional. 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.
*/
public function register_handler( $id, $regex, $callback, $priority = 10 ) {
$this->handlers[ $priority ][ $id ] = array(
'regex' => $regex,
'callback' => $callback,
);
}
/**
* Unregisters a previously-registered embed handler.
*
* Do not use this function directly, use wp_embed_unregister_handler() instead.
*
* @param string $id The handler ID that should be removed.
* @param int $priority Optional. The priority of the handler to be removed (default: 10).
*/
public function unregister_handler( $id, $priority = 10 ) {
unset( $this->handlers[ $priority ][ $id ] );
}
/**
* Returns embed HTML for a given URL from embed handlers.
*
* Attempts to convert a URL into embed HTML by checking the URL
* against the regex of the registered embed handlers.
*
* @since 5.5.0
*
* @param array $attr {
* Shortcode attributes. Optional.
*
* @type int $width Width of the embed in pixels.
* @type int $height Height of the embed in pixels.
* }
* @param string $url The URL attempting to be embedded.
* @return string|false The embed HTML on success, false otherwise.
*/
public function get_embed_handler_html( $attr, $url ) {
$rawattr = $attr;
$attr = wp_parse_args( $attr, wp_embed_defaults( $url ) );
ksort( $this->handlers );
foreach ( $this->handlers as $priority => $handlers ) {
foreach ( $handlers as $id => $handler ) {
if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
$return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr );
if ( false !== $return ) {
/**
* Filters the returned embed HTML.
*
* @since 2.9.0
*
* @see WP_Embed::shortcode()
*
* @param string|false $return The HTML result of the shortcode, or false on failure.
* @param string $url The embed URL.
* @param array $attr An array of shortcode attributes.
*/
return apply_filters( 'embed_handler_html', $return, $url, $attr );
}
}
}
}
return false;
}
/**
* The do_shortcode() callback function.
*
* Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of
* the registered embed handlers. If none of the regex matches and it's enabled, then the URL
* will be given to the WP_oEmbed class.
*
* @param array $attr {
* Shortcode attributes. Optional.
*
* @type int $width Width of the embed in pixels.
* @type int $height Height of the embed in pixels.
* }
* @param string $url The URL attempting to be embedded.
* @return string|false The embed HTML on success, otherwise the original URL.
* `->maybe_make_link()` can return false on failure.
*/
public function shortcode( $attr, $url = '' ) {
$post = get_post();
if ( empty( $url ) && ! empty( $attr['src'] ) ) {
$url = $attr['src'];
}
$this->last_url = $url;
if ( empty( $url ) ) {
$this->last_attr = $attr;
return '';
}
$rawattr = $attr;
$attr = wp_parse_args( $attr, wp_embed_defaults( $url ) );
$this->last_attr = $attr;
// KSES converts & into &amp; and we need to undo this.
// See https://core.trac.wordpress.org/ticket/11311
$url = str_replace( '&amp;', '&', $url );
// Look for known internal handlers.
$embed_handler_html = $this->get_embed_handler_html( $rawattr, $url );
if ( false !== $embed_handler_html ) {
return $embed_handler_html;
}
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
$post_id = ( ! empty( $post->ID ) ) ? $post->ID : null;
// Potentially set by WP_Embed::cache_oembed().
if ( ! empty( $this->post_ID ) ) {
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
$post_id = $this->post_ID;
}
// Check for a cached result (stored as custom post or in the post meta).
$key_suffix = md5( $url . serialize( $attr ) );
$cachekey = '_oembed_' . $key_suffix;
$cachekey_time = '_oembed_time_' . $key_suffix;
/**
* Filters the oEmbed TTL value (time to live).
*
* @since 4.0.0
*
* @param int $time Time to live (in seconds).
* @param string $url The attempted embed URL.
* @param array $attr An array of shortcode attributes.
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
* @param int $post_id Post ID.
*/
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, $url, $attr, $post_id );
$cache = '';
$cache_time = 0;
$cached_post_id = $this->find_oembed_post_id( $key_suffix );
Improve oEmbed caching. Introduces the concept of a TTL for oEmbed caches and a filter for `oembed_ttl`. We will no longer replace previously valid oEmbed responses with an `{{unknown}}` cache value. When this happens due to reaching a rate limit or a service going down, it is data loss, and is not acceptable. This means that oEmbed caches for a post are no longer deleted indiscriminately every time that post is saved. oEmbed continues to be cached in post meta, with the addition of a separate meta key containing the timestamp of the last retrieval, which is used to avoid re-requesting a recently cached oEmbed response. By default, we consider a valued cached in the past day to be fresh. This can greatly reduce the number of outbound requests, especially in cases where a post containing multiple embeds is saved frequently. The TTL used to determine whether or not to request a response can be filtered using `oembed_ttl`, thus allowing for the possibility of respecting the optional oEmbed response parameter `cache_age` or altering the period of time a cached value is considered to be fresh. Now that oEmbeds are previewed in the visual editor as well as the media modal, oEmbed caches are often populated before a post is saved or published. By pre-populating and avoiding having to re-request that response, we also greatly reduce the chances of a stampede happening when a published post is visible before oEmbed caching is complete. As it previously stood, a stampede was extremely likely to happen, as the AJAX caching was only triggered when `$_GET['message']` was 1. The published message is 6. We now trigger the caching every time `$_GET['message']` is present on the edit screen, as we are able to avoid triggering so many HTTP requests overall. props markjaquith. fixes #14759. see #17210. Built from https://develop.svn.wordpress.org/trunk@28972 git-svn-id: http://core.svn.wordpress.org/trunk@28761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 18:45:14 +02:00
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
if ( $post_id ) {
$cache = get_post_meta( $post_id, $cachekey, true );
$cache_time = get_post_meta( $post_id, $cachekey_time, true );
Improve oEmbed caching. Introduces the concept of a TTL for oEmbed caches and a filter for `oembed_ttl`. We will no longer replace previously valid oEmbed responses with an `{{unknown}}` cache value. When this happens due to reaching a rate limit or a service going down, it is data loss, and is not acceptable. This means that oEmbed caches for a post are no longer deleted indiscriminately every time that post is saved. oEmbed continues to be cached in post meta, with the addition of a separate meta key containing the timestamp of the last retrieval, which is used to avoid re-requesting a recently cached oEmbed response. By default, we consider a valued cached in the past day to be fresh. This can greatly reduce the number of outbound requests, especially in cases where a post containing multiple embeds is saved frequently. The TTL used to determine whether or not to request a response can be filtered using `oembed_ttl`, thus allowing for the possibility of respecting the optional oEmbed response parameter `cache_age` or altering the period of time a cached value is considered to be fresh. Now that oEmbeds are previewed in the visual editor as well as the media modal, oEmbed caches are often populated before a post is saved or published. By pre-populating and avoiding having to re-request that response, we also greatly reduce the chances of a stampede happening when a published post is visible before oEmbed caching is complete. As it previously stood, a stampede was extremely likely to happen, as the AJAX caching was only triggered when `$_GET['message']` was 1. The published message is 6. We now trigger the caching every time `$_GET['message']` is present on the edit screen, as we are able to avoid triggering so many HTTP requests overall. props markjaquith. fixes #14759. see #17210. Built from https://develop.svn.wordpress.org/trunk@28972 git-svn-id: http://core.svn.wordpress.org/trunk@28761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 18:45:14 +02:00
if ( ! $cache_time ) {
$cache_time = 0;
}
} elseif ( $cached_post_id ) {
$cached_post = get_post( $cached_post_id );
Improve oEmbed caching. Introduces the concept of a TTL for oEmbed caches and a filter for `oembed_ttl`. We will no longer replace previously valid oEmbed responses with an `{{unknown}}` cache value. When this happens due to reaching a rate limit or a service going down, it is data loss, and is not acceptable. This means that oEmbed caches for a post are no longer deleted indiscriminately every time that post is saved. oEmbed continues to be cached in post meta, with the addition of a separate meta key containing the timestamp of the last retrieval, which is used to avoid re-requesting a recently cached oEmbed response. By default, we consider a valued cached in the past day to be fresh. This can greatly reduce the number of outbound requests, especially in cases where a post containing multiple embeds is saved frequently. The TTL used to determine whether or not to request a response can be filtered using `oembed_ttl`, thus allowing for the possibility of respecting the optional oEmbed response parameter `cache_age` or altering the period of time a cached value is considered to be fresh. Now that oEmbeds are previewed in the visual editor as well as the media modal, oEmbed caches are often populated before a post is saved or published. By pre-populating and avoiding having to re-request that response, we also greatly reduce the chances of a stampede happening when a published post is visible before oEmbed caching is complete. As it previously stood, a stampede was extremely likely to happen, as the AJAX caching was only triggered when `$_GET['message']` was 1. The published message is 6. We now trigger the caching every time `$_GET['message']` is present on the edit screen, as we are able to avoid triggering so many HTTP requests overall. props markjaquith. fixes #14759. see #17210. Built from https://develop.svn.wordpress.org/trunk@28972 git-svn-id: http://core.svn.wordpress.org/trunk@28761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 18:45:14 +02:00
$cache = $cached_post->post_content;
$cache_time = strtotime( $cached_post->post_modified_gmt );
}
$cached_recently = ( time() - $cache_time ) < $ttl;
if ( $this->usecache || $cached_recently ) {
// Failures are cached. Serve one if we're using the cache.
if ( '{{unknown}}' === $cache ) {
return $this->maybe_make_link( $url );
}
if ( ! empty( $cache ) ) {
/**
* Filters the cached oEmbed HTML.
*
* @since 2.9.0
*
* @see WP_Embed::shortcode()
*
* @param string|false $cache The cached HTML result, stored in post meta.
* @param string $url The attempted embed URL.
* @param array $attr An array of shortcode attributes.
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
* @param int $post_id Post ID.
*/
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_id );
}
}
/**
* Filters whether to inspect the given URL for discoverable link tags.
*
* @since 2.9.0
* @since 4.4.0 The default value changed to true.
*
* @see WP_oEmbed::discover()
*
* @param bool $enable Whether to enable `<link>` tag discovery. Default true.
*/
$attr['discover'] = apply_filters( 'embed_oembed_discover', true );
// Use oEmbed to get the HTML.
$html = wp_oembed_get( $url, $attr );
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
if ( $post_id ) {
Improve oEmbed caching. Introduces the concept of a TTL for oEmbed caches and a filter for `oembed_ttl`. We will no longer replace previously valid oEmbed responses with an `{{unknown}}` cache value. When this happens due to reaching a rate limit or a service going down, it is data loss, and is not acceptable. This means that oEmbed caches for a post are no longer deleted indiscriminately every time that post is saved. oEmbed continues to be cached in post meta, with the addition of a separate meta key containing the timestamp of the last retrieval, which is used to avoid re-requesting a recently cached oEmbed response. By default, we consider a valued cached in the past day to be fresh. This can greatly reduce the number of outbound requests, especially in cases where a post containing multiple embeds is saved frequently. The TTL used to determine whether or not to request a response can be filtered using `oembed_ttl`, thus allowing for the possibility of respecting the optional oEmbed response parameter `cache_age` or altering the period of time a cached value is considered to be fresh. Now that oEmbeds are previewed in the visual editor as well as the media modal, oEmbed caches are often populated before a post is saved or published. By pre-populating and avoiding having to re-request that response, we also greatly reduce the chances of a stampede happening when a published post is visible before oEmbed caching is complete. As it previously stood, a stampede was extremely likely to happen, as the AJAX caching was only triggered when `$_GET['message']` was 1. The published message is 6. We now trigger the caching every time `$_GET['message']` is present on the edit screen, as we are able to avoid triggering so many HTTP requests overall. props markjaquith. fixes #14759. see #17210. Built from https://develop.svn.wordpress.org/trunk@28972 git-svn-id: http://core.svn.wordpress.org/trunk@28761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 18:45:14 +02:00
if ( $html ) {
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
update_post_meta( $post_id, $cachekey, $html );
update_post_meta( $post_id, $cachekey_time, time() );
Improve oEmbed caching. Introduces the concept of a TTL for oEmbed caches and a filter for `oembed_ttl`. We will no longer replace previously valid oEmbed responses with an `{{unknown}}` cache value. When this happens due to reaching a rate limit or a service going down, it is data loss, and is not acceptable. This means that oEmbed caches for a post are no longer deleted indiscriminately every time that post is saved. oEmbed continues to be cached in post meta, with the addition of a separate meta key containing the timestamp of the last retrieval, which is used to avoid re-requesting a recently cached oEmbed response. By default, we consider a valued cached in the past day to be fresh. This can greatly reduce the number of outbound requests, especially in cases where a post containing multiple embeds is saved frequently. The TTL used to determine whether or not to request a response can be filtered using `oembed_ttl`, thus allowing for the possibility of respecting the optional oEmbed response parameter `cache_age` or altering the period of time a cached value is considered to be fresh. Now that oEmbeds are previewed in the visual editor as well as the media modal, oEmbed caches are often populated before a post is saved or published. By pre-populating and avoiding having to re-request that response, we also greatly reduce the chances of a stampede happening when a published post is visible before oEmbed caching is complete. As it previously stood, a stampede was extremely likely to happen, as the AJAX caching was only triggered when `$_GET['message']` was 1. The published message is 6. We now trigger the caching every time `$_GET['message']` is present on the edit screen, as we are able to avoid triggering so many HTTP requests overall. props markjaquith. fixes #14759. see #17210. Built from https://develop.svn.wordpress.org/trunk@28972 git-svn-id: http://core.svn.wordpress.org/trunk@28761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 18:45:14 +02:00
} elseif ( ! $cache ) {
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
update_post_meta( $post_id, $cachekey, '{{unknown}}' );
Improve oEmbed caching. Introduces the concept of a TTL for oEmbed caches and a filter for `oembed_ttl`. We will no longer replace previously valid oEmbed responses with an `{{unknown}}` cache value. When this happens due to reaching a rate limit or a service going down, it is data loss, and is not acceptable. This means that oEmbed caches for a post are no longer deleted indiscriminately every time that post is saved. oEmbed continues to be cached in post meta, with the addition of a separate meta key containing the timestamp of the last retrieval, which is used to avoid re-requesting a recently cached oEmbed response. By default, we consider a valued cached in the past day to be fresh. This can greatly reduce the number of outbound requests, especially in cases where a post containing multiple embeds is saved frequently. The TTL used to determine whether or not to request a response can be filtered using `oembed_ttl`, thus allowing for the possibility of respecting the optional oEmbed response parameter `cache_age` or altering the period of time a cached value is considered to be fresh. Now that oEmbeds are previewed in the visual editor as well as the media modal, oEmbed caches are often populated before a post is saved or published. By pre-populating and avoiding having to re-request that response, we also greatly reduce the chances of a stampede happening when a published post is visible before oEmbed caching is complete. As it previously stood, a stampede was extremely likely to happen, as the AJAX caching was only triggered when `$_GET['message']` was 1. The published message is 6. We now trigger the caching every time `$_GET['message']` is present on the edit screen, as we are able to avoid triggering so many HTTP requests overall. props markjaquith. fixes #14759. see #17210. Built from https://develop.svn.wordpress.org/trunk@28972 git-svn-id: http://core.svn.wordpress.org/trunk@28761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 18:45:14 +02:00
}
} else {
$has_kses = false !== has_filter( 'content_save_pre', 'wp_filter_post_kses' );
if ( $has_kses ) {
// Prevent KSES from corrupting JSON in post_content.
kses_remove_filters();
}
$insert_post_args = array(
'post_name' => $key_suffix,
'post_status' => 'publish',
'post_type' => 'oembed_cache',
);
if ( $html ) {
if ( $cached_post_id ) {
wp_update_post(
wp_slash(
array(
'ID' => $cached_post_id,
'post_content' => $html,
)
)
);
} else {
wp_insert_post(
wp_slash(
array_merge(
$insert_post_args,
array(
'post_content' => $html,
)
)
)
);
}
} elseif ( ! $cache ) {
wp_insert_post(
wp_slash(
array_merge(
$insert_post_args,
array(
'post_content' => '{{unknown}}',
)
)
)
);
}
if ( $has_kses ) {
kses_init_filters();
}
}
// If there was a result, return it.
if ( $html ) {
/** This filter is documented in wp-includes/class-wp-embed.php */
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_id );
}
// Still unknown.
return $this->maybe_make_link( $url );
}
/**
* Deletes all oEmbed caches. Unused by core as of 4.0.0.
*
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
* @param int $post_id Post ID to delete the caches for.
*/
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
public function delete_oembed_caches( $post_id ) {
$post_metas = get_post_custom_keys( $post_id );
if ( empty( $post_metas ) ) {
return;
}
foreach ( $post_metas as $post_meta_key ) {
if ( str_starts_with( $post_meta_key, '_oembed_' ) ) {
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
delete_post_meta( $post_id, $post_meta_key );
}
}
}
/**
* Triggers a caching of all oEmbed results.
*
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
* @param int $post_id Post ID to do the caching for.
*/
Coding Standards: Rename `$post_ID` variable to `$post_id` in various files. The `$post_ID` variable is [https://github.com/WordPress/WordPress-Coding-Standards/blob/546f59c67854589bb8f6b49a30e642e75ff419ad/WordPress/Sniffs/NamingConventions/ValidVariableNameSniff.php#L54 technically allowed in WPCS], as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to `$post_id` where appropriate brings more consistency with the rest of core. Additionally, this commit resolves a few WPCS warnings in core: {{{ Variable "$post_IDs" is not in valid snake_case format }}} This affects: * Function parameters in: * `add_meta()` * `post_preview()` * `WP_Embed::delete_oembed_caches()` * `WP_Embed::cache_oembed()` * `wp_get_post_cats()` * `wp_set_post_cats()` * `wp_unique_post_slug()` * `wp_set_post_categories()` * `wp_check_post_hierarchy_for_loops()` * `wp_add_trashed_suffix_to_post_name_for_trashed_posts()` * `wp_filter_wp_template_unique_post_slug()` * `wp_xmlrpc_server::add_enclosure_if_new()` * `wp_xmlrpc_server::attach_uploads()` * `wp_xmlrpc_server::mt_getTrackbackPings()` * Internal variables in: * `wp_ajax_inline_save()` * `wp_ajax_set_post_thumbnail()` * `wp_ajax_get_post_thumbnail_html()` * `edit_post()` * `bulk_edit_posts()` * `wp_write_post()` * `WP_Embed::shortcode()` * `wp_insert_post()` * `wp_xmlrpc_server::_insert_post()` * `wp_xmlrpc_server::blogger_getPost()` * `wp_xmlrpc_server::blogger_newPost()` * `wp_xmlrpc_server::blogger_editPost()` * `wp_xmlrpc_server::blogger_deletePost()` * `wp_xmlrpc_server::mw_getPost()` * `wp_xmlrpc_server::mw_newPost()` * `wp_xmlrpc_server::mw_editPost()` * `wp_xmlrpc_server::mt_getPostCategories()` * `wp_xmlrpc_server::mt_setPostCategories()` * `wp_xmlrpc_server::mt_publishPost()` * `wp_xmlrpc_server::pingback_ping()` * Hook parameters in: * `oembed_ttl` * `embed_oembed_html` * `wp_insert_post_parent` * `add_trashed_suffix_to_trashed_posts` * `pre_post_update` * `edit_attachment` * `attachment_updated` * `add_attachment` * `edit_post_{$post->post_type}` * `edit_post` * `post_updated` * `save_post_{$post->post_type}` * `save_post` * `wp_insert_post` * `pre_wp_unique_post_slug` * `wp_unique_post_slug` * `xmlrpc_call_success_blogger_newPost` * `xmlrpc_call_success_blogger_editPost` * `xmlrpc_call_success_blogger_deletePost` * `xmlrpc_call_success_mw_newPost` * `xmlrpc_call_success_mw_editPost` Note: The name change only affects variable names and DocBlocks. The change does not affect the `$post_ID` global still used in a few places. Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334]. Props mahekkalola, tanjimtc71, SergeyBiryukov. Fixes #57692. Built from https://develop.svn.wordpress.org/trunk@55365 git-svn-id: http://core.svn.wordpress.org/trunk@54898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-19 16:05:22 +01:00
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;
}
}
/**
* Passes any unlinked URLs that are on their own line to WP_Embed::shortcode() for potential embedding.
*
* @see WP_Embed::autoembed_callback()
*
* @param string $content The content to be searched.
* @return string Potentially modified $content.
*/
public function autoembed( $content ) {
// Replace line breaks from all HTML elements with placeholders.
$content = wp_replace_in_html_tags( $content, array( "\n" => '<!-- wp-line-break -->' ) );
if ( preg_match( '#(^|\s|>)https?://#i', $content ) ) {
// Find URLs on their own line.
$content = preg_replace_callback( '|^(\s*)(https?://[^\s<>"]+)(\s*)$|im', array( $this, 'autoembed_callback' ), $content );
// Find URLs in their own paragraph.
$content = preg_replace_callback( '|(<p(?: [^>]*)?>\s*)(https?://[^\s<>"]+)(\s*<\/p>)|i', array( $this, 'autoembed_callback' ), $content );
}
// Put the line breaks back.
return str_replace( '<!-- wp-line-break -->', "\n", $content );
}
/**
* Callback function for WP_Embed::autoembed().
*
* @param array $matches A regex match array.
* @return string The embed HTML on success, otherwise the original URL.
*/
public function autoembed_callback( $matches ) {
$oldval = $this->linkifunknown;
$this->linkifunknown = false;
$return = $this->shortcode( array(), $matches[2] );
$this->linkifunknown = $oldval;
return $matches[1] . $return . $matches[3];
}
/**
* Conditionally makes a hyperlink based on an internal class variable.
*
* @param string $url URL to potentially be linked.
* @return string|false Linked URL or the original URL. False if 'return_false_on_fail' is true.
*/
public function maybe_make_link( $url ) {
if ( $this->return_false_on_fail ) {
return false;
}
$output = ( $this->linkifunknown ) ? '<a href="' . esc_url( $url ) . '">' . esc_html( $url ) . '</a>' : $url;
/**
* Filters the returned, maybe-linked embed URL.
*
* @since 2.9.0
*
* @param string $output The linked or original URL.
* @param string $url The original URL.
*/
return apply_filters( 'embed_maybe_make_link', $output, $url );
}
/**
* Finds the oEmbed cache post ID for a given cache key.
*
* @since 4.9.0
*
* @param string $cache_key oEmbed cache key.
* @return int|null Post ID on success, null on failure.
*/
public function find_oembed_post_id( $cache_key ) {
$cache_group = 'oembed_cache_post';
$oembed_post_id = wp_cache_get( $cache_key, $cache_group );
if ( $oembed_post_id && 'oembed_cache' === get_post_type( $oembed_post_id ) ) {
return $oembed_post_id;
}
$oembed_post_query = new WP_Query(
array(
'post_type' => 'oembed_cache',
'post_status' => 'publish',
'name' => $cache_key,
'posts_per_page' => 1,
'no_found_rows' => true,
'cache_results' => true,
'update_post_meta_cache' => false,
'update_post_term_cache' => false,
'lazy_load_term_meta' => false,
)
);
if ( ! empty( $oembed_post_query->posts ) ) {
// Note: 'fields' => 'ids' is not being used in order to cache the post object as it will be needed.
$oembed_post_id = $oembed_post_query->posts[0]->ID;
wp_cache_set( $cache_key, $oembed_post_id, $cache_group );
return $oembed_post_id;
}
return null;
}
}