Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
33.94%
74 / 218
23.81%
5 / 21
 CRAP
0.00%
0 / 1
jetpack_post_likes_get_value
n/a
0 / 0
n/a
0 / 0
 1
jetpack_post_likes_update_value
n/a
0 / 0
n/a
0 / 0
 1
jetpack_post_likes_register_rest_field
n/a
0 / 0
n/a
0 / 0
 1
Jetpack_Likes
32.46%
62 / 191
11.11%
2 / 18
 1022.15
0.00%
0 / 1
 init
100.00%
4 / 4
100.00%
1 / 1
 2
 __construct
88.24%
15 / 17
0.00%
0 / 1
 3.01
 set_social_notifications_like
0.00%
0 / 1
0.00%
0 / 1
 2
 delete_social_notifications_like
0.00%
0 / 1
0.00%
0 / 1
 2
 jetpack_likes_configuration_url
100.00%
1 / 1
100.00%
1 / 1
 1
 load_jp_css
n/a
0 / 0
n/a
0 / 0
 1
 configuration_target_area
n/a
0 / 0
n/a
0 / 0
 1
 load_styles_register_scripts
0.00%
0 / 23
0.00%
0 / 1
 56
 admin_discussion_likes_settings_init
0.00%
0 / 3
0.00%
0 / 1
 2
 admin_discussion_likes_settings_section
0.00%
0 / 14
0.00%
0 / 1
 2
 admin_likes_get_option
0.00%
0 / 2
0.00%
0 / 1
 2
 admin_discussion_likes_settings_field
0.00%
0 / 2
0.00%
0 / 1
 2
 admin_discussion_likes_settings_validate
0.00%
0 / 3
0.00%
0 / 1
 12
 admin_init
0.00%
0 / 6
0.00%
0 / 1
 2
 action_init
84.62%
11 / 13
0.00%
0 / 1
 15.82
 load_admin_css
0.00%
0 / 38
0.00%
0 / 1
 2
 enqueue_admin_scripts
0.00%
0 / 21
0.00%
0 / 1
 20
 likes_edit_column
0.00%
0 / 4
0.00%
0 / 1
 6
 add_like_count_column
0.00%
0 / 5
0.00%
0 / 1
 2
 post_likes
93.94%
31 / 33
0.00%
0 / 1
 8.01
1<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2/**
3 * Module Name: Likes
4 * Module Description: Let readers like your posts to show appreciation and encourage interaction.
5 * First Introduced: 2.2
6 * Sort Order: 23
7 * Requires Connection: Yes
8 * Auto Activate: No
9 * Module Tags: Social
10 * Feature: Engagement
11 * Additional Search Queries: like, likes, wordpress.com
12 *
13 * @package automattic/jetpack
14 */
15/**
16 * NOTE: While the front-end behavior currently varies, try to keep the data
17 * model here the same as on wpcom to facilitate Simple→Atomic moves and
18 * possible future work to recombine the front-ends.
19 */
20
21// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
22
23use Automattic\Jetpack\Assets;
24use Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch;
25use Automattic\Jetpack\Status\Host;
26
27if ( ! defined( 'ABSPATH' ) ) {
28    exit( 0 );
29}
30
31add_filter(
32    'wp_resource_hints',
33    function ( $hints, $relation_type ) {
34        if ( 'dns-prefetch' !== $relation_type ) {
35            return $hints;
36        }
37
38        // Only hint on pages where Likes can render.
39        if ( ! is_singular() && ! is_home() && ! is_front_page() && ! is_archive() && ! is_search() ) {
40            return $hints;
41        }
42
43        return array_merge(
44            $hints,
45            array(
46                '//widgets.wp.com',
47                '//s0.wp.com',
48                '//0.gravatar.com',
49                '//1.gravatar.com',
50                '//2.gravatar.com',
51            )
52        );
53    },
54    10,
55    2
56);
57
58require_once __DIR__ . '/likes/jetpack-likes-master-iframe.php';
59require_once __DIR__ . '/likes/jetpack-likes-settings.php';
60
61/**
62 * Jetpack Like Class
63 */
64class Jetpack_Likes {
65    /**
66     * Jetpack_Likes_Settings object
67     *
68     * @var Jetpack_Likes_Settings
69     */
70    public $settings;
71
72    /**
73     * Initialize class
74     */
75    public static function init() {
76        static $instance = null;
77
78        if ( ! $instance ) {
79            $instance = new Jetpack_Likes();
80        }
81
82        return $instance;
83    }
84
85    /**
86     * Constructs Likes class
87     */
88    public function __construct() {
89        $this->settings = new Jetpack_Likes_Settings();
90
91        // We need to run on wp hook rather than init because we check is_amp_endpoint()
92        // when bootstrapping hooks.
93        add_action( 'wp', array( $this, 'action_init' ), 99 );
94
95        add_action( 'admin_init', array( $this, 'admin_init' ) );
96
97        add_action( 'jetpack_activate_module_likes', array( $this, 'set_social_notifications_like' ) );
98        add_action( 'jetpack_deactivate_module_likes', array( $this, 'delete_social_notifications_like' ) );
99
100        // The `enable_module_configurable` method doesn't exist in the WP.com loader implementation.
101        if ( ! ( new Host() )->is_wpcom_simple() ) {
102            Jetpack::enable_module_configurable( __FILE__ );
103        }
104
105        add_filter( 'jetpack_module_configuration_url_likes', array( $this, 'jetpack_likes_configuration_url' ) );
106
107        $sharedaddy_active = Jetpack::is_module_active( 'sharedaddy' );
108
109        if ( ! $sharedaddy_active ) {
110            add_action( 'admin_init', array( $this->settings, 'add_meta_box' ) );
111        } else {
112            add_filter( 'sharing_meta_box_title', array( $this->settings, 'add_likes_to_sharing_meta_box_title' ) );
113            add_action( 'start_sharing_meta_box_content', array( $this->settings, 'meta_box_content' ) );
114        }
115
116        add_action( 'admin_init', array( $this, 'admin_discussion_likes_settings_init' ) ); // Likes notifications.
117
118        add_action( 'wp_enqueue_scripts', array( $this, 'load_styles_register_scripts' ) );
119
120        add_action( 'save_post', array( $this->settings, 'meta_box_save' ) );
121        add_action( 'edit_attachment', array( $this->settings, 'meta_box_save' ) );
122    }
123
124    /**
125     * Set the social_notifications_like option to `on` when the Likes module is activated.
126     *
127     * @since 3.7.0
128     */
129    public function set_social_notifications_like() {
130        update_option( 'social_notifications_like', 'on' );
131    }
132
133    /**
134     * Delete the social_notifications_like option that was set to `on` on module activation.
135     *
136     * @since 3.7.0
137     */
138    public function delete_social_notifications_like() {
139        delete_option( 'social_notifications_like' );
140    }
141
142    /**
143     * Overrides default configuration url
144     *
145     * @uses admin_url
146     * @return string module settings URL
147     */
148    public function jetpack_likes_configuration_url() {
149        return admin_url( 'options-general.php?page=sharing#likes' );
150    }
151
152    /**
153     * Loads Jetpack's CSS on the sharing page so we can use .jetpack-targetable
154     *
155     * @deprecated 16.3 Settings > Sharing is a plain WordPress settings screen now.
156     *
157     * @return void
158     */
159    public function load_jp_css() {
160        _deprecated_function( __METHOD__, 'jetpack-16.3' );
161    }
162
163    /**
164     * Adds in the jetpack-targetable class so when we visit sharing#likes our like settings get highlighted by a yellow box
165     *
166     * @deprecated 16.3 The Likes settings have a section of their own on Settings > Sharing.
167     *
168     * @param string $html row heading for the sharedaddy "which page" setting.
169     * @return string The unchanged $html.
170     */
171    public function configuration_target_area( $html = '' ) {
172        _deprecated_function( __METHOD__, 'jetpack-16.3' );
173        return $html;
174    }
175
176    /**
177     * Load scripts and styles for front end.
178     */
179    public function load_styles_register_scripts() {
180        // Likes are only rendered on pages that display post content.
181        if ( ! is_singular() && ! is_home() && ! is_front_page() && ! is_archive() && ! is_search() ) {
182            return;
183        }
184
185        $style_url = Assets::get_file_url_for_environment(
186            '_inc/build/likes/style.min.css',
187            'modules/likes/style.css'
188        );
189        wp_enqueue_style( 'jetpack_likes', $style_url, array(), JETPACK__VERSION );
190        $style_path = plugin_dir_path( JETPACK__PLUGIN_FILE ) . (
191            /** This filter is documented in projects/plugins/jetpack/load-jetpack.php */
192            apply_filters( 'jetpack_should_use_minified_assets', true )
193                ? '_inc/build/likes/style.min.css'
194                : 'modules/likes/style.css'
195        );
196        wp_style_add_data( 'jetpack_likes', 'path', $style_path );
197        wp_register_script(
198            'jetpack_likes_queuehandler',
199            Assets::get_file_url_for_environment(
200                '_inc/build/likes/queuehandler.min.js',
201                'modules/likes/queuehandler.js'
202            ),
203            array(),
204            JETPACK__VERSION,
205            true
206        );
207    }
208
209    /**
210     * Options to be added to the discussion page. The Sharing settings live in Sharing_Likes\Settings\Likes_Section.
211     */
212    public function admin_discussion_likes_settings_init() {
213        // Add a temporary section, until we can move the setting out of there and with the rest of the email notification settings.
214        add_settings_section( 'likes-notifications', __( 'Likes Notifications', 'jetpack' ), array( $this, 'admin_discussion_likes_settings_section' ), 'discussion' );
215        add_settings_field( 'social-notifications', __( 'Email me whenever', 'jetpack' ), array( $this, 'admin_discussion_likes_settings_field' ), 'discussion', 'likes-notifications' );
216        // Register the setting.
217        register_setting( 'discussion', 'social_notifications_like', array( $this, 'admin_discussion_likes_settings_validate' ) );
218    }
219
220    /** Add email notification options to WordPress discussion settings */
221    public function admin_discussion_likes_settings_section() {
222        // Atypical usage here.  We emit jquery to move likes notification checkbox to be with the rest of the email notification settings.
223        ?>
224    <script type="text/javascript">
225    jQuery( function( $ )  {
226        var table = $( '#social_notifications_like' ).parents( 'table:first' ),
227            header = table.prevAll( 'h2:first' ),
228            newParent = $( '#moderation_notify' ).parent( 'label' ).parent();
229
230        if ( !table.length || !header.length || !newParent.length ) {
231            return;
232        }
233
234        newParent.append( '<br/>' ).append( table.end().parent( 'label' ).siblings().andSelf() );
235        header.remove();
236        table.remove();
237    } );
238    </script>
239        <?php
240    }
241
242    /** Check if email notifications for likes is on or off.
243     *
244     * @param string $option - which option we're checking (social_notifications_like).
245     */
246    public function admin_likes_get_option( $option ) {
247        $option_setting = get_option( $option, 'on' );
248
249        return (int) ( 'on' === $option_setting );
250    }
251
252    /** Display email notification for likes setting in WordPress' discussion settings. */
253    public function admin_discussion_likes_settings_field() {
254        $like = $this->admin_likes_get_option( 'social_notifications_like' );
255        ?>
256        <label><input type="checkbox" id="social_notifications_like" name="social_notifications_like" value="1" <?php checked( $like ); ?> /> <?php esc_html_e( 'Someone likes one of my posts', 'jetpack' ); ?></label>
257        <?php
258    }
259
260    /**
261     * Validate email notification settings.
262     *
263     * @param string $input - determines if checbox is on or off.
264     */
265    public function admin_discussion_likes_settings_validate( $input ) {
266        // If it's not set (was unchecked during form submission) or was set to off (during option update), return 'off'.
267        if ( ! $input || 'off' === $input ) {
268            return 'off';
269        }
270        // Otherwise return 'on'.
271        return 'on';
272    }
273
274    /** Initialize admin settings */
275    public function admin_init() {
276        add_filter( 'manage_posts_columns', array( $this, 'add_like_count_column' ) );
277        add_filter( 'manage_pages_columns', array( $this, 'add_like_count_column' ) );
278        add_action( 'manage_posts_custom_column', array( $this, 'likes_edit_column' ), 10, 2 );
279        add_action( 'manage_pages_custom_column', array( $this, 'likes_edit_column' ), 10, 2 );
280        add_action( 'admin_print_styles-edit.php', array( $this, 'load_admin_css' ) );
281        add_action( 'admin_print_scripts-edit.php', array( $this, 'enqueue_admin_scripts' ) );
282    }
283
284    /** Initialize action */
285    public function action_init() {
286        /*
287         * Only check if the module is enabled here because
288         * we are not currently in The Loop and do not yet have access to check
289         * the switch_like_status post meta flag for the post to be loaded.
290         */
291        if ( is_admin() || ! $this->settings->is_likes_module_enabled() ) {
292            return;
293        }
294
295        if ( ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) ||
296            ( defined( 'APP_REQUEST' ) && APP_REQUEST ) ||
297            ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST ) ||
298            ( defined( 'COOKIE_AUTH_REQUEST' ) && COOKIE_AUTH_REQUEST ) ||
299            ( defined( 'JABBER_SERVER' ) && JABBER_SERVER ) ) {
300            return;
301        }
302
303        if (
304            class_exists( 'Jetpack_AMP_Support' )
305            && Jetpack_AMP_Support::is_amp_request()
306        ) {
307            return;
308        }
309
310        add_filter( 'the_content', array( $this, 'post_likes' ), 30, 1 );
311        add_filter( 'the_excerpt', array( $this, 'post_likes' ), 30, 1 );
312    }
313
314    /**
315     * Load the CSS needed for the wp-admin area.
316     */
317    public function load_admin_css() {
318        ?>
319        <style type="text/css">
320            .vers img { display: none; }
321            .metabox-prefs .vers img { display: inline; }
322            .fixed .column-likes { width: 2.5em; padding: 4px 0; text-align: left; }
323            .fixed .column-stats { width: 5em; white-space: nowrap; }
324            .fixed .column-likes .post-com-count {
325                -webkit-box-sizing: border-box;
326                -moz-box-sizing: border-box;
327                box-sizing: border-box;
328                display: inline-block;
329                padding: 0 4px;
330                min-width: 2em;
331                text-align: center;
332                height: 2em;
333                margin-top: 5px;
334                -webkit-border-radius: 5px;
335                border-radius: 5px;
336                background-color: #787c82;
337                color: #FFF;
338                font-size: 11px;
339                line-height: 21px;
340            }
341            .fixed .column-likes .post-com-count::after { border: none !important; }
342            .fixed .column-likes .post-com-count:hover { background-color: #2271b1; }
343            .fixed .column-likes .vers::before {
344                font: normal 20px/1 dashicons;
345                content: '\f155';
346                speak: none;
347                -webkit-font-smoothing: antialiased;
348                -moz-osx-font-smoothing: grayscale;
349            }
350            @media screen and (max-width: 782px) {
351                .fixed .column-likes {
352                    display: none;
353                }
354            }
355        </style>
356        <?php
357    }
358
359    /**
360     * Load the JS required for loading the like counts.
361     */
362    public function enqueue_admin_scripts() {
363        if ( empty( $_GET['post_type'] ) || 'post' === $_GET['post_type'] || 'page' === $_GET['post_type'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
364            wp_enqueue_script(
365                'likes-post-count',
366                Assets::get_file_url_for_environment(
367                    '_inc/build/likes/post-count.min.js',
368                    'modules/likes/post-count.js'
369                ),
370                array( 'jquery' ),
371                JETPACK__VERSION,
372                false
373            );
374            wp_enqueue_script(
375                'likes-post-count-jetpack',
376                Assets::get_file_url_for_environment(
377                    '_inc/build/likes/post-count-jetpack.min.js',
378                    'modules/likes/post-count-jetpack.js'
379                ),
380                array( 'jquery', 'likes-post-count' ),
381                JETPACK__VERSION,
382                false
383            );
384        }
385    }
386
387    /**
388     * Add "Likes" column data to the post edit table in wp-admin.
389     *
390     * @param string $column_name - name of the column.
391     * @param int    $post_id - the post id.
392     */
393    public function likes_edit_column( $column_name, $post_id ) {
394        if ( 'likes' === $column_name ) {
395
396            $blog_id = Jetpack_Options::get_option( 'id' );
397
398            $permalink = get_permalink( get_the_ID() );
399            ?>
400            <a title="" data-post-id="<?php echo (int) $post_id; ?>" class="post-com-count post-like-count" id="post-like-count-<?php echo (int) $post_id; ?>" data-blog-id="<?php echo (int) $blog_id; ?>" href="<?php echo esc_url( $permalink ); ?>#like-<?php echo (int) $post_id; ?>">
401                <span class="comment-count">0</span>
402            </a>
403            <?php
404        }
405    }
406
407    /**
408     * Add a "Likes" column header to the post edit table in wp-admin.
409     *
410     * @param array $columns - array of columns in wp-admin.
411     */
412    public function add_like_count_column( $columns ) {
413        $date = $columns['date'];
414        unset( $columns['date'] );
415
416        $columns['likes'] = '<span class="vers"><img title="' . esc_attr__( 'Likes', 'jetpack' ) . '" alt="' . esc_attr__( 'Likes', 'jetpack' ) . '" src="//s0.wordpress.com/i/like-grey-icon.png" /><span class="screen-reader-text">' . __( 'Likes', 'jetpack' ) . '</span></span>';
417        $columns['date']  = $date;
418
419        return $columns;
420    }
421
422    /**
423     * Append like button to content.
424     *
425     * @param string $content - content of the page.
426     */
427    public function post_likes( $content ) {
428        global $wp_current_filter;
429        $post_id = get_the_ID();
430
431        if ( ! is_numeric( $post_id ) || ! $this->settings->is_likes_visible() ) {
432            return $content;
433        }
434
435        // Do not output Likes on requests for ActivityPub requests.
436        if (
437            function_exists( '\Activitypub\is_activitypub_request' )
438            && \Activitypub\is_activitypub_request()
439        ) {
440            return $content;
441        }
442
443        // Ensure we don't display like button on post excerpts that are hooked inside the post content
444        if ( in_array( 'the_excerpt', (array) $wp_current_filter, true ) &&
445            in_array( 'the_content', (array) $wp_current_filter, true ) ) {
446            return $content;
447        }
448
449        $blog_id   = Jetpack_Options::get_option( 'id' );
450        $url       = home_url();
451        $url_parts = wp_parse_url( $url );
452        $domain    = $url_parts['host'];
453
454        // Make sure to include the `queuehandler` scripts before the iframe otherwise the script won't find the iframe.
455        if ( ! has_action( 'wp_footer', 'jetpack_likes_master_iframe' ) ) {
456            add_action( 'wp_footer', 'jetpack_likes_master_iframe', 21 );
457        }
458
459        /**
460        * If the same post appears more then once on a page the page goes crazy
461        * we need a slightly more unique id / name for the widget wrapper.
462        */
463        $uniqid   = uniqid();
464        $src      = sprintf( 'https://widgets.wp.com/likes/?ver=%1$s#blog_id=%2$d&amp;post_id=%3$d&amp;origin=%4$s&amp;obj_id=%2$d-%3$d-%5$s', rawurlencode( JETPACK__VERSION ), $blog_id, $post_id, $domain, $uniqid );
465        $name     = sprintf( 'like-post-frame-%1$d-%2$d-%3$s', $blog_id, $post_id, $uniqid );
466        $wrapper  = sprintf( 'like-post-wrapper-%1$d-%2$d-%3$s', $blog_id, $post_id, $uniqid );
467        $headline = sprintf(
468            /** This filter is already documented in modules/sharedaddy/sharing-service.php */
469            apply_filters( 'jetpack_sharing_headline_html', '<h3 class="sd-title">%s</h3>', esc_html__( 'Like this:', 'jetpack' ), 'likes' ),
470            esc_html__( 'Like this:', 'jetpack' )
471        );
472
473        $title = esc_html__( 'Like or Reblog', 'jetpack' );
474
475        /** This filter is documented in modules/likes/jetpack-likes-master-iframe.php */
476        $src = apply_filters( 'jetpack_likes_iframe_src', $src );
477
478        $html  = "<div class='sharedaddy sd-block sd-like jetpack-likes-widget-wrapper jetpack-likes-widget-unloaded' id='$wrapper' data-src='$src' data-name='$name' data-title='$title'>";
479        $html .= $headline;
480        require_once JETPACK__PLUGIN_DIR . '_inc/lib/class-jetpack-spinner.php';
481        $html .= "<div class='likes-widget-placeholder post-likes-widget-placeholder' style='height: 55px;'><span class='button'><span>" . esc_html__( 'Like', 'jetpack' ) . '</span></span> <span class="loading">' . Jetpack_Spinner::render( 18 ) . '<span class="screen-reader-text">' . esc_html__( 'Loading…', 'jetpack' ) . '</span></span></div>';
482        $html .= "<span class='sd-text-color'></span><a class='sd-link-color'></a>";
483        $html .= '</div>';
484
485        // Let's make sure that the script is enqueued.
486        wp_enqueue_script( 'jetpack_likes_queuehandler' );
487
488        return $content . $html;
489    }
490}
491
492/**
493 * Callback to get the value for the jetpack_likes_enabled field.
494 *
495 * @deprecated 16.3 Use Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch::get_value() instead.
496 *
497 * @param array $post - post data we're checking.
498 *
499 * @return bool|null
500 */
501function jetpack_post_likes_get_value( array $post ) {
502    _deprecated_function( __FUNCTION__, 'jetpack-16.3', 'Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch::get_value' );
503    return Post_Likes_Switch::get_value( $post );
504}
505
506/**
507 * Callback to set switch_like_status post_meta when jetpack_likes_enabled is updated.
508 *
509 * @deprecated 16.3 Use Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch::update_value() instead.
510 *
511 * @param bool   $enable_post_likes - checks if post likes are enabled.
512 * @param object $post_object - object containing post data.
513 *
514 * @return int|bool
515 */
516function jetpack_post_likes_update_value( $enable_post_likes, $post_object ) {
517    _deprecated_function( __FUNCTION__, 'jetpack-16.3', 'Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch::update_value' );
518    return Post_Likes_Switch::update_value( $enable_post_likes, $post_object );
519}
520
521/**
522 * Add Likes post_meta to the REST API Post response.
523 *
524 * @deprecated 16.3 Use Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch::register_rest_field() instead.
525 */
526function jetpack_post_likes_register_rest_field() {
527    _deprecated_function( __FUNCTION__, 'jetpack-16.3', 'Automattic\Jetpack\Sharing_Likes\Post_Likes_Switch::register_rest_field' );
528    Post_Likes_Switch::register_rest_field();
529}
530
531Post_Likes_Switch::init();
532
533Jetpack_Likes::init();