2020-06-23 13:49:54 +02:00
< ? php
/**
* Subscriptions Block .
*
2021-04-27 08:32:47 +02:00
* @ package automattic / jetpack
2020-06-23 13:49:54 +02:00
*/
namespace Automattic\Jetpack\Extensions\Subscriptions ;
2020-11-18 09:10:44 +01:00
use Automattic\Jetpack\Blocks ;
2022-12-15 17:41:53 +01:00
use Automattic\Jetpack\Status ;
2020-06-23 13:49:54 +02:00
use Jetpack ;
use Jetpack_Gutenberg ;
2023-04-26 17:39:43 +02:00
use Jetpack_Memberships ;
2022-12-15 17:41:53 +01:00
use Jetpack_Subscriptions_Widget ;
2020-06-23 13:49:54 +02:00
2023-04-26 17:39:43 +02:00
require_once __DIR__ . '/constants.php' ;
2020-06-23 13:49:54 +02:00
2022-12-15 17:41:53 +01:00
/**
* 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 ;
2020-06-23 13:49:54 +02:00
/**
* 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 () {
if (
2020-09-15 14:30:05 +02:00
( defined ( 'IS_WPCOM' ) && IS_WPCOM )
2023-04-26 17:39:43 +02:00
|| ( Jetpack :: is_connection_ready () && ! ( new Status () ) -> is_offline_mode () )
2020-06-23 13:49:54 +02:00
) {
2020-11-18 09:10:44 +01:00
Blocks :: jetpack_register_block (
2020-06-23 13:49:54 +02:00
BLOCK_NAME ,
2022-04-02 10:26:41 +02:00
array (
'render_callback' => __NAMESPACE__ . '\render_block' ,
'supports' => array (
'spacing' => array (
'margin' => true ,
'padding' => true ,
),
'align' => array ( 'wide' , 'full' ),
),
)
2020-06-23 13:49:54 +02:00
);
}
2023-04-26 17:39:43 +02:00
/*
* If the Subscriptions module is not active ,
* do not make any further changes on the site .
*/
if ( ! Jetpack :: is_module_active ( 'subscriptions' ) ) {
return ;
}
2023-05-23 23:18:12 +02:00
/**
* Do not proceed if the newsletter feature is not enabled
* or if the 'Jetpack_Memberships' class does not exists .
*/
if (
/** This filter is documented in class.jetpack-gutenberg.php */
! apply_filters ( 'jetpack_subscriptions_newsletter_feature_enabled' , false )
|| ! class_exists ( '\Jetpack_Memberships' )
) {
return ;
2023-04-26 17:39:43 +02:00
}
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
add_action ( 'the_content' , __NAMESPACE__ . '\maybe_get_locked_content' );
// 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 );
2020-06-23 13:49:54 +02:00
}
2021-07-23 11:58:50 +02:00
add_action ( 'init' , __NAMESPACE__ . '\register_block' , 9 );
2020-06-23 13:49:54 +02:00
2022-12-15 17:41:53 +01:00
/**
* Returns true when in a WP . com environment .
*
* @ return boolean
*/
function is_wpcom () {
return defined ( 'IS_WPCOM' ) && IS_WPCOM ;
}
2023-01-25 20:43:46 +01:00
/**
2023-05-23 23:18:12 +02:00
* Determine the amount of folks currently subscribed to the blog , splitted out in email_subscribers & social_followers & paid_subscribers
2023-01-25 20:43:46 +01:00
*
2023-05-23 23:18:12 +02:00
* @ return array containing [ 'value' => [ 'email_subscribers' => 0 , 'paid_subscribers' => 0 , 'social_followers' => 0 ]]
2023-01-25 20:43:46 +01:00
*/
function fetch_subscriber_counts () {
$subs_count = 0 ;
if ( is_wpcom () ) {
$subs_count = array (
2023-05-23 23:18:12 +02:00
'value' => \wpcom_fetch_subs_counts ( false ),
2023-01-25 20:43:46 +01:00
);
} 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 ,
),
);
} 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 ;
}
2022-12-15 17:41:53 +01:00
/**
* 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' => join ( ' ' , array_keys ( $block_wrapper_classes ) ),
'email_field' => join ( ' ' , array_keys ( $email_field_classes ) ),
'submit_button' => join ( ' ' , 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' )
2023-01-25 20:43:46 +01:00
? sprintf ( 'width: calc(100%% - %dpx);' , get_attribute ( $attributes , 'spacing' , DEFAULT_SPACING_VALUE ) )
2022-12-15 17:41:53 +01:00
: '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 ;
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 ;
}
return array (
'email_field' => $email_field_styles ,
'submit_button' => $submit_button_styles ,
'submit_button_wrapper' => $submit_button_wrapper_styles ,
);
}
2020-06-23 13:49:54 +02:00
/**
* Subscriptions block render callback .
*
2023-04-26 17:39:43 +02:00
* @ param array $attributes Array containing the block attributes .
2020-06-23 13:49:54 +02:00
*
* @ return string
*/
2023-04-26 17:39:43 +02:00
function render_block ( $attributes ) {
// If the Subscriptions module is not active, don't render the block.
if ( ! Jetpack :: is_module_active ( 'subscriptions' ) ) {
return '' ;
}
2023-05-23 23:18:12 +02:00
if ( Jetpack_Gutenberg :: is_newsletter_configured () ) {
2023-04-26 17:39:43 +02:00
// 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 );
}
2020-06-23 13:49:54 +02:00
2022-12-15 17:41:53 +01:00
$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.
2023-04-26 17:39:43 +02:00
++ Jetpack_Subscriptions_Widget :: $instance_count ;
2022-12-15 17:41:53 +01:00
2023-01-25 20:43:46 +01:00
$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 ;
2022-12-15 17:41:53 +01:00
$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' ),
2023-01-25 20:43:46 +01:00
'subscribers_total' => get_subscriber_count ( $include_social_followers ),
2022-12-15 17:41:53 +01:00
'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' ,
);
if ( is_wpcom () ) {
return render_wpcom_subscribe_form ( $data , $classes , $styles );
}
return render_jetpack_subscribe_form ( $data , $classes , $styles );
}
2023-04-26 17:39:43 +02:00
/**
* Generates the source parameter to pass to the iframe
*
* @ return string the actual post access level ( see projects / plugins / jetpack / extensions / blocks / subscriptions / settings . js for the values ) .
*/
function get_post_access_level () {
2023-05-23 23:18:12 +02:00
if ( ! is_singular () ) {
// There is no "actual" current post.
return 'everybody' ;
}
2023-04-26 17:39:43 +02:00
$post_id = get_the_ID ();
if ( ! $post_id ) {
return 'everybody' ;
}
$meta = get_post_meta ( $post_id , META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS , true );
if ( empty ( $meta ) ) {
$meta = 'everybody' ;
}
return $meta ;
}
2022-12-15 17:41:53 +01:00
/**
* 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' ],
)
);
2023-04-26 17:39:43 +02:00
$post_access_level = get_post_access_level ();
2022-12-15 17:41:53 +01:00
?>
< 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 "
2023-04-26 17:39:43 +02:00
data - blog = " <?php echo esc_attr( get_current_blog_id() ); ?> "
data - post_access_level = " <?php echo esc_attr( $post_access_level ); ?> "
2022-12-15 17:41:53 +01:00
id = " <?php echo esc_attr( $form_id ); ?> "
>
< ? 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
2023-04-26 17:39:43 +02:00
required = " required "
2022-12-15 17:41:53 +01:00
type = " email "
name = " email "
% 1 $s
style = " %2 $s "
placeholder = " %3 $s "
2023-04-26 17:39:43 +02:00
value = " %4 $s "
id = " %5 $s "
2022-12-15 17:41:53 +01:00
/> ' ,
( ! 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' ] ),
2023-04-26 17:39:43 +02:00
esc_attr ( $data [ 'subscribe_email' ] ),
2022-12-15 17:41:53 +01:00
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 (
2023-01-25 20:43:46 +01:00
html_entity_decode ( $data [ 'submit_button_text' ], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ),
2022-12-15 17:41:53 +01:00
Jetpack_Subscriptions_Widget :: $allowed_html_tags_for_submit_button
);
?>
</ button >
</ p >
</ 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' ],
)
);
2023-04-26 17:39:43 +02:00
$blog_id = \Jetpack_Options :: get_option ( 'id' );
$post_access_level = get_post_access_level ();
2022-12-15 17:41:53 +01:00
?>
< div < ? php echo wp_kses_data ( $data [ 'wrapper_attributes' ] ); ?> >
< div class = " jetpack_subscription_widget " >
< div class = " wp-block-jetpack-subscriptions__container " >
2023-04-26 17:39:43 +02:00
< 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 ); ?> "
>
2022-12-15 17:41:53 +01:00
< 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 " />
2023-04-26 17:39:43 +02:00
< input type = " hidden " name = " blog_id " value = " <?php echo (int) $blog_id ; ?> " />
2022-12-15 17:41:53 +01:00
< 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 (
2023-01-25 20:43:46 +01:00
html_entity_decode ( $data [ 'submit_button_text' ], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ),
2022-12-15 17:41:53 +01:00
Jetpack_Subscriptions_Widget :: $allowed_html_tags_for_submit_button
);
?>
</ button >
</ p >
</ 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 */
2023-01-25 20:43:46 +01:00
echo esc_html ( sprintf ( _n ( 'Join %s other subscriber' , 'Join %s other subscribers' , $data [ 'subscribers_total' ], 'jetpack' ), number_format_i18n ( $data [ 'subscribers_total' ] ) ) );
2022-12-15 17:41:53 +01:00
?>
</ div >
< ? php endif ; ?>
</ div >
</ div >
</ div >
< ? php
return ob_get_clean ();
2020-06-23 13:49:54 +02:00
}
2023-04-26 17:39:43 +02:00
/**
* 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 maybe_get_locked_content ( $the_content ) {
require_once JETPACK__PLUGIN_DIR . 'modules/memberships/class-jetpack-memberships.php' ;
if ( Jetpack_Memberships :: user_can_view_post () ) {
return $the_content ;
}
2023-05-23 23:18:12 +02:00
$newsletter_access_level = Jetpack_Memberships :: get_newsletter_access_level ();
return get_locked_content_placeholder_text ( $newsletter_access_level );
2023-04-26 17:39:43 +02:00
}
/**
* 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 exisiting 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 '' ;
}
/**
* Placeholder text for non - subscribers
*
2023-05-23 23:18:12 +02:00
* @ param string $newsletter_access_level The newsletter access level .
2023-04-26 17:39:43 +02:00
* @ return string
*/
2023-05-23 23:18:12 +02:00
function get_locked_content_placeholder_text ( $newsletter_access_level ) {
// Default to subscribers
$access_level = __ ( 'subscribers' , 'jetpack' );
// Only display this text when Stripe is connected and the post is marked for paid subscribers
if (
$newsletter_access_level === 'paid_subscribers'
&& ! empty ( \Jetpack_Memberships :: get_connected_account_id () )
) {
$access_level = __ ( 'paid subscribers' , 'jetpack' );
}
2023-04-26 17:39:43 +02:00
return do_blocks (
' <!-- wp : group { " style " : { " spacing " : { " padding " : { " top " : " var:preset|spacing|80 " , " right " : " var:preset|spacing|80 " , " bottom " : " var:preset|spacing|80 " , " left " : " var:preset|spacing|80 " }}, " border " : { " width " : " 1px " , " radius " : " 4px " }}, " borderColor " : " primary " , " layout " : { " type " : " constrained " , " contentSize " : " 400px " }} -->
< div class = " wp-block-group has-border-color has-primary-border-color " style = " border-width:1px;border-radius:4px;padding-top:var(--wp--preset--spacing--80);padding-right:var(--wp--preset--spacing--80);padding-bottom:var(--wp--preset--spacing--80);padding-left:var(--wp--preset--spacing--80) " ><!-- wp : heading { " textAlign " : " center " , " style " : { " typography " : { " fontSize " : " 24px " }, " spacing " : { " margin " : { " bottom " : " var:preset|spacing|60 " }}}} -->
2023-05-23 23:18:12 +02:00
< h2 class = " wp-block-heading has-text-align-center " style = " margin-bottom:var(--wp--preset--spacing--60);font-size:24px " > ' .
/* translators: Newsletter access. Possible values are "paid newsletters" and "subscribers" */
sprintf ( esc_html__ ( 'This post is for %s' , 'jetpack' ), $access_level )
. ' </ h2 >
2023-04-26 17:39:43 +02:00
<!-- / wp : heading -->
<!-- wp : jetpack / subscriptions { " borderRadius " : 50 , " borderColor " : " primary " , " className " : " is-style-compact " } /-->
</ div >
<!-- / wp : group --> '
);
}