<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
* @package automattic/jetpack
require __DIR__ . '/base.php';
use Automattic\Jetpack\Connection\Tokens;
use Automattic\Jetpack\Status\Host;
if ( ! defined( 'ABSPATH' ) ) {
* @package automattic/jetpack
class Jetpack_Comments extends Highlander_Comments_Base {
/** Variables *************************************************************/
* Possible comment form sources - empty array as default
public $id_sources = array();
* Remote comment URL - empty string as default
* The default comment form color scheme - default is light
* @see ::set_default_color_theme_based_on_theme_settings()
public $default_color_scheme = 'light';
/** Methods ***************************************************************/
public static function init() {
static $instance = false;
$instance = new Jetpack_Comments();
* Main constructor for Comments
public function __construct() {
* Fires after the Jetpack_Comments object has been instantiated
* @param array $jetpack_comments_loaded First element in array of type Jetpack_Comments
do_action_ref_array( 'jetpack_comments_loaded', array( $this ) );
add_action( 'after_setup_theme', array( $this, 'set_default_color_theme_based_on_theme_settings' ), 100 );
* Set the default comments color theme based on theme settings
public function set_default_color_theme_based_on_theme_settings() {
if ( function_exists( 'twentyeleven_get_theme_options' ) ) {
$theme_options = twentyeleven_get_theme_options();
$theme_color_scheme = isset( $theme_options['color_scheme'] ) ? $theme_options['color_scheme'] : 'transparent';
$theme_color_scheme = get_theme_mod( 'color_scheme', 'transparent' );
// Default for $theme_color_scheme is 'transparent' just so it doesn't match 'light' or 'dark'.
// The default for Jetpack's color scheme is still defined above as 'light'.
if ( false !== stripos( $theme_color_scheme, 'light' ) ) {
$this->default_color_scheme = 'light';
} elseif ( false !== stripos( $theme_color_scheme, 'dark' ) ) {
$this->default_color_scheme = 'dark';
/** Private Methods *******************************************************/
* Set any global variables or class variables
* This is primarily defining the comment form sources.
protected function setup_globals() {
$this->id_sources = array(
* Setup actions for methods in this class
protected function setup_actions() {
// Selfishly remove everything from the existing comment form.
remove_all_actions( 'comment_form_before' );
// Selfishly add only our actions back to the comment form.
add_action( 'comment_form_before', array( $this, 'manage_post_cookie' ) );
add_action( 'comment_form_before', array( $this, 'comment_form_before' ) );
add_action( 'comment_form_after', array( $this, 'comment_form_after' ), 1 ); // Set very early since we remove everything outputed before our action.
// Before a comment is posted.
add_action( 'pre_comment_on_post', array( $this, 'pre_comment_on_post' ), 1 );
// After a comment is posted.
add_action( 'comment_post', array( $this, 'add_comment_meta' ) );
* Setup filters for methods in this class
protected function setup_filters() {
add_filter( 'comment_post_redirect', array( $this, 'capture_comment_post_redirect_to_reload_parent_frame' ), 100 );
add_filter( 'comment_duplicate_trigger', array( $this, 'capture_comment_duplicate_trigger' ), 100 );
add_filter( 'get_avatar', array( $this, 'get_avatar' ), 10, 4 );
// Fix comment reply link when `comment_registration` is required.
add_filter( 'comment_reply_link', array( $this, 'comment_reply_link' ), 10, 4 );
* In order for comments to work properly for password-protected posts we need to set `wp-postpass` cookie to SameSite none.
public function manage_post_cookie() {
$postpass_cookie_key = 'wp-postpass_' . COOKIEHASH;
if ( empty( $_COOKIE[ $postpass_cookie_key ] ) ) {
$postpass_cookie_value = sanitize_text_field( wp_unslash( $_COOKIE[ $postpass_cookie_key ] ) );
if ( empty( $_COOKIE['verbum-wp-postpass'] ) || ( $_COOKIE['verbum-wp-postpass'] !== $postpass_cookie_value ) ) {
$expire = apply_filters( 'post_password_expires', time() + 10 * DAY_IN_SECONDS );
'domain' => COOKIE_DOMAIN,
'domain' => COOKIE_DOMAIN,
* Get the comment avatar from Gravatar or Twitter/Facebook.
* Leaving the Twitter reference for legacy comments even though support is no longer offered.
* @param string $avatar Current avatar URL.
* @param string $comment Comment for the avatar.
* @param int $size Size of the avatar.
* @return string New avatar
public function get_avatar( $avatar, $comment, $size ) {
if ( ! isset( $comment->comment_post_ID ) || ! isset( $comment->comment_ID ) ) {
// it's not a comment - bail.
// Detect whether it's a Facebook avatar.
$foreign_avatar = get_comment_meta( $comment->comment_ID, 'hc_avatar', true );
$foreign_avatar_hostname = wp_parse_url( $foreign_avatar, PHP_URL_HOST );
if ( ! $foreign_avatar_hostname ||
! preg_match( '/\.?(graph\.facebook\.com|twimg\.com)$/', $foreign_avatar_hostname ) ) {
// Return the Facebook or Twitter avatar.
return preg_replace( '#src=([\'"])[^\'"]+\\1#', 'src=\\1' . esc_url( set_url_scheme( $this->photon_avatar( $foreign_avatar, $size ), 'https' ) ) . '\\1', $avatar );
* Set comment reply link.
* This is to fix the reply link when comment registration is required.
* @param string $reply_link The HTML markup for the comment reply link.
* @param array $args An array of arguments overriding the defaults.
* @param WP_Comment $comment The object of the comment being replied.
* @param WP_Post $post The WP_Post object.
* @return string New reply link.
public function comment_reply_link( $reply_link, $args, $comment, $post ) {
// This is only necessary if comment_registration is required to post comments
if ( ! get_option( 'comment_registration' ) ) {
$respond_id = esc_attr( $args['respond_id'] );
$add_below = esc_attr( $args['add_below'] );
/* This is to accommodate some themes that add an SVG to the Reply link like twenty-seventeen. */
'aria-labelledby' => true,
$before_link = wp_kses( $args['before'], wp_kses_allowed_html( 'post' ) );
$after_link = wp_kses( $args['after'], wp_kses_allowed_html( 'post' ) );
$reply_url = esc_url( add_query_arg( 'replytocom', $comment->comment_ID . '#' . $respond_id ) );
<a class="comment-reply-link" href="$reply_url" onclick="return addComment.moveForm( '$add_below-$comment->comment_ID', '$comment->comment_ID', '$respond_id', '$post->ID' )">$reply_text</a>
* Get the site's blog token.
* This can be used to bypass Comments entirely if Jetpack is not properly connected.
* @return bool|object False if not properly connected. Object with the blog token if connected.
private function get_blog_token() {
$blog_token = ( new Tokens() )->get_access_token();
// If we have no token, bail.
if ( ! $blog_token || is_wp_error( $blog_token ) ) {
/** Output Methods ********************************************************/
* Start capturing the core comment_form() output
* Comment form output will only be captured if comments are enabled - we return otherwise.
public function comment_form_before() {
* Filters the setting that determines if Jetpack comments should be enabled for
* @param boolean $return Should comments be enabled?
if ( ! apply_filters( 'jetpack_comment_form_enabled_for_' . get_post_type(), true ) ) {
// If the Jetpack connection is not healthy, bail.
if ( ! $this->get_blog_token() ) {
// Add some JS to the footer.
add_action( 'wp_footer', array( $this, 'watch_comment_parent' ), 100 );
* Noop the default comment form output, get some options, and output our
* tricked out totally radical comment form.
public function comment_form_after() {
/** This filter is documented in modules/comments/comments.php */
if ( ! apply_filters( 'jetpack_comment_form_enabled_for_' . get_post_type(), true ) ) {
$blog_token = $this->get_blog_token();
// If the Jetpack connection is not healthy, bail.
// Throw it all out and drop in our replacement.
if ( in_array( 'subscriptions', Jetpack::get_active_modules(), true ) ) {
$stb_enabled = get_option( 'stb_enabled', 1 );
$stb_enabled = empty( $stb_enabled ) ? 0 : 1;
$stc_enabled = get_option( 'stc_enabled', 1 );
$stc_enabled = empty( $stc_enabled ) ? 0 : 1;
'blogid' => Jetpack_Options::get_option( 'id' ),
'postid' => get_the_ID(),
'comment_registration' => ( get_option( 'comment_registration' ) ? '1' : '0' ), // Need to explicitly send a '1' or a '0' for these.
'require_name_email' => ( get_option( 'require_name_email' ) ? '1' : '0' ),
'stc_enabled' => $stc_enabled,
'stb_enabled' => $stb_enabled,
'show_avatars' => ( get_option( 'show_avatars' ) ? '1' : '0' ),
'avatar_default' => get_option( 'avatar_default' ),
'greeting' => get_option( 'highlander_comment_form_prompt', __( 'Leave a Reply', 'jetpack' ) ),
'jetpack_comments_nonce' => wp_create_nonce( 'jetpack_comments_nonce-' . get_the_ID() ),
* Changes the comment form prompt.
* @param string $var Default is "Leave a Reply to %s."
'greeting_reply' => apply_filters(
'jetpack_comment_form_prompt_reply',
/* translators: %s is the displayed username of the post (or comment) author */
__( 'Leave a Reply to %s', 'jetpack' )
'color_scheme' => get_option( 'jetpack_comment_form_color_scheme', $this->default_color_scheme ),
'jetpack_version' => JETPACK__VERSION,
'iframe_unique_id' => wp_unique_id(),
// Extra parameters for logged in user.
if ( is_user_logged_in() ) {
$current_user = wp_get_current_user();
$params['hc_post_as'] = 'jetpack';
$params['hc_userid'] = $current_user->ID;
$params['hc_username'] = $current_user->display_name;
$params['hc_userurl'] = $current_user->user_url;
$params['hc_useremail'] = md5( strtolower( trim( $current_user->user_email ) ) );
if ( current_user_can( 'unfiltered_html' ) ) {
$params['_wp_unfiltered_html_comment'] = wp_create_nonce( 'unfiltered-html-comment_' . get_the_ID() );
$commenter = wp_get_current_commenter();
$params['show_cookie_consent'] = (int) has_action( 'set_comment_cookies', 'wp_set_comment_cookies' );
$params['has_cookie_consent'] = (int) ! empty( $commenter['comment_author_email'] );
// Jetpack_Memberships for logged out users only checks for the wp-jp-premium-content-session cookie
$params['is_current_user_subscribed'] = class_exists( '\Jetpack_Memberships' ) ? (int) Jetpack_Memberships::is_current_user_subscribed() : 0;
list( $token_key ) = explode( '.', $blog_token->secret, 2 );
// Prophylactic check: anything else should never happen.
if ( $token_key && $token_key !== $blog_token->secret ) {
// Is the token a Special Token (@see class.tokens.php)?
if ( preg_match( '/^;.\d+;\d+;$/', $token_key, $matches ) ) {
// The token key for a Special Token is public.
$params['token_key'] = $token_key;
* The token key for a Normal Token is public but
* looks like sensitive data. Since there can only be
* one Normal Token per site, avoid concern by
* sending the magic "use the Normal Token" token key.
$params['token_key'] = Tokens::MAGIC_NORMAL_TOKEN_KEY;
$signature = self::sign_remote_comment_parameters( $params, $blog_token->secret );
if ( is_wp_error( $signature ) ) {
$params['sig'] = $signature;
$url_origin = 'https://jetpack.wordpress.com';
$url = "{$url_origin}/jetpack-comment/?" . http_build_query( $params );
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sniff misses the esc_url_raw.
$url = "{$url}#parent=" . rawurlencode( esc_url_raw( set_url_scheme( 'http://' . ( isset( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : '' ) . ( isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : '' ) ) ) );
$this->signed_url = $url;
$height = $params['comment_registration'] || is_user_logged_in() ? '315' : '430'; // Iframe can be shorter if we're not allowing guest commenting.
$transparent = ( 'transparent' === $params['color_scheme'] ) ? 'true' : 'false';
if ( isset( $_GET['replytocom'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
$url .= '&replytocom=' . (int) $_GET['replytocom']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
* Filter whether the comment title can be displayed.
* @param bool $show Can the comment be displayed? Default to true.
$show_greeting = apply_filters( 'jetpack_comment_form_display_greeting', true );
* Filter the comment title tag.
* @param string $comment_reply_title_tag The comment title tag. Default to h3.
$comment_reply_title_tag = apply_filters( 'jetpack_comment_reply_title_tag', 'h3' );
// The actual iframe (loads comment form from Jetpack server).
$is_amp = class_exists( Jetpack_AMP_Support::class ) && Jetpack_AMP_Support::is_amp_request();
<div id="respond" class="comment-respond">
if ( true === $show_greeting ) :
'<%1$s id="reply-title" class="comment-reply-title">',
esc_html( $comment_reply_title_tag )
esc_html( $params['greeting'] ),
esc_html( $params['greeting_reply'] )
cancel_comment_reply_link( esc_html__( 'Cancel reply', 'jetpack' ) );