|
16
|
1 |
<?php |
|
|
2 |
/** |
|
|
3 |
* API for fetching the HTML to embed remote content based on a provided URL |
|
|
4 |
* |
|
|
5 |
* Used internally by the WP_Embed class, but is designed to be generic. |
|
|
6 |
* |
|
|
7 |
* @link https://wordpress.org/support/article/embeds/ |
|
|
8 |
* @link http://oembed.com/ |
|
|
9 |
* |
|
|
10 |
* @package WordPress |
|
|
11 |
* @subpackage oEmbed |
|
|
12 |
*/ |
|
|
13 |
|
|
|
14 |
/** |
|
|
15 |
* Core class used to implement oEmbed functionality. |
|
|
16 |
* |
|
|
17 |
* @since 2.9.0 |
|
|
18 |
*/ |
|
|
19 |
class WP_oEmbed { |
|
|
20 |
|
|
|
21 |
/** |
|
|
22 |
* A list of oEmbed providers. |
|
|
23 |
* |
|
|
24 |
* @since 2.9.0 |
|
|
25 |
* @var array |
|
|
26 |
*/ |
|
|
27 |
public $providers = array(); |
|
|
28 |
|
|
|
29 |
/** |
|
|
30 |
* A list of an early oEmbed providers. |
|
|
31 |
* |
|
|
32 |
* @since 4.0.0 |
|
|
33 |
* @var array |
|
|
34 |
*/ |
|
|
35 |
public static $early_providers = array(); |
|
|
36 |
|
|
|
37 |
/** |
|
|
38 |
* A list of private/protected methods, used for backward compatibility. |
|
|
39 |
* |
|
|
40 |
* @since 4.2.0 |
|
|
41 |
* @var array |
|
|
42 |
*/ |
|
|
43 |
private $compat_methods = array( '_fetch_with_format', '_parse_json', '_parse_xml', '_parse_xml_body' ); |
|
|
44 |
|
|
|
45 |
/** |
|
|
46 |
* Constructor. |
|
|
47 |
* |
|
|
48 |
* @since 2.9.0 |
|
|
49 |
*/ |
|
|
50 |
public function __construct() { |
|
|
51 |
$host = urlencode( home_url() ); |
|
|
52 |
$providers = array( |
|
|
53 |
'#https?://((m|www)\.)?youtube\.com/watch.*#i' => array( 'https://www.youtube.com/oembed', true ), |
|
|
54 |
'#https?://((m|www)\.)?youtube\.com/playlist.*#i' => array( 'https://www.youtube.com/oembed', true ), |
|
19
|
55 |
'#https?://((m|www)\.)?youtube\.com/shorts/*#i' => array( 'https://www.youtube.com/oembed', true ), |
|
16
|
56 |
'#https?://youtu\.be/.*#i' => array( 'https://www.youtube.com/oembed', true ), |
|
|
57 |
'#https?://(.+\.)?vimeo\.com/.*#i' => array( 'https://vimeo.com/api/oembed.{format}', true ), |
|
|
58 |
'#https?://(www\.)?dailymotion\.com/.*#i' => array( 'https://www.dailymotion.com/services/oembed', true ), |
|
|
59 |
'#https?://dai\.ly/.*#i' => array( 'https://www.dailymotion.com/services/oembed', true ), |
|
|
60 |
'#https?://(www\.)?flickr\.com/.*#i' => array( 'https://www.flickr.com/services/oembed/', true ), |
|
|
61 |
'#https?://flic\.kr/.*#i' => array( 'https://www.flickr.com/services/oembed/', true ), |
|
|
62 |
'#https?://(.+\.)?smugmug\.com/.*#i' => array( 'https://api.smugmug.com/services/oembed/', true ), |
|
|
63 |
'#https?://(www\.)?scribd\.com/(doc|document)/.*#i' => array( 'https://www.scribd.com/services/oembed', true ), |
|
|
64 |
'#https?://wordpress\.tv/.*#i' => array( 'https://wordpress.tv/oembed/', true ), |
|
|
65 |
'#https?://(.+\.)?polldaddy\.com/.*#i' => array( 'https://api.crowdsignal.com/oembed', true ), |
|
|
66 |
'#https?://poll\.fm/.*#i' => array( 'https://api.crowdsignal.com/oembed', true ), |
|
|
67 |
'#https?://(.+\.)?survey\.fm/.*#i' => array( 'https://api.crowdsignal.com/oembed', true ), |
|
|
68 |
'#https?://(www\.)?twitter\.com/\w{1,15}/status(es)?/.*#i' => array( 'https://publish.twitter.com/oembed', true ), |
|
|
69 |
'#https?://(www\.)?twitter\.com/\w{1,15}$#i' => array( 'https://publish.twitter.com/oembed', true ), |
|
|
70 |
'#https?://(www\.)?twitter\.com/\w{1,15}/likes$#i' => array( 'https://publish.twitter.com/oembed', true ), |
|
|
71 |
'#https?://(www\.)?twitter\.com/\w{1,15}/lists/.*#i' => array( 'https://publish.twitter.com/oembed', true ), |
|
|
72 |
'#https?://(www\.)?twitter\.com/\w{1,15}/timelines/.*#i' => array( 'https://publish.twitter.com/oembed', true ), |
|
|
73 |
'#https?://(www\.)?twitter\.com/i/moments/.*#i' => array( 'https://publish.twitter.com/oembed', true ), |
|
|
74 |
'#https?://(www\.)?soundcloud\.com/.*#i' => array( 'https://soundcloud.com/oembed', true ), |
|
|
75 |
'#https?://(.+?\.)?slideshare\.net/.*#i' => array( 'https://www.slideshare.net/api/oembed/2', true ), |
|
|
76 |
'#https?://(open|play)\.spotify\.com/.*#i' => array( 'https://embed.spotify.com/oembed/', true ), |
|
|
77 |
'#https?://(.+\.)?imgur\.com/.*#i' => array( 'https://api.imgur.com/oembed', true ), |
|
|
78 |
'#https?://(www\.)?issuu\.com/.+/docs/.+#i' => array( 'https://issuu.com/oembed_wp', true ), |
|
|
79 |
'#https?://(www\.)?mixcloud\.com/.*#i' => array( 'https://www.mixcloud.com/oembed', true ), |
|
|
80 |
'#https?://(www\.|embed\.)?ted\.com/talks/.*#i' => array( 'https://www.ted.com/services/v1/oembed.{format}', true ), |
|
|
81 |
'#https?://(www\.)?(animoto|video214)\.com/play/.*#i' => array( 'https://animoto.com/oembeds/create', true ), |
|
|
82 |
'#https?://(.+)\.tumblr\.com/post/.*#i' => array( 'https://www.tumblr.com/oembed/1.0', true ), |
|
|
83 |
'#https?://(www\.)?kickstarter\.com/projects/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ), |
|
|
84 |
'#https?://kck\.st/.*#i' => array( 'https://www.kickstarter.com/services/oembed', true ), |
|
|
85 |
'#https?://cloudup\.com/.*#i' => array( 'https://cloudup.com/oembed', true ), |
|
|
86 |
'#https?://(www\.)?reverbnation\.com/.*#i' => array( 'https://www.reverbnation.com/oembed', true ), |
|
|
87 |
'#https?://videopress\.com/v/.*#' => array( 'https://public-api.wordpress.com/oembed/?for=' . $host, true ), |
|
|
88 |
'#https?://(www\.)?reddit\.com/r/[^/]+/comments/.*#i' => array( 'https://www.reddit.com/oembed', true ), |
|
|
89 |
'#https?://(www\.)?speakerdeck\.com/.*#i' => array( 'https://speakerdeck.com/oembed.{format}', true ), |
|
|
90 |
'#https?://(www\.)?screencast\.com/.*#i' => array( 'https://api.screencast.com/external/oembed', true ), |
|
|
91 |
'#https?://([a-z0-9-]+\.)?amazon\.(com|com\.mx|com\.br|ca)/.*#i' => array( 'https://read.amazon.com/kp/api/oembed', true ), |
|
|
92 |
'#https?://([a-z0-9-]+\.)?amazon\.(co\.uk|de|fr|it|es|in|nl|ru)/.*#i' => array( 'https://read.amazon.co.uk/kp/api/oembed', true ), |
|
|
93 |
'#https?://([a-z0-9-]+\.)?amazon\.(co\.jp|com\.au)/.*#i' => array( 'https://read.amazon.com.au/kp/api/oembed', true ), |
|
|
94 |
'#https?://([a-z0-9-]+\.)?amazon\.cn/.*#i' => array( 'https://read.amazon.cn/kp/api/oembed', true ), |
|
|
95 |
'#https?://(www\.)?a\.co/.*#i' => array( 'https://read.amazon.com/kp/api/oembed', true ), |
|
|
96 |
'#https?://(www\.)?amzn\.to/.*#i' => array( 'https://read.amazon.com/kp/api/oembed', true ), |
|
|
97 |
'#https?://(www\.)?amzn\.eu/.*#i' => array( 'https://read.amazon.co.uk/kp/api/oembed', true ), |
|
|
98 |
'#https?://(www\.)?amzn\.in/.*#i' => array( 'https://read.amazon.in/kp/api/oembed', true ), |
|
|
99 |
'#https?://(www\.)?amzn\.asia/.*#i' => array( 'https://read.amazon.com.au/kp/api/oembed', true ), |
|
|
100 |
'#https?://(www\.)?z\.cn/.*#i' => array( 'https://read.amazon.cn/kp/api/oembed', true ), |
|
|
101 |
'#https?://www\.someecards\.com/.+-cards/.+#i' => array( 'https://www.someecards.com/v2/oembed/', true ), |
|
|
102 |
'#https?://www\.someecards\.com/usercards/viewcard/.+#i' => array( 'https://www.someecards.com/v2/oembed/', true ), |
|
|
103 |
'#https?://some\.ly\/.+#i' => array( 'https://www.someecards.com/v2/oembed/', true ), |
|
|
104 |
'#https?://(www\.)?tiktok\.com/.*/video/.*#i' => array( 'https://www.tiktok.com/oembed', true ), |
|
19
|
105 |
'#https?://([a-z]{2}|www)\.pinterest\.com(\.(au|mx))?/.*#i' => array( 'https://www.pinterest.com/oembed.json', true ), |
|
|
106 |
'#https?://(www\.)?wolframcloud\.com/obj/.+#i' => array( 'https://www.wolframcloud.com/oembed', true ), |
|
16
|
107 |
); |
|
|
108 |
|
|
|
109 |
if ( ! empty( self::$early_providers['add'] ) ) { |
|
|
110 |
foreach ( self::$early_providers['add'] as $format => $data ) { |
|
|
111 |
$providers[ $format ] = $data; |
|
|
112 |
} |
|
|
113 |
} |
|
|
114 |
|
|
|
115 |
if ( ! empty( self::$early_providers['remove'] ) ) { |
|
|
116 |
foreach ( self::$early_providers['remove'] as $format ) { |
|
|
117 |
unset( $providers[ $format ] ); |
|
|
118 |
} |
|
|
119 |
} |
|
|
120 |
|
|
|
121 |
self::$early_providers = array(); |
|
|
122 |
|
|
|
123 |
/** |
|
|
124 |
* Filters the list of sanctioned oEmbed providers. |
|
|
125 |
* |
|
|
126 |
* Since WordPress 4.4, oEmbed discovery is enabled for all users and allows embedding of sanitized |
|
|
127 |
* iframes. The providers in this list are sanctioned, meaning they are trusted and allowed to |
|
|
128 |
* embed any content, such as iframes, videos, JavaScript, and arbitrary HTML. |
|
|
129 |
* |
|
|
130 |
* Supported providers: |
|
|
131 |
* |
|
|
132 |
* | Provider | Flavor | Since | |
|
|
133 |
* | ------------ | ----------------------------------------- | ------- | |
|
|
134 |
* | Dailymotion | dailymotion.com | 2.9.0 | |
|
|
135 |
* | Flickr | flickr.com | 2.9.0 | |
|
|
136 |
* | Scribd | scribd.com | 2.9.0 | |
|
|
137 |
* | Vimeo | vimeo.com | 2.9.0 | |
|
|
138 |
* | WordPress.tv | wordpress.tv | 2.9.0 | |
|
|
139 |
* | YouTube | youtube.com/watch | 2.9.0 | |
|
|
140 |
* | Crowdsignal | polldaddy.com | 3.0.0 | |
|
|
141 |
* | SmugMug | smugmug.com | 3.0.0 | |
|
|
142 |
* | YouTube | youtu.be | 3.0.0 | |
|
|
143 |
* | Twitter | twitter.com | 3.4.0 | |
|
|
144 |
* | Slideshare | slideshare.net | 3.5.0 | |
|
|
145 |
* | SoundCloud | soundcloud.com | 3.5.0 | |
|
|
146 |
* | Dailymotion | dai.ly | 3.6.0 | |
|
|
147 |
* | Flickr | flic.kr | 3.6.0 | |
|
|
148 |
* | Spotify | spotify.com | 3.6.0 | |
|
|
149 |
* | Imgur | imgur.com | 3.9.0 | |
|
|
150 |
* | Animoto | animoto.com | 4.0.0 | |
|
|
151 |
* | Animoto | video214.com | 4.0.0 | |
|
|
152 |
* | Issuu | issuu.com | 4.0.0 | |
|
|
153 |
* | Mixcloud | mixcloud.com | 4.0.0 | |
|
|
154 |
* | Crowdsignal | poll.fm | 4.0.0 | |
|
|
155 |
* | TED | ted.com | 4.0.0 | |
|
|
156 |
* | YouTube | youtube.com/playlist | 4.0.0 | |
|
|
157 |
* | Tumblr | tumblr.com | 4.2.0 | |
|
|
158 |
* | Kickstarter | kickstarter.com | 4.2.0 | |
|
|
159 |
* | Kickstarter | kck.st | 4.2.0 | |
|
|
160 |
* | Cloudup | cloudup.com | 4.3.0 | |
|
|
161 |
* | ReverbNation | reverbnation.com | 4.4.0 | |
|
|
162 |
* | VideoPress | videopress.com | 4.4.0 | |
|
|
163 |
* | Reddit | reddit.com | 4.4.0 | |
|
|
164 |
* | Speaker Deck | speakerdeck.com | 4.4.0 | |
|
|
165 |
* | Twitter | twitter.com/timelines | 4.5.0 | |
|
|
166 |
* | Twitter | twitter.com/moments | 4.5.0 | |
|
|
167 |
* | Twitter | twitter.com/user | 4.7.0 | |
|
|
168 |
* | Twitter | twitter.com/likes | 4.7.0 | |
|
|
169 |
* | Twitter | twitter.com/lists | 4.7.0 | |
|
|
170 |
* | Screencast | screencast.com | 4.8.0 | |
|
|
171 |
* | Amazon | amazon.com (com.mx, com.br, ca) | 4.9.0 | |
|
|
172 |
* | Amazon | amazon.de (fr, it, es, in, nl, ru, co.uk) | 4.9.0 | |
|
|
173 |
* | Amazon | amazon.co.jp (com.au) | 4.9.0 | |
|
|
174 |
* | Amazon | amazon.cn | 4.9.0 | |
|
|
175 |
* | Amazon | a.co | 4.9.0 | |
|
|
176 |
* | Amazon | amzn.to (eu, in, asia) | 4.9.0 | |
|
|
177 |
* | Amazon | z.cn | 4.9.0 | |
|
|
178 |
* | Someecards | someecards.com | 4.9.0 | |
|
|
179 |
* | Someecards | some.ly | 4.9.0 | |
|
|
180 |
* | Crowdsignal | survey.fm | 5.1.0 | |
|
|
181 |
* | TikTok | tiktok.com | 5.4.0 | |
|
19
|
182 |
* | Pinterest | pinterest.com | 5.9.0 | |
|
|
183 |
* | WolframCloud | wolframcloud.com | 5.9.0 | |
|
16
|
184 |
* |
|
|
185 |
* No longer supported providers: |
|
|
186 |
* |
|
|
187 |
* | Provider | Flavor | Since | Removed | |
|
|
188 |
* | ------------ | -------------------- | --------- | --------- | |
|
|
189 |
* | Qik | qik.com | 2.9.0 | 3.9.0 | |
|
|
190 |
* | Viddler | viddler.com | 2.9.0 | 4.0.0 | |
|
|
191 |
* | Revision3 | revision3.com | 2.9.0 | 4.2.0 | |
|
|
192 |
* | Blip | blip.tv | 2.9.0 | 4.4.0 | |
|
|
193 |
* | Rdio | rdio.com | 3.6.0 | 4.4.1 | |
|
|
194 |
* | Rdio | rd.io | 3.6.0 | 4.4.1 | |
|
|
195 |
* | Vine | vine.co | 4.1.0 | 4.9.0 | |
|
|
196 |
* | Photobucket | photobucket.com | 2.9.0 | 5.1.0 | |
|
|
197 |
* | Funny or Die | funnyordie.com | 3.0.0 | 5.1.0 | |
|
|
198 |
* | CollegeHumor | collegehumor.com | 4.0.0 | 5.3.1 | |
|
|
199 |
* | Hulu | hulu.com | 2.9.0 | 5.5.0 | |
|
18
|
200 |
* | Instagram | instagram.com | 3.5.0 | 5.5.2 | |
|
|
201 |
* | Instagram | instagr.am | 3.5.0 | 5.5.2 | |
|
|
202 |
* | Instagram TV | instagram.com | 5.1.0 | 5.5.2 | |
|
|
203 |
* | Instagram TV | instagr.am | 5.1.0 | 5.5.2 | |
|
|
204 |
* | Facebook | facebook.com | 4.7.0 | 5.5.2 | |
|
19
|
205 |
* | Meetup.com | meetup.com | 3.9.0 | 6.0.1 | |
|
|
206 |
* | Meetup.com | meetu.ps | 3.9.0 | 6.0.1 | |
|
16
|
207 |
* |
|
|
208 |
* @see wp_oembed_add_provider() |
|
|
209 |
* |
|
|
210 |
* @since 2.9.0 |
|
|
211 |
* |
|
|
212 |
* @param array[] $providers An array of arrays containing data about popular oEmbed providers. |
|
|
213 |
*/ |
|
|
214 |
$this->providers = apply_filters( 'oembed_providers', $providers ); |
|
|
215 |
|
|
|
216 |
// Fix any embeds that contain new lines in the middle of the HTML which breaks wpautop(). |
|
|
217 |
add_filter( 'oembed_dataparse', array( $this, '_strip_newlines' ), 10, 3 ); |
|
|
218 |
} |
|
|
219 |
|
|
|
220 |
/** |
|
|
221 |
* Exposes private/protected methods for backward compatibility. |
|
|
222 |
* |
|
|
223 |
* @since 4.0.0 |
|
|
224 |
* |
|
|
225 |
* @param string $name Method to call. |
|
|
226 |
* @param array $arguments Arguments to pass when calling. |
|
18
|
227 |
* @return mixed|false Return value of the callback, false otherwise. |
|
16
|
228 |
*/ |
|
|
229 |
public function __call( $name, $arguments ) { |
|
|
230 |
if ( in_array( $name, $this->compat_methods, true ) ) { |
|
|
231 |
return $this->$name( ...$arguments ); |
|
|
232 |
} |
|
|
233 |
return false; |
|
|
234 |
} |
|
|
235 |
|
|
|
236 |
/** |
|
|
237 |
* Takes a URL and returns the corresponding oEmbed provider's URL, if there is one. |
|
|
238 |
* |
|
|
239 |
* @since 4.0.0 |
|
|
240 |
* |
|
|
241 |
* @see WP_oEmbed::discover() |
|
|
242 |
* |
|
|
243 |
* @param string $url The URL to the content. |
|
18
|
244 |
* @param string|array $args { |
|
|
245 |
* Optional. Additional provider arguments. Default empty. |
|
|
246 |
* |
|
|
247 |
* @type bool $discover Optional. Determines whether to attempt to discover link tags |
|
|
248 |
* at the given URL for an oEmbed provider when the provider URL |
|
|
249 |
* is not found in the built-in providers list. Default true. |
|
|
250 |
* } |
|
16
|
251 |
* @return string|false The oEmbed provider URL on success, false on failure. |
|
|
252 |
*/ |
|
|
253 |
public function get_provider( $url, $args = '' ) { |
|
|
254 |
$args = wp_parse_args( $args ); |
|
|
255 |
|
|
|
256 |
$provider = false; |
|
|
257 |
|
|
|
258 |
if ( ! isset( $args['discover'] ) ) { |
|
|
259 |
$args['discover'] = true; |
|
|
260 |
} |
|
|
261 |
|
|
|
262 |
foreach ( $this->providers as $matchmask => $data ) { |
|
|
263 |
list( $providerurl, $regex ) = $data; |
|
|
264 |
|
|
|
265 |
// Turn the asterisk-type provider URLs into regex. |
|
|
266 |
if ( ! $regex ) { |
|
|
267 |
$matchmask = '#' . str_replace( '___wildcard___', '(.+)', preg_quote( str_replace( '*', '___wildcard___', $matchmask ), '#' ) ) . '#i'; |
|
|
268 |
$matchmask = preg_replace( '|^#http\\\://|', '#https?\://', $matchmask ); |
|
|
269 |
} |
|
|
270 |
|
|
|
271 |
if ( preg_match( $matchmask, $url ) ) { |
|
|
272 |
$provider = str_replace( '{format}', 'json', $providerurl ); // JSON is easier to deal with than XML. |
|
|
273 |
break; |
|
|
274 |
} |
|
|
275 |
} |
|
|
276 |
|
|
|
277 |
if ( ! $provider && $args['discover'] ) { |
|
|
278 |
$provider = $this->discover( $url ); |
|
|
279 |
} |
|
|
280 |
|
|
|
281 |
return $provider; |
|
|
282 |
} |
|
|
283 |
|
|
|
284 |
/** |
|
|
285 |
* Adds an oEmbed provider. |
|
|
286 |
* |
|
|
287 |
* The provider is added just-in-time when wp_oembed_add_provider() is called before |
|
|
288 |
* the {@see 'plugins_loaded'} hook. |
|
|
289 |
* |
|
|
290 |
* The just-in-time addition is for the benefit of the {@see 'oembed_providers'} filter. |
|
|
291 |
* |
|
|
292 |
* @since 4.0.0 |
|
|
293 |
* |
|
|
294 |
* @see wp_oembed_add_provider() |
|
|
295 |
* |
|
|
296 |
* @param string $format Format of URL that this provider can handle. You can use |
|
|
297 |
* asterisks as wildcards. |
|
|
298 |
* @param string $provider The URL to the oEmbed provider.. |
|
|
299 |
* @param bool $regex Optional. Whether the $format parameter is in a regex format. |
|
|
300 |
* Default false. |
|
|
301 |
*/ |
|
|
302 |
public static function _add_provider_early( $format, $provider, $regex = false ) { |
|
|
303 |
if ( empty( self::$early_providers['add'] ) ) { |
|
|
304 |
self::$early_providers['add'] = array(); |
|
|
305 |
} |
|
|
306 |
|
|
|
307 |
self::$early_providers['add'][ $format ] = array( $provider, $regex ); |
|
|
308 |
} |
|
|
309 |
|
|
|
310 |
/** |
|
|
311 |
* Removes an oEmbed provider. |
|
|
312 |
* |
|
|
313 |
* The provider is removed just-in-time when wp_oembed_remove_provider() is called before |
|
|
314 |
* the {@see 'plugins_loaded'} hook. |
|
|
315 |
* |
|
|
316 |
* The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter. |
|
|
317 |
* |
|
|
318 |
* @since 4.0.0 |
|
|
319 |
* |
|
|
320 |
* @see wp_oembed_remove_provider() |
|
|
321 |
* |
|
|
322 |
* @param string $format The format of URL that this provider can handle. You can use |
|
|
323 |
* asterisks as wildcards. |
|
|
324 |
*/ |
|
|
325 |
public static function _remove_provider_early( $format ) { |
|
|
326 |
if ( empty( self::$early_providers['remove'] ) ) { |
|
|
327 |
self::$early_providers['remove'] = array(); |
|
|
328 |
} |
|
|
329 |
|
|
|
330 |
self::$early_providers['remove'][] = $format; |
|
|
331 |
} |
|
|
332 |
|
|
|
333 |
/** |
|
|
334 |
* Takes a URL and attempts to return the oEmbed data. |
|
|
335 |
* |
|
|
336 |
* @see WP_oEmbed::fetch() |
|
|
337 |
* |
|
|
338 |
* @since 4.8.0 |
|
|
339 |
* |
|
|
340 |
* @param string $url The URL to the content that should be attempted to be embedded. |
|
18
|
341 |
* @param string|array $args Optional. Additional arguments for retrieving embed HTML. |
|
|
342 |
* See wp_oembed_get() for accepted arguments. Default empty. |
|
16
|
343 |
* @return object|false The result in the form of an object on success, false on failure. |
|
|
344 |
*/ |
|
|
345 |
public function get_data( $url, $args = '' ) { |
|
|
346 |
$args = wp_parse_args( $args ); |
|
|
347 |
|
|
|
348 |
$provider = $this->get_provider( $url, $args ); |
|
|
349 |
|
|
|
350 |
if ( ! $provider ) { |
|
|
351 |
return false; |
|
|
352 |
} |
|
|
353 |
|
|
|
354 |
$data = $this->fetch( $provider, $url, $args ); |
|
|
355 |
|
|
|
356 |
if ( false === $data ) { |
|
|
357 |
return false; |
|
|
358 |
} |
|
|
359 |
|
|
|
360 |
return $data; |
|
|
361 |
} |
|
|
362 |
|
|
|
363 |
/** |
|
|
364 |
* The do-it-all function that takes a URL and attempts to return the HTML. |
|
|
365 |
* |
|
|
366 |
* @see WP_oEmbed::fetch() |
|
|
367 |
* @see WP_oEmbed::data2html() |
|
|
368 |
* |
|
|
369 |
* @since 2.9.0 |
|
|
370 |
* |
|
|
371 |
* @param string $url The URL to the content that should be attempted to be embedded. |
|
18
|
372 |
* @param string|array $args Optional. Additional arguments for retrieving embed HTML. |
|
|
373 |
* See wp_oembed_get() for accepted arguments. Default empty. |
|
|
374 |
* @return string|false The UNSANITIZED (and potentially unsafe) HTML that should be used to embed |
|
|
375 |
* on success, false on failure. |
|
16
|
376 |
*/ |
|
|
377 |
public function get_html( $url, $args = '' ) { |
|
|
378 |
/** |
|
|
379 |
* Filters the oEmbed result before any HTTP requests are made. |
|
|
380 |
* |
|
|
381 |
* This allows one to short-circuit the default logic, perhaps by |
|
|
382 |
* replacing it with a routine that is more optimal for your setup. |
|
|
383 |
* |
|
|
384 |
* Returning a non-null value from the filter will effectively short-circuit retrieval |
|
|
385 |
* and return the passed value instead. |
|
|
386 |
* |
|
|
387 |
* @since 4.5.3 |
|
|
388 |
* |
|
18
|
389 |
* @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. |
|
|
390 |
* Default null to continue retrieving the result. |
|
|
391 |
* @param string $url The URL to the content that should be attempted to be embedded. |
|
|
392 |
* @param string|array $args Optional. Additional arguments for retrieving embed HTML. |
|
|
393 |
* See wp_oembed_get() for accepted arguments. Default empty. |
|
16
|
394 |
*/ |
|
|
395 |
$pre = apply_filters( 'pre_oembed_result', null, $url, $args ); |
|
|
396 |
|
|
|
397 |
if ( null !== $pre ) { |
|
|
398 |
return $pre; |
|
|
399 |
} |
|
|
400 |
|
|
|
401 |
$data = $this->get_data( $url, $args ); |
|
|
402 |
|
|
|
403 |
if ( false === $data ) { |
|
|
404 |
return false; |
|
|
405 |
} |
|
|
406 |
|
|
|
407 |
/** |
|
|
408 |
* Filters the HTML returned by the oEmbed provider. |
|
|
409 |
* |
|
|
410 |
* @since 2.9.0 |
|
|
411 |
* |
|
|
412 |
* @param string|false $data The returned oEmbed HTML (false if unsafe). |
|
|
413 |
* @param string $url URL of the content to be embedded. |
|
18
|
414 |
* @param string|array $args Optional. Additional arguments for retrieving embed HTML. |
|
|
415 |
* See wp_oembed_get() for accepted arguments. Default empty. |
|
16
|
416 |
*/ |
|
|
417 |
return apply_filters( 'oembed_result', $this->data2html( $data, $url ), $url, $args ); |
|
|
418 |
} |
|
|
419 |
|
|
|
420 |
/** |
|
|
421 |
* Attempts to discover link tags at the given URL for an oEmbed provider. |
|
|
422 |
* |
|
|
423 |
* @since 2.9.0 |
|
|
424 |
* |
|
|
425 |
* @param string $url The URL that should be inspected for discovery `<link>` tags. |
|
|
426 |
* @return string|false The oEmbed provider URL on success, false on failure. |
|
|
427 |
*/ |
|
|
428 |
public function discover( $url ) { |
|
|
429 |
$providers = array(); |
|
|
430 |
$args = array( |
|
|
431 |
'limit_response_size' => 153600, // 150 KB |
|
|
432 |
); |
|
|
433 |
|
|
|
434 |
/** |
|
|
435 |
* Filters oEmbed remote get arguments. |
|
|
436 |
* |
|
|
437 |
* @since 4.0.0 |
|
|
438 |
* |
|
|
439 |
* @see WP_Http::request() |
|
|
440 |
* |
|
|
441 |
* @param array $args oEmbed remote get arguments. |
|
|
442 |
* @param string $url URL to be inspected. |
|
|
443 |
*/ |
|
|
444 |
$args = apply_filters( 'oembed_remote_get_args', $args, $url ); |
|
|
445 |
|
|
|
446 |
// Fetch URL content. |
|
|
447 |
$request = wp_safe_remote_get( $url, $args ); |
|
|
448 |
$html = wp_remote_retrieve_body( $request ); |
|
|
449 |
if ( $html ) { |
|
|
450 |
|
|
|
451 |
/** |
|
|
452 |
* Filters the link types that contain oEmbed provider URLs. |
|
|
453 |
* |
|
|
454 |
* @since 2.9.0 |
|
|
455 |
* |
|
|
456 |
* @param string[] $format Array of oEmbed link types. Accepts 'application/json+oembed', |
|
|
457 |
* 'text/xml+oembed', and 'application/xml+oembed' (incorrect, |
|
|
458 |
* used by at least Vimeo). |
|
|
459 |
*/ |
|
|
460 |
$linktypes = apply_filters( |
|
|
461 |
'oembed_linktypes', |
|
|
462 |
array( |
|
|
463 |
'application/json+oembed' => 'json', |
|
|
464 |
'text/xml+oembed' => 'xml', |
|
|
465 |
'application/xml+oembed' => 'xml', |
|
|
466 |
) |
|
|
467 |
); |
|
|
468 |
|
|
|
469 |
// Strip <body>. |
|
|
470 |
$html_head_end = stripos( $html, '</head>' ); |
|
|
471 |
if ( $html_head_end ) { |
|
|
472 |
$html = substr( $html, 0, $html_head_end ); |
|
|
473 |
} |
|
|
474 |
|
|
|
475 |
// Do a quick check. |
|
|
476 |
$tagfound = false; |
|
|
477 |
foreach ( $linktypes as $linktype => $format ) { |
|
|
478 |
if ( stripos( $html, $linktype ) ) { |
|
|
479 |
$tagfound = true; |
|
|
480 |
break; |
|
|
481 |
} |
|
|
482 |
} |
|
|
483 |
|
|
|
484 |
if ( $tagfound && preg_match_all( '#<link([^<>]+)/?>#iU', $html, $links ) ) { |
|
|
485 |
foreach ( $links[1] as $link ) { |
|
|
486 |
$atts = shortcode_parse_atts( $link ); |
|
|
487 |
|
|
|
488 |
if ( ! empty( $atts['type'] ) && ! empty( $linktypes[ $atts['type'] ] ) && ! empty( $atts['href'] ) ) { |
|
|
489 |
$providers[ $linktypes[ $atts['type'] ] ] = htmlspecialchars_decode( $atts['href'] ); |
|
|
490 |
|
|
|
491 |
// Stop here if it's JSON (that's all we need). |
|
|
492 |
if ( 'json' === $linktypes[ $atts['type'] ] ) { |
|
|
493 |
break; |
|
|
494 |
} |
|
|
495 |
} |
|
|
496 |
} |
|
|
497 |
} |
|
|
498 |
} |
|
|
499 |
|
|
|
500 |
// JSON is preferred to XML. |
|
|
501 |
if ( ! empty( $providers['json'] ) ) { |
|
|
502 |
return $providers['json']; |
|
|
503 |
} elseif ( ! empty( $providers['xml'] ) ) { |
|
|
504 |
return $providers['xml']; |
|
|
505 |
} else { |
|
|
506 |
return false; |
|
|
507 |
} |
|
|
508 |
} |
|
|
509 |
|
|
|
510 |
/** |
|
|
511 |
* Connects to a oEmbed provider and returns the result. |
|
|
512 |
* |
|
|
513 |
* @since 2.9.0 |
|
|
514 |
* |
|
|
515 |
* @param string $provider The URL to the oEmbed provider. |
|
|
516 |
* @param string $url The URL to the content that is desired to be embedded. |
|
18
|
517 |
* @param string|array $args Optional. Additional arguments for retrieving embed HTML. |
|
|
518 |
* See wp_oembed_get() for accepted arguments. Default empty. |
|
16
|
519 |
* @return object|false The result in the form of an object on success, false on failure. |
|
|
520 |
*/ |
|
|
521 |
public function fetch( $provider, $url, $args = '' ) { |
|
|
522 |
$args = wp_parse_args( $args, wp_embed_defaults( $url ) ); |
|
|
523 |
|
|
|
524 |
$provider = add_query_arg( 'maxwidth', (int) $args['width'], $provider ); |
|
|
525 |
$provider = add_query_arg( 'maxheight', (int) $args['height'], $provider ); |
|
|
526 |
$provider = add_query_arg( 'url', urlencode( $url ), $provider ); |
|
|
527 |
$provider = add_query_arg( 'dnt', 1, $provider ); |
|
|
528 |
|
|
|
529 |
/** |
|
|
530 |
* Filters the oEmbed URL to be fetched. |
|
|
531 |
* |
|
|
532 |
* @since 2.9.0 |
|
|
533 |
* @since 4.9.0 The `dnt` (Do Not Track) query parameter was added to all oEmbed provider URLs. |
|
|
534 |
* |
|
|
535 |
* @param string $provider URL of the oEmbed provider. |
|
|
536 |
* @param string $url URL of the content to be embedded. |
|
18
|
537 |
* @param array $args Optional. Additional arguments for retrieving embed HTML. |
|
|
538 |
* See wp_oembed_get() for accepted arguments. Default empty. |
|
16
|
539 |
*/ |
|
|
540 |
$provider = apply_filters( 'oembed_fetch_url', $provider, $url, $args ); |
|
|
541 |
|
|
|
542 |
foreach ( array( 'json', 'xml' ) as $format ) { |
|
|
543 |
$result = $this->_fetch_with_format( $provider, $format ); |
|
|
544 |
if ( is_wp_error( $result ) && 'not-implemented' === $result->get_error_code() ) { |
|
|
545 |
continue; |
|
|
546 |
} |
|
|
547 |
return ( $result && ! is_wp_error( $result ) ) ? $result : false; |
|
|
548 |
} |
|
|
549 |
return false; |
|
|
550 |
} |
|
|
551 |
|
|
|
552 |
/** |
|
|
553 |
* Fetches result from an oEmbed provider for a specific format and complete provider URL |
|
|
554 |
* |
|
|
555 |
* @since 3.0.0 |
|
|
556 |
* |
|
|
557 |
* @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.) |
|
|
558 |
* @param string $format Format to use. |
|
|
559 |
* @return object|false|WP_Error The result in the form of an object on success, false on failure. |
|
|
560 |
*/ |
|
|
561 |
private function _fetch_with_format( $provider_url_with_args, $format ) { |
|
|
562 |
$provider_url_with_args = add_query_arg( 'format', $format, $provider_url_with_args ); |
|
|
563 |
|
|
|
564 |
/** This filter is documented in wp-includes/class-wp-oembed.php */ |
|
|
565 |
$args = apply_filters( 'oembed_remote_get_args', array(), $provider_url_with_args ); |
|
|
566 |
|
|
|
567 |
$response = wp_safe_remote_get( $provider_url_with_args, $args ); |
|
|
568 |
if ( 501 == wp_remote_retrieve_response_code( $response ) ) { |
|
|
569 |
return new WP_Error( 'not-implemented' ); |
|
|
570 |
} |
|
|
571 |
$body = wp_remote_retrieve_body( $response ); |
|
|
572 |
if ( ! $body ) { |
|
|
573 |
return false; |
|
|
574 |
} |
|
|
575 |
$parse_method = "_parse_$format"; |
|
|
576 |
return $this->$parse_method( $body ); |
|
|
577 |
} |
|
|
578 |
|
|
|
579 |
/** |
|
|
580 |
* Parses a json response body. |
|
|
581 |
* |
|
|
582 |
* @since 3.0.0 |
|
|
583 |
* |
|
|
584 |
* @param string $response_body |
|
|
585 |
* @return object|false |
|
|
586 |
*/ |
|
|
587 |
private function _parse_json( $response_body ) { |
|
|
588 |
$data = json_decode( trim( $response_body ) ); |
|
|
589 |
return ( $data && is_object( $data ) ) ? $data : false; |
|
|
590 |
} |
|
|
591 |
|
|
|
592 |
/** |
|
|
593 |
* Parses an XML response body. |
|
|
594 |
* |
|
|
595 |
* @since 3.0.0 |
|
|
596 |
* |
|
|
597 |
* @param string $response_body |
|
|
598 |
* @return object|false |
|
|
599 |
*/ |
|
|
600 |
private function _parse_xml( $response_body ) { |
|
|
601 |
if ( ! function_exists( 'libxml_disable_entity_loader' ) ) { |
|
|
602 |
return false; |
|
|
603 |
} |
|
|
604 |
|
|
18
|
605 |
if ( PHP_VERSION_ID < 80000 ) { |
|
|
606 |
// This function has been deprecated in PHP 8.0 because in libxml 2.9.0, external entity loading |
|
|
607 |
// is disabled by default, so this function is no longer needed to protect against XXE attacks. |
|
|
608 |
// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.libxml_disable_entity_loaderDeprecated |
|
|
609 |
$loader = libxml_disable_entity_loader( true ); |
|
|
610 |
} |
|
|
611 |
|
|
16
|
612 |
$errors = libxml_use_internal_errors( true ); |
|
|
613 |
|
|
|
614 |
$return = $this->_parse_xml_body( $response_body ); |
|
|
615 |
|
|
|
616 |
libxml_use_internal_errors( $errors ); |
|
18
|
617 |
|
|
|
618 |
if ( PHP_VERSION_ID < 80000 && isset( $loader ) ) { |
|
|
619 |
// phpcs:ignore PHPCompatibility.FunctionUse.RemovedFunctions.libxml_disable_entity_loaderDeprecated |
|
|
620 |
libxml_disable_entity_loader( $loader ); |
|
|
621 |
} |
|
16
|
622 |
|
|
|
623 |
return $return; |
|
|
624 |
} |
|
|
625 |
|
|
|
626 |
/** |
|
|
627 |
* Serves as a helper function for parsing an XML response body. |
|
|
628 |
* |
|
|
629 |
* @since 3.6.0 |
|
|
630 |
* |
|
|
631 |
* @param string $response_body |
|
|
632 |
* @return stdClass|false |
|
|
633 |
*/ |
|
|
634 |
private function _parse_xml_body( $response_body ) { |
|
|
635 |
if ( ! function_exists( 'simplexml_import_dom' ) || ! class_exists( 'DOMDocument', false ) ) { |
|
|
636 |
return false; |
|
|
637 |
} |
|
|
638 |
|
|
|
639 |
$dom = new DOMDocument; |
|
|
640 |
$success = $dom->loadXML( $response_body ); |
|
|
641 |
if ( ! $success ) { |
|
|
642 |
return false; |
|
|
643 |
} |
|
|
644 |
|
|
|
645 |
if ( isset( $dom->doctype ) ) { |
|
|
646 |
return false; |
|
|
647 |
} |
|
|
648 |
|
|
|
649 |
foreach ( $dom->childNodes as $child ) { |
|
|
650 |
if ( XML_DOCUMENT_TYPE_NODE === $child->nodeType ) { |
|
|
651 |
return false; |
|
|
652 |
} |
|
|
653 |
} |
|
|
654 |
|
|
|
655 |
$xml = simplexml_import_dom( $dom ); |
|
|
656 |
if ( ! $xml ) { |
|
|
657 |
return false; |
|
|
658 |
} |
|
|
659 |
|
|
|
660 |
$return = new stdClass; |
|
|
661 |
foreach ( $xml as $key => $value ) { |
|
|
662 |
$return->$key = (string) $value; |
|
|
663 |
} |
|
|
664 |
|
|
|
665 |
return $return; |
|
|
666 |
} |
|
|
667 |
|
|
|
668 |
/** |
|
|
669 |
* Converts a data object from WP_oEmbed::fetch() and returns the HTML. |
|
|
670 |
* |
|
|
671 |
* @since 2.9.0 |
|
|
672 |
* |
|
|
673 |
* @param object $data A data object result from an oEmbed provider. |
|
|
674 |
* @param string $url The URL to the content that is desired to be embedded. |
|
|
675 |
* @return string|false The HTML needed to embed on success, false on failure. |
|
|
676 |
*/ |
|
|
677 |
public function data2html( $data, $url ) { |
|
|
678 |
if ( ! is_object( $data ) || empty( $data->type ) ) { |
|
|
679 |
return false; |
|
|
680 |
} |
|
|
681 |
|
|
|
682 |
$return = false; |
|
|
683 |
|
|
|
684 |
switch ( $data->type ) { |
|
|
685 |
case 'photo': |
|
|
686 |
if ( empty( $data->url ) || empty( $data->width ) || empty( $data->height ) ) { |
|
|
687 |
break; |
|
|
688 |
} |
|
|
689 |
if ( ! is_string( $data->url ) || ! is_numeric( $data->width ) || ! is_numeric( $data->height ) ) { |
|
|
690 |
break; |
|
|
691 |
} |
|
|
692 |
|
|
|
693 |
$title = ! empty( $data->title ) && is_string( $data->title ) ? $data->title : ''; |
|
|
694 |
$return = '<a href="' . esc_url( $url ) . '"><img src="' . esc_url( $data->url ) . '" alt="' . esc_attr( $title ) . '" width="' . esc_attr( $data->width ) . '" height="' . esc_attr( $data->height ) . '" /></a>'; |
|
|
695 |
break; |
|
|
696 |
|
|
|
697 |
case 'video': |
|
|
698 |
case 'rich': |
|
|
699 |
if ( ! empty( $data->html ) && is_string( $data->html ) ) { |
|
|
700 |
$return = $data->html; |
|
|
701 |
} |
|
|
702 |
break; |
|
|
703 |
|
|
|
704 |
case 'link': |
|
|
705 |
if ( ! empty( $data->title ) && is_string( $data->title ) ) { |
|
|
706 |
$return = '<a href="' . esc_url( $url ) . '">' . esc_html( $data->title ) . '</a>'; |
|
|
707 |
} |
|
|
708 |
break; |
|
|
709 |
|
|
|
710 |
default: |
|
|
711 |
$return = false; |
|
|
712 |
} |
|
|
713 |
|
|
|
714 |
/** |
|
|
715 |
* Filters the returned oEmbed HTML. |
|
|
716 |
* |
|
|
717 |
* Use this filter to add support for custom data types, or to filter the result. |
|
|
718 |
* |
|
|
719 |
* @since 2.9.0 |
|
|
720 |
* |
|
|
721 |
* @param string $return The returned oEmbed HTML. |
|
|
722 |
* @param object $data A data object result from an oEmbed provider. |
|
|
723 |
* @param string $url The URL of the content to be embedded. |
|
|
724 |
*/ |
|
|
725 |
return apply_filters( 'oembed_dataparse', $return, $data, $url ); |
|
|
726 |
} |
|
|
727 |
|
|
|
728 |
/** |
|
|
729 |
* Strips any new lines from the HTML. |
|
|
730 |
* |
|
|
731 |
* @since 2.9.0 as strip_scribd_newlines() |
|
|
732 |
* @since 3.0.0 |
|
|
733 |
* |
|
|
734 |
* @param string $html Existing HTML. |
|
|
735 |
* @param object $data Data object from WP_oEmbed::data2html() |
|
|
736 |
* @param string $url The original URL passed to oEmbed. |
|
|
737 |
* @return string Possibly modified $html |
|
|
738 |
*/ |
|
|
739 |
public function _strip_newlines( $html, $data, $url ) { |
|
|
740 |
if ( false === strpos( $html, "\n" ) ) { |
|
|
741 |
return $html; |
|
|
742 |
} |
|
|
743 |
|
|
|
744 |
$count = 1; |
|
|
745 |
$found = array(); |
|
|
746 |
$token = '__PRE__'; |
|
|
747 |
$search = array( "\t", "\n", "\r", ' ' ); |
|
|
748 |
$replace = array( '__TAB__', '__NL__', '__CR__', '__SPACE__' ); |
|
|
749 |
$tokenized = str_replace( $search, $replace, $html ); |
|
|
750 |
|
|
|
751 |
preg_match_all( '#(<pre[^>]*>.+?</pre>)#i', $tokenized, $matches, PREG_SET_ORDER ); |
|
|
752 |
foreach ( $matches as $i => $match ) { |
|
|
753 |
$tag_html = str_replace( $replace, $search, $match[0] ); |
|
|
754 |
$tag_token = $token . $i; |
|
|
755 |
|
|
|
756 |
$found[ $tag_token ] = $tag_html; |
|
|
757 |
$html = str_replace( $tag_html, $tag_token, $html, $count ); |
|
|
758 |
} |
|
|
759 |
|
|
|
760 |
$replaced = str_replace( $replace, $search, $html ); |
|
|
761 |
$stripped = str_replace( array( "\r\n", "\n" ), '', $replaced ); |
|
|
762 |
$pre = array_values( $found ); |
|
|
763 |
$tokens = array_keys( $found ); |
|
|
764 |
|
|
|
765 |
return str_replace( $tokens, $pre, $stripped ); |
|
|
766 |
} |
|
|
767 |
} |