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