PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 13.5
Jetpack – WP Security, Backup, Speed, & Growth v13.5
12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 14.4.2 All 500 releases
jetpack / functions.opengraph.php
functions.opengraph.php
536 lines 17.7 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase
2 /**
3 * Open Graph Tags
4 *
5 * Add Open Graph tags so that Facebook (and any other service that supports them)
6 * can crawl the site better and we provide a better sharing experience.
7 *
8 * @link https://ogp.me/
9 * @link https://developers.facebook.com/docs/opengraph/
10 *
11 * @package automattic/jetpack
12 */
13
14 add_action( 'wp_head', 'jetpack_og_tags' );
15 add_action( 'web_stories_story_head', 'jetpack_og_tags' );
16
17 /**
18 * Outputs Open Graph tags generated by Jetpack.
19 */
20 function jetpack_og_tags() {
21 global $post;
22 $data = $post; // so that we don't accidentally explode the global.
23
24 $is_amp_response = ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() );
25
26 // Disable the widont filter on WP.com to avoid stray &nbsps.
27 $disable_widont = remove_filter( 'the_title', 'widont' );
28
29 $og_output = "\n";
30 if ( ! $is_amp_response ) { // Because AMP optimizes the order or the nodes in the head.
31 $og_output .= "<!-- Jetpack Open Graph Tags -->\n";
32 }
33 $tags = array();
34
35 /**
36 * Filter the minimum width of the images used in Jetpack Open Graph Meta Tags.
37 *
38 * @module sharedaddy, publicize
39 *
40 * @since 2.0.0
41 *
42 * @param int 200 Minimum image width used in Jetpack Open Graph Meta Tags.
43 */
44 $image_width = absint( apply_filters( 'jetpack_open_graph_image_width', 200 ) );
45 /**
46 * Filter the minimum height of the images used in Jetpack Open Graph Meta Tags.
47 *
48 * @module sharedaddy, publicize
49 *
50 * @since 2.0.0
51 *
52 * @param int 200 Minimum image height used in Jetpack Open Graph Meta Tags.
53 */
54 $image_height = absint( apply_filters( 'jetpack_open_graph_image_height', 200 ) );
55 $description_length = 197;
56
57 if ( is_home() || is_front_page() ) {
58 $site_type = Jetpack_Options::get_option_and_ensure_autoload( 'open_graph_protocol_site_type', '' );
59 $tags['og:type'] = ! empty( $site_type ) ? $site_type : 'website';
60 $tags['og:title'] = get_bloginfo( 'name' );
61 $tags['og:description'] = get_bloginfo( 'description' );
62
63 $front_page_id = get_option( 'page_for_posts' );
64 if ( 'page' === get_option( 'show_on_front' ) && $front_page_id && is_home() ) {
65 $tags['og:url'] = get_permalink( $front_page_id );
66 } else {
67 $tags['og:url'] = home_url( '/' );
68 }
69
70 // Associate a blog's root path with one or more Facebook accounts.
71 $facebook_admins = Jetpack_Options::get_option_and_ensure_autoload( 'facebook_admins', array() );
72 if ( ! empty( $facebook_admins ) ) {
73 $tags['fb:admins'] = $facebook_admins;
74 }
75 } elseif ( is_author() ) {
76 $tags['og:type'] = 'profile';
77
78 $author = get_queried_object();
79
80 if ( is_a( $author, 'WP_User' ) ) {
81 $tags['og:title'] = $author->display_name;
82 if ( ! empty( $author->user_url ) ) {
83 $tags['og:url'] = $author->user_url;
84 } else {
85 $tags['og:url'] = get_author_posts_url( $author->ID );
86 }
87 $tags['og:description'] = $author->description;
88 $tags['profile:first_name'] = get_the_author_meta( 'first_name', $author->ID );
89 $tags['profile:last_name'] = get_the_author_meta( 'last_name', $author->ID );
90 }
91 } elseif ( is_archive() ) {
92 $tags['og:type'] = 'website';
93 $tags['og:title'] = wp_get_document_title();
94
95 $archive = get_queried_object();
96 if ( ! empty( $archive ) ) {
97 if ( is_category() || is_tag() || is_tax() ) {
98 $tags['og:url'] = get_term_link( $archive->term_id, $archive->taxonomy );
99 $tags['og:description'] = $archive->description;
100 } elseif ( is_post_type_archive() ) {
101 $tags['og:url'] = get_post_type_archive_link( $archive->name );
102 $tags['og:description'] = $archive->description;
103 }
104 }
105 } elseif ( is_singular() && is_a( $data, 'WP_Post' ) ) {
106 $tags['og:type'] = 'article';
107 if ( empty( $data->post_title ) ) {
108 $tags['og:title'] = ' ';
109 } else {
110 /** This filter is documented in core/src/wp-includes/post-template.php */
111 $tags['og:title'] = wp_kses( apply_filters( 'the_title', $data->post_title, $data->ID ), array() );
112 }
113
114 $tags['og:url'] = get_permalink( $data->ID );
115 if ( ! post_password_required() ) {
116 /*
117 * If the post author set an excerpt, use that.
118 * Otherwise, pick the post content that comes before the More tag if there is one.
119 * Do not use the post content if it contains premium content.
120 */
121 if ( ! empty( $data->post_excerpt ) ) {
122 $tags['og:description'] = jetpack_og_get_description( $data->post_excerpt );
123 } elseif ( ! has_block( 'premium-content/container', $data->post_content ) ) {
124 $excerpt = explode( '<!--more-->', $data->post_content )[0];
125 $tags['og:description'] = jetpack_og_get_description( $excerpt );
126 }
127 }
128
129 $tags['article:published_time'] = gmdate( 'c', strtotime( $data->post_date_gmt ) );
130 $tags['article:modified_time'] = gmdate( 'c', strtotime( $data->post_modified_gmt ) );
131 if ( post_type_supports( get_post_type( $data ), 'author' ) && isset( $data->post_author ) ) {
132 $publicize_facebook_user = get_post_meta( $data->ID, '_publicize_facebook_user', true );
133 if ( ! empty( $publicize_facebook_user ) ) {
134 $tags['article:author'] = esc_url( $publicize_facebook_user );
135 }
136 }
137 } elseif ( is_search() ) {
138 if ( '' !== get_query_var( 's', '' ) ) {
139 $tags['og:title'] = wp_get_document_title();
140 }
141 }
142 /**
143 * Allow plugins to inject additional template-specific Open Graph tags.
144 *
145 * @module sharedaddy, publicize
146 *
147 * @since 3.0.0
148 *
149 * @param array $tags Array of Open Graph Meta tags.
150 * @param array $args Array of image size parameters.
151 */
152 $tags = apply_filters( 'jetpack_open_graph_base_tags', $tags, compact( 'image_width', 'image_height' ) );
153
154 // Re-enable widont if we had disabled it.
155 if ( $disable_widont ) {
156 add_filter( 'the_title', 'widont' );
157 }
158
159 /**
160 * Do not return any Open Graph Meta tags if we don't have any info about a post.
161 *
162 * @module sharedaddy, publicize
163 *
164 * @since 3.0.0
165 *
166 * @param bool true Do not return any Open Graph Meta tags if we don't have any info about a post.
167 */
168 if ( empty( $tags ) && apply_filters( 'jetpack_open_graph_return_if_empty', true ) ) {
169 return;
170 }
171
172 $tags['og:site_name'] = get_bloginfo( 'name' );
173
174 // Get image info and build tags.
175 if ( ! post_password_required() ) {
176 $image_info = jetpack_og_get_image( $image_width, $image_height );
177 $tags['og:image'] = $image_info['src'];
178
179 if ( ! empty( $image_info['width'] ) ) {
180 $tags['og:image:width'] = (int) $image_info['width'];
181 }
182 if ( ! empty( $image_info['height'] ) ) {
183 $tags['og:image:height'] = (int) $image_info['height'];
184 }
185 // If we have an image, add the alt text even if it's empty.
186 if ( ! empty( $image_info['src'] ) && isset( $image_info['alt_text'] ) ) {
187 $tags['og:image:alt'] = esc_attr( $image_info['alt_text'] );
188 }
189 }
190
191 // Facebook whines if you give it an empty title.
192 if ( empty( $tags['og:title'] ) ) {
193 $tags['og:title'] = __( '(no title)', 'jetpack' );
194 }
195
196 // Shorten the description if it's too long.
197 if ( isset( $tags['og:description'] ) ) {
198 $tags['og:description'] = strlen( $tags['og:description'] ) > $description_length ? mb_substr( $tags['og:description'], 0, $description_length ) . '' : $tags['og:description'];
199 }
200
201 // Try to add OG locale tag if the WP->FB data mapping exists.
202 if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
203 require_once JETPACK__GLOTPRESS_LOCALES_PATH;
204 $_locale = get_locale();
205
206 // We have to account for w.org vs WP.com locale divergence.
207 if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
208 $gp_locale = GP_Locales::by_field( 'slug', $_locale );
209 } else {
210 $gp_locale = GP_Locales::by_field( 'wp_locale', $_locale );
211 }
212 }
213
214 if ( isset( $gp_locale->facebook_locale ) && ! empty( $gp_locale->facebook_locale ) ) {
215 $tags['og:locale'] = $gp_locale->facebook_locale;
216 }
217
218 /**
219 * Allow the addition of additional Open Graph Meta tags, or modify the existing tags.
220 *
221 * @module sharedaddy, publicize
222 *
223 * @since 2.0.0
224 *
225 * @param array $tags Array of Open Graph Meta tags.
226 * @param array $args Array of image size parameters.
227 */
228 $tags = apply_filters( 'jetpack_open_graph_tags', $tags, compact( 'image_width', 'image_height' ) );
229
230 // secure_urls need to go right after each og:image to work properly so we will abstract them here.
231 $tags['og:image:secure_url'] = ( empty( $tags['og:image:secure_url'] ) ) ? '' : $tags['og:image:secure_url'];
232 $secure = $tags['og:image:secure_url'];
233 unset( $tags['og:image:secure_url'] );
234 $secure_image_num = 0;
235
236 $allowed_empty_tags = array(
237 'og:image:alt',
238 );
239
240 foreach ( (array) $tags as $tag_property => $tag_content ) {
241 // to accommodate multiple images.
242 $tag_content = (array) $tag_content;
243 $tag_content = array_unique( $tag_content );
244
245 foreach ( $tag_content as $tag_content_single ) {
246 if ( empty( $tag_content_single ) && ! in_array( $tag_property, $allowed_empty_tags, true ) ) {
247 continue; // Only allow certain empty tags.
248 }
249
250 switch ( $tag_property ) {
251 case 'og:url':
252 case 'og:image':
253 case 'og:image:url':
254 case 'og:image:secure_url':
255 case 'og:audio':
256 case 'og:audio:url':
257 case 'og:audio:secure_url':
258 case 'og:video':
259 case 'og:video:url':
260 case 'og:video:secure_url':
261 $og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_url( $tag_content_single ) );
262 break;
263 default:
264 $og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_attr( $tag_content_single ) );
265 }
266 /**
267 * Filter the HTML Output of each Open Graph Meta tag.
268 *
269 * @module sharedaddy, publicize
270 *
271 * @since 2.0.0
272 *
273 * @param string $og_tag HTML HTML Output of each Open Graph Meta tag.
274 */
275 $og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
276 $og_output .= "\n";
277
278 if ( 'og:image' === $tag_property ) {
279 if ( is_array( $secure ) && ! empty( $secure[ $secure_image_num ] ) ) {
280 $og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure[ $secure_image_num ] ) );
281 /** This filter is documented in functions.opengraph.php */
282 $og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
283 $og_output .= "\n";
284 } elseif ( ! is_array( $secure ) && ! empty( $secure ) ) {
285 $og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure ) );
286 /** This filter is documented in functions.opengraph.php */
287 $og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
288 $og_output .= "\n";
289 }
290 ++$secure_image_num;
291 }
292 }
293 }
294
295 if ( ! $is_amp_response ) { // Because AMP optimizes the order or the nodes in the head.
296 $og_output .= "\n<!-- End Jetpack Open Graph Tags -->";
297 }
298 $og_output .= "\n";
299 // This is trusted output or added by a filter.
300 echo $og_output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
301 }
302
303 /**
304 * Returns an image used in social shares.
305 *
306 * @since 2.0.0
307 *
308 * @param int $width Minimum width for the image. Default is 200 based on Facebook's requirement.
309 * @param int $height Minimum height for the image. Default is 200 based on Facebook's requirement.
310 * @param null $deprecated Deprecated.
311 *
312 * @return array The source ('src'), 'width', and 'height' of the image.
313 */
314 function jetpack_og_get_image( $width = 200, $height = 200, $deprecated = null ) {
315 if ( ! empty( $deprecated ) ) {
316 _deprecated_argument( __FUNCTION__, 'jetpack-6.6.0' );
317 }
318 $image = array();
319
320 if ( is_singular() && ! is_home() ) {
321 // Grab obvious image if post is an attachment page for an image.
322 if ( is_attachment( get_the_ID() ) && str_starts_with( get_post_mime_type(), 'image' ) ) {
323 $image['src'] = wp_get_attachment_url( get_the_ID() );
324 $image['alt_text'] = Jetpack_PostImages::get_alt_text( get_the_ID() );
325 }
326
327 // Attempt to find something good for this post using our generalized PostImages code.
328 if ( empty( $image ) && class_exists( 'Jetpack_PostImages' ) ) {
329 $post_image = Jetpack_PostImages::get_image(
330 get_the_ID(),
331 array(
332 'width' => $width,
333 'height' => $height,
334 )
335 );
336 if ( ! empty( $post_image ) && is_array( $post_image ) ) {
337 $image['src'] = $post_image['src'];
338 if ( isset( $post_image['src_width'] ) && isset( $post_image['src_height'] ) ) {
339 $image['width'] = $post_image['src_width'];
340 $image['height'] = $post_image['src_height'];
341 }
342 if ( ! empty( $post_image['alt_text'] ) ) {
343 $image['alt_text'] = $post_image['alt_text'];
344 }
345 }
346 }
347 } elseif ( is_author() ) {
348 $author = get_queried_object();
349 if ( is_a( $author, 'WP_User' ) ) {
350 $image['src'] = get_avatar_url(
351 $author->user_email,
352 array(
353 'size' => $width,
354 )
355 );
356 $image['alt_text'] = $author->display_name;
357 }
358 }
359
360 // First fall back, blavatar.
361 if ( empty( $image ) && function_exists( 'blavatar_domain' ) ) {
362 $blavatar_domain = blavatar_domain( site_url() );
363 if ( blavatar_exists( $blavatar_domain ) ) {
364 $image['src'] = blavatar_url( $blavatar_domain, 'img', $width, false, true );
365 $image['width'] = $width;
366 $image['height'] = $height;
367 }
368 }
369
370 // Second fall back, Site Logo.
371 if ( empty( $image ) && ( function_exists( 'jetpack_has_site_logo' ) && jetpack_has_site_logo() ) ) {
372 $image_id = jetpack_get_site_logo( 'id' );
373 $logo = wp_get_attachment_image_src( $image_id, 'full' );
374 if (
375 isset( $logo[0] ) && isset( $logo[1] ) && isset( $logo[2] )
376 && ( _jetpack_og_get_image_validate_size( $logo[1], $logo[2], $width, $height ) )
377 ) {
378 $image['src'] = $logo[0];
379 $image['width'] = $logo[1];
380 $image['height'] = $logo[2];
381 $image['alt_text'] = Jetpack_PostImages::get_alt_text( $image_id );
382 }
383 }
384
385 // Third fall back, Core Site Icon, if valid in size.
386 if ( empty( $image ) && has_site_icon() ) {
387 $image_id = get_option( 'site_icon' );
388 $icon = wp_get_attachment_image_src( $image_id, 'full' );
389 if (
390 isset( $icon[0] ) && isset( $icon[1] ) && isset( $icon[2] )
391 && ( _jetpack_og_get_image_validate_size( $icon[1], $icon[2], $width, $height ) )
392 ) {
393 $image['src'] = $icon[0];
394 $image['width'] = $icon[1];
395 $image['height'] = $icon[2];
396 $image['alt_text'] = Jetpack_PostImages::get_alt_text( $image_id );
397 }
398 }
399
400 // Final fall back, blank image.
401 if ( empty( $image ) ) {
402 /**
403 * Filter the default Open Graph Image tag, used when no Image can be found in a post.
404 *
405 * @since 3.0.0
406 *
407 * @param string $str Default Image URL.
408 */
409 $image['src'] = apply_filters( 'jetpack_open_graph_image_default', 'https://s0.wp.com/i/blank.jpg' );
410 }
411
412 // If we didn't get an explicit alt tag from the image, set a default.
413 if ( empty( $image['alt_text'] ) ) {
414 /**
415 * Filter the default Open Graph image alt text, used when the Open Graph image from the post does not have an alt text.
416 *
417 * @since 10.4
418 *
419 * @param string $str Default Open Graph image alt text.
420 */
421 $image['alt_text'] = apply_filters( 'jetpack_open_graph_image_default_alt_text', '' );
422 }
423
424 return $image;
425 }
426
427 /**
428 * Validate the width and height against required width and height
429 *
430 * @param int $width Width of the image.
431 * @param int $height Height of the image.
432 * @param int $req_width Required width to pass validation.
433 * @param int $req_height Required height to pass validation.
434 *
435 * @return bool - True if the image passed the required size validation
436 */
437 function _jetpack_og_get_image_validate_size( $width, $height, $req_width, $req_height ) {
438 if ( ! $width || ! $height ) {
439 return false;
440 }
441
442 $valid_width = ( $width >= $req_width );
443 $valid_height = ( $height >= $req_height );
444 $is_image_acceptable = $valid_width && $valid_height;
445
446 return $is_image_acceptable;
447 }
448
449 /**
450 * Gets a gravatar URL of the specified size.
451 *
452 * @param string $email E-mail address to get gravatar for.
453 * @param int $width Size of returned gravatar.
454 * @return array|bool|mixed|string
455 */
456 function jetpack_og_get_image_gravatar( $email, $width ) {
457 return get_avatar_url(
458 $email,
459 array(
460 'size' => $width,
461 )
462 );
463 }
464
465 /**
466 * Clean up text meant to be used as Description Open Graph tag.
467 *
468 * There should be:
469 * - no links
470 * - no shortcodes
471 * - no html tags or their contents
472 * - not too many words.
473 *
474 * @param string $description Text coming from WordPress (autogenerated or manually generated by author).
475 * @param WP_Post|null $data Information about our post.
476 *
477 * @return string $description Cleaned up description string.
478 */
479 function jetpack_og_get_description( $description = '', $data = null ) {
480 // Remove tags such as <style or <script.
481 $description = wp_strip_all_tags( $description );
482
483 /*
484 * Clean up any plain text entities left into formatted entities.
485 * Intentionally not using a filter to prevent pollution.
486 * @see https://github.com/Automattic/jetpack/pull/2899#issuecomment-151957382
487 */
488 $description = wp_kses(
489 trim(
490 convert_chars(
491 wptexturize( $description )
492 )
493 ),
494 array()
495 );
496
497 // Remove shortcodes.
498 $description = strip_shortcodes( $description );
499
500 // Remove links.
501 $description = preg_replace(
502 '@https?://[\S]+@',
503 '',
504 $description
505 );
506
507 /*
508 * Limit things to a small text blurb.
509 * There isn't a hard limit set by Facebook, so let's rely on WP's own limit.
510 * (55 words or the localized equivalent).
511 * This limit can be customized with the wp_trim_words filter.
512 */
513 $description = wp_trim_words( $description );
514
515 // Let's set a default if we have no text by now.
516 if ( empty( $description ) ) {
517 /**
518 * Filter the fallback `og:description` used when no excerpt information is provided.
519 *
520 * @module sharedaddy, publicize
521 *
522 * @since 3.9.0
523 *
524 * @param string $var Fallback og:description. Default is translated `Visit the post for more'.
525 * @param object $data Post object for the current post.
526 */
527 $description = apply_filters(
528 'jetpack_open_graph_fallback_description',
529 __( 'Visit the post for more.', 'jetpack' ),
530 $data
531 );
532 }
533
534 return $description;
535 }
536