Jetpack_Twitter_Cards

Twitter Cards.

Defined (1)

The class is defined in the following location(s).

/class.jetpack-twitter-cards.php  
  1. class Jetpack_Twitter_Cards { 
  2.  
  3. static function twitter_cards_tags( $og_tags ) { 
  4. global $post; 
  5.  
  6. if ( post_password_required() ) { 
  7. return $og_tags; 
  8.  
  9. /** This action is documented in class.jetpack.php */ 
  10. if ( apply_filters( 'jetpack_disable_twitter_cards', false ) ) { 
  11. return $og_tags; 
  12.  
  13. /** 
  14. * These tags apply to any page (home, archives, etc) 
  15. */ 
  16.  
  17. $site_tag = self::site_tag(); 
  18. /** This action is documented in modules/sharedaddy/sharing-sources.php */ 
  19. $site_tag = apply_filters( 'jetpack_sharing_twitter_via', $site_tag, ( is_singular() ? $post->ID : null ) ); 
  20. /** This action is documented in modules/sharedaddy/sharing-sources.php */ 
  21. $site_tag = apply_filters( 'jetpack_twitter_cards_site_tag', $site_tag, $og_tags ); 
  22. if ( ! empty( $site_tag ) ) { 
  23. $og_tags['twitter:site'] = self::sanitize_twitter_user( $site_tag ); 
  24.  
  25. if ( ! is_singular() || ! empty( $og_tags['twitter:card'] ) ) { 
  26. return $og_tags; 
  27.  
  28. /** 
  29. * The following tags only apply to single pages. 
  30. */ 
  31.  
  32. $card_type = 'summary'; 
  33.  
  34. // Try to give priority to featured images 
  35. if ( class_exists('Jetpack_PostImages') ) { 
  36. $featured = Jetpack_PostImages::from_thumbnail( $post->ID, 240, 240 ); 
  37. if ( !empty( $featured ) && count( $featured ) > 0 ) { 
  38. if ( (int) $featured[0]['src_width'] >= 280 && (int) $featured[0]['src_height'] >= 150 ) { 
  39. $card_type = 'summary_large_image'; 
  40. $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 640, $featured[0]['src'] ) ); 
  41. } else { 
  42. $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 240, $featured[0]['src'] ) ); 
  43.  
  44. // Only proceed with media analysis if a featured image has not superseded it already. 
  45. if ( empty( $og_tags['twitter:image'] ) && empty( $og_tags['twitter:image:src'] ) ) { 
  46. if ( ! class_exists( 'Jetpack_Media_Summary' ) && defined('IS_WPCOM') && IS_WPCOM ) { 
  47. include( WP_CONTENT_DIR . '/lib/class.wpcom-media-summary.php' ); 
  48.  
  49. // Test again, class should already be auto-loaded in Jetpack. 
  50. // If not, skip extra media analysis and stick with a summary card 
  51. if ( class_exists( 'Jetpack_Media_Summary' ) ) { 
  52. $extract = Jetpack_Media_Summary::get( $post->ID ); 
  53.  
  54. if ( 'gallery' == $extract['type'] ) { 
  55. list( $og_tags, $card_type ) = self::twitter_cards_define_type_based_on_image_count( $og_tags, $extract ); 
  56. } elseif ( 'video' == $extract['type'] ) { 
  57. // Leave as summary, but with large pict of poster frame (we know those comply to Twitter's size requirements) 
  58. $card_type = 'summary_large_image'; 
  59. $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 640, $extract['image'] ) ); 
  60. } else { 
  61. list( $og_tags, $card_type ) = self::twitter_cards_define_type_based_on_image_count( $og_tags, $extract ); 
  62.  
  63. $og_tags['twitter:card'] = $card_type; 
  64.  
  65. // If we have information on the author/creator, then include that as well 
  66. if ( ! empty( $post ) && ! empty( $post->post_author ) ) { 
  67. /** This action is documented in modules/sharedaddy/sharing-sources.php */ 
  68. $handle = apply_filters( 'jetpack_sharing_twitter_via', '', $post->ID ); 
  69. if ( ! empty( $handle ) && 'wordpressdotcom' != $handle && 'jetpack' != $handle ) { 
  70. $og_tags['twitter:creator'] = self::sanitize_twitter_user( $handle ); 
  71.  
  72. // Make sure we have a description for Twitter, their validator isn't happy without some content (single space not valid). 
  73. if ( ! isset( $og_tags['og:description'] ) || '' == trim( $og_tags['og:description'] ) || __('Visit the post for more.', 'jetpack') == $og_tags['og:description'] ) { // empty( trim( $og_tags['og:description'] ) ) isn't valid php 
  74. $has_creator = ( ! empty($og_tags['twitter:creator']) && '@wordpressdotcom' != $og_tags['twitter:creator'] ) ? true : false; 
  75. if ( ! empty( $extract ) && 'video' == $extract['type'] ) { // use $extract['type'] since $card_type is 'summary' for video posts 
  76. $og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Video post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Video post.', 'jetpack'); 
  77. } else { 
  78. $og_tags['twitter:description'] = ( $has_creator ) ? sprintf( __('Post by %s.', 'jetpack'), $og_tags['twitter:creator'] ) : __('Visit the post for more.', 'jetpack'); 
  79.  
  80. return $og_tags; 
  81.  
  82. static function sanitize_twitter_user( $str ) { 
  83. return '@' . preg_replace( '/^@/', '', $str ); 
  84.  
  85. static function prioritize_creator_over_default_site( $site_tag, $og_tags = array() ) { 
  86. if ( ! empty( $og_tags['twitter:creator'] ) && in_array( $site_tag, array( '@wordpressdotcom', '@jetpack' ) ) ) { 
  87. $site_tag = $og_tags['twitter:creator']; 
  88. return $site_tag; 
  89.  
  90. static function twitter_cards_define_type_based_on_image_count( $og_tags, $extract ) { 
  91. $card_type = 'summary'; 
  92. $img_count = $extract['count']['image']; 
  93.  
  94. if ( empty( $img_count ) ) { 
  95.  
  96. // No images, use Blavatar as a thumbnail for the summary type. 
  97. if ( function_exists('blavatar_domain') ) { 
  98. $blavatar_domain = blavatar_domain( site_url() ); 
  99. if ( blavatar_exists( $blavatar_domain ) ) { 
  100. $og_tags['twitter:image'] = blavatar_url( $blavatar_domain, 'img', 240 ); 
  101.  
  102. // Second fall back, Site Logo 
  103. if ( empty( $og_tags['twitter:image'] ) && ( function_exists( 'jetpack_has_site_logo' ) && jetpack_has_site_logo() ) ) { 
  104. $og_tags['twitter:image'] = jetpack_get_site_logo( 'url' ); 
  105.  
  106. // Third fall back, Site Icon 
  107. if ( empty( $og_tags['twitter:image'] ) && ( function_exists( 'jetpack_has_site_icon' ) && jetpack_has_site_icon() ) ) { 
  108. $og_tags['twitter:image'] = jetpack_site_icon_url( null, '240' ); 
  109.  
  110. // Not falling back on Gravatar, because there's no way to know if we end up with an auto-generated one. 
  111.  
  112. } elseif ( $img_count && ( 'image' == $extract['type'] || 'gallery' == $extract['type'] ) ) { 
  113. // 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. 
  114. $card_type = 'summary_large_image'; 
  115. $og_tags['twitter:image'] = esc_url( add_query_arg( 'w', 1400, ( empty( $extract['images'] ) ) ? $extract['image'] : $extract['images'][0]['url'] ) ); 
  116.  
  117. return array( $og_tags, $card_type ); 
  118.  
  119. static function twitter_cards_output( $og_tag ) { 
  120. return ( false !== strpos( $og_tag, 'twitter:' ) ) ? preg_replace( '/property="([^"]+)"/', 'name="\1"', $og_tag ) : $og_tag; 
  121.  
  122. static function settings_init() { 
  123. add_settings_section( 'jetpack-twitter-cards-settings', 'Twitter Cards', '__return_false', 'sharing' ); 
  124. add_settings_field( 
  125. 'jetpack-twitter-cards-site-tag',  
  126. __( 'Twitter Site Tag', 'jetpack' ),  
  127. array( __CLASS__, 'settings_field' ),  
  128. 'sharing',  
  129. 'jetpack-twitter-cards-settings',  
  130. array( 
  131. 'label_for' => 'jetpack-twitter-cards-site-tag',  
  132. ); 
  133.  
  134. static function sharing_global_options() { 
  135. do_settings_fields( 'sharing', 'jetpack-twitter-cards-settings' ); 
  136.  
  137. static function site_tag() { 
  138. $site_tag = get_option( 'jetpack-twitter-cards-site-tag' ); 
  139. if ( empty( $site_tag ) ) { 
  140. if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { 
  141. return 'wordpressdotcom'; 
  142. } else { 
  143. return; 
  144. return $site_tag; 
  145.  
  146. static function settings_field() { 
  147. wp_nonce_field( 'jetpack-twitter-cards-settings', 'jetpack_twitter_cards_nonce', false ); 
  148. ?> 
  149. <input type="text" id="jetpack-twitter-cards-site-tag" class="regular-text" name="jetpack-twitter-cards-site-tag" value="<?php echo esc_attr( get_option( 'jetpack-twitter-cards-site-tag' ) ); ?>" /> 
  150. <p class="description" style="width: auto;"><?php esc_html_e( 'The Twitter username of the owner of this site\'s domain.', 'jetpack' ); ?></p> 
  151. <?php 
  152.  
  153. static function settings_validate() { 
  154. if ( wp_verify_nonce( $_POST['jetpack_twitter_cards_nonce'], 'jetpack-twitter-cards-settings' ) ) { 
  155. update_option( 'jetpack-twitter-cards-site-tag', trim( ltrim( strip_tags( $_POST['jetpack-twitter-cards-site-tag'] ), '@' ) ) ); 
  156.  
  157. static function init() { 
  158. add_filter( 'jetpack_open_graph_tags', array( __CLASS__, 'twitter_cards_tags' ) ); 
  159. add_filter( 'jetpack_open_graph_output', array( __CLASS__, 'twitter_cards_output' ) ); 
  160. add_filter( 'jetpack_twitter_cards_site_tag', array( __CLASS__, 'site_tag' ), -99 ); 
  161. add_filter( 'jetpack_twitter_cards_site_tag', array( __CLASS__, 'prioritize_creator_over_default_site' ), 99, 2 ); 
  162. add_action( 'admin_init', array( __CLASS__, 'settings_init' ) ); 
  163. add_action( 'sharing_global_options', array( __CLASS__, 'sharing_global_options' ) ); 
  164. add_action( 'sharing_admin_update', array( __CLASS__, 'settings_validate' ) );