summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/jetpack/modules/shortcodes/tweet.php')
-rw-r--r--plugins/jetpack/modules/shortcodes/tweet.php276
1 files changed, 276 insertions, 0 deletions
diff --git a/plugins/jetpack/modules/shortcodes/tweet.php b/plugins/jetpack/modules/shortcodes/tweet.php
new file mode 100644
index 00000000..5d6acd29
--- /dev/null
+++ b/plugins/jetpack/modules/shortcodes/tweet.php
@@ -0,0 +1,276 @@
+<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
+/**
+ * Tweet shortcode.
+ * Params map to key value pairs, and all but tweet are optional:
+ * tweet = id or permalink url* (Required)
+ * align = none|left|right|center
+ * width = number in pixels example: width="300"
+ * lang = en|fr|de|ko|etc... language country code.
+ * hide_thread = true | false **
+ * hide_media = true | false **
+ *
+ * Basic:
+ * [tweet https://twitter.com/jack/statuses/20 width="350"]
+ *
+ * More parameters and another tweet syntax admitted:
+ * [tweet tweet="https://twitter.com/jack/statuses/20" align="left" width="350" align="center" lang="es"]
+ *
+ * @package Jetpack
+ */
+
+add_shortcode( 'tweet', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode' ) );
+
+/**
+ * Tweet Shortcode class.
+ */
+class Jetpack_Tweet {
+
+ /**
+ * Array of arguments about a tweet.
+ *
+ * @var array
+ */
+ public static $provider_args;
+
+ /**
+ * Parse shortcode arguments and render its output.
+ *
+ * @since 4.5.0
+ *
+ * @param array $atts Shortcode parameters.
+ *
+ * @return string
+ */
+ public static function jetpack_tweet_shortcode( $atts ) {
+ global $wp_embed;
+
+ $default_atts = array(
+ 'tweet' => '',
+ 'align' => 'none',
+ 'width' => '',
+ 'lang' => 'en',
+ 'hide_thread' => 'false',
+ 'hide_media' => 'false',
+ );
+
+ $attr = shortcode_atts( $default_atts, $atts );
+
+ self::$provider_args = $attr;
+
+ /*
+ * figure out the tweet id for the requested tweet
+ * supporting both omitted attributes and tweet="tweet_id"
+ * and supporting both an id and a URL
+ */
+ if ( empty( $attr['tweet'] ) && ! empty( $atts[0] ) ) {
+ $attr['tweet'] = $atts[0];
+ }
+
+ if ( ctype_digit( $attr['tweet'] ) ) {
+ $id = 'https://twitter.com/jetpack/status/' . $attr['tweet'];
+ $tweet_id = intval( $attr['tweet'] );
+ } else {
+ preg_match( '/^http(s|):\/\/twitter\.com(\/\#\!\/|\/)([a-zA-Z0-9_]{1,20})\/status(es)*\/(\d+)$/', $attr['tweet'], $urlbits );
+
+ if ( isset( $urlbits[5] ) && intval( $urlbits[5] ) ) {
+ $id = 'https://twitter.com/' . $urlbits[3] . '/status/' . intval( $urlbits[5] );
+ $tweet_id = intval( $urlbits[5] );
+ } else {
+ return '<!-- Invalid tweet id -->';
+ }
+ }
+
+ /*
+ * Fetch tweet.
+ *
+ * On WordPress.com, we also cache tweets for better performance and less requests.
+ */
+ if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
+ /*
+ * See if we have the tweet stored in our tweet store
+ * if not get_tweet_store queues up a job to request
+ */
+ $data = get_tweet_store( $tweet_id );
+ if ( $data ) {
+ $tweet_handler = new Tweet_Handler();
+
+ /*
+ * Replace Unicode characters with ther entities like Blackbird Pie v 0.3.2 did
+ * to store tweets from other languages (important for non-english bloggers)
+ */
+ $data->text = $tweet_handler->unicode_replace_entities( $data->text );
+ $data->user->screen_name = $tweet_handler->unicode_replace_entities( $data->user->screen_name );
+ $data->user->name = $tweet_handler->unicode_replace_entities( $data->user->name );
+
+ $tweet = esc_html( $data->text );
+ $tweet = $tweet_handler->expand_tco_links( $tweet, $data );
+
+ $tweet = $tweet_handler->autolink( $tweet );
+
+ $screen_name = esc_html( $data->user->screen_name );
+ $name = esc_html( $data->user->name );
+
+ $url = 'https://twitter.com/' . $screen_name . '/status/' . intval( $data->id );
+
+ // Only show the user's real name if they set it to something different from their screename.
+ if ( $screen_name !== $name ) {
+ $real_name = '<br />' . $name;
+ } else {
+ $real_name = '<br />&nbsp;';
+ }
+
+ $time = strtotime( $data->created_at );
+ $human_readable = date( 'F d, Y', $time );
+ $data_datetime = date( 'Y-m-d\TH:i:sP', $time );
+
+ /*
+ * Additional params.
+ */
+
+ // align (float).
+ $extra_classes = '';
+ if ( in_array( $attr['align'], array( 'left', 'right', 'center' ), true ) ) {
+ $extra_classes = ' tw-align-' . $attr['align'];
+ }
+
+ if ( 'true' === $attr['hide_thread'] ) {
+ $extra_classes .= ' tw-hide-thread';
+ }
+
+ if ( 'true' === $attr['hide_media'] ) {
+ $extra_classes .= ' tw-hide-media';
+ }
+
+ // lang.
+ $lang = substr( $attr['lang'], 0, 2 );
+ if ( empty( $lang ) ) {
+ $lang = 'en';
+ }
+
+ // width.
+ $width_html = '';
+ $width = intval( $attr['width'] );
+ if ( $width > 100 ) {
+ $width_html = ' width="' . esc_attr( $width ) . '"';
+ }
+
+ // in reply to id (conversation tweets).
+ $in_reply_to_html = '';
+ $in_reply_to = intval( $data->in_reply_to_status_id );
+ if ( ! empty( $in_reply_to ) && 'false' === $attr['hide_thread'] ) {
+ $in_reply_to_html = ' data-in-reply-to="' . esc_attr( $in_reply_to ) . '"';
+ }
+
+ // Generate the HTML output.
+ $output = sprintf(
+ '<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>',
+ esc_attr( $extra_classes ),
+ $width_html,
+ $in_reply_to_html,
+ esc_attr( $lang ),
+ $tweet,
+ wp_kses( $real_name, array( 'br' => array() ) ),
+ esc_html( $screen_name ),
+ esc_url( $url ),
+ esc_attr( $data_datetime ),
+ esc_html( $human_readable )
+ );
+ } else {
+ /**
+ * Filter the default display when a tweet is not available in the store.
+ * Not available in Jetpack.
+ *
+ * @module shortcodes
+ *
+ * @since 5.1.0
+ *
+ * @param string $message Default display when a tweet is not available.
+ * @param string $id Twitter URL.
+ * @param array $attr Shortcode attributes.
+ */
+ return apply_filters( 'tweet_shortcode_pending_tweet', '', $id, $attr );
+ }
+ } else {
+ // Add shortcode arguments to provider URL.
+ add_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10, 3 );
+
+ /*
+ * In Jetpack, we use $wp_embed->shortcode() to return the tweet output.
+ * @see https://github.com/Automattic/jetpack/pull/11173
+ */
+ $output = $wp_embed->shortcode( $atts, $id );
+
+ // Clean up filter.
+ remove_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10 );
+ }
+
+ // Add Twitter widgets.js script to the footer.
+ add_action( 'wp_footer', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode_script' ) );
+
+ /** This action is documented in modules/widgets/social-media-icons.php */
+ do_action( 'jetpack_bump_stats_extras', 'embeds', 'tweet' );
+
+ return $output;
+ }
+
+ /**
+ * Adds parameters to URL used to fetch the tweet.
+ *
+ * @since 4.5.0
+ *
+ * @param string $provider URL of provider that supplies the tweet we're requesting.
+ * @param string $url URL of tweet to embed.
+ * @param array $args Parameters supplied to shortcode and passed to wp_oembed_get.
+ *
+ * @return string
+ */
+ public static function jetpack_tweet_url_extra_args( $provider, $url, $args = array() ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+ foreach ( self::$provider_args as $key => $value ) {
+ switch ( $key ) {
+ case 'align':
+ case 'lang':
+ case 'hide_thread':
+ case 'hide_media':
+ $provider = add_query_arg( $key, $value, $provider );
+ break;
+ }
+ }
+
+ // Disable script since we're enqueing it in our own way in the footer.
+ $provider = add_query_arg( 'omit_script', 'true', $provider );
+
+ // Twitter doesn't support maxheight so don't send it.
+ $provider = remove_query_arg( 'maxheight', $provider );
+
+ /**
+ * Filter the Twitter Partner ID.
+ *
+ * @module shortcodes
+ *
+ * @since 4.6.0
+ *
+ * @param string $partner_id Twitter partner ID.
+ */
+ $partner = apply_filters( 'jetpack_twitter_partner_id', 'jetpack' );
+
+ // Add Twitter partner ID to track embeds from Jetpack.
+ if ( ! empty( $partner ) ) {
+ $provider = add_query_arg( 'partner', $partner, $provider );
+ }
+
+ return $provider;
+ }
+
+ /**
+ * Enqueue front end assets.
+ *
+ * @since 4.5.0
+ */
+ public static function jetpack_tweet_shortcode_script() {
+ if ( ! wp_script_is( 'twitter-widgets', 'registered' ) ) {
+ wp_register_script( 'twitter-widgets', 'https://platform.twitter.com/widgets.js', array(), JETPACK__VERSION, true );
+ wp_print_scripts( 'twitter-widgets' );
+ }
+ }
+
+} // class end