Subscriptions: Add Welcome Overlay behind the feature flag (#37372)

projects/plugins/jetpack/changelog/update-subscribe-welcome-overlay

@@ -0,0 +1,4 @@
+Significance: minor
+Type: other
+
+Subscriptions: Add Welcome Overlay behind the feature flag

projects/plugins/jetpack/class.jetpack.php

@@ -138,6 +138,7 @@ class Jetpack {
 		'wpcom_instagram_widget',
 		'milestone-widget',
 		'subscribe-modal-css',
+		'subscribe-overlay-css',
 	);
 
 	/**

projects/plugins/jetpack/modules/comments/subscription-modal-on-comment/class-jetpack-subscription-modal-on-comment.php

@@ -121,7 +121,7 @@ public function get_template() {
 		$template->status         = 'publish';
 		$template->has_theme_file = false;
 		$template->is_custom      = true;
-		$template->description    = __( 'A subscribe form that submit a comment', 'jetpack' );
+		$template->description    = __( 'A subscribe form that submit a comment.', 'jetpack' );
 
 		return $template;
 	}

projects/plugins/jetpack/modules/subscriptions.php

@@ -1076,3 +1076,4 @@ public function track_newsletter_category_creation() {
 
 require __DIR__ . '/subscriptions/views.php';
 require __DIR__ . '/subscriptions/subscribe-modal/class-jetpack-subscribe-modal.php';
+require __DIR__ . '/subscriptions/subscribe-overlay/class-jetpack-subscribe-overlay.php';

projects/plugins/jetpack/modules/subscriptions/subscribe-modal/class-jetpack-subscribe-modal.php

@@ -131,7 +131,7 @@ public function get_template() {
 		$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' );
+		$template->description    = __( 'A subscribe form that pops up when someone visits your site.', 'jetpack' );
 
 		return $template;
 	}

projects/plugins/jetpack/modules/subscriptions/subscribe-modal/subscribe-modal.css

@@ -1,3 +1,7 @@
+body.jetpack-subscribe-modal-open {
+	overflow: hidden;
+}
+
 .jetpack-subscribe-modal {
 	visibility: hidden;
 	position: fixed;
@@ -51,7 +55,3 @@
 		width: 94%;
 	}
 }
-
-body.jetpack-subscribe-modal-open {
-	overflow: hidden;
-}

projects/plugins/jetpack/modules/subscriptions/subscribe-overlay/class-jetpack-subscribe-overlay.php

@@ -0,0 +1,208 @@
+<?php
+/**
+ * Adds support for Jetpack Subscribe Overlay feature
+ *
+ * @package automattic/jetpack-subscriptions
+ * @since $$next-version$$
+ */
+
+/**
+ * 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 ( apply_filters( '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 );
+	}
+
+	/**
+	 * 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() {
+		$skip_to_content = __( 'Skip to content', 'jetpack' );
+
+		return <<<HTML
+	<!-- wp:group {"layout":{"type":"constrained","contentSize":"400px"}} -->
+	<div class="wp-block-group">
+		<!-- wp:site-logo {"width":90,"isLink":false,"shouldSyncIcon":true,"align":"center","className":"is-style-rounded"} /-->
+	
+		<!-- wp:site-title {"textAlign":"center","isLink":false} /-->
+
+		<!-- wp:site-tagline {"textAlign":"center"} /-->
+
+		<!-- wp:jetpack/subscriptions /-->
+
+		<!-- wp:paragraph {"align":"center","className":"jetpack-subscribe-overlay__to-content"} -->
+		<p class="has-text-align-center jetpack-subscribe-overlay__to-content"><a href="#">$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();
+	}
+);

projects/plugins/jetpack/modules/subscriptions/subscribe-overlay/subscribe-overlay.css

@@ -0,0 +1,79 @@
+body.jetpack-subscribe-overlay-open {
+	overflow: hidden;
+}
+
+.jetpack-subscribe-overlay {
+	--jetpack-subscribe-overlay--text-color: var(--wp--preset--color--primary, black);
+	--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: 50000; /* Same as WP.com Action bar */
+	left: 0;
+	top: 0;
+	width: 100%;
+	height: 100%;
+	overflow: hidden;
+	background-color: transparent;
+	transition: background-color 0.4s, visibility 0.4s;
+	color: var(--jetpack-subscribe-overlay--text-color);
+}
+
+.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;
+}
+
+.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%;
+	}
+}