Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
88.89%
48 / 54
66.67%
2 / 3
 CRAP
0.00%
0 / 1
Jetpack_Tweet
94.12%
48 / 51
66.67%
2 / 3
 18.07
0.00%
0 / 1
 jetpack_tweet_shortcode
100.00%
35 / 35
100.00%
1 / 1
 9
 jetpack_tweet_url_extra_args
100.00%
13 / 13
100.00%
1 / 1
 7
 jetpack_tweet_shortcode_script
0.00%
0 / 3
0.00%
0 / 1
 6
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 automattic/jetpack
19 */
20
21if ( ! defined( 'ABSPATH' ) ) {
22    exit( 0 );
23}
24
25add_shortcode( 'tweet', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode' ) );
26
27/**
28 * Tweet Shortcode class.
29 */
30class Jetpack_Tweet {
31
32    /**
33     * Array of arguments about a tweet.
34     *
35     * @var array
36     */
37    public static $provider_args;
38
39    /**
40     * Parse shortcode arguments and render its output.
41     *
42     * @since 4.5.0
43     *
44     * @param array $atts Shortcode parameters.
45     *
46     * @return string
47     */
48    public static function jetpack_tweet_shortcode( $atts ) {
49        global $wp_embed;
50
51        $default_atts = array(
52            'tweet'       => '',
53            'align'       => 'none',
54            'width'       => '',
55            'lang'        => 'en',
56            'hide_thread' => 'false',
57            'hide_media'  => 'false',
58        );
59
60        $attr = shortcode_atts( $default_atts, $atts );
61
62        self::$provider_args = $attr;
63
64        /*
65         * figure out the tweet id for the requested tweet
66         * supporting both omitted attributes and tweet="tweet_id"
67         * and supporting both an id and a URL
68         */
69        if ( empty( $attr['tweet'] ) && ! empty( $atts[0] ) ) {
70            $attr['tweet'] = $atts[0];
71        }
72
73        if ( ctype_digit( $attr['tweet'] ) ) {
74            $id       = 'https://twitter.com/jetpack/status/' . $attr['tweet'];
75            $tweet_id = (int) $attr['tweet'];
76        } else {
77            preg_match( '/^http(s|):\/\/twitter\.com(\/\#\!\/|\/)([a-zA-Z0-9_]{1,20})\/status(es)*\/(\d+)$/', $attr['tweet'], $urlbits );
78
79            if ( isset( $urlbits[5] ) && (int) $urlbits[5] ) {
80                $id       = 'https://twitter.com/' . $urlbits[3] . '/status/' . (int) $urlbits[5];
81                $tweet_id = (int) $urlbits[5];
82            } else {
83                return '<!-- Invalid tweet id -->';
84            }
85        }
86
87        // Add shortcode arguments to provider URL.
88        add_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10, 3 );
89
90        /*
91            * In Jetpack, we use $wp_embed->shortcode() to return the tweet output.
92            * @see https://github.com/Automattic/jetpack/pull/11173
93            */
94        $output = $wp_embed->shortcode( $atts, $id );
95
96        // Clean up filter.
97        remove_filter( 'oembed_fetch_url', array( 'Jetpack_Tweet', 'jetpack_tweet_url_extra_args' ), 10 );
98
99        /** This action is documented in modules/widgets/social-media-icons.php */
100        do_action( 'jetpack_bump_stats_extras', 'embeds', 'tweet' );
101
102        if ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() ) {
103            $width  = ! empty( $attr['width'] ) ? $attr['width'] : 600;
104            $height = 480;
105            $output = sprintf(
106                '<amp-twitter data-tweetid="%1$s" layout="responsive" width="%2$d" height="%3$d"></amp-twitter>',
107                esc_attr( $tweet_id ),
108                absint( $width ),
109                absint( $height )
110            );
111        } else {
112            // Add Twitter widgets.js script to the footer.
113            add_action( 'wp_footer', array( 'Jetpack_Tweet', 'jetpack_tweet_shortcode_script' ) );
114        }
115
116        return $output;
117    }
118
119    /**
120     * Adds parameters to URL used to fetch the tweet.
121     *
122     * @since 4.5.0
123     *
124     * @param string $provider URL of provider that supplies the tweet we're requesting.
125     * @param string $url      URL of tweet to embed.
126     * @param array  $args     Parameters supplied to shortcode and passed to wp_oembed_get.
127     *
128     * @return string
129     */
130    public static function jetpack_tweet_url_extra_args( $provider, $url, $args = array() ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
131        foreach ( self::$provider_args as $key => $value ) {
132            switch ( $key ) {
133                case 'align':
134                case 'lang':
135                case 'hide_thread':
136                case 'hide_media':
137                    $provider = add_query_arg( $key, $value, $provider );
138                    break;
139            }
140        }
141
142        // Disable script since we're enqueing it in our own way in the footer.
143        $provider = add_query_arg( 'omit_script', 'true', $provider );
144
145        // Twitter doesn't support maxheight so don't send it.
146        $provider = remove_query_arg( 'maxheight', $provider );
147
148        /**
149         * Filter the Twitter Partner ID.
150         *
151         * @module shortcodes
152         *
153         * @since 4.6.0
154         *
155         * @param string $partner_id Twitter partner ID.
156         */
157        $partner = apply_filters( 'jetpack_twitter_partner_id', 'jetpack' );
158
159        // Add Twitter partner ID to track embeds from Jetpack.
160        if ( ! empty( $partner ) ) {
161            $provider = add_query_arg( 'partner', $partner, $provider );
162        }
163
164        return $provider;
165    }
166
167    /**
168     * Enqueue front end assets.
169     *
170     * @since 4.5.0
171     */
172    public static function jetpack_tweet_shortcode_script() {
173        if ( ! wp_script_is( 'twitter-widgets', 'registered' ) ) {
174            wp_register_script( 'twitter-widgets', 'https://platform.twitter.com/widgets.js', array(), JETPACK__VERSION, true );
175            wp_print_scripts( 'twitter-widgets' );
176        }
177    }
178} // class end