PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.7
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.7
16.3-a.5 16.3-a.7 16.3-a.3 16.3-a.1 16.2 16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 All 506 releases
jetpack / modules / likes.php

likes.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-a.7, at modules/likes.php

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