functions.twitter-cards.php — Jetpack – WP Security, Backup, Speed, & Growth 2.9.6

jetpack / functions.twitter-cards.php

jetpack Last commit date

functions.twitter-cards.php

139 lines

1	<?php
2
3	/* Twitter Cards
4	*
5	* Hooks onto the Open Graph protocol and extends it by adding only the tags
6	* we need for twitter cards.
7	*
8	* @see /wp-content/blog-plugins/open-graph.php
9	* @see https://dev.twitter.com/docs/cards
10	*/
11	function wpcom_twitter_cards_tags( $og_tags ) {
12	global $post;
13
14	if( post_password_required() )
15	return $og_tags;
16
17	if ( apply_filters( 'jetpack_disable_twitter_cards', false ) )
18	return $og_tags;
19
20	/*
21	* These tags apply to any page (home, archives, etc)
22	*/
23
24	$og_tags['twitter:site'] = ( defined('IS_WPCOM') && IS_WPCOM ) ? '@wordpressdotcom' : '@jetpack';
25
26	if ( ! is_singular() \|\| ! empty( $og_tags['twitter:card'] ) )
27	return $og_tags;
28
29	/*
30	* The following tags only apply to single pages.
31	*/
32
33	$card_type = 'summary';
34
35	// Try to give priority to featured images
36	if ( class_exists('Jetpack_PostImages') ) {
37	$featured = Jetpack_PostImages::from_thumbnail( $post->ID, 240, 240 );
38	if ( !empty( $featured ) && count( $featured ) > 0 ) {
39	if ( (int) $featured[0]['src_width'] >= 280 && (int) $featured[0]['src_height'] >= 150 ) {
40	$card_type = 'summary_large_image';
41	$og_tags['twitter:image:src'] = add_query_arg( 'w', 640, $featured[0]['src'] );
42	} else {
43	$og_tags['twitter:image'] = add_query_arg( 'w', 240, $featured[0]['src'] );
44	}
45	}
46	}
47
48	// Only proceed with media analysis if a featured image has not superseded it already.
49	if ( empty( $og_tags['twitter:image'] ) && empty( $og_tags['twitter:image:src'] ) ) {
50	if ( ! class_exists( 'Jetpack_Media_Summary' ) && defined('IS_WPCOM') && IS_WPCOM )
51	include WP_CONTENT_DIR . '/lib/class.wpcom-media-summary.php';
52
53	// Test again, class should already be auto-loaded in Jetpack.
54	// If not, skip extra media analysis and stick with a summary card
55	if ( class_exists( 'Jetpack_Media_Summary' ) ) {
56	$extract = Jetpack_Media_Summary::get( $post->ID );
57
58	if ( 'gallery' == $extract['type'] ) {
59	list( $og_tags, $card_type ) = wpcom_twitter_cards_define_type_based_on_image_count( $og_tags, $extract );
60	} else if ( 'video' == $extract['type'] ) {
61	// Leave as summary, but with large pict of poster frame (we know those comply to Twitter's size requirements)
62	$card_type = 'summary_large_image';
63	$og_tags['twitter:image:src'] = add_query_arg( 'w', 640, $extract['image'] );
64	} else {
65	list( $og_tags, $card_type ) = wpcom_twitter_cards_define_type_based_on_image_count( $og_tags, $extract );
66	}
67	}
68	}
69
70	$og_tags['twitter:card'] = $card_type;
71
72	// If we have information on the author/creator, then include that as well
73	if ( ! empty( $post ) && ! empty( $post->post_author ) ) {
74	$handle = apply_filters( 'jetpack_sharing_twitter_via', '', $post->ID );
75	if ( !empty( $handle ) && 'wordpressdotcom' != $handle )
76	$og_tags['twitter:creator'] = '@' . $handle;
77	}
78
79	// Make sure we have a description for Twitter, their validator isn't happy without some content (single space not valid).
80	if ( ! isset( $og_tags['og:description'] ) \|\| '' == trim( $og_tags['og:description'] ) ) { // empty( trim( $og_tags['og:description'] ) ) isn't valid php
81	$has_creator = ( !empty($og_tags['twitter:creator']) && '@wordpressdotcom' != $og_tags['twitter:creator'] ) ? true : false;
82	if ( 'photo' == $card_type )
83	$og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Photo post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Photo post.', 'jetpack');
84	else if ( !empty( $extract ) && 'video' == $extract['type'] ) // use $extract['type'] since $card_type is 'summary' for video posts
85	$og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Video post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Video post.', 'jetpack');
86	else if ( 'gallery' == $card_type )
87	$og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Gallery post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Gallery post.', 'jetpack');
88	else
89	$og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('New post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('New post.', 'jetpack');
90	}
91
92	return $og_tags;
93	}
94
95	function wpcom_twitter_cards_define_type_based_on_image_count( $og_tags, $extract ) {
96	$card_type = 'summary';
97	$img_count = $extract['count']['image'];
98
99	if ( empty( $img_count ) ) {
100	// No images, use Blavatar as a thumbnail for the summary type.
101	if ( function_exists('blavatar_domain') ) {
102	$blavatar_domain = blavatar_domain(site_url());
103	if ( blavatar_exists( $blavatar_domain ) )
104	$og_tags['twitter:image'] = blavatar_url( $blavatar_domain, 'img', 240);
105	}
106	// Not falling back on Gravatar, because there's no way to know if we end up with an auto-generated one.
107	} else if ( 1 == $img_count && ( 'image' == $extract['type'] \|\| 'gallery' == $extract['type'] ) ) {
108	// 1 image = photo
109	// Test for $extract['type'] to limit to image and gallery, so we don't send a potential fallback image like a Gravatar as a photo post.
110	$card_type = 'photo';
111	$og_tags['twitter:image'] = add_query_arg( 'w', 1400, ( empty( $extract['images'] ) ) ? $extract['image'] : $extract['images'][0]['url'] );
112	} else if ( $img_count <= 3 ) {
113	// 2-3 images = summary with small thumbnail
114	$og_tags['twitter:image'] = add_query_arg( 'w', 240, ( empty( $extract['images'] ) ) ? $extract['image'] : $extract['images'][0]['url'] );
115	} else if ( $img_count >= 4 ) {
116	// >= 4 images = gallery
117	$card_type = 'gallery';
118	$og_tags = wpcom_twitter_cards_gallery( $extract, $og_tags );
119	}
120
121	return array( $og_tags, $card_type );
122	}
123
124	function wpcom_twitter_cards_gallery( $extract, $og_tags ) {
125	foreach( $extract['images'] as $key => $value ) {
126	if ( $key > 3 )
127	break; // Can only send a max of 4 picts (https://dev.twitter.com/docs/cards/types/gallery-card)
128	$og_tags[ 'twitter:image' . $key ] = add_query_arg( 'w', 640, $value['url'] );
129	}
130	return $og_tags;
131	}
132
133	add_filter( 'jetpack_open_graph_tags', 'wpcom_twitter_cards_tags' );
134
135	function wpcom_twitter_cards_output( $og_tag ) {
136	return ( false !== strpos( $og_tag, 'twitter:' ) ) ? preg_replace( '/property="([^"]+)"/', 'name="\1"', $og_tag ) : $og_tag;
137	}
138
139	add_filter( 'jetpack_open_graph_output', 'wpcom_twitter_cards_output' );