3
* API for easily embedding rich media such as videos and images into content.
10
public $handlers = array();
12
public $usecache = true;
13
public $linkifunknown = true;
16
* When an URL cannot be embedded, return false instead of returning a link
17
* or the URL. Bypasses the 'embed_maybe_make_link' filter.
19
public $return_false_on_fail = false;
24
public function __construct() {
25
// Hack to get the [embed] shortcode to run before wpautop()
26
add_filter( 'the_content', array( $this, 'run_shortcode' ), 8 );
28
// Shortcode placeholder for strip_shortcodes()
29
add_shortcode( 'embed', '__return_false' );
31
// Attempts to embed all URLs in a post
32
add_filter( 'the_content', array( $this, 'autoembed' ), 8 );
34
// After a post is saved, cache oEmbed items via AJAX
35
add_action( 'edit_form_advanced', array( $this, 'maybe_run_ajax_cache' ) );
39
* Process the [embed] shortcode.
41
* Since the [embed] shortcode needs to be run earlier than other shortcodes,
42
* this function removes all existing shortcodes, registers the [embed] shortcode,
43
* calls {@link do_shortcode()}, and then re-registers the old shortcodes.
45
* @uses $shortcode_tags
46
* @uses remove_all_shortcodes()
47
* @uses add_shortcode()
48
* @uses do_shortcode()
50
* @param string $content Content to parse
51
* @return string Content with shortcode parsed
53
public function run_shortcode( $content ) {
54
global $shortcode_tags;
56
// Back up current registered shortcodes and clear them all out
57
$orig_shortcode_tags = $shortcode_tags;
58
remove_all_shortcodes();
60
add_shortcode( 'embed', array( $this, 'shortcode' ) );
62
// Do the shortcode (only the [embed] one is registered)
63
$content = do_shortcode( $content );
65
// Put the original shortcodes back
66
$shortcode_tags = $orig_shortcode_tags;
72
* If a post/page was saved, then output JavaScript to make
73
* an AJAX request that will call WP_Embed::cache_oembed().
75
public function maybe_run_ajax_cache() {
78
if ( ! $post || empty( $_GET['message'] ) )
82
<script type="text/javascript">
84
jQuery(document).ready(function($){
85
$.get("<?php echo admin_url( 'admin-ajax.php?action=oembed-cache&post=' . $post->ID, 'relative' ); ?>");
93
* Register an embed handler. Do not use this function directly, use {@link wp_embed_register_handler()} instead.
94
* This function should probably also only be used for sites that do not support oEmbed.
96
* @param string $id An internal ID/name for the handler. Needs to be unique.
97
* @param string $regex The regex that will be used to see if this handler should be used for a URL.
98
* @param callback $callback The callback function that will be called if the regex is matched.
99
* @param int $priority Optional. Used to specify the order in which the registered handlers will be tested (default: 10). 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.
101
public function register_handler( $id, $regex, $callback, $priority = 10 ) {
102
$this->handlers[$priority][$id] = array(
104
'callback' => $callback,
109
* Unregister a previously registered embed handler. Do not use this function directly, use {@link wp_embed_unregister_handler()} instead.
111
* @param string $id The handler ID that should be removed.
112
* @param int $priority Optional. The priority of the handler to be removed (default: 10).
114
public function unregister_handler( $id, $priority = 10 ) {
115
if ( isset($this->handlers[$priority][$id]) )
116
unset($this->handlers[$priority][$id]);
120
* The {@link do_shortcode()} callback function.
122
* Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
123
* If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
125
* @uses wp_oembed_get()
126
* @uses wp_parse_args()
127
* @uses wp_embed_defaults()
128
* @uses WP_Embed::maybe_make_link()
131
* @uses wp_cache_get()
132
* @uses wp_cache_set()
133
* @uses get_post_meta()
134
* @uses update_post_meta()
136
* @param array $attr {
137
* Shortcode attributes. Optional.
139
* @type int $width Width of the embed in pixels.
140
* @type int $height Height of the embed in pixels.
142
* @param string $url The URL attempting to be embedded.
143
* @return string The embed HTML on success, otherwise the original URL.
145
public function shortcode( $attr, $url = '' ) {
148
if ( empty( $url ) && ! empty( $attr['src'] ) ) {
156
$attr = wp_parse_args( $attr, wp_embed_defaults( $url ) );
158
// kses converts & into & and we need to undo this
159
// See http://core.trac.wordpress.org/ticket/11311
160
$url = str_replace( '&', '&', $url );
162
// Look for known internal handlers
163
ksort( $this->handlers );
164
foreach ( $this->handlers as $priority => $handlers ) {
165
foreach ( $handlers as $id => $handler ) {
166
if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
167
if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) )
169
* Filter the returned embed handler.
173
* @see WP_Embed::shortcode()
175
* @param mixed $return The shortcode callback function to call.
176
* @param string $url The attempted embed URL.
177
* @param array $attr An array of shortcode attributes.
179
return apply_filters( 'embed_handler_html', $return, $url, $attr );
184
$post_ID = ( ! empty( $post->ID ) ) ? $post->ID : null;
185
if ( ! empty( $this->post_ID ) ) // Potentially set by WP_Embed::cache_oembed()
186
$post_ID = $this->post_ID;
188
// Unknown URL format. Let oEmbed have a go.
191
// Check for a cached result (stored in the post meta)
192
$key_suffix = md5( $url . serialize( $attr ) );
193
$cachekey = '_oembed_' . $key_suffix;
194
$cachekey_time = '_oembed_time_' . $key_suffix;
197
* Filter the oEmbed TTL value (time to live).
201
* @param int $time Time to live (in seconds).
202
* @param string $url The attempted embed URL.
203
* @param array $attr An array of shortcode attributes.
204
* @param int $post_ID Post ID.
206
$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, $url, $attr, $post_ID );
208
$cache = get_post_meta( $post_ID, $cachekey, true );
209
$cache_time = get_post_meta( $post_ID, $cachekey_time, true );
211
if ( ! $cache_time ) {
215
$cached_recently = ( time() - $cache_time ) < $ttl;
217
if ( $this->usecache || $cached_recently ) {
218
// Failures are cached. Serve one if we're using the cache.
219
if ( '{{unknown}}' === $cache )
220
return $this->maybe_make_link( $url );
222
if ( ! empty( $cache ) ) {
224
* Filter the cached oEmbed HTML.
228
* @see WP_Embed::shortcode()
230
* @param mixed $cache The cached HTML result, stored in post meta.
231
* @param string $url The attempted embed URL.
232
* @param array $attr An array of shortcode attributes.
233
* @param int $post_ID Post ID.
235
return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );
240
* Filter whether to inspect the given URL for discoverable <link> tags.
244
* @see WP_oEmbed::discover()
246
* @param bool $enable Whether to enable <link> tag discovery. Default false.
248
$attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );
250
// Use oEmbed to get the HTML
251
$html = wp_oembed_get( $url, $attr );
253
// Maybe cache the result
255
update_post_meta( $post_ID, $cachekey, $html );
256
update_post_meta( $post_ID, $cachekey_time, time() );
257
} elseif ( ! $cache ) {
258
update_post_meta( $post_ID, $cachekey, '{{unknown}}' );
261
// If there was a result, return it
263
/** This filter is documented in wp-includes/class-wp-embed.php */
264
return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_ID );
269
return $this->maybe_make_link( $url );
273
* Delete all oEmbed caches. Unused by core as of 4.0.0.
275
* @param int $post_ID Post ID to delete the caches for.
277
public function delete_oembed_caches( $post_ID ) {
278
$post_metas = get_post_custom_keys( $post_ID );
279
if ( empty($post_metas) )
282
foreach( $post_metas as $post_meta_key ) {
283
if ( '_oembed_' == substr( $post_meta_key, 0, 8 ) )
284
delete_post_meta( $post_ID, $post_meta_key );
289
* Triggers a caching of all oEmbed results.
291
* @param int $post_ID Post ID to do the caching for.
293
public function cache_oembed( $post_ID ) {
294
$post = get_post( $post_ID );
296
$post_types = get_post_types( array( 'show_ui' => true ) );
298
* Filter the array of post types to cache oEmbed results for.
302
* @param array $post_types Array of post types to cache oEmbed results for. Defaults to post types with `show_ui` set to true.
304
if ( empty( $post->ID ) || ! in_array( $post->post_type, apply_filters( 'embed_cache_oembed_types', $post_types ) ) ){
309
if ( ! empty( $post->post_content ) ) {
310
$this->post_ID = $post->ID;
311
$this->usecache = false;
313
$content = $this->run_shortcode( $post->post_content );
314
$this->autoembed( $content );
316
$this->usecache = true;
321
* Passes any unlinked URLs that are on their own line to {@link WP_Embed::shortcode()} for potential embedding.
323
* @uses WP_Embed::autoembed_callback()
325
* @param string $content The content to be searched.
326
* @return string Potentially modified $content.
328
public function autoembed( $content ) {
329
return preg_replace_callback( '|^\s*(https?://[^\s"]+)\s*$|im', array( $this, 'autoembed_callback' ), $content );
333
* Callback function for {@link WP_Embed::autoembed()}.
335
* @uses WP_Embed::shortcode()
337
* @param array $match A regex match array.
338
* @return string The embed HTML on success, otherwise the original URL.
340
public function autoembed_callback( $match ) {
341
$oldval = $this->linkifunknown;
342
$this->linkifunknown = false;
343
$return = $this->shortcode( array(), $match[1] );
344
$this->linkifunknown = $oldval;
346
return "\n$return\n";
350
* Conditionally makes a hyperlink based on an internal class variable.
352
* @param string $url URL to potentially be linked.
353
* @return string Linked URL or the original URL.
355
public function maybe_make_link( $url ) {
356
if ( $this->return_false_on_fail ) {
360
$output = ( $this->linkifunknown ) ? '<a href="' . esc_url($url) . '">' . esc_html($url) . '</a>' : $url;
363
* Filter the returned, maybe-linked embed URL.
367
* @param string $output The linked or original URL.
368
* @param string $url The original URL.
370
return apply_filters( 'embed_maybe_make_link', $output, $url );
373
$GLOBALS['wp_embed'] = new WP_Embed();
added
removed
wp-includes/class-wp-embed.php
