enmi-conf.org: comparison wp/wp-includes/class-wp-embed.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 class WP_Embed {
 	public $handlers = array();
 	public $post_ID;
 	public $usecache = true;
 	public $linkifunknown = true;
+	public $last_attr = array();
-	/**
+	public $last_url = '';
-	 * When an URL cannot be embedded, return false instead of returning a link
-	 * or the URL. Bypasses the 'embed_maybe_make_link' filter.
+	/**
+	 * 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 );
 		// 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 );
-		// After a post is saved, cache oEmbed items via AJAX
+		// 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' ) );
 	}
 	/**
 	 * Process 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 {@link do_shortcode()}, and then re-registers the old shortcodes.
+	 * calls do_shortcode(), and then re-registers the old shortcodes.
 	 *
-	 * @uses $shortcode_tags
+	 * @global array $shortcode_tags
 	 *
 	 * @param string $content Content to parse
 	 * @return string Content with shortcode parsed
 	 */
 	public function run_shortcode( $content ) {
 		remove_all_shortcodes();
 		add_shortcode( 'embed', array( $this, 'shortcode' ) );
 		// Do the shortcode (only the [embed] one is registered)
-		$content = do_shortcode( $content );
+		$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().
+	 * an Ajax request that will call WP_Embed::cache_oembed().
 	 */
 	public function maybe_run_ajax_cache() {
 		$post = get_post();
 		if ( ! $post || empty( $_GET['message'] ) )
 </script>
 <?php
 	}
 	/**
-	 * Register an embed handler. Do not use this function directly, use {@link wp_embed_register_handler()} instead.
+	 * 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 callback $callback The callback function that will be called if the regex is matched.
+	 * @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 (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.
 	 */
 	public function register_handler( $id, $regex, $callback, $priority = 10 ) {
 		$this->handlers[$priority][$id] = array(
 			'regex'    => $regex,
 			'callback' => $callback,
 		);
 	}
 	/**
-	 * Unregister a previously registered embed handler. Do not use this function directly, use {@link wp_embed_unregister_handler()} instead.
+	 * 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 ) {
-		if ( isset($this->handlers[$priority][$id]) )
+		unset( $this->handlers[ $priority ][ $id ] );
-			unset($this->handlers[$priority][$id]);
+	}
-	}
+	/**
-	/**
+	 * The do_shortcode() callback function.
-	 * The {@link do_shortcode()} callback function.
+	 *
-	 *
+	 * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of
-	 * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
+	 * the registered embed handlers. If none of the regex matches and it's enabled, then the URL
-	 * If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
+	 * will be given to the WP_oEmbed class.
 	 *
 	 * @param array $attr {
 	 *     Shortcode attributes. Optional.
 	 *
 	 *     @type int $width  Width of the embed in pixels.
 		if ( empty( $url ) && ! empty( $attr['src'] ) ) {
 			$url = $attr['src'];
 		}
+		$this->last_url = $url;
-		if ( empty( $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 );
 		foreach ( $this->handlers as $priority => $handlers ) {
 			foreach ( $handlers as $id => $handler ) {
 				if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
 					if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) )
 						/**
-						 * Filter the returned embed handler.
+						 * Filters the returned embed handler.
 						 *
 						 * @since 2.9.0
 						 *
 						 * @see WP_Embed::shortcode()
 						 *
 				}
 			}
 		}
 		$post_ID = ( ! empty( $post->ID ) ) ? $post->ID : null;
-		if ( ! empty( $this->post_ID ) ) // Potentially set by WP_Embed::cache_oembed()
+		// Potentially set by WP_Embed::cache_oembed().
+		if ( ! empty( $this->post_ID ) ) {
 			$post_ID = $this->post_ID;
+		}
-		// Unknown URL format. Let oEmbed have a go.
+		// 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.
+		 * @param int    $post_ID Post ID.
+		 */
+		$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 );
 		if ( $post_ID ) {
-			// Check for a cached result (stored in the post meta)
-			$key_suffix = md5( $url . serialize( $attr ) );
-			$cachekey = '_oembed_' . $key_suffix;
-			$cachekey_time = '_oembed_time_' . $key_suffix;
-			/**
-			 * Filter 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.
-			 * @param int    $post_ID Post ID.
-			 */
-			$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, $url, $attr, $post_ID );
 			$cache = get_post_meta( $post_ID, $cachekey, true );
 			$cache_time = get_post_meta( $post_ID, $cachekey_time, true );
 			if ( ! $cache_time ) {
 				$cache_time = 0;
 			}
+		} elseif ( $cached_post_id ) {
-			$cached_recently = ( time() - $cache_time ) < $ttl;
+			$cached_post = get_post( $cached_post_id );
-			if ( $this->usecache || $cached_recently ) {
+			$cache      = $cached_post->post_content;
-				// Failures are cached. Serve one if we're using the cache.
+			$cache_time = strtotime( $cached_post->post_modified_gmt );
-				if ( '{{unknown}}' === $cache )
+		}
-					return $this->maybe_make_link( $url );
+		$cached_recently = ( time() - $cache_time ) < $ttl;
-				if ( ! empty( $cache ) ) {
-					/**
+		if ( $this->usecache || $cached_recently ) {
-					 * Filter the cached oEmbed HTML.
+			// Failures are cached. Serve one if we're using the cache.
-					 *
+			if ( '{{unknown}}' === $cache ) {
-					 * @since 2.9.0
+				return $this->maybe_make_link( $url );
-					 *
+			}
-					 * @see WP_Embed::shortcode()
-					 *
+			if ( ! empty( $cache ) ) {
-					 * @param mixed  $cache   The cached HTML result, stored in post meta.
+				/**
-					 * @param string $url     The attempted embed URL.
+				 * Filters the cached oEmbed HTML.
-					 * @param array  $attr    An array of shortcode attributes.
+				 *
-					 * @param int    $post_ID Post ID.
+				 * @since 2.9.0
-					 */
+				 *
-					return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );
+				 * @see WP_Embed::shortcode()
-				}
+				 *
-			}
+				 * @param mixed  $cache   The cached HTML result, stored in post meta.
+				 * @param string $url     The attempted embed URL.
-			/**
+				 * @param array  $attr    An array of shortcode attributes.
-			 * Filter whether to inspect the given URL for discoverable link tags.
+				 * @param int    $post_ID Post ID.
-			 *
+				 */
-			 * @since 2.9.0
+				return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );
-			 *
+			}
-			 * @see WP_oEmbed::discover()
+		}
-			 *
-			 * @param bool $enable Whether to enable `<link>` tag discovery. Default false.
+		/**
-			 */
+		 * Filters whether to inspect the given URL for discoverable link tags.
-			$attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );
+		 *
+		 * @since 2.9.0
-			// Use oEmbed to get the HTML
+		 * @since 4.4.0 The default value changed to true.
-			$html = wp_oembed_get( $url, $attr );
+		 *
+		 * @see WP_oEmbed::discover()
-			// Maybe cache the result
+		 *
+		 * @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 );
+		if ( $post_ID ) {
 			if ( $html ) {
 				update_post_meta( $post_ID, $cachekey, $html );
 				update_post_meta( $post_ID, $cachekey_time, time() );
 			} elseif ( ! $cache ) {
 				update_post_meta( $post_ID, $cachekey, '{{unknown}}' );
 			}
+		} else {
-			// If there was a result, return it
+			$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 ) {
-				/** This filter is documented in wp-includes/class-wp-embed.php */
+				if ( $cached_post_id ) {
-				return apply_filters( 'embed_oembed_html', $html, $url, $attr, $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 */
+			return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_ID );
 		}
 		// Still unknown
 		return $this->maybe_make_link( $url );
 	}
 	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 ) {
+		foreach ( $post_metas as $post_meta_key ) {
 			if ( '_oembed_' == substr( $post_meta_key, 0, 8 ) )
 				delete_post_meta( $post_ID, $post_meta_key );
 		}
 	}
 	public function cache_oembed( $post_ID ) {
 		$post = get_post( $post_ID );
 		$post_types = get_post_types( array( 'show_ui' => true ) );
 		/**
-		 * Filter the array of post types to cache oEmbed results for.
+		 * Filters the array of post types to cache oEmbed results for.
 		 *
 		 * @since 2.9.0
 		 *
 		 * @param array $post_types Array of post types to cache oEmbed results for. Defaults to post types with `show_ui` set to true.
 		 */
 			$this->usecache = true;
 		}
 	}
 	/**
-	 * Passes any unlinked URLs that are on their own line to {@link WP_Embed::shortcode()} for potential embedding.
+	 * Passes any unlinked URLs that are on their own line to WP_Embed::shortcode() for potential embedding.
 	 *
-	 * @uses WP_Embed::autoembed_callback()
+	 * @see WP_Embed::autoembed_callback()
 	 *
 	 * @param string $content The content to be searched.
 	 * @return string Potentially modified $content.
 	 */
 	public function autoembed( $content ) {
-		return preg_replace_callback( '|^(\s*)(https?://[^\s"]+)(\s*)$|im', array( $this, 'autoembed_callback' ), $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 ) ) {
-	 * Callback function for {@link WP_Embed::autoembed()}.
+			// 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 $match A regex match array.
 	 * @return string The embed HTML on success, otherwise the original URL.
 	 */
 	public function autoembed_callback( $match ) {
 		}
 		$output = ( $this->linkifunknown ) ? '<a href="' . esc_url($url) . '">' . esc_html($url) . '</a>' : $url;
 		/**
-		 * Filter the returned, maybe-linked embed 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 );
 	}
+	/**
+	 * Find 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;
+	}
 }
-$GLOBALS['wp_embed'] = new WP_Embed();

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9