kollapsminoriteten/wp-content/plugins/jetpack/extensions/blocks/subscriptions/subscriptions.php

1184 lines
43 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
/**
* Subscriptions Block.
*
* @package automattic/jetpack
*/
namespace Automattic\Jetpack\Extensions\Subscriptions;
use Automattic\Jetpack\Blocks;
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Token_Subscription_Service;
use Automattic\Jetpack\Status;
use Automattic\Jetpack\Status\Host;
use Jetpack;
use Jetpack_Gutenberg;
use Jetpack_Memberships;
use Jetpack_Subscriptions_Widget;
require_once __DIR__ . '/constants.php';
/**
* These block defaults should match ./constants.js
*/
const DEFAULT_BORDER_RADIUS_VALUE = 0;
const DEFAULT_BORDER_WEIGHT_VALUE = 1;
const DEFAULT_FONTSIZE_VALUE = '16px';
const DEFAULT_PADDING_VALUE = 15;
const DEFAULT_SPACING_VALUE = 10;
/**
* Registers the block for use in Gutenberg
* This is done via an action so that we can disable
* registration if we need to.
*/
function register_block() {
/*
* Disable the feature on P2 blogs
*/
if ( function_exists( '\WPForTeams\is_wpforteams_site' ) &&
\WPForTeams\is_wpforteams_site( get_current_blog_id() ) ) {
return;
}
if (
( defined( 'IS_WPCOM' ) && IS_WPCOM )
|| ( ( new Connection_Manager( 'jetpack' ) )->has_connected_owner() && ! ( new Status() )->is_offline_mode() )
) {
Blocks::jetpack_register_block(
BLOCK_NAME,
array(
'render_callback' => __NAMESPACE__ . '\render_block',
'supports' => array(
'spacing' => array(
'margin' => true,
'padding' => true,
),
'align' => array( 'wide', 'full' ),
),
)
);
}
/*
* If the Subscriptions module is not active,
* do not make any further changes on the site.
*/
if ( ! Jetpack::is_module_active( 'subscriptions' ) ) {
return;
}
/**
* Do not proceed if the newsletter feature is not enabled
* or if the 'Jetpack_Memberships' class does not exists.
*/
if ( ! class_exists( '\Jetpack_Memberships' ) ) {
return;
}
register_post_meta(
'post',
META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS,
array(
'show_in_rest' => true,
'single' => true,
'type' => 'string',
'auth_callback' => function () {
return wp_get_current_user()->has_cap( 'edit_posts' );
},
)
);
// This ensures Jetpack will sync this post meta to WPCOM.
add_filter(
'jetpack_sync_post_meta_whitelist',
function ( $allowed_meta ) {
return array_merge( $allowed_meta, array( META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS ) );
}
);
// Hide the content Priority 8 makes it run before do_blocks gets called for the content
add_filter( 'the_content', __NAMESPACE__ . '\add_paywall', 8 );
// Close comments on the front-end
add_filter( 'comments_open', __NAMESPACE__ . '\maybe_close_comments', 10, 2 );
add_filter( 'pings_open', __NAMESPACE__ . '\maybe_close_comments', 10, 2 );
// Hide existing comments
add_filter( 'get_comment', __NAMESPACE__ . '\maybe_gate_existing_comments' );
// Gate the excerpt for a post
add_filter( 'get_the_excerpt', __NAMESPACE__ . '\jetpack_filter_excerpt_for_newsletter', 10, 2 );
// Add a 'Newsletter access' column to the Edit posts page
add_action( 'manage_post_posts_columns', __NAMESPACE__ . '\register_newsletter_access_column' );
add_action( 'manage_post_posts_custom_column', __NAMESPACE__ . '\render_newsletter_access_rows', 10, 2 );
}
add_action( 'init', __NAMESPACE__ . '\register_block', 9 );
/**
* Returns true when in a WP.com environment.
*
* @return boolean
*/
function is_wpcom() {
return defined( 'IS_WPCOM' ) && IS_WPCOM;
}
/**
* Adds a 'Newsletter' column after the 'Title' column in the post list
*
* @param array $columns An array of column names.
* @return array An array of column names.
*/
function register_newsletter_access_column( $columns ) {
if ( ! Jetpack_Memberships::has_configured_plans_jetpack_recurring_payments( 'newsletter' ) ) {
// We only display the "NL access" column if we have published one paid-newsletter
return $columns;
}
$position = array_search( 'title', array_keys( $columns ), true );
$new_column = array( NEWSLETTER_COLUMN_ID => '<span>' . __( 'Newsletter', 'jetpack' ) . '</span>' );
return array_merge(
array_slice( $columns, 0, $position + 1, true ),
$new_column,
array_slice( $columns, $position, null, true )
);
}
/**
* Displays the newsletter access level.
*
* @param string $column_id The ID of the column to display.
* @param int $post_id The current post ID.
*/
function render_newsletter_access_rows( $column_id, $post_id ) {
if ( NEWSLETTER_COLUMN_ID !== $column_id ) {
return;
}
$access_level = get_post_meta( $post_id, META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, true );
switch ( $access_level ) {
case Token_Subscription_Service::POST_ACCESS_LEVEL_PAID_SUBSCRIBERS:
echo esc_html__( 'Paid Subscribers', 'jetpack' );
break;
case Token_Subscription_Service::POST_ACCESS_LEVEL_SUBSCRIBERS:
echo esc_html__( 'Subscribers', 'jetpack' );
break;
case Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY:
echo esc_html__( 'Everybody', 'jetpack' );
break;
default:
echo '';
}
}
/**
* Determine the amount of folks currently subscribed to the blog, splitted out in email_subscribers & social_followers & paid_subscribers
*
* @return array containing ['value' => ['email_subscribers' => 0, 'paid_subscribers' => 0, 'social_followers' => 0]]
*/
function fetch_subscriber_counts() {
$subs_count = 0;
if ( is_wpcom() ) {
$subs_count = array(
'value' => \wpcom_fetch_subs_counts( true ),
);
} else {
$cache_key = 'wpcom_subscribers_totals';
$subs_count = get_transient( $cache_key );
if ( false === $subs_count || 'failed' === $subs_count['status'] ) {
$xml = new \Jetpack_IXR_Client();
$xml->query( 'jetpack.fetchSubscriberCounts' );
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'] : array(
'email_subscribers' => 0,
'social_followers' => 0,
'paid_subscribers' => 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;
}
/**
* Returns subscriber count based on include_social_followers attribute
*
* @param bool $include_social_followers Whether to include social followers in the count.
* @return int
*/
function get_subscriber_count( $include_social_followers ) {
$counts = fetch_subscriber_counts();
if ( $include_social_followers ) {
$subscriber_count = $counts['value']['email_subscribers'] + $counts['value']['social_followers'];
} else {
$subscriber_count = $counts['value']['email_subscribers'];
}
return $subscriber_count;
}
/**
* Returns the newsletter categories from the .com API or the Jetpack XML-RPC API.
*
* @return array containing [ 'enabled' => true|false, 'newsletter_categories' => array ]
*/
function fetch_newsletter_categories() {
$categories = array();
if ( is_wpcom() ) {
$categories = \wpcom_fetch_newsletter_categories();
} else {
$xml = new \Jetpack_IXR_Client();
$xml->query( 'jetpack.fetchNewsletterCategories' );
if ( ! $xml->isError() ) {
$categories = $xml->getResponse();
}
}
return $categories;
}
/**
* Returns the newsletter categories if the feature is enabled, otherwise returns an empty array.
*
* @return array
*/
function get_newsletter_categories() {
$response = fetch_newsletter_categories();
if (
isset( $response['enabled'] )
&& (bool) $response['enabled']
&& isset( $response['newsletter_categories'] )
&& is_array( $response['newsletter_categories'] )
) {
return $response['newsletter_categories'];
}
return array();
}
/**
* Returns true if the block attributes contain a value for the given key.
*
* @param array $attributes Array containing the block attributes.
* @param string $key Block attribute key.
*
* @return boolean
*/
function has_attribute( $attributes, $key ) {
return isset( $attributes[ $key ] ) && $attributes[ $key ] !== 'undefined';
}
/**
* Returns the value for the given attribute key, with the option of providing a default fallback value.
*
* @param array $attributes Array containing the block attributes.
* @param string $key Block attribute key.
* @param mixed $default Optional fallback value in case the key doesn't exist.
*
* @return mixed
*/
function get_attribute( $attributes, $key, $default = null ) {
return has_attribute( $attributes, $key ) ? $attributes[ $key ] : $default;
}
/**
* Mimics getColorClassName, getFontSizeClass and getGradientClass from @wordpress/block-editor js package.
*
* @param string $setting Setting name.
* @param string $value Setting value.
*
* @return string
*/
function get_setting_class_name( $setting, $value ) {
if ( ! $setting || ! $value ) {
return '';
}
return sprintf( 'has-%s-%s', $value, $setting );
}
/**
* Uses block attributes to generate an array containing the classes for various block elements.
* Based on Jetpack_Subscriptions_Widget::do_subscription_form() which the block was originally using.
*
* @param array $attributes Array containing the block attributes.
*
* @return array
*/
function get_element_class_names_from_attributes( $attributes ) {
$text_color_class = get_setting_class_name( 'color', get_attribute( $attributes, 'textColor' ) );
$font_size_class = get_setting_class_name( 'font-size', get_attribute( $attributes, 'fontSize' ) );
$border_class = get_setting_class_name( 'border-color', get_attribute( $attributes, 'borderColor' ) );
$button_background_class = get_setting_class_name( 'background-color', get_attribute( $attributes, 'buttonBackgroundColor' ) );
$button_gradient_class = get_setting_class_name( 'gradient-background', get_attribute( $attributes, 'buttonGradient' ) );
$email_field_background_class = get_setting_class_name( 'background-color', get_attribute( $attributes, 'emailFieldBackgroundColor' ) );
$email_field_gradient_class = get_setting_class_name( 'gradient-background', get_attribute( $attributes, 'emailFieldGradient' ) );
$submit_button_classes = array_filter(
array(
'wp-block-button__link' => true,
'no-border-radius' => 0 === get_attribute( $attributes, 'borderRadius', 0 ),
$font_size_class => true,
$border_class => true,
'has-text-color' => ! empty( $text_color_class ),
$text_color_class => true,
'has-background' => ! empty( $button_background_class ) || ! empty( $button_gradient_class ),
$button_background_class => ! empty( $button_background_class ),
$button_gradient_class => ! empty( $button_gradient_class ),
)
);
$email_field_classes = array_filter(
array(
'no-border-radius' => 0 === get_attribute( $attributes, 'borderRadius', 0 ),
$font_size_class => true,
$border_class => true,
$email_field_background_class => true,
$email_field_gradient_class => true,
)
);
$block_wrapper_classes = array_filter(
array(
'wp-block-jetpack-subscriptions__supports-newline' => true,
'wp-block-jetpack-subscriptions__use-newline' => (bool) get_attribute( $attributes, 'buttonOnNewLine' ),
'wp-block-jetpack-subscriptions__show-subs' => (bool) get_attribute( $attributes, 'showSubscribersTotal' ),
)
);
return array(
'block_wrapper' => implode( ' ', array_keys( $block_wrapper_classes ) ),
'email_field' => implode( ' ', array_keys( $email_field_classes ) ),
'submit_button' => implode( ' ', array_keys( $submit_button_classes ) ),
);
}
/**
* Uses block attributes to generate an array containing the styles for various block elements.
* Based on Jetpack_Subscriptions_Widget::do_subscription_form() which the block was originally using.
*
* @param array $attributes Array containing the block attributes.
*
* @return array
*/
function get_element_styles_from_attributes( $attributes ) {
$button_background_style = ! has_attribute( $attributes, 'buttonBackgroundColor' ) && has_attribute( $attributes, 'customButtonGradient' )
? get_attribute( $attributes, 'customButtonGradient' )
: get_attribute( $attributes, 'customButtonBackgroundColor' );
$email_field_styles = '';
$submit_button_wrapper_styles = '';
$submit_button_styles = '';
if ( ! empty( $button_background_style ) ) {
$submit_button_styles .= sprintf( 'background: %s;', $button_background_style );
}
if ( has_attribute( $attributes, 'customTextColor' ) ) {
$submit_button_styles .= sprintf( 'color: %s;', get_attribute( $attributes, 'customTextColor' ) );
}
if ( has_attribute( $attributes, 'buttonWidth' ) ) {
$submit_button_wrapper_styles .= sprintf( 'width: %s;', get_attribute( $attributes, 'buttonWidth' ) );
$submit_button_wrapper_styles .= 'max-width: 100%;';
// Account for custom margins on inline forms.
$submit_button_styles .= true === get_attribute( $attributes, 'buttonOnNewLine' )
? sprintf( 'width: calc(100%% - %dpx);', get_attribute( $attributes, 'spacing', DEFAULT_SPACING_VALUE ) )
: 'width: 100%;';
}
$font_size = get_attribute( $attributes, 'customFontSize', DEFAULT_FONTSIZE_VALUE );
$style = sprintf( 'font-size: %s%s;', $font_size, is_numeric( $font_size ) ? 'px' : '' );
$submit_button_styles .= $style;
$email_field_styles .= $style;
$padding = get_attribute( $attributes, 'padding', DEFAULT_PADDING_VALUE );
$style = sprintf( 'padding: %1$dpx %2$dpx %1$dpx %2$dpx;', $padding, round( $padding * 1.5 ) );
$submit_button_styles .= $style;
$email_field_styles .= $style;
$button_spacing = get_attribute( $attributes, 'spacing', DEFAULT_SPACING_VALUE );
if ( true === get_attribute( $attributes, 'buttonOnNewLine' ) ) {
$submit_button_styles .= sprintf( 'margin-top: %dpx;', $button_spacing );
} else {
$submit_button_styles .= 'margin: 0px; '; // Reset Safari's 2px default margin for buttons affecting input and button union
$submit_button_styles .= sprintf( 'margin-left: %dpx;', $button_spacing );
}
if ( has_attribute( $attributes, 'borderColor' ) ) {
$style = sprintf( 'border-color: %s;', get_attribute( $attributes, 'borderColor', '' ) );
$submit_button_styles .= $style;
$email_field_styles .= $style;
}
$style = sprintf( 'border-radius: %dpx;', get_attribute( $attributes, 'borderRadius', DEFAULT_BORDER_RADIUS_VALUE ) );
$submit_button_styles .= $style;
$email_field_styles .= $style;
$style = sprintf( 'border-width: %dpx;', get_attribute( $attributes, 'borderWeight', DEFAULT_BORDER_WEIGHT_VALUE ) );
$submit_button_styles .= $style;
$email_field_styles .= $style;
$categories_styles = sprintf( '--subscribe-block-border-radius: %dpx;', get_attribute( $attributes, 'borderRadius', DEFAULT_BORDER_RADIUS_VALUE ) );
if ( has_attribute( $attributes, 'customBorderColor' ) ) {
$style = sprintf( 'border-color: %s; border-style: solid;', get_attribute( $attributes, 'customBorderColor' ) );
$submit_button_styles .= $style;
$email_field_styles .= $style;
}
if ( ! jetpack_is_frontend() ) {
$background_color_style = get_attribute_color( 'buttonBackgroundColor', $attributes, '#113AF5' /* default lettre theme color */ );
$text_color_style = get_attribute_color( 'textColor', $attributes, '#FFFFFF' );
$submit_button_styles .= sprintf( ' background-color: %s; color: %s;', $background_color_style, $text_color_style );
}
return array(
'email_field' => $email_field_styles,
'submit_button' => $submit_button_styles,
'submit_button_wrapper' => $submit_button_wrapper_styles,
'categories' => $categories_styles,
);
}
/**
* Retrieve the resolved color for a given attribute.
*
* @param string $attribute_name The name of the attribute to resolve.
* @param array $attributes An array of all attributes.
* @param string $default_color A fallback color in case no color can be resolved.
*
* @return string Returns the resolved color or the default color if no color is found.
*/
function get_attribute_color( $attribute_name, $attributes, $default_color ) {
if ( has_attribute( $attributes, $attribute_name ) ) {
$color_slug = get_attribute( $attributes, $attribute_name );
$resolved_color = get_color_from_slug( $color_slug );
if ( $resolved_color ) {
return $resolved_color;
}
}
return get_global_style_color( $attribute_name, $default_color );
}
/**
* Retrieve the global style color based on a provided style key.
*
* @param string $style_key The key for the desired style.
* @param string $default_color A fallback color in case the global style is not set.
*
* @return string Returns the color defined in global styles or the default color if not defined.
*/
function get_global_style_color( $style_key, $default_color ) {
$global_styles = wp_get_global_styles(
array( 'color' ),
array(
'block_name' => 'core/button',
'transforms' => array( 'resolve-variables' ),
)
);
if ( isset( $global_styles[ $style_key ] ) ) {
return $global_styles[ $style_key ];
}
return $default_color;
}
/**
* Convert a color slug into its corresponding color value.
*
* @param string $slug The slug representation of the color.
*
* @return string|null Returns the color value if found, or null otherwise.
*/
function get_color_from_slug( $slug ) {
$color_palettes = wp_get_global_settings( array( 'color', 'palette' ) );
if ( ! is_array( $color_palettes ) ) {
return null;
}
foreach ( $color_palettes as $palette ) {
if ( is_array( $palette ) ) {
foreach ( $palette as $color ) {
if ( isset( $color['slug'] ) && $color['slug'] === $slug && isset( $color['color'] ) ) {
return $color['color'];
}
}
}
}
return null;
}
/**
* Subscriptions block render callback.
*
* @param array $attributes Array containing the block attributes.
*
* @return string
*/
function render_block( $attributes ) {
// If the Subscriptions module is not active, don't render the block.
if ( ! Jetpack::is_module_active( 'subscriptions' ) ) {
return '';
}
if ( class_exists( '\Jetpack_Memberships' ) ) {
// We only want the sites that have newsletter feature enabled to be graced by this JavaScript and thickbox.
Jetpack_Gutenberg::load_assets_as_required( FEATURE_NAME, array( 'thickbox' ) );
if ( ! wp_style_is( 'enqueued' ) ) {
wp_enqueue_style( 'thickbox' );
}
} else {
Jetpack_Gutenberg::load_styles_as_required( FEATURE_NAME );
}
$subscribe_email = '';
/** This filter is documented in modules/contact-form/grunion-contact-form.php */
if ( is_wpcom() || false !== apply_filters( 'jetpack_auto_fill_logged_in_user', false ) ) {
$current_user = wp_get_current_user();
$subscribe_email = ! empty( $current_user->user_email ) ? $current_user->user_email : '';
}
// The block is using the Jetpack_Subscriptions_Widget backend, hence the need to increase the instance count.
++Jetpack_Subscriptions_Widget::$instance_count;
$classes = get_element_class_names_from_attributes( $attributes );
$styles = get_element_styles_from_attributes( $attributes );
$include_social_followers = isset( $attributes['includeSocialFollowers'] ) ? (bool) get_attribute( $attributes, 'includeSocialFollowers' ) : true;
$data = array(
'widget_id' => Jetpack_Subscriptions_Widget::$instance_count,
'subscribe_email' => $subscribe_email,
'wrapper_attributes' => get_block_wrapper_attributes(
array(
'class' => $classes['block_wrapper'],
)
),
'subscribe_placeholder' => get_attribute( $attributes, 'subscribePlaceholder', esc_html__( 'Type your email…', 'jetpack' ) ),
'submit_button_text' => get_attribute( $attributes, 'submitButtonText', esc_html__( 'Subscribe', 'jetpack' ) ),
'success_message' => get_attribute(
$attributes,
'successMessage',
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' )
),
'show_subscribers_total' => (bool) get_attribute( $attributes, 'showSubscribersTotal' ),
'subscribers_total' => get_subscriber_count( $include_social_followers ),
'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' => 'subscribe-block',
'newsletter_categories' => get_newsletter_categories(),
);
if ( ! jetpack_is_frontend() ) {
return render_for_email( $data, $styles );
}
if ( is_wpcom() ) {
return render_wpcom_subscribe_form( $data, $classes, $styles );
}
return render_jetpack_subscribe_form( $data, $classes, $styles );
}
/**
* Get the post access level for the current post. Defaults to 'everybody' if the query is not for a single post
*
* @return string the actual post access level (see projects/plugins/jetpack/extensions/blocks/subscriptions/constants.js for the values).
*/
function get_post_access_level_for_current_post() {
if ( ! is_singular() ) {
// There is no "actual" current post.
return Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY;
}
return Jetpack_Memberships::get_post_access_level();
}
/**
* Renders the newsletter categories in checkbox form.
*
* This function outputs a div containing labels and checkboxes for each newsletter category.
* Each checkbox represents a category, allowing users to select multiple newsletter categories.
*
* @param array $newsletter_categories An array of newsletter categories where each category is an associative array
* with keys 'id' and 'name' representing the category's ID and display name, respectively.
* @param array $styles An associative array of style settings. Default is an empty array.
*
* @return void Outputs HTML directly.
*/
function render_newsletter_categories( $newsletter_categories, $styles = array() ) {
if ( count( $newsletter_categories ) ) :
?>
<div
class="wp-block-jetpack-subscriptions__newsletter-categories"
style="<?php echo esc_attr( $styles['categories'] ); ?>"
>
<?php foreach ( $newsletter_categories as $category ) : ?>
<label class="wp-block-jetpack-subscriptions__newsletter-category">
<input type="checkbox" value="<?php echo esc_html( $category['id'] ); ?>" />
<div>
<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M14.9406 6.6485L8.94211 14.7159L5.1785 11.9174L5.92436 10.9143L8.68487 12.9669L13.9375 5.90264L14.9406 6.6485Z" fill="#1D39EB"/>
</svg>
<?php echo esc_html( $category['name'] ); ?>
</div>
</label>
<?php endforeach; ?>
</div>
<?php
endif;
}
/**
* Renders the WP.com version of the subscriptions block.
*
* @param array $data Array containing block view data.
* @param array $classes Array containing the classes for different block elements.
* @param array $styles Array containing the styles for different block elements.
*
* @return string
*/
function render_wpcom_subscribe_form( $data, $classes, $styles ) {
global $current_blog;
$form_id = 'subscribe-blog' . ( Jetpack_Subscriptions_Widget::$instance_count > 1 ? '-' . Jetpack_Subscriptions_Widget::$instance_count : '' );
$url = defined( 'SUBSCRIBE_BLOG_URL' ) ? SUBSCRIBE_BLOG_URL : '';
ob_start();
Jetpack_Subscriptions_Widget::render_widget_status_messages(
array(
'success_message' => $data['success_message'],
)
);
$post_access_level = get_post_access_level_for_current_post();
$newsletter_categories = $data['newsletter_categories'];
?>
<div <?php echo wp_kses_data( $data['wrapper_attributes'] ); ?>>
<div class="wp-block-jetpack-subscriptions__container">
<form
action="<?php echo esc_url( $url ); ?>"
method="post"
accept-charset="utf-8"
data-blog="<?php echo esc_attr( get_current_blog_id() ); ?>"
data-post_access_level="<?php echo esc_attr( $post_access_level ); ?>"
id="<?php echo esc_attr( $form_id ); ?>"
>
<?php render_newsletter_categories( $newsletter_categories, $styles ); ?>
<div class="wp-block-jetpack-subscriptions__form-elements">
<?php
$email_field_id = 'subscribe-field';
$email_field_id .= Jetpack_Subscriptions_Widget::$instance_count > 1
? '-' . Jetpack_Subscriptions_Widget::$instance_count
: '';
$label_field_id = $email_field_id . '-label';
?>
<p id="subscribe-email">
<label
id="<?php echo esc_attr( $label_field_id ); ?>"
for="<?php echo esc_attr( $email_field_id ); ?>"
class="screen-reader-text"
>
<?php echo esc_html( $data['subscribe_placeholder'] ); ?>
</label>
<?php
printf(
'<input
required="required"
type="email"
name="email"
%1$s
style="%2$s"
placeholder="%3$s"
value="%4$s"
id="%5$s"
/>',
( ! empty( $classes['email_field'] )
? 'class="' . esc_attr( $classes['email_field'] ) . '"'
: ''
),
( ! empty( $styles['email_field'] )
? esc_attr( $styles['email_field'] )
: 'width: 95%; padding: 1px 10px'
),
esc_attr( $data['subscribe_placeholder'] ),
esc_attr( $data['subscribe_email'] ),
esc_attr( $email_field_id )
);
?>
</p>
<p id="subscribe-submit"
<?php if ( ! empty( $styles['submit_button_wrapper'] ) ) : ?>
style="<?php echo esc_attr( $styles['submit_button_wrapper'] ); ?>"
<?php endif; ?>
>
<input type="hidden" name="action" value="subscribe"/>
<input type="hidden" name="blog_id" value="<?php echo (int) $current_blog->blog_id; ?>"/>
<input type="hidden" name="source" value="<?php echo esc_url( $data['referer'] ); ?>"/>
<input type="hidden" name="sub-type" value="<?php echo esc_attr( $data['source'] ); ?>"/>
<input type="hidden" name="redirect_fragment" value="<?php echo esc_attr( $form_id ); ?>"/>
<?php wp_nonce_field( 'blogsub_subscribe_' . $current_blog->blog_id, '_wpnonce', false ); ?>
<button type="submit"
<?php if ( ! empty( $classes['submit_button'] ) ) : ?>
class="<?php echo esc_attr( $classes['submit_button'] ); ?>"
<?php endif; ?>
<?php if ( ! empty( $styles['submit_button'] ) ) : ?>
style="<?php echo esc_attr( $styles['submit_button'] ); ?>"
<?php endif; ?>
>
<?php
echo wp_kses(
html_entity_decode( $data['submit_button_text'], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ),
Jetpack_Subscriptions_Widget::$allowed_html_tags_for_submit_button
);
?>
</button>
</p>
</div>
</form>
<?php if ( $data['show_subscribers_total'] && $data['subscribers_total'] ) : ?>
<div class="wp-block-jetpack-subscriptions__subscount">
<?php
/* translators: %s: number of folks following the blog */
echo esc_html( sprintf( _n( 'Join %s other follower', 'Join %s other followers', $data['subscribers_total'], 'jetpack' ), number_format_i18n( $data['subscribers_total'] ) ) );
?>
</div>
<?php endif; ?>
</div>
</div>
<?php
return ob_get_clean();
}
/**
* Renders the Jetpack version of the subscriptions block.
*
* @param array $data Array containing block view data.
* @param array $classes Array containing the classes for different block elements.
* @param array $styles Array containing the styles for different block elements.
*
* @return string
*/
function render_jetpack_subscribe_form( $data, $classes, $styles ) {
$form_id = sprintf( 'subscribe-blog-%s', $data['widget_id'] );
$subscribe_field_id = apply_filters( 'subscribe_field_id', 'subscribe-field', $data['widget_id'] );
ob_start();
Jetpack_Subscriptions_Widget::render_widget_status_messages(
array(
'success_message' => $data['success_message'],
)
);
$blog_id = \Jetpack_Options::get_option( 'id' );
$post_access_level = get_post_access_level_for_current_post();
$newsletter_categories = $data['newsletter_categories'];
?>
<div <?php echo wp_kses_data( $data['wrapper_attributes'] ); ?>>
<div class="jetpack_subscription_widget">
<div class="wp-block-jetpack-subscriptions__container">
<form
action="#"
method="post"
accept-charset="utf-8"
data-blog="<?php echo esc_attr( $blog_id ); ?>"
data-post_access_level="<?php echo esc_attr( $post_access_level ); ?>"
id="<?php echo esc_attr( $form_id ); ?>"
>
<?php render_newsletter_categories( $newsletter_categories, $styles ); ?>
<div class="wp-block-jetpack-subscriptions__form-elements">
<p id="subscribe-email">
<label id="jetpack-subscribe-label"
class="screen-reader-text"
for="<?php echo esc_attr( $subscribe_field_id . '-' . $data['widget_id'] ); ?>">
<?php echo esc_html( $data['subscribe_placeholder'] ); ?>
</label>
<input type="email" name="email" required="required"
<?php if ( ! empty( $classes['email_field'] ) ) : ?>
class="<?php echo esc_attr( $classes['email_field'] ); ?> required"
<?php endif; ?>
<?php if ( ! empty( $styles['email_field'] ) ) : ?>
style="<?php echo esc_attr( $styles['email_field'] ); ?>"
<?php endif; ?>
value="<?php echo esc_attr( $data['subscribe_email'] ); ?>"
id="<?php echo esc_attr( $subscribe_field_id . '-' . $data['widget_id'] ); ?>"
placeholder="<?php echo esc_attr( $data['subscribe_placeholder'] ); ?>"
/>
</p>
<p id="subscribe-submit"
<?php if ( ! empty( $styles['submit_button_wrapper'] ) ) : ?>
style="<?php echo esc_attr( $styles['submit_button_wrapper'] ); ?>"
<?php endif; ?>
>
<input type="hidden" name="action" value="subscribe"/>
<input type="hidden" name="blog_id" value="<?php echo (int) $blog_id; ?>"/>
<input type="hidden" name="source" value="<?php echo esc_url( $data['referer'] ); ?>"/>
<input type="hidden" name="sub-type" value="<?php echo esc_attr( $data['source'] ); ?>"/>
<input type="hidden" name="redirect_fragment" value="<?php echo esc_attr( $form_id ); ?>"/>
<?php
if ( is_user_logged_in() ) {
wp_nonce_field( 'blogsub_subscribe_' . get_current_blog_id(), '_wpnonce', false );
}
?>
<button type="submit"
<?php if ( ! empty( $classes['submit_button'] ) ) : ?>
class="<?php echo esc_attr( $classes['submit_button'] ); ?>"
<?php endif; ?>
<?php if ( ! empty( $styles['submit_button'] ) ) : ?>
style="<?php echo esc_attr( $styles['submit_button'] ); ?>"
<?php endif; ?>
name="jetpack_subscriptions_widget"
>
<?php
echo wp_kses(
html_entity_decode( $data['submit_button_text'], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ),
Jetpack_Subscriptions_Widget::$allowed_html_tags_for_submit_button
);
?>
</button>
</p>
</div>
</form>
<?php if ( $data['show_subscribers_total'] && $data['subscribers_total'] ) : ?>
<div class="wp-block-jetpack-subscriptions__subscount">
<?php
echo esc_html( Jetpack_Memberships::get_join_others_text( $data['subscribers_total'] ) );
?>
</div>
<?php endif; ?>
</div>
</div>
</div>
<?php
return ob_get_clean();
}
/**
* Renders the email version of the subscriptions block.
*
* @param array $data Array containing block view data.
* @param array $styles Array containing the styles for different block elements.
*
* @return string
*/
function render_for_email( $data, $styles ) {
$submit_button_wrapper_style = ! empty( $styles['submit_button_wrapper'] ) ? 'style="' . esc_attr( $styles['submit_button_wrapper'] ) . '"' : '';
$button_text = wp_kses(
html_entity_decode( $data['submit_button_text'], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ),
Jetpack_Subscriptions_Widget::$allowed_html_tags_for_submit_button
);
$html = '<div ' . wp_kses_data( $data['wrapper_attributes'] ) . '>
<div>
<div>
<div>
<p ' . $submit_button_wrapper_style . '>
<a href="' . esc_url( get_post_permalink() ) . '" style="text-decoration: none; ' . esc_attr( $styles['submit_button'] ) . '">' . $button_text . '</a>
</p>
</div>
</div>
</div>
</div>';
return $html;
}
/**
* Filter excerpts looking for subscription data.
*
* @param string $excerpt The extrapolated excerpt string.
* @param \WP_Post $post The current post being processed (in `get_the_excerpt`).
*
* @return mixed
*/
function jetpack_filter_excerpt_for_newsletter( $excerpt, $post = null ) {
// The blogmagazine theme is overriding WP core `get_the_excerpt` filter and only passing the excerpt
// TODO: Until this is fixed, return the excerpt without gating. See https://github.com/Automattic/jetpack/pull/28102#issuecomment-1369161116
if ( $post && false !== strpos( $post->post_content, '<!-- wp:jetpack/subscriptions -->' ) ) {
$excerpt .= sprintf(
// translators: %s is the permalink url to the current post.
__( "<p><a href='%s'>View post</a> to subscribe to site newsletter.</p>", 'jetpack' ),
get_post_permalink()
);
}
return $excerpt;
}
/**
* Gate access to posts
*
* @param string $the_content Post content.
*
* @return string
*/
function add_paywall( $the_content ) {
require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php';
if ( Jetpack_Memberships::user_can_view_post() ) {
return $the_content;
}
$post_access_level = Jetpack_Memberships::get_post_access_level();
$paywalled_content = get_paywall_content( $post_access_level, isset( $_GET['subscribe'] ) && 'success' === $_GET['subscribe'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( has_block( \Automattic\Jetpack\Extensions\Paywall\BLOCK_NAME ) ) {
if ( strpos( $the_content, \Automattic\Jetpack\Extensions\Paywall\BLOCK_HTML ) ) {
return strstr( $the_content, \Automattic\Jetpack\Extensions\Paywall\BLOCK_HTML, true ) . $paywalled_content;
}
// WordPress generates excerpts by either rendering or stripping blocks before invoking the `the_content` filter.
// In the context of generating an excerpt, the Paywall block specifically renders THE_EXCERPT_BLOCK.
if ( strpos( $the_content, \Automattic\Jetpack\Extensions\Paywall\THE_EXCERPT_BLOCK ) ) {
return strstr( $the_content, \Automattic\Jetpack\Extensions\Paywall\THE_EXCERPT_BLOCK, true );
}
}
return $paywalled_content;
}
/**
* Gate access to comments. We want to close comments on private sites.
*
* @param bool $default_comments_open Default state of the comments_open filter.
* @param int $post_id Current post id.
*
* @return bool
*/
function maybe_close_comments( $default_comments_open, $post_id ) {
if ( ! $default_comments_open || ! $post_id ) {
return $default_comments_open;
}
require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php';
return Jetpack_Memberships::user_can_view_post();
}
/**
* Gate access to existing comments
*
* @param string $comment The comment.
*
* @return string
*/
function maybe_gate_existing_comments( $comment ) {
if ( empty( $comment ) ) {
return $comment;
}
require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php';
if ( Jetpack_Memberships::user_can_view_post() ) {
return $comment;
}
return '';
}
/**
* Returns paywall content blocks
*
* @param string $post_access_level The newsletter access level.
* @param string $email_confirmation_pending True if the current user needs to validate their email.
* @return string
*/
function get_paywall_content( $post_access_level, $email_confirmation_pending = false ) {
if ( $email_confirmation_pending ) {
return get_paywall_blocks_subscribe_pending();
}
if ( ! jetpack_is_frontend() ) { // emails
return get_paywall_simple();
}
if ( doing_filter( 'get_the_excerpt' ) ) {
return '';
}
return get_paywall_blocks( $post_access_level );
}
/**
* Returns paywall content blocks if user is not authenticated
*
* @param string $newsletter_access_level The newsletter access level.
* @return string
*/
function get_paywall_blocks( $newsletter_access_level ) {
require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php';
// Only display paid texts when Stripe is connected and the post is marked for paid subscribers
$is_paid_post = $newsletter_access_level === 'paid_subscribers' && Jetpack_Memberships::has_connected_account();
$access_heading = esc_html__( 'Subscribe to continue reading', 'jetpack' );
$subscribe_text = $is_paid_post
// translators: %s is the name of the site.
? esc_html__( 'Become a paid subscriber to get access to the rest of this post and other exclusive content.', 'jetpack' )
// translators: %s is the name of the site.
: esc_html__( 'Subscribe to get access to the rest of this post and other subscriber-only content.', 'jetpack' );
$access_question = $is_paid_post
? __( 'Already a paid subscriber?', 'jetpack' )
: __( 'Already a subscriber?', 'jetpack' );
$sign_in = '';
if ( ! is_user_logged_in() && ( new Host() )->is_wpcom_simple() ) {
$sign_in_link = add_query_arg( 'redirect_to', rawurlencode( get_post_permalink() ), 'https://wordpress.com/log-in/link' );
$sign_in = '<!-- wp:paragraph {"align":"center", "typography":{"fontSize":"14px","fontWeight":"400";"color":"#646970"}} -->
<p class="has-text-align-center" style="font-size:14px;font-weight:400;color:#646970">' . esc_html( $access_question ) . ' <a href="' . $sign_in_link . '" class="jetpack-subscriber-paywall-login" style="font-size:14px;font-weight:400;color:#646970">' . esc_html__( 'Log in', 'jetpack' ) . '</a></p>
<!-- /wp:paragraph -->';
}
$lock_svg = plugins_url( 'images/lock-paywall.svg', JETPACK__PLUGIN_FILE );
return '
<!-- wp:group {"style":{"border":{"width":"1px","radius":"4px"},"spacing":{"padding":{"top":"var:preset|spacing|70","bottom":"var:preset|spacing|70","left":"32px","right":"32px"}}},"borderColor":"primary","className":"jetpack-subscribe-paywall","layout":{"type":"constrained","contentSize":"400px"}} -->
<div class="wp-block-group jetpack-subscribe-paywall has-border-color has-primary-border-color" style="border-width:1px;border-radius:4px;padding-top:var(--wp--preset--spacing--70);padding-right:32px;padding-bottom:var(--wp--preset--spacing--70);padding-left:32px">
<!-- wp:image {"align":"center","width":24,"height":24,"sizeSlug":"large","linkDestination":"none"} -->
<figure class="wp-block-image aligncenter size-large is-resized"><img src="' . $lock_svg . '" alt="" width="24" height="24"/></figure>
<!-- /wp:image -->
<!-- wp:heading {"textAlign":"center","style":{"typography":{"fontStyle":"normal","fontWeight":"600","fontSize":"24px"},"layout":{"selfStretch":"fit"}}} -->
<h2 class="wp-block-heading has-text-align-center" style="font-size:24px;font-style:normal;font-weight:600">' . $access_heading . '</h2>
<!-- /wp:heading -->
<!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"14px"},"spacing":{"margin":{"top":"10px","bottom":"10px"}}}} -->
<p class="has-text-align-center" style="margin-top:10px;margin-bottom:10px;font-size:14px">' . $subscribe_text . '</p>
<!-- /wp:paragraph -->
<!-- wp:jetpack/subscriptions {"borderRadius":50,"borderColor":"primary","className":"is-style-compact"} /-->
' . $sign_in . '
</div>
<!-- /wp:group -->
';
}
/**
* Returns paywall content blocks when email confirmation is pending
*
* @return string
*/
function get_paywall_blocks_subscribe_pending() {
$access_heading = esc_html__( 'Verify your email and continue reading', 'jetpack' );
$subscribe_text = esc_html__( 'Please check your inbox to confirm your subscription.', 'jetpack' );
$lock_svg = plugins_url( 'images/lock-paywall.svg', JETPACK__PLUGIN_FILE );
return '
<!-- wp:group {"style":{"border":{"width":"1px","radius":"4px"},"spacing":{"padding":{"top":"var:preset|spacing|70","bottom":"var:preset|spacing|70","left":"32px","right":"32px"}}},"borderColor":"primary","className":"jetpack-subscribe-paywall","layout":{"type":"constrained","contentSize":"400px"}} -->
<div class="wp-block-group jetpack-subscribe-paywall has-border-color has-primary-border-color" style="border-width:1px;border-radius:4px;padding-top:var(--wp--preset--spacing--70);padding-right:32px;padding-bottom:var(--wp--preset--spacing--70);padding-left:32px">
<!-- wp:image {"align":"center","width":24,"height":24,"sizeSlug":"large","linkDestination":"none"} -->
<figure class="wp-block-image aligncenter size-large is-resized"><img src="' . $lock_svg . '" alt="" width="24" height="24"/></figure>
<!-- /wp:image -->
<!-- wp:heading {"textAlign":"center","style":{"typography":{"fontStyle":"normal","fontWeight":"600","fontSize":"24px", "maxWidth":"initial"},"layout":{"selfStretch":"fit"}}} -->
<h2 class="wp-block-heading has-text-align-center" style="font-size:24px;font-style:normal;font-weight:600;max-width:initial">' . $access_heading . '</h2>
<!-- /wp:heading -->
<!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"14px"},"spacing":{"margin":{"top":"10px","bottom":"10px"}}}} -->
<p class="has-text-align-center" style="margin-top:10px;margin-bottom:10px;font-size:14px">' . $subscribe_text . '</p>
<!-- /wp:paragraph -->
</div>
<!-- /wp:group -->
';
}
/**
* Return content for non frontend views like emails.
*
* @return string
*/
function get_paywall_simple() {
$access_heading = esc_html__( "You're currently a free subscriber. Upgrade your subscription to get access to the rest of this post and other paid-subscriber only content.", 'jetpack' );
$subscribe_text = esc_html__( 'Upgrade subscription', 'jetpack' );
return '
<!-- wp:columns -->
<div class="wp-block-columns" style="display: inline-block; width: 90%">
<!-- wp:column -->
<div class="wp-block-column" style="background-color: #F6F7F7; padding: 32px; 24px;">
<!-- wp:paragraph -->
<p class="has-text-align-center"
style="text-align: center;
color: #50575E;
font-weight: 400;
font-size: 16px;
font-family: \'SF Pro Text\', sans-serif;
line-height: 28.8px;">
' . $access_heading . '
</p>
<!-- /wp:paragraph -->
<!-- wp:buttons -->
<div class="wp-block-buttons" style="text-align: center;">
<!-- wp:button -->
<div class="wp-block-button" style="display: inline-block; margin: 10px 0;">
<a href="' . esc_url( get_post_permalink() ) . '" class="wp-block-button__link wp-element-button"
data-wpcom-track data-tracks-link-desc="paywall-email-click"
style="display: inline-block;
padding: 15px 20px;
background-color: #0675C4;
color: #FFFFFF;
text-decoration: none;
border-radius: 5px;
font-family: \'SF Pro Display\', sans-serif;
font-weight: 500;
font-size: 16px;
text-align: center;">' . $subscribe_text . '</a>
</div>
<!-- /wp:button -->
</div>
<!-- /wp:buttons -->
</div>
<!-- /wp:column -->
</div>
<!-- /wp:columns -->
';
}