array(),
's' => array(),
'strong' => array(),
'em' => array(),
);
/**
* Use this variable when printing the message after submitting an email in subscription widgets
*
* @var array what tags are allowed
*/
public static $allowed_html_tags_for_message = array(
'a' => array(
'href' => array(),
'title' => array(),
'rel' => array(),
'target' => array(),
),
'br' => array(),
);
/**
* Jetpack_Subscriptions_Widget constructor.
*/
public function __construct() {
$widget_ops = array(
'classname' => 'widget_blog_subscription jetpack_subscription_widget',
'description' => __( 'Add an email signup form to allow people to subscribe to your blog.', 'jetpack' ),
'customize_selective_refresh' => true,
'show_instance_in_rest' => true,
);
$name = self::is_jetpack() ?
/** This filter is documented in modules/widgets/facebook-likebox.php */
apply_filters( 'jetpack_widget_name', __( 'Blog Subscriptions', 'jetpack' ) ) :
__( 'Follow Blog', 'jetpack' );
parent::__construct(
'blog_subscription',
$name,
$widget_ops
);
if ( self::is_jetpack() &&
(
is_active_widget( false, false, $this->id_base ) ||
is_active_widget( false, false, 'monster' ) ||
is_customize_preview()
)
) {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ) );
}
add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) );
}
/**
* Remove the "Blog Subscription" widget from the Legacy Widget block
*
* @param array $widget_types List of widgets that are currently removed from the Legacy Widget block.
* @return array $widget_types New list of widgets that will be removed.
*/
public function hide_widget_in_block_editor( $widget_types ) {
$widget_types[] = self::ID_BASE;
return $widget_types;
}
/**
* Enqueue the form's CSS.
*
* @since 4.5.0
*/
public function enqueue_style() {
wp_register_style(
'jetpack-subscriptions',
plugins_url( 'subscriptions.css', __FILE__ ),
array(),
JETPACK__VERSION
);
wp_enqueue_style( 'jetpack-subscriptions' );
}
/**
* Renders a full widget either within the context of WordPress widget, or in response to a shortcode.
*
* @param array $args Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
* @param array $instance The settings for the particular instance of the widget.
*/
public function widget( $args, $instance ) {
if ( self::is_jetpack() &&
/** This filter is documented in modules/contact-form/grunion-contact-form.php */
false === apply_filters( 'jetpack_auto_fill_logged_in_user', false )
) {
$subscribe_email = '';
} else {
$current_user = wp_get_current_user();
if ( ! empty( $current_user->user_email ) ) {
$subscribe_email = esc_attr( $current_user->user_email );
} else {
$subscribe_email = '';
}
}
$stats_action = self::is_jetpack() ? 'jetpack_subscriptions' : 'follow_blog';
/** This action is documented in modules/widgets/gravatar-profile.php */
do_action( 'jetpack_stats_extra', 'widget_view', $stats_action );
$after_widget = isset( $args['after_widget'] ) ? $args['after_widget'] : '';
$before_widget = isset( $args['before_widget'] ) ? $args['before_widget'] : '';
$instance = wp_parse_args( (array) $instance, $this->defaults() );
echo $before_widget; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
self::$instance_count ++;
self::render_widget_title( $args, $instance );
self::render_widget_status_messages( $instance );
self::render_widget_subscription_form( $args, $instance, $subscribe_email );
echo "\n" . $after_widget; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Prints the widget's title. If show_only_email_and_button is true, we will not show a title.
*
* @param array $args Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
* @param array $instance The settings for the particular instance of the widget.
*/
public static function render_widget_title( $args, $instance ) {
$show_only_email_and_button = $instance['show_only_email_and_button'];
$before_title = isset( $args['before_title'] ) ? $args['before_title'] : '';
$after_title = isset( $args['after_title'] ) ? $args['after_title'] : '';
if ( self::is_wpcom() && ! $show_only_email_and_button ) {
if ( self::is_current_user_subscribed() ) {
if ( ! empty( $instance['title_following'] ) ) {
echo $before_title . '' . $after_title . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
} else {
if ( ! empty( $instance['title'] ) ) {
echo $before_title . '' . $after_title . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}
}
if ( self::is_jetpack() && empty( $instance['show_only_email_and_button'] ) ) {
echo $args['before_title'] . $instance['title'] . $args['after_title'] . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}
/**
* Prints the subscription block's status messages after someone has attempted to subscribe.
* Either a success message or an error message.
*
* @param array $instance The settings for the particular instance of the widget.
*/
public static function render_widget_status_messages( $instance ) {
if ( self::is_jetpack() && isset( $_GET['subscribe'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Non-sensitive informational output.
$success_message = isset( $instance['success_message'] ) ? stripslashes( $instance['success_message'] ) : '';
$subscribers_total = self::fetch_subscriber_count();
switch ( $_GET['subscribe'] ) : // phpcs:ignore WordPress.Security.NonceVerification.Recommended
case 'invalid_email':
?>
You can manage your preferences at subscribe.wordpress.com', 'jetpack' ),
self::$allowed_html_tags_for_message
),
'https://subscribe.wordpress.com/',
esc_attr__( 'Manage your email preferences.', 'jetpack' )
);
?>
You can manage your preferences at subscribe.wordpress.com', 'jetpack' ),
self::$allowed_html_tags_for_message
),
'https://subscribe.wordpress.com/',
esc_attr__( 'Manage your email preferences.', 'jetpack' )
);
?>
Approve or delete a few subscriptions at subscribe.wordpress.com before continuing.', 'jetpack' ),
self::$allowed_html_tags_for_message
),
'https://subscribe.wordpress.com/',
esc_attr__( 'Manage your email preferences.', 'jetpack' )
);
?>
Otherwise, you can manage your preferences at subscribe.wordpress.com.', 'jetpack' ),
self::$allowed_html_tags_for_message
),
'https://subscribe.wordpress.com/',
esc_attr__( 'Manage your email preferences.', 'jetpack' )
);
?>
contact us.', 'jetpack' );
break;
case 'blocked':
$message = __( 'Subscriptions have been blocked for this email address.', 'jetpack' );
break;
case 'flooded':
$message = __( 'You already have several pending email subscriptions. Approve or delete a few through your Subscription Manager before attempting to subscribe to more blogs.', 'jetpack' );
break;
case 'spammed':
/* translators: %s is a URL */
$message = sprintf( __( 'Because there are many pending subscriptions for this email address, we have blocked the subscription. Please activate or delete pending subscriptions before attempting to subscribe.', 'jetpack' ), 'https://subscribe.wordpress.com/' );
break;
case 'subscribed':
$message = __( 'You’re already subscribed to this site.', 'jetpack' );
break;
case 'pending':
$message = __( 'You have a pending subscription already; we just sent you another email. Click the link or contact us if you don’t receive it.', 'jetpack' );
break;
case 'confirmed':
$message = __( 'Congrats, you’re subscribed! You’ll get an email with the details of your subscription and an unsubscribe link.', 'jetpack' );
break;
}
$border_color = isset( $themecolors['border'] ) ? " #{$themecolors['border']}" : '';
$redirect_fragment = self::get_redirect_fragment();
printf(
'
%3$s
',
esc_attr( $redirect_fragment ),
esc_attr( $border_color ),
wp_kses_post( $message )
);
}
}
/**
* Generates the redirect fragment used after form submission.
*
* @param string $id is the specific id that will appear in the redirect fragment. If none is provided self::$instance_count will be used.
*/
protected static function get_redirect_fragment( $id = null ) {
if ( $id === null ) {
return 'subscribe-blog' . ( self::$instance_count > 1 ? '-' . self::$instance_count : '' );
}
return 'subscribe-blog-' . $id;
}
/**
* Renders a form allowing folks to subscribe to the blog.
*
* @param array $args Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
* @param array $instance The settings for the particular instance of the widget.
* @param string $subscribe_email The email to use to prefill the form.
*/
public static function render_widget_subscription_form( $args, $instance, $subscribe_email ) {
$show_only_email_and_button = $instance['show_only_email_and_button'];
$show_subscribers_total = (bool) $instance['show_subscribers_total'];
$subscribers_total = self::fetch_subscriber_count();
$subscribe_text = empty( $instance['show_only_email_and_button'] ) ?
stripslashes( $instance['subscribe_text'] ) :
false;
$referer = esc_url_raw( ( is_ssl() ? 'https' : 'http' ) . '://' . ( isset( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : '' ) . ( isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : '' ) );
$source = 'widget';
$widget_id = ! empty( $args['widget_id'] ) ? $args['widget_id'] : self::$instance_count;
$subscribe_button = ! empty( $instance['submit_button_text'] ) ? $instance['submit_button_text'] : $instance['subscribe_button'];
$subscribe_placeholder = isset( $instance['subscribe_placeholder'] ) ? stripslashes( $instance['subscribe_placeholder'] ) : '';
$submit_button_classes = isset( $instance['submit_button_classes'] ) ? 'wp-block-button__link ' . $instance['submit_button_classes'] : 'wp-block-button__link';
$submit_button_styles = isset( $instance['submit_button_styles'] ) ? $instance['submit_button_styles'] : '';
$submit_button_wrapper_styles = isset( $instance['submit_button_wrapper_styles'] ) ? $instance['submit_button_wrapper_styles'] : '';
$email_field_classes = isset( $instance['email_field_classes'] ) ? $instance['email_field_classes'] : '';
$email_field_styles = isset( $instance['email_field_styles'] ) ? $instance['email_field_styles'] : '';
if ( self::is_wpcom() && ! self::wpcom_has_status_message() ) {
global $current_blog;
$url = defined( 'SUBSCRIBE_BLOG_URL' ) ? SUBSCRIBE_BLOG_URL : '';
$form_id = self::get_redirect_fragment();
?>
query( 'jetpack.fetchSubscriberCount' );
if ( $xml->isError() ) { // If we get an error from .com, set the status to failed so that we will try again next time the data is requested.
$subs_count = array(
'status' => 'failed',
'code' => $xml->getErrorCode(),
'message' => $xml->getErrorMessage(),
'value' => ( isset( $subs_count['value'] ) ) ? $subs_count['value'] : 0,
);
} else {
$subs_count = array(
'status' => 'success',
'value' => $xml->getResponse(),
);
}
set_transient( $cache_key, $subs_count, 3600 ); // Try to cache the result for at least 1 hour.
}
return $subs_count['value'];
}
if ( self::is_wpcom() ) {
$subs_count = wpcom_reach_total_for_blog();
return $subs_count;
}
}
/**
* Updates a particular instance of a widget when someone saves it in wp-admin.
*
* @param array $new_instance New widget instance settings.
* @param array $old_instance Old widget instance settings.
*
* @return array
*/
public function update( $new_instance, $old_instance ) {
$instance = $old_instance;
if ( self::is_jetpack() ) {
$instance['title'] = wp_kses( stripslashes( $new_instance['title'] ), array() );
$instance['subscribe_placeholder'] = wp_kses( stripslashes( $new_instance['subscribe_placeholder'] ), array() );
$instance['subscribe_button'] = wp_kses( stripslashes( $new_instance['subscribe_button'] ), array() );
$instance['success_message'] = wp_kses( stripslashes( $new_instance['success_message'] ), array() );
}
if ( self::is_wpcom() ) {
$instance['title'] = wp_strip_all_tags( stripslashes( $new_instance['title'] ) );
$instance['title_following'] = wp_strip_all_tags( stripslashes( $new_instance['title_following'] ) );
$instance['subscribe_logged_in'] = wp_filter_post_kses( stripslashes( $new_instance['subscribe_logged_in'] ) );
$instance['subscribe_button'] = wp_strip_all_tags( stripslashes( $new_instance['subscribe_button'] ) );
}
$instance['show_subscribers_total'] = isset( $new_instance['show_subscribers_total'] ) && $new_instance['show_subscribers_total'];
$instance['show_only_email_and_button'] = isset( $new_instance['show_only_email_and_button'] ) && $new_instance['show_only_email_and_button'];
$instance['subscribe_text'] = wp_filter_post_kses( stripslashes( $new_instance['subscribe_text'] ) );
return $instance;
}
/**
* The default args for rendering a subscription form.
*
* @return array
*/
public static function defaults() {
$defaults = array(
'show_subscribers_total' => true,
'show_only_email_and_button' => false,
'include_social_followers' => true,
);
$defaults['title'] = esc_html__( 'Subscribe to Blog via Email', 'jetpack' );
$defaults['subscribe_text'] = esc_html__( 'Enter your email address to subscribe to this blog and receive notifications of new posts by email.', 'jetpack' );
$defaults['subscribe_placeholder'] = esc_html__( 'Email Address', 'jetpack' );
$defaults['subscribe_button'] = esc_html__( 'Subscribe', 'jetpack' );
$defaults['success_message'] = esc_html__( "Success! An email was just sent to confirm your subscription. Please find the email now and click 'Confirm Follow' to start subscribing.", 'jetpack' );
return $defaults;
}
/**
* Renders the widget's options form in wp-admin.
*
* @param array $instance Widget instance.
*/
public function form( $instance ) {
$instance = wp_parse_args( (array) $instance, $this->defaults() );
$show_subscribers_total = checked( $instance['show_subscribers_total'], true, false );
if ( self::is_wpcom() ) {
$title = esc_attr( stripslashes( $instance['title'] ) );
$title_following = esc_attr( stripslashes( $instance['title_following'] ) );
$subscribe_text = esc_attr( stripslashes( $instance['subscribe_text'] ) );
$subscribe_logged_in = esc_attr( stripslashes( $instance['subscribe_logged_in'] ) );
$subscribe_button = esc_attr( stripslashes( $instance['subscribe_button'] ) );
$subscribers_total = self::fetch_subscriber_count();
}
if ( self::is_jetpack() ) {
$title = stripslashes( $instance['title'] );
$subscribe_text = stripslashes( $instance['subscribe_text'] );
$subscribe_placeholder = stripslashes( $instance['subscribe_placeholder'] );
$subscribe_button = stripslashes( $instance['subscribe_button'] );
$success_message = stripslashes( $instance['success_message'] );
$subscribers_total = self::fetch_subscriber_count();
}
if ( self::is_wpcom() ) :
?>