PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 10.3
Jetpack – WP Security, Backup, Speed, & Growth v10.3
16.2-beta 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 All 501 releases
jetpack / functions.opengraph.php
functions.opengraph.php
515 lines 16.7 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
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 ( ! empty( $image_info['alt_text'] ) ) {
186 $tags['og:image:alt'] = esc_attr( $image_info['alt_text'] );
187 }
188 }
189
190 // Facebook whines if you give it an empty title.
191 if ( empty( $tags['og:title'] ) ) {
192 $tags['og:title'] = __( '(no title)', 'jetpack' );
193 }
194
195 // Shorten the description if it's too long.
196 if ( isset( $tags['og:description'] ) ) {
197 $tags['og:description'] = strlen( $tags['og:description'] ) > $description_length ? mb_substr( $tags['og:description'], 0, $description_length ) . '' : $tags['og:description'];
198 }
199
200 // Try to add OG locale tag if the WP->FB data mapping exists.
201 if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
202 require_once JETPACK__GLOTPRESS_LOCALES_PATH;
203 $_locale = get_locale();
204
205 // We have to account for w.org vs WP.com locale divergence.
206 if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
207 $gp_locale = GP_Locales::by_field( 'slug', $_locale );
208 } else {
209 $gp_locale = GP_Locales::by_field( 'wp_locale', $_locale );
210 }
211 }
212
213 if ( isset( $gp_locale->facebook_locale ) && ! empty( $gp_locale->facebook_locale ) ) {
214 $tags['og:locale'] = $gp_locale->facebook_locale;
215 }
216
217 /**
218 * Allow the addition of additional Open Graph Meta tags, or modify the existing tags.
219 *
220 * @module sharedaddy, publicize
221 *
222 * @since 2.0.0
223 *
224 * @param array $tags Array of Open Graph Meta tags.
225 * @param array $args Array of image size parameters.
226 */
227 $tags = apply_filters( 'jetpack_open_graph_tags', $tags, compact( 'image_width', 'image_height' ) );
228
229 // secure_urls need to go right after each og:image to work properly so we will abstract them here.
230 $tags['og:image:secure_url'] = ( empty( $tags['og:image:secure_url'] ) ) ? '' : $tags['og:image:secure_url'];
231 $secure = $tags['og:image:secure_url'];
232 unset( $tags['og:image:secure_url'] );
233 $secure_image_num = 0;
234
235 foreach ( (array) $tags as $tag_property => $tag_content ) {
236 // to accommodate multiple images.
237 $tag_content = (array) $tag_content;
238 $tag_content = array_unique( $tag_content );
239
240 foreach ( $tag_content as $tag_content_single ) {
241 if ( empty( $tag_content_single ) ) {
242 continue; // Don't ever output empty tags.
243 }
244
245 switch ( $tag_property ) {
246 case 'og:url':
247 case 'og:image':
248 case 'og:image:url':
249 case 'og:image:secure_url':
250 case 'og:audio':
251 case 'og:audio:url':
252 case 'og:audio:secure_url':
253 case 'og:video':
254 case 'og:video:url':
255 case 'og:video:secure_url':
256 $og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_url( $tag_content_single ) );
257 break;
258 default:
259 $og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_attr( $tag_content_single ) );
260 }
261 /**
262 * Filter the HTML Output of each Open Graph Meta tag.
263 *
264 * @module sharedaddy, publicize
265 *
266 * @since 2.0.0
267 *
268 * @param string $og_tag HTML HTML Output of each Open Graph Meta tag.
269 */
270 $og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
271 $og_output .= "\n";
272
273 if ( 'og:image' === $tag_property ) {
274 if ( is_array( $secure ) && ! empty( $secure[ $secure_image_num ] ) ) {
275 $og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure[ $secure_image_num ] ) );
276 /** This filter is documented in functions.opengraph.php */
277 $og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
278 $og_output .= "\n";
279 } elseif ( ! is_array( $secure ) && ! empty( $secure ) ) {
280 $og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure ) );
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 }
285 $secure_image_num++;
286 }
287 }
288 }
289
290 if ( ! $is_amp_response ) { // Because AMP optimizes the order or the nodes in the head.
291 $og_output .= "\n<!-- End Jetpack Open Graph Tags -->";
292 }
293 $og_output .= "\n";
294 // This is trusted output or added by a filter.
295 echo $og_output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
296 }
297
298 /**
299 * Returns an image used in social shares.
300 *
301 * @since 2.0.0
302 *
303 * @param int $width Minimum width for the image. Default is 200 based on Facebook's requirement.
304 * @param int $height Minimum height for the image. Default is 200 based on Facebook's requirement.
305 * @param null $deprecated Deprecated.
306 *
307 * @return array The source ('src'), 'width', and 'height' of the image.
308 */
309 function jetpack_og_get_image( $width = 200, $height = 200, $deprecated = null ) {
310 if ( ! empty( $deprecated ) ) {
311 _deprecated_argument( __FUNCTION__, 'jetpack-6.6.0' );
312 }
313 $image = array();
314
315 if ( is_singular() && ! is_home() ) {
316 // Grab obvious image if post is an attachment page for an image.
317 if ( is_attachment( get_the_ID() ) && 'image' === substr( get_post_mime_type(), 0, 5 ) ) {
318 $image['src'] = wp_get_attachment_url( get_the_ID() );
319 }
320
321 // Attempt to find something good for this post using our generalized PostImages code.
322 if ( empty( $image ) && class_exists( 'Jetpack_PostImages' ) ) {
323 $post_image = Jetpack_PostImages::get_image(
324 get_the_ID(),
325 array(
326 'width' => $width,
327 'height' => $height,
328 )
329 );
330 if ( ! empty( $post_image ) && is_array( $post_image ) ) {
331 $image['src'] = $post_image['src'];
332 if ( isset( $post_image['src_width'], $post_image['src_height'] ) ) {
333 $image['width'] = $post_image['src_width'];
334 $image['height'] = $post_image['src_height'];
335 }
336 if ( ! empty( $post_image['alt_text'] ) ) {
337 $image['alt_text'] = $post_image['alt_text'];
338 }
339 }
340 }
341 } elseif ( is_author() ) {
342 $author = get_queried_object();
343 if ( is_a( $author, 'WP_User' ) ) {
344 $image['src'] = get_avatar_url(
345 $author->user_email,
346 array(
347 'size' => $width,
348 )
349 );
350 }
351 }
352
353 // First fall back, blavatar.
354 if ( empty( $image ) && function_exists( 'blavatar_domain' ) ) {
355 $blavatar_domain = blavatar_domain( site_url() );
356 if ( blavatar_exists( $blavatar_domain ) ) {
357 $image['src'] = blavatar_url( $blavatar_domain, 'img', $width, false, true );
358 $image['width'] = $width;
359 $image['height'] = $height;
360 }
361 }
362
363 // Second fall back, Site Logo.
364 if ( empty( $image ) && ( function_exists( 'jetpack_has_site_logo' ) && jetpack_has_site_logo() ) ) {
365 $image_id = jetpack_get_site_logo( 'id' );
366 $logo = wp_get_attachment_image_src( $image_id, 'full' );
367 if (
368 isset( $logo[0], $logo[1], $logo[2] )
369 && ( _jetpack_og_get_image_validate_size( $logo[1], $logo[2], $width, $height ) )
370 ) {
371 $image['src'] = $logo[0];
372 $image['width'] = $logo[1];
373 $image['height'] = $logo[2];
374 }
375 }
376
377 // Third fall back, Core Site Icon, if valid in size.
378 if ( empty( $image ) && has_site_icon() ) {
379 $image_id = get_option( 'site_icon' );
380 $icon = wp_get_attachment_image_src( $image_id, 'full' );
381 if (
382 isset( $icon[0], $icon[1], $icon[2] )
383 && ( _jetpack_og_get_image_validate_size( $icon[1], $icon[2], $width, $height ) )
384 ) {
385 $image['src'] = $icon[0];
386 $image['width'] = $icon[1];
387 $image['height'] = $icon[2];
388 }
389 }
390
391 // Final fall back, blank image.
392 if ( empty( $image ) ) {
393 /**
394 * Filter the default Open Graph Image tag, used when no Image can be found in a post.
395 *
396 * @since 3.0.0
397 *
398 * @param string $str Default Image URL.
399 */
400 $image['src'] = apply_filters( 'jetpack_open_graph_image_default', 'https://s0.wp.com/i/blank.jpg' );
401 }
402
403 return $image;
404 }
405
406 /**
407 * Validate the width and height against required width and height
408 *
409 * @param int $width Width of the image.
410 * @param int $height Height of the image.
411 * @param int $req_width Required width to pass validation.
412 * @param int $req_height Required height to pass validation.
413 *
414 * @return bool - True if the image passed the required size validation
415 */
416 function _jetpack_og_get_image_validate_size( $width, $height, $req_width, $req_height ) {
417 if ( ! $width || ! $height ) {
418 return false;
419 }
420
421 $valid_width = ( $width >= $req_width );
422 $valid_height = ( $height >= $req_height );
423 $is_image_acceptable = $valid_width && $valid_height;
424
425 return $is_image_acceptable;
426 }
427
428 /**
429 * Gets a gravatar URL of the specified size.
430 *
431 * @param string $email E-mail address to get gravatar for.
432 * @param int $width Size of returned gravatar.
433 * @return array|bool|mixed|string
434 */
435 function jetpack_og_get_image_gravatar( $email, $width ) {
436 return get_avatar_url(
437 $email,
438 array(
439 'size' => $width,
440 )
441 );
442 }
443
444 /**
445 * Clean up text meant to be used as Description Open Graph tag.
446 *
447 * There should be:
448 * - no links
449 * - no shortcodes
450 * - no html tags or their contents
451 * - not too many words.
452 *
453 * @param string $description Text coming from WordPress (autogenerated or manually generated by author).
454 * @param WP_Post|null $data Information about our post.
455 *
456 * @return string $description Cleaned up description string.
457 */
458 function jetpack_og_get_description( $description = '', $data = null ) {
459 // Remove tags such as <style or <script.
460 $description = wp_strip_all_tags( $description );
461
462 /*
463 * Clean up any plain text entities left into formatted entities.
464 * Intentionally not using a filter to prevent pollution.
465 * @see https://github.com/Automattic/jetpack/pull/2899#issuecomment-151957382
466 */
467 $description = wp_kses(
468 trim(
469 convert_chars(
470 wptexturize( $description )
471 )
472 ),
473 array()
474 );
475
476 // Remove shortcodes.
477 $description = strip_shortcodes( $description );
478
479 // Remove links.
480 $description = preg_replace(
481 '@https?://[\S]+@',
482 '',
483 $description
484 );
485
486 /*
487 * Limit things to a small text blurb.
488 * There isn't a hard limit set by Facebook, so let's rely on WP's own limit.
489 * (55 words or the localized equivalent).
490 * This limit can be customized with the wp_trim_words filter.
491 */
492 $description = wp_trim_words( $description );
493
494 // Let's set a default if we have no text by now.
495 if ( empty( $description ) ) {
496 /**
497 * Filter the fallback `og:description` used when no excerpt information is provided.
498 *
499 * @module sharedaddy, publicize
500 *
501 * @since 3.9.0
502 *
503 * @param string $var Fallback og:description. Default is translated `Visit the post for more'.
504 * @param object $data Post object for the current post.
505 */
506 $description = apply_filters(
507 'jetpack_open_graph_fallback_description',
508 __( 'Visit the post for more.', 'jetpack' ),
509 $data
510 );
511 }
512
513 return $description;
514 }
515