File Editor

Directories:

.. (Back)

Files:

cookie-consent.php

Create New File

Edit File: cookie-consent.php

<?php
/**
 * Cookie-consent Block.
 *
 * @since 12.0
 *
 * @package automattic/jetpack
 */

namespace Automattic\Jetpack\Extensions\CookieConsent;

use Automattic\Jetpack\Blocks;
use Jetpack_Gutenberg;

const COOKIE_NAME = 'eucookielaw';

/**
 * Should the block be registered?
 * In wp-admin, we only want to show the block in the site editor.
 *
 * @since 12.0
 *
 * @return bool
 */
function should_register_block() {
	global $pagenow;

// Always register the widget if we're on the front end
	if ( ! is_admin() ) {
		return true;
	}

if ( is_admin() && $pagenow === 'site-editor.php' ) {
		return true;
	}
}

/**
 * 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 ( ! should_register_block() ) {
		return;
	}

Blocks::jetpack_register_block(
		__DIR__,
		array( 'render_callback' => __NAMESPACE__ . '\load_assets' ),
		array(
			'attributes' => array(
				'render_from_template' => array(
					'default' => false,
					'type'    => 'boolean',
				),
			),
		)
	);
}
add_action( 'init', __NAMESPACE__ . '\register_block' );

/**
 * Cookie-consent block registration/dependency declaration.
 *
 * @param array  $attr    Array containing the Cookie-consent block attributes.
 * @param string $content String containing the Cookie-consent block content.
 *
 * @return string
 */
function load_assets( $attr, $content ) {
	// We want to bust the cache even if the cookie isn't set.
	// This is needed for when the cookie expires,
	// and we should send fresh HTML with the cookie block in it.
	notify_batcache_that_content_changed();

if (
		/**
		 * Filters the display of the Cookie-consent Block e.g by GDPR CMP banner on WordAds sites.
		 *
		 * @since 13.2
		 *
		 * @param bool $disable_cookie_consent_block Whether to disable the Cookie-consent Block.
		 */
		apply_filters( 'jetpack_disable_cookie_consent_block', false )
	) {
		return '';
	}

// If the user has already accepted the cookie consent, don't show the block.
	if ( isset( $_COOKIE[ COOKIE_NAME ] ) ) {
		return '';
	}

$option = get_option( 'cookie_consent_template' );
	if ( ! empty( $option ) && empty( $attr['render_from_template'] ) ) {
		return '';
	}

/*
	 * Enqueue necessary scripts and styles.
	 */
	Jetpack_Gutenberg::load_assets_as_required( __DIR__ );

return sprintf(
		'<div class="%1$s">%2$s</div>',
		esc_attr( Blocks::classes( Blocks::get_block_feature( __DIR__ ), $attr ) ),
		$content
	);
}

/**
 * Batcache busting: since the cookie consent is part of the cached response HTML, it can still render even when the cookie is set (when it shouldn't).
 * Because, by default, the cache doesn't vary around the cookie's value. This makes the cookie value part of the cache key.
 *
 * See: https://github.com/Automattic/batcache/blob/d4f617b335e9772a61b6d03ad3498b55c8137592/advanced-cache.php#L29
 */
function notify_batcache_that_content_changed() {
	if ( function_exists( 'vary_cache_on_function' ) ) {
		vary_cache_on_function( 'return isset( $_COOKIE[ "' . COOKIE_NAME . '" ] );' );
	}
}

/**
 * Render the cookie consent template.
 *
 * @since 12.4
 */
function render_cookie_consent_template() {

if ( is_admin() ) {
		return;
	}

// Check whether block theme functions exist.
	if ( ! function_exists( 'parse_blocks' ) ) {
		return;
	}

$template = get_option( 'cookie_consent_template' );

if ( empty( $template ) ) {
		return;
	}

$parsed = parse_blocks( $template );
	if ( ! empty( $parsed[0] ) ) {
		$parsed[0]['attrs']['render_from_template'] = true;
		echo render_block( $parsed[0] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	}
}
add_action( 'wp_footer', __NAMESPACE__ . '\render_cookie_consent_template' );

/**
 * Register cookie_consent_template setting
 *
 * @since 12.4
 */
function cookie_consent_register_settings() {
	register_setting(
		'general',
		'cookie_consent_template',
		array(
			'type'         => 'string',
			'show_in_rest' => true,
		)
	);
}

add_action( 'rest_api_init', __NAMESPACE__ . '\cookie_consent_register_settings' );

File Editor

Directories:

Files:

Create New File

Edit File: cookie-consent.php

Rename File