Completed
Push — add/module-registration-refact... ( af2fe6...74b9d5 )
by
unknown
295:53 queued 288:51
created

Jetpack_Tweet::jetpack_tweet_shortcode_script()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 0
dl 0
loc 6
rs 10
c 0
b 0
f 0
1
<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
/**
3
 * Tweet shortcode.
4
 * Params map to key value pairs, and all but tweet are optional:
5
 * tweet = id or permalink url* (Required)
6
 * align = none|left|right|center
7
 * width = number in pixels  example: width="300"
8
 * lang  =  en|fr|de|ko|etc...  language country code.
9
 * hide_thread = true | false **
10
 * hide_media  = true | false **
11
 *
12
 * Basic:
13
 * [tweet https://twitter.com/jack/statuses/20 width="350"]
14
 *
15
 * More parameters and another tweet syntax admitted:
16
 * [tweet tweet="https://twitter.com/jack/statuses/20" align="left" width="350" align="center" lang="es"]
17
 *
18
 * @package Jetpack
19
 */
20
21
add_shortcode( 'tweet', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode' ) );
22
23
/**
24
 * Tweet Shortcode class.
25
 */
26
class Jetpack_Tweet {
27
28
	/**
29
	 * Array of arguments about a tweet.
30
	 *
31
	 * @var array
32
	 */
33
	public static $provider_args;
34
35
	/**
36
	 * Parse shortcode arguments and render its output.
37
	 *
38
	 * @since 4.5.0
39
	 *
40
	 * @param array $atts Shortcode parameters.
41
	 *
42
	 * @return string
43
	 */
44
	public static function jetpack_tweet_shortcode( $atts ) {
45
		global $wp_embed;
46
47
		$default_atts = array(
48
			'tweet'       => '',
49
			'align'       => 'none',
50
			'width'       => '',
51
			'lang'        => 'en',
52
			'hide_thread' => 'false',
53
			'hide_media'  => 'false',
54
		);
55
56
		$attr = shortcode_atts( $default_atts, $atts );
57
58
		self::$provider_args = $attr;
59
60
		/*
61
		 * figure out the tweet id for the requested tweet
62
		 * supporting both omitted attributes and tweet="tweet_id"
63
		 * and supporting both an id and a URL
64
		 */
65
		if ( empty( $attr['tweet'] ) && ! empty( $atts[0] ) ) {
66
			$attr['tweet'] = $atts[0];
67
		}
68
69
		if ( ctype_digit( $attr['tweet'] ) ) {
70
			$id       = 'https://twitter.com/jetpack/status/' . $attr['tweet'];
71
			$tweet_id = intval( $attr['tweet'] );
72
		} else {
73
			preg_match( '/^http(s|):\/\/twitter\.com(\/\#\!\/|\/)([a-zA-Z0-9_]{1,20})\/status(es)*\/(\d+)$/', $attr['tweet'], $urlbits );
74
75
			if ( isset( $urlbits[5] ) && intval( $urlbits[5] ) ) {
76
				$id       = 'https://twitter.com/' . $urlbits[3] . '/status/' . intval( $urlbits[5] );
77
				$tweet_id = intval( $urlbits[5] );
78
			} else {
79
				return '<!-- Invalid tweet id -->';
80
			}
81
		}
82
83
		/*
84
		 * Fetch tweet.
85
		 *
86
		 * On WordPress.com, we also cache tweets for better performance and less requests.
87
		 */
88
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
89
			/*
90
			 * See if we have the tweet stored in our tweet store
91
			 * if not get_tweet_store queues up a job to request
92
			 */
93
			$data = get_tweet_store( $tweet_id );
94
			if ( $data ) {
95
				$tweet_handler = new Tweet_Handler();
96
97
				/*
98
				 * Replace Unicode characters with ther entities like Blackbird Pie v 0.3.2 did
99
				 * to store tweets from other languages (important for non-english bloggers)
100
				 */
101
				$data->text              = $tweet_handler->unicode_replace_entities( $data->text );
102
				$data->user->screen_name = $tweet_handler->unicode_replace_entities( $data->user->screen_name );
103
				$data->user->name        = $tweet_handler->unicode_replace_entities( $data->user->name );
104
105
				$tweet = esc_html( $data->text );
106
				$tweet = $tweet_handler->expand_tco_links( $tweet, $data );
107
108
				$tweet = $tweet_handler->autolink( $tweet );
109
110
				$screen_name = esc_html( $data->user->screen_name );
111
				$name        = esc_html( $data->user->name );
112
113
				$url = 'https://twitter.com/' . $screen_name . '/status/' . intval( $data->id );
114
115
				// Only show the user's real name if they set it to something different from their screename.
116
				if ( $screen_name !== $name ) {
117
					$real_name = '<br />' . $name;
118
				} else {
119
					$real_name = '<br />&nbsp;';
120
				}
121
122
				$time           = strtotime( $data->created_at );
123
				$human_readable = date( 'F d, Y', $time );
124
				$data_datetime  = date( 'Y-m-d\TH:i:sP', $time );
125
126
				/*
127
				 * Additional params.
128
				 */
129
130
				// align (float).
131
				$extra_classes = '';
132 View Code Duplication
				if ( in_array( $attr['align'], array( 'left', 'right', 'center' ), true ) ) {
133
					$extra_classes = ' tw-align-' . $attr['align'];
134
				}
135
136
				if ( 'true' === $attr['hide_thread'] ) {
137
					$extra_classes .= ' tw-hide-thread';
138
				}
139
140
				if ( 'true' === $attr['hide_media'] ) {
141
					$extra_classes .= ' tw-hide-media';
142
				}
143
144
				// lang.
145
				$lang = substr( $attr['lang'], 0, 2 );
146
				if ( empty( $lang ) ) {
147
					$lang = 'en';
148
				}
149
150
				// width.
151
				$width_html = '';
152
				$width      = intval( $attr['width'] );
153
				if ( $width > 100 ) {
154
					$width_html = ' width="' . esc_attr( $width ) . '"';
155
				}
156
157
				// in reply to id (conversation tweets).
158
				$in_reply_to_html = '';
159
				$in_reply_to      = intval( $data->in_reply_to_status_id );
160
				if ( ! empty( $in_reply_to ) && 'false' === $attr['hide_thread'] ) {
161
					$in_reply_to_html = ' data-in-reply-to="' . esc_attr( $in_reply_to ) . '"';
162
				}
163
164
				// Generate the HTML output.
165
				$output = sprintf(
166
					'<blockquote class="twitter-tweet%1$s"%2$s%3$s lang="%4$s"><p>%5$s</p>&mdash; %6$s (@%7$s) <a href="%8$s" data-datetime="%9$s">%10$s</a></blockquote>',
167
					esc_attr( $extra_classes ),
168
					$width_html,
169
					$in_reply_to_html,
170
					esc_attr( $lang ),
171
					$tweet,
172
					wp_kses( $real_name, array( 'br' => array() ) ),
173
					esc_html( $screen_name ),
174
					esc_url( $url ),
175
					esc_attr( $data_datetime ),
176
					esc_html( $human_readable )
177
				);
178
			} else {
179
				/**
180
				 * Filter the default display when a tweet is not available in the store.
181
				 * Not available in Jetpack.
182
				 *
183
				 * @module shortcodes
184
				 *
185
				 * @since 5.1.0
186
				 *
187
				 * @param string $message Default display when a tweet is not available.
188
				 * @param string $id      Twitter URL.
189
				 * @param array  $attr    Shortcode attributes.
190
				 */
191
				return apply_filters( 'tweet_shortcode_pending_tweet', '', $id, $attr );
192
			}
193
		} else {
194
			// Add shortcode arguments to provider URL.
195
			add_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10, 3 );
196
197
			/*
198
			 * In Jetpack, we use $wp_embed->shortcode() to return the tweet output.
199
			 * @see https://github.com/Automattic/jetpack/pull/11173
200
			 */
201
			$output = $wp_embed->shortcode( $atts, $id );
202
203
			// Clean up filter.
204
			remove_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10 );
205
		}
206
207
		// Add Twitter widgets.js script to the footer.
208
		add_action( 'wp_footer', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode_script' ) );
209
210
		/** This action is documented in modules/widgets/social-media-icons.php */
211
		do_action( 'jetpack_bump_stats_extras', 'embeds', 'tweet' );
212
213
		return $output;
214
	}
215
216
	/**
217
	 * Adds parameters to URL used to fetch the tweet.
218
	 *
219
	 * @since 4.5.0
220
	 *
221
	 * @param string $provider URL of provider that supplies the tweet we're requesting.
222
	 * @param string $url      URL of tweet to embed.
223
	 * @param array  $args     Parameters supplied to shortcode and passed to wp_oembed_get.
224
	 *
225
	 * @return string
226
	 */
227
	public static function jetpack_tweet_url_extra_args( $provider, $url, $args = array() ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
228
		foreach ( self::$provider_args as $key => $value ) {
229
			switch ( $key ) {
230
				case 'align':
231
				case 'lang':
232
				case 'hide_thread':
233
				case 'hide_media':
234
					$provider = add_query_arg( $key, $value, $provider );
235
					break;
236
			}
237
		}
238
239
		// Disable script since we're enqueing it in our own way in the footer.
240
		$provider = add_query_arg( 'omit_script', 'true', $provider );
241
242
		// Twitter doesn't support maxheight so don't send it.
243
		$provider = remove_query_arg( 'maxheight', $provider );
244
245
		/**
246
		 * Filter the Twitter Partner ID.
247
		 *
248
		 * @module shortcodes
249
		 *
250
		 * @since 4.6.0
251
		 *
252
		 * @param string $partner_id Twitter partner ID.
253
		 */
254
		$partner = apply_filters( 'jetpack_twitter_partner_id', 'jetpack' );
255
256
		// Add Twitter partner ID to track embeds from Jetpack.
257
		if ( ! empty( $partner ) ) {
258
			$provider = add_query_arg( 'partner', $partner, $provider );
259
		}
260
261
		return $provider;
262
	}
263
264
	/**
265
	 * Enqueue front end assets.
266
	 *
267
	 * @since 4.5.0
268
	 */
269
	public static function jetpack_tweet_shortcode_script() {
270
		if ( ! wp_script_is( 'twitter-widgets', 'registered' ) ) {
271
			wp_register_script( 'twitter-widgets', 'https://platform.twitter.com/widgets.js', array(), JETPACK__VERSION, true );
272
			wp_print_scripts( 'twitter-widgets' );
273
		}
274
	}
275
276
} // class end
277