This commit is contained in:
emmymayo
2025-02-05 23:15:46 +01:00
commit 7269c99357
16995 changed files with 3389680 additions and 0 deletions
@@ -0,0 +1,36 @@
<?php
/**
* The Subscriptions settings.
*
* This is a class that contains helper functions for the Subscriptions settings module.
*
* @package automattic/jetpack-subscriptions
*/
namespace Automattic\Jetpack\Modules\Subscriptions;
/**
* Class Settings
*/
class Settings {
/**
* The default reply-to option.
*
* @var string
*/
public static $default_reply_to = 'comment';
/**
* Validate the reply-to option.
*
* @param string $reply_to The reply-to option to validate.
* @return bool Whether the reply-to option is valid or not.
*/
public static function is_valid_reply_to( $reply_to ) {
$valid_values = array( 'author', 'no-reply', 'comment' );
if ( in_array( $reply_to, $valid_values, true ) ) {
return true;
}
return false;
}
}
@@ -0,0 +1,79 @@
<?php
/**
* User Content Link Redirection
*
* The purpose of this file is to track and redirect user content links in emails.
* This renders an iframe pointing to subscribe.wordpress.com which will track and
* return the destination url for the iframe parent to redirect to.
*
* @package automattic/jetpack
*/
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
/**
* Render a page with an iframe to track and redirect user content links in emails.
*
* Hooked to the `init` action, this function renders a page with an iframe pointing to
* subscribe.wordpress.com to track and return the destination URL for redirection.
*
* Redirects to the site's home page if required parameters are missing.
* Returns a 400 error if the request's `blog_id` doesn't match the actual `blog_id`.
*
* @return never
*/
function jetpack_user_content_link_redirection() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( empty( $_SERVER['QUERY_STRING'] ) || empty( $_SERVER['HTTP_HOST'] ) || empty( $_GET['blog_id'] ) ) {
wp_safe_redirect( get_home_url() );
exit( 0 );
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$request_blog_id = intval( sanitize_text_field( wp_unslash( $_GET['blog_id'] ) ) );
$actual_blog_id = Connection_Manager::get_site_id( true );
if ( $actual_blog_id !== $request_blog_id ) {
wp_die( esc_html__( 'Invalid link.', 'jetpack' ), 400 );
exit( 0 );
}
$query_params = sanitize_text_field( wp_unslash( $_SERVER['QUERY_STRING'] ) );
$iframe_url = "https://subscribe.wordpress.com/?$query_params";
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
echo <<<EOF
<!DOCTYPE html>
<html>
<head>
<script>
let messageReceived = false;
window.addEventListener( 'message', function(event) {
if ( event.origin !== 'https://subscribe.wordpress.com' || messageReceived ) {
return;
}
if ( event.data.redirectUrl ) {
messageReceived = true;
window.location.href = event.data.redirectUrl;
}
} );
</script>
</head>
<body>
EOF;
echo '<iframe id="user-content-link-redirection" hidden aria-hidden="true" tabindex="-1" width="0" height="0" style="display: none" src="' . esc_url( $iframe_url ) . '"></iframe>';
echo <<<EOF
</body>
</html>
EOF;
// phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped
exit( 0 );
}
// The WPCOM_USER_CONTENT_LINK_REDIRECTION flag prevents this redirection logic from running
// on Atomic in case we'd like to override the redirection logic on the Atomic end.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! defined( 'WPCOM_USER_CONTENT_LINK_REDIRECTION' ) && isset( $_GET['action'] ) && $_GET['action'] === 'user_content_redirect' ) {
add_action( 'init', 'jetpack_user_content_link_redirection' );
}
@@ -0,0 +1,12 @@
## Assets for Subscriptions
### subscriptions.css
CSS required to render the subscription widget
### views.php
This file handles the registration of various subscriptions
views, i.e. a widget and a block for the post editor.
This file is shared with wordpress.com
@@ -0,0 +1,196 @@
<?php
/**
* Adds support for Jetpack floating Subscribe button feature
*
* @package automattic/jetpack-subscriptions
* @since 14.0
*/
/**
* Jetpack_Subscribe_Floating_Button class.
*/
class Jetpack_Subscribe_Floating_Button {
/**
* Jetpack_Subscribe_Floating_Button singleton instance.
*
* @var Jetpack_Subscribe_Floating_Button|null
*/
private static $instance;
/**
* Jetpack_Subscribe_Floating_Button instance init.
*/
public static function init() {
if ( self::$instance === null ) {
self::$instance = new Jetpack_Subscribe_Floating_Button();
}
return self::$instance;
}
const BLOCK_TEMPLATE_PART_SLUG = 'jetpack-subscribe-floating-button';
/**
* Jetpack_Subscribe_Floating_Button class constructor.
*/
public function __construct() {
if ( get_option( 'jetpack_subscribe_floating_button_enabled', false ) ) {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_assets' ) );
add_action( 'wp_footer', array( $this, 'add_subscribe_floating_button_to_frontend' ) );
}
add_filter( 'get_block_template', array( $this, 'get_block_template_filter' ), 10, 3 );
add_filter(
'jetpack_options_whitelist',
function ( $options ) {
$options[] = 'jetpack_subscribe_floating_button_enabled';
return $options;
}
);
}
/**
* Returns the block template part ID.
*
* @return string
*/
public static function get_block_template_part_id() {
return get_stylesheet() . '//' . self::BLOCK_TEMPLATE_PART_SLUG;
}
/**
* Makes get_block_template return the WP_Block_Template for the floating Subscribe button.
*
* @param WP_Block_Template $block_template The block template to be returned.
* @param string $id Template unique identifier (example: theme_slug//template_slug).
* @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
*
* @return WP_Block_Template|null
*/
public function get_block_template_filter( $block_template, $id, $template_type ) {
if ( empty( $block_template ) && $template_type === 'wp_template_part' ) {
if ( $id === self::get_block_template_part_id() ) {
return $this->get_template();
}
}
return $block_template;
}
/**
* Returns a custom template for the floating Subscribe button.
*
* @return WP_Block_Template
*/
public function get_template() {
$template = new WP_Block_Template();
$template->theme = get_stylesheet();
$template->slug = self::BLOCK_TEMPLATE_PART_SLUG;
$template->id = self::get_block_template_part_id();
$template->area = 'uncategorized';
$template->content = $this->get_floating_subscribe_button_template_content();
$template->source = 'plugin';
$template->type = 'wp_template_part';
$template->title = __( 'Jetpack Subscribe floating button', 'jetpack' );
$template->status = 'publish';
$template->has_theme_file = false;
$template->is_custom = true;
$template->description = __( 'A floating subscribe button that shows up when someone visits your site.', 'jetpack' );
return $template;
}
/**
* Returns the initial content of the floating Subscribe button template.
* This can then be edited by the user.
*
* @return string
*/
public function get_floating_subscribe_button_template_content() {
$block_name = esc_attr__( 'Floating subscribe button', 'jetpack' );
return '<!-- wp:jetpack/subscriptions {"className":"is-style-button","appSource":"subscribe-floating-button","lock":{"move":false,"remove":true},"style":{"spacing":{"margin":{"right":"20px","left":"20px","top":"20px","bottom":"20px"}}},"metadata":{"name":"' . $block_name . '"}} /-->';
}
/**
* Enqueues styles.
*
* @return void
*/
public function enqueue_assets() {
if ( $this->should_user_see_floating_button() ) {
wp_enqueue_style( 'subscribe-floating-button-css', plugins_url( 'subscribe-floating-button.css', __FILE__ ), array(), JETPACK__VERSION );
// Disables WP.com action bar as the features collide/overlap
add_filter( 'wpcom_disable_logged_out_follow', '__return_true', 10, 1 );
}
}
/**
* Adds floating Subscribe button HTML wrapper
*
* @return void
*/
public function add_subscribe_floating_button_to_frontend() {
if ( $this->should_user_see_floating_button() ) { ?>
<div class="jetpack-subscribe-floating-button">
<?php block_template_part( self::BLOCK_TEMPLATE_PART_SLUG ); ?>
</div>
<?php
}
}
/**
* Returns true if a site visitor should see
* the floating Subscribe button.
*
* @return bool
*/
public function should_user_see_floating_button() {
// Only show when viewing frontend.
if ( is_admin() ) {
return false;
}
// Needed because Elementor editor makes is_admin() return false
// See https://coreysalzano.com/wordpress/why-elementor-disobeys-is_admin/
// Ignore nonce warning as just checking if is set
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['elementor-preview'] ) ) {
return false;
}
// Don't show when previewing blog posts or site's theme
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['preview'] ) || isset( $_GET['theme_preview'] ) || isset( $_GET['customize_preview'] ) || isset( $_GET['hide_banners'] ) ) {
return false;
}
// Don't show if one of subscribe query params is set.
// They are set when user submits the subscribe form.
// The nonce is checked elsewhere before redirect back to this page with query params.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['subscribe'] ) || isset( $_GET['blogsub'] ) ) {
return false;
}
// Don't show if user is subscribed to blog.
require_once __DIR__ . '/../views.php';
if ( ! class_exists( 'Jetpack_Memberships' ) || Jetpack_Memberships::is_current_user_subscribed() ) {
return false;
}
return true;
}
}
Jetpack_Subscribe_Floating_Button::init();
add_action(
'rest_api_switched_to_blog',
function () {
Jetpack_Subscribe_Floating_Button::init();
}
);
@@ -0,0 +1,12 @@
.jetpack-subscribe-floating-button {
position: fixed;
z-index: 50000; /* Same as WP.com Action bar */
bottom: 0;
right: 0;
}
@media screen and (max-width: 640px) {
.jetpack-subscribe-floating-button {
display: none;
}
}
@@ -0,0 +1,265 @@
<?php
/**
* Adds support for Jetpack Subscribe Modal feature
*
* @package automattic/jetpack-mu-wpcom
* @since 12.4
*/
use Automattic\Jetpack\Extensions\Premium_Content\Subscription_Service\Abstract_Token_Subscription_Service;
use const Automattic\Jetpack\Extensions\Subscriptions\META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS;
/**
* Jetpack_Subscribe_Modal class.
*/
class Jetpack_Subscribe_Modal {
/**
* Jetpack_Subscribe_Modal singleton instance.
*
* @var Jetpack_Subscribe_Modal|null
*/
private static $instance;
/**
* Jetpack_Subscribe_Modal instance init.
*/
public static function init() {
if ( self::$instance === null ) {
self::$instance = new Jetpack_Subscribe_Modal();
}
return self::$instance;
}
const BLOCK_TEMPLATE_PART_SLUG = 'jetpack-subscribe-modal';
/**
* Returns the block template part ID.
*
* @return string
*/
public static function get_block_template_part_id() {
return get_stylesheet() . '//' . self::BLOCK_TEMPLATE_PART_SLUG;
}
/**
* Jetpack_Subscribe_Modal class constructor.
*/
public function __construct() {
if ( get_option( 'sm_enabled', false ) ) {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_assets' ) );
add_action( 'wp_footer', array( $this, 'add_subscribe_modal_to_frontend' ) );
}
add_filter( 'get_block_template', array( $this, 'get_block_template_filter' ), 10, 3 );
}
/**
* Enqueues JS to load modal.
*
* @return void
*/
public function enqueue_assets() {
if ( $this->should_user_see_modal() ) {
wp_enqueue_style( 'subscribe-modal-css', plugins_url( 'subscribe-modal.css', __FILE__ ), array(), JETPACK__VERSION );
wp_enqueue_script( 'subscribe-modal-js', plugins_url( 'subscribe-modal.js', __FILE__ ), array( 'wp-dom-ready' ), JETPACK__VERSION, true );
/**
* Filter how many milliseconds until the Subscribe Modal appears.
*
* @module subscriptions
*
* @since 13.4
*
* @param int 60000 Time in milliseconds for the Subscribe Modal to appear.
*/
$load_time = absint( apply_filters( 'jetpack_subscribe_modal_load_time', 60000 ) );
/**
* Filter how many percentage of the page should be scrolled before the Subscribe Modal appears.
*
* @module subscriptions
*
* @since 13.6
*
* @param int Percentage of the page scrolled before the Subscribe Modal appears.
*/
$scroll_threshold = absint( apply_filters( 'jetpack_subscribe_modal_scroll_threshold', 50 ) );
/**
* Filter to control the interval at which the subscribe modal is shown to the same user. The default interval is 24 hours.
*
* @since 13.7
*
* @param int 24 Hours before we show the same user the Subscribe Modal to again.
*/
$modal_interval = absint( apply_filters( 'jetpack_subscribe_modal_interval', 24 ) );
wp_localize_script(
'subscribe-modal-js',
'Jetpack_Subscriptions',
array(
'modalLoadTime' => $load_time,
'modalScrollThreshold' => $scroll_threshold,
'modalInterval' => ( $modal_interval * HOUR_IN_SECONDS * 1000 ),
)
);
}
}
/**
* Adds modal with Subscribe Modal content.
*
* @return void
*/
public function add_subscribe_modal_to_frontend() {
if ( $this->should_user_see_modal() ) { ?>
<div class="jetpack-subscribe-modal">
<div class="jetpack-subscribe-modal__modal-content">
<?php block_template_part( self::BLOCK_TEMPLATE_PART_SLUG ); ?>
</div>
</div>
<?php
}
}
/**
* Makes get_block_template return the WP_Block_Template for the Subscribe Modal.
*
* @param WP_Block_Template $block_template The block template to be returned.
* @param string $id Template unique identifier (example: theme_slug//template_slug).
* @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
*
* @return WP_Block_Template
*/
public function get_block_template_filter( $block_template, $id, $template_type ) {
if ( empty( $block_template ) && $template_type === 'wp_template_part' ) {
if ( $id === self::get_block_template_part_id() ) {
return $this->get_template();
}
}
return $block_template;
}
/**
* Returns a custom template for the Subscribe Modal.
*
* @return WP_Block_Template
*/
public function get_template() {
$template = new WP_Block_Template();
$template->theme = get_stylesheet();
$template->slug = self::BLOCK_TEMPLATE_PART_SLUG;
$template->id = self::get_block_template_part_id();
$template->area = 'uncategorized';
$template->content = $this->get_subscribe_template_content();
$template->source = 'plugin';
$template->type = 'wp_template_part';
$template->title = __( 'Jetpack Subscribe modal', 'jetpack' );
$template->status = 'publish';
$template->has_theme_file = false;
$template->is_custom = true;
$template->description = __( 'A subscribe form that pops up when someone visits your site.', 'jetpack' );
return $template;
}
/**
* Returns the initial content of the Subscribe Modal template.
* This can then be edited by the user.
*
* @return string
*/
public function get_subscribe_template_content() {
// translators: %s is the name of the site.
$discover_more_from = sprintf( __( 'Discover more from %s', 'jetpack' ), get_bloginfo( 'name' ) );
$continue_reading = __( 'Continue reading', 'jetpack' );
$subscribe_text = __( 'Subscribe now to keep reading and get access to the full archive.', 'jetpack' );
$group_block_name = esc_attr__( 'Subscription pop-up container', 'jetpack' );
return <<<HTML
<!-- wp:group {"metadata":{"name":"$group_block_name"},"style":{"spacing":{"padding":{"top":"32px","bottom":"32px","left":"32px","right":"32px"},"margin":{"top":"0","bottom":"0"}},"border":{"color":"#dddddd","width":"1px"}},"layout":{"type":"constrained","contentSize":"450px"}} -->
<div class="wp-block-group has-border-color" style="border-color:#dddddd;border-width:1px;margin-top:0;margin-bottom:0;padding-top:32px;padding-right:32px;padding-bottom:32px;padding-left:32px">
<!-- wp:heading {"textAlign":"center","style":{"typography":{"fontStyle":"normal","fontWeight":"600","fontSize":"26px"},"layout":{"selfStretch":"fit","flexSize":null},"spacing":{"margin":{"top":"4px","bottom":"10px"}}}} -->
<h2 class="wp-block-heading has-text-align-center" style="margin-top:4px;margin-bottom:10px;font-size:26px;font-style:normal;font-weight:600">$discover_more_from</h2>
<!-- /wp:heading -->
<!-- wp:paragraph {"align":"center","style":{"typography":{"fontSize":"15px"},"spacing":{"margin":{"top":"4px","bottom":"0px"}}}} -->
<p class='has-text-align-center' style='margin-top:4px;margin-bottom:1em;font-size:15px'>$subscribe_text</p>
<!-- /wp:paragraph -->
<!-- wp:jetpack/subscriptions {"borderRadius":50,"className":"is-style-compact","appSource":"subscribe-modal"} /-->
<!-- wp:paragraph {"align":"center","style":{"spacing":{"margin":{"top":"20px"}},"typography":{"fontSize":"14px"}},"className":"jetpack-subscribe-modal__close"} -->
<p class="has-text-align-center jetpack-subscribe-modal__close" style="margin-top:20px;margin-bottom:0;font-size:14px"><a href="#">$continue_reading</a></p>
<!-- /wp:paragraph -->
</div>
<!-- /wp:group -->
HTML;
}
/**
* Returns true if a site visitor should see
* the Subscribe Modal.
*
* @return bool
*/
public function should_user_see_modal() {
// Only show when viewing frontend single post.
if ( is_admin() || ! is_singular( 'post' ) ) {
return false;
}
// Needed because Elementor editor makes is_admin() return false
// See https://coreysalzano.com/wordpress/why-elementor-disobeys-is_admin/
// Ignore nonce warning as just checking if is set
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['elementor-preview'] ) ) {
return false;
}
// Don't show when previewing blog posts or site's theme
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['preview'] ) || isset( $_GET['theme_preview'] ) || isset( $_GET['customize_preview'] ) || isset( $_GET['hide_banners'] ) ) {
return false;
}
// Don't show if one of subscribe query params is set.
// They are set when user submits the subscribe form.
// The nonce is checked elsewhere before redirect back to this page with query params.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['subscribe'] ) || isset( $_GET['blogsub'] ) ) {
return false;
}
// Don't show if post is for subscribers only or has paywall block
global $post;
if ( defined( 'Automattic\\Jetpack\\Extensions\\Subscriptions\\META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS' ) ) {
$access_level = get_post_meta( $post->ID, META_NAME_FOR_POST_LEVEL_ACCESS_SETTINGS, true );
} else {
$access_level = get_post_meta( $post->ID, '_jetpack_newsletter_access', true );
}
require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
$is_accessible_by_everyone = Abstract_Token_Subscription_Service::POST_ACCESS_LEVEL_EVERYBODY === $access_level || empty( $access_level );
if ( ! $is_accessible_by_everyone ) {
return false;
}
// Don't show if user is subscribed to blog.
require_once __DIR__ . '/../views.php';
if ( ! class_exists( 'Jetpack_Memberships' ) || Jetpack_Memberships::is_current_user_subscribed() ) {
return false;
}
return true;
}
}
Jetpack_Subscribe_Modal::init();
add_action(
'rest_api_switched_to_blog',
function () {
Jetpack_Subscribe_Modal::init();
}
);
@@ -0,0 +1,57 @@
body.jetpack-subscribe-modal-open {
overflow: hidden;
}
.jetpack-subscribe-modal {
visibility: hidden;
position: fixed;
z-index: 50000; /* Same as WP.com Action bar */
left: 0;
top: 0;
width: 100%;
height: 100%;
overflow: auto;
background-color: transparent;
transition: all 0.4s;
}
.jetpack-subscribe-modal.open {
background-color: rgba(0,0,0,0.3);
visibility: visible;
}
.jetpack-subscribe-modal__modal-content {
position: relative;
visibility: hidden;
overflow: hidden;
top: 100%;
background-color: #fefefe;
margin: 15% auto;
width: 100%;
max-width: 600px;
border-radius: 10px;
box-sizing: border-box;
transition: all 0.4s;
text-wrap: balance;
}
.jetpack-subscribe-modal.open .jetpack-subscribe-modal__modal-content {
top: 0;
visibility: visible;
}
/*
* These text-wrap properties still have limited browser
* support, but based on feedback still adding them for when
* they are supported.
*/
.jetpack-subscribe-modal__modal-content p {
text-wrap: balance;
text-wrap: pretty;
}
@media screen and (max-width: 640px) {
.jetpack-subscribe-modal__modal-content {
width: 94%;
}
}
@@ -0,0 +1,123 @@
/* global Jetpack_Subscriptions */
const { domReady } = wp;
domReady( () => {
const modal = document.querySelector( '.jetpack-subscribe-modal' );
const modalDismissedCookie = 'jetpack_post_subscribe_modal_dismissed';
const skipUrlParam = 'jetpack_skip_subscription_popup';
function hasEnoughTimePassed() {
const lastDismissed = localStorage.getItem( modalDismissedCookie );
return lastDismissed ? Date.now() - lastDismissed > Jetpack_Subscriptions.modalInterval : true;
}
// Subscriber ended up here e.g. from emails:
// we won't show the modal to them in future since they most likely are already a subscriber.
function skipModal() {
const url = new URL( window.location.href );
if ( url.searchParams.has( skipUrlParam ) ) {
url.searchParams.delete( skipUrlParam );
window.history.replaceState( {}, '', url );
storeCloseTimestamp();
return true;
}
return false;
}
if ( ! modal || ! hasEnoughTimePassed() || skipModal() ) {
return;
}
const modalLoadTimeout = setTimeout( openModal, Jetpack_Subscriptions.modalLoadTime );
const targetElement = (
document.querySelector( '.entry-content' ) || document.documentElement
).getBoundingClientRect();
function hasPassedScrollThreshold() {
const scrollPosition = window.scrollY + window.innerHeight / 2;
const scrollPositionThreshold =
targetElement.top +
( targetElement.height * Jetpack_Subscriptions.modalScrollThreshold ) / 100;
return scrollPosition > scrollPositionThreshold;
}
function onScroll() {
requestAnimationFrame( () => {
if ( hasPassedScrollThreshold() ) {
openModal();
}
} );
}
window.addEventListener( 'scroll', onScroll, { passive: true } );
// This take care of the case where the user has multiple tabs open.
function onLocalStorage( event ) {
if ( event.key === modalDismissedCookie ) {
closeModal();
removeEventListeners();
}
}
window.addEventListener( 'storage', onLocalStorage );
// When the form is submitted, and next modal loads, it'll fire "subscription-modal-loaded" signalling that this form can be hidden.
const form = modal.querySelector( 'form' );
if ( form ) {
form.addEventListener( 'subscription-modal-loaded', closeModal );
}
// User can edit modal, and could remove close link.
function onCloseButtonClick( event ) {
event.preventDefault();
closeModal();
}
const close = document.getElementsByClassName( 'jetpack-subscribe-modal__close' )[ 0 ];
if ( close ) {
close.addEventListener( 'click', onCloseButtonClick );
}
function closeOnWindowClick( event ) {
if ( event.target === modal ) {
closeModal();
}
}
function closeModalOnEscapeKeydown( event ) {
if ( event.key === 'Escape' ) {
closeModal();
}
}
function openModal() {
// If the user is typing in a form, don't open the modal or has anything else focused.
if ( document.activeElement && document.activeElement.tagName !== 'BODY' ) {
return;
}
modal.classList.add( 'open' );
document.body.classList.add( 'jetpack-subscribe-modal-open' );
window.addEventListener( 'keydown', closeModalOnEscapeKeydown );
window.addEventListener( 'click', closeOnWindowClick );
removeEventListeners();
}
function closeModal() {
modal.classList.remove( 'open' );
document.body.classList.remove( 'jetpack-subscribe-modal-open' );
window.removeEventListener( 'keydown', closeModalOnEscapeKeydown );
window.removeEventListener( 'storage', onLocalStorage );
window.removeEventListener( 'click', closeOnWindowClick );
storeCloseTimestamp();
}
// Remove all event listeners. That would add the modal again.
function removeEventListeners() {
window.removeEventListener( 'scroll', onScroll );
clearTimeout( modalLoadTimeout );
}
function storeCloseTimestamp() {
localStorage.setItem( modalDismissedCookie, Date.now() );
}
} );
@@ -0,0 +1,224 @@
<?php
/**
* Adds support for Jetpack Subscribe Overlay feature
*
* @package automattic/jetpack-subscriptions
* @since 13.5
*/
/**
* Jetpack_Subscribe_Overlay class.
*/
class Jetpack_Subscribe_Overlay {
/**
* Jetpack_Subscribe_Overlay singleton instance.
*
* @var Jetpack_Subscribe_Overlay|null
*/
private static $instance;
/**
* Jetpack_Subscribe_Overlay instance init.
*/
public static function init() {
if ( self::$instance === null ) {
self::$instance = new Jetpack_Subscribe_Overlay();
}
return self::$instance;
}
const BLOCK_TEMPLATE_PART_SLUG = 'jetpack-subscribe-overlay';
/**
* Jetpack_Subscribe_Overlay class constructor.
*/
public function __construct() {
if ( get_option( 'jetpack_subscribe_overlay_enabled', false ) ) {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_assets' ) );
add_action( 'wp_footer', array( $this, 'add_subscribe_overlay_to_frontend' ) );
}
add_filter( 'get_block_template', array( $this, 'get_block_template_filter' ), 10, 3 );
add_filter(
'jetpack_options_whitelist',
function ( $options ) {
$options[] = 'jetpack_subscribe_overlay_enabled';
return $options;
}
);
}
/**
* Returns the block template part ID.
*
* @return string
*/
public static function get_block_template_part_id() {
return get_stylesheet() . '//' . self::BLOCK_TEMPLATE_PART_SLUG;
}
/**
* Makes get_block_template return the WP_Block_Template for the Subscribe Overlay.
*
* @param WP_Block_Template $block_template The block template to be returned.
* @param string $id Template unique identifier (example: theme_slug//template_slug).
* @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
*
* @return WP_Block_Template|null
*/
public function get_block_template_filter( $block_template, $id, $template_type ) {
if ( empty( $block_template ) && $template_type === 'wp_template_part' ) {
if ( $id === self::get_block_template_part_id() ) {
return $this->get_template();
}
}
return $block_template;
}
/**
* Returns a custom template for the Subscribe Overlay.
*
* @return WP_Block_Template
*/
public function get_template() {
$template = new WP_Block_Template();
$template->theme = get_stylesheet();
$template->slug = self::BLOCK_TEMPLATE_PART_SLUG;
$template->id = self::get_block_template_part_id();
$template->area = 'uncategorized';
$template->content = $this->get_subscribe_overlay_template_content();
$template->source = 'plugin';
$template->type = 'wp_template_part';
$template->title = __( 'Jetpack Subscribe overlay', 'jetpack' );
$template->status = 'publish';
$template->has_theme_file = false;
$template->is_custom = true;
$template->description = __( 'An overlay that shows up when someone visits your site.', 'jetpack' );
return $template;
}
/**
* Returns the initial content of the Subscribe Overlay template.
* This can then be edited by the user.
*
* @return string
*/
public function get_subscribe_overlay_template_content() {
$home_url = get_home_url();
$site_tagline = get_bloginfo( 'description' );
$default_tagline = __( 'Stay informed with curated content and the latest headlines, all delivered straight to your inbox. Subscribe now to stay ahead and never miss a beat!', 'jetpack' );
$tagline_block = empty( $site_tagline )
? '<!-- wp:paragraph {"align":"center","fontSize":"medium"} --><p class="has-text-align-center has-medium-font-size">' . $default_tagline . '</p><!-- /wp:paragraph -->'
: '<!-- wp:site-tagline {"textAlign":"center","fontSize":"medium"} /-->';
$skip_to_content = __( 'Skip to content', 'jetpack' );
$group_block_name = esc_attr__( 'Subscribe overlay container', 'jetpack' );
return <<<HTML
<!-- wp:group {"metadata":{"name":"$group_block_name"},"style":{"spacing":{"padding":{"top":"0","bottom":"0","left":"0","right":"0"}}},"layout":{"type":"constrained","contentSize":"400px"}} -->
<div class="wp-block-group" style="padding-top:0;padding-right:0;padding-bottom:0;padding-left:0">
<!-- wp:site-logo {"width":90,"isLink":false,"shouldSyncIcon":true,"align":"center","className":"is-style-rounded"} /-->
<!-- wp:site-title {"textAlign":"center","isLink":false,"fontSize":"x-large"} /-->
$tagline_block
<!-- wp:jetpack/subscriptions {"appSource":"subscribe-overlay"} /-->
<!-- wp:paragraph {"align":"center","className":"jetpack-subscribe-overlay__to-content"} -->
<p class="has-text-align-center jetpack-subscribe-overlay__to-content"><a href="$home_url">$skip_to_content ↓</a></p>
<!-- /wp:paragraph -->
</div>
<!-- /wp:group -->
HTML;
}
/**
* Enqueues JS to load overlay.
*
* @return void
*/
public function enqueue_assets() {
if ( $this->should_user_see_overlay() ) {
wp_enqueue_style( 'subscribe-overlay-css', plugins_url( 'subscribe-overlay.css', __FILE__ ), array(), JETPACK__VERSION );
wp_enqueue_script( 'subscribe-overlay-js', plugins_url( 'subscribe-overlay.js', __FILE__ ), array( 'wp-dom-ready' ), JETPACK__VERSION, true );
}
}
/**
* Adds overlay with Subscribe Overlay content.
*
* @return void
*/
public function add_subscribe_overlay_to_frontend() {
if ( $this->should_user_see_overlay() ) { ?>
<div class="jetpack-subscribe-overlay">
<div class="jetpack-subscribe-overlay__close">
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
<path d="M5.40456 5L19 19M5 19L18.5954 5" stroke="currentColor" stroke-width="1.5"/>
</svg>
</div>
<div class="jetpack-subscribe-overlay__content">
<?php block_template_part( self::BLOCK_TEMPLATE_PART_SLUG ); ?>
</div>
</div>
<?php
}
}
/**
* Returns true if a site visitor should see
* the Subscribe Overlay.
*
* @return bool
*/
public function should_user_see_overlay() {
// Only show when viewing frontend.
if ( is_admin() ) {
return false;
}
// Needed because Elementor editor makes is_admin() return false
// See https://coreysalzano.com/wordpress/why-elementor-disobeys-is_admin/
// Ignore nonce warning as just checking if is set
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['elementor-preview'] ) ) {
return false;
}
// Don't show when previewing blog posts or site's theme
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['preview'] ) || isset( $_GET['theme_preview'] ) || isset( $_GET['customize_preview'] ) || isset( $_GET['hide_banners'] ) ) {
return false;
}
// Don't show if one of subscribe query params is set.
// They are set when user submits the subscribe form.
// The nonce is checked elsewhere before redirect back to this page with query params.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['subscribe'] ) || isset( $_GET['blogsub'] ) ) {
return false;
}
// Don't show if user is subscribed to blog.
require_once __DIR__ . '/../views.php';
if ( ! class_exists( 'Jetpack_Memberships' ) || Jetpack_Memberships::is_current_user_subscribed() ) {
return false;
}
return is_home() || is_front_page();
}
}
Jetpack_Subscribe_Overlay::init();
add_action(
'rest_api_switched_to_blog',
function () {
Jetpack_Subscribe_Overlay::init();
}
);
@@ -0,0 +1,85 @@
body.jetpack-subscribe-overlay-open {
overflow: hidden;
}
.jetpack-subscribe-overlay {
--jetpack-subscribe-overlay--background-color: var(--wp--preset--color--background, var(--wp--preset--color--base, var(--wp--preset--color--contrast, #F9F9F9)));
visibility: hidden;
position: fixed;
z-index: 50001; /* WP.com Action bar and floating subscribe button are 5000 */
left: 0;
top: 0;
width: 100%;
height: 100%;
overflow: hidden;
background-color: transparent;
transition: background-color 0.4s, visibility 0.4s;
}
.jetpack-subscribe-overlay__content {
position: relative;
visibility: hidden;
overflow: hidden;
top: 100%;
margin: 15% auto;
width: 100%;
max-width: 400px;
transition: top 0.4s, visibility 0.4s;
text-wrap: pretty;
}
.jetpack-subscribe-overlay__close {
display: none;
cursor: pointer;
position: absolute;
top: 32px;
right: 32px;
width: 24px;
height: 24px;
}
body.admin-bar .jetpack-subscribe-overlay__close {
top: 64px;
}
body.has-marketing-bar .jetpack-subscribe-overlay__close {
top: 81px;
}
body.admin-bar.has-marketing-bar .jetpack-subscribe-overlay__close {
top: 114px;
}
.jetpack-subscribe-overlay__to-content {
display: none;
position: fixed;
bottom: 64px;
left: 0;
right: 0;
margin: 0 auto;
}
.jetpack-subscribe-overlay.open {
background-color: var(--jetpack-subscribe-overlay--background-color);
visibility: visible;
.jetpack-subscribe-overlay__content {
top: 0;
visibility: visible;
}
.jetpack-subscribe-overlay__close {
display: block;
}
.jetpack-subscribe-overlay__to-content {
display: block;
}
}
@media screen and (max-width: 640px) {
.jetpack-subscribe-overlay__content {
width: 94%;
}
}
@@ -0,0 +1,73 @@
const { domReady } = wp;
domReady( function () {
const overlay = document.querySelector( '.jetpack-subscribe-overlay' );
const overlayDismissedCookie = 'jetpack_post_subscribe_overlay_dismissed';
const skipUrlParam = 'jetpack_skip_subscription_popup';
const hasOverlayDismissedCookie =
document.cookie && document.cookie.indexOf( overlayDismissedCookie ) > -1;
// Subscriber ended up here e.g. from emails:
// we won't show the overlay to them in future since they most likely are already a subscriber.
function skipOverlay() {
const url = new URL( window.location.href );
if ( url.searchParams.has( skipUrlParam ) ) {
url.searchParams.delete( skipUrlParam );
window.history.replaceState( {}, '', url );
setOverlayDismissedCookie();
return true;
}
return false;
}
if ( ! overlay || hasOverlayDismissedCookie || skipOverlay() ) {
return;
}
const close = overlay.querySelector( '.jetpack-subscribe-overlay__close' );
close.onclick = function ( event ) {
event.preventDefault();
closeOverlay();
};
const toContent = overlay.querySelector( '.jetpack-subscribe-overlay__to-content' );
// User can edit overlay, and could remove to content link.
if ( toContent ) {
toContent.onclick = function ( event ) {
event.preventDefault();
closeOverlay();
};
}
// When the form is submitted, and next modal loads, it'll fire "subscription-modal-loaded" signalling that this form can be hidden.
const form = overlay.querySelector( 'form' );
if ( form ) {
form.addEventListener( 'subscription-modal-loaded', closeOverlay );
}
function closeOverlayOnEscapeKeydown( event ) {
if ( event.key === 'Escape' ) {
closeOverlay();
}
}
function openOverlay() {
overlay.classList.add( 'open' );
document.body.classList.add( 'jetpack-subscribe-overlay-open' );
setOverlayDismissedCookie();
window.addEventListener( 'keydown', closeOverlayOnEscapeKeydown );
}
function closeOverlay() {
overlay.classList.remove( 'open' );
document.body.classList.remove( 'jetpack-subscribe-overlay-open' );
window.removeEventListener( 'keydown', closeOverlayOnEscapeKeydown );
}
function setOverlayDismissedCookie() {
document.cookie = `${ overlayDismissedCookie }=true; path=/;`;
}
openOverlay();
} );
@@ -0,0 +1,29 @@
#subscribe-email input {
width: 95%;
}
.comment-subscription-form {
margin-bottom: 1em;
}
.comment-subscription-form .subscribe-label {
display: inline !important;
}
/*
Text meant only for screen readers.
Provides support for themes that do not bundle this CSS yet.
@see https://make.wordpress.org/accessibility/2015/02/09/hiding-text-for-screen-readers-with-wordpress-core/
***********************************/
.screen-reader-text {
border: 0;
clip: rect(1px, 1px, 1px, 1px);
clip-path: inset(50%);
height: 1px;
margin: -1px;
overflow: hidden;
padding: 0;
position: absolute ! important;
width: 1px;
word-wrap: normal ! important;
}
File diff suppressed because it is too large Load Diff