Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Register inline scripts with wp_add_inline_script #302

Merged
merged 1 commit into from
Oct 19, 2023
Merged

Register inline scripts with wp_add_inline_script #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ Yes! Pagespeed is one of our main focus points, and we strive to make the plugin
= 1.X =

Enhancements:
* Inline scripts are now registered with the wp_add_inline_script insted of wp_head. This allows easy extension GTM Kit and implementation of a CSP (Content Security Policy).

Bugfixes:
* The product ID Prefix was not added when a product variation was selected.
Expand Down
3 changes: 2 additions & 1 deletion src/Common/Util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,8 @@ public function enqueue_script( string $handle, string $script ): void {
$dependency = $deps_file['dependencies'];
$version = $deps_file['version'];
}
$dependency[] = 'gtmkit';

\wp_enqueue_script( $handle, GTMKIT_URL . 'assets/' . $script . '.js', $dependency, $version, true );
\wp_enqueue_script( $handle, GTMKIT_URL . 'assets/' . $script . '.js', $dependency, $version, [ 'strategy' => 'defer' ] );
}
}
158 changes: 83 additions & 75 deletions src/Frontend/Frontend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,109 +44,86 @@ public function __construct( Options $options ) {
* @param Options $options An instance of Options.
*/
public static function register( Options $options ): void {
$page = new Frontend( $options );
$page = new Frontend( $options );
$container_active = Options::init()->get( 'general', 'container_active' );
$noscript_implementation = Options::init()->get( 'general', 'noscript_implementation' );

if ( empty( $options->get( 'general', 'just_the_container' ) ) ) {
add_action( 'wp_head', [ $page, 'get_header_datalayer' ], 1, 0 );
add_action( 'wp_head', [ $page, 'get_datalayer_content' ] );
add_action( 'wp_enqueue_scripts', [ $page, 'enqueue_settings_and_data_script' ], 1, 0 );
add_action( 'wp_enqueue_scripts', [ $page, 'enqueue_datalayer_content' ] );
}

$container_active = Options::init()->get( 'general', 'container_active' );

if ( $container_active ) {
add_action( 'wp_head', [ $page, 'get_header_script' ], 10, 0 );
add_action( 'wp_enqueue_scripts', [ $page, 'enqueue_header_script' ] );
} elseif ( Options::init()->get( 'general', 'console_log' ) ) {
add_action( 'wp_head', [ $page, 'container_disabled' ] );
}

add_filter( 'wp_resource_hints', [ $page, 'dns_prefetch' ], 10, 2 );
add_filter( 'rocket_excluded_inline_js_content', [ $page, 'wp_rocket_exclude_javascript' ] );

$noscript_implementation = Options::init()->get( 'general', 'noscript_implementation' );

if ( $noscript_implementation === '0' && $container_active ) {
add_action( 'wp_body_open', [ $page, 'get_body_script' ] );
} elseif ( $noscript_implementation === '1' && $container_active ) {
add_action( 'body_footer', [ $page, 'get_body_script' ] );
}

add_filter( 'wp_resource_hints', [ $page, 'dns_prefetch' ], 10, 2 );
add_filter( 'rocket_excluded_inline_js_content', [ $page, 'wp_rocket_exclude_javascript' ] );
add_filter( 'wp_inline_script_attributes', [ $page, 'set_inline_script_attributes' ], 10, 2 );
}

/**
* The dataLayer initialization and settings
* The inline script for settings and data use by other GTM Kit scripts.
*/
public function get_header_datalayer(): void {
public function enqueue_settings_and_data_script(): void {
$settings = [
'datalayer_name' => $this->datalayer_name,
'console_log' => Options::init()->get( 'general', 'console_log' ),
];
?>

<!-- GTM Kit -->
<script <?php $this->get_attributes(); ?>>
window.<?php echo esc_js( $this->datalayer_name ); ?> = window.<?php echo esc_js( $this->datalayer_name ); ?> || [];
window.gtmkit_settings = <?php echo wp_json_encode( apply_filters( 'gtmkit_header_script_settings', $settings ), JSON_FORCE_OBJECT ); ?>;
window.gtmkit_data = <?php echo wp_json_encode( apply_filters( 'gtmkit_header_script_data', [] ), JSON_FORCE_OBJECT ); ?>;
<?php if ( $this->options->get( 'general', 'gcm_default_settings' ) ) : ?>

if (typeof gtag === "undefined") {
function gtag(){<?php echo esc_attr( $this->datalayer_name ); ?>.push(arguments);}
gtag('consent', 'default', {
'ad_storage': '<?php echo ( $this->options->get( 'general', 'gcm_ad_storage' ) ) ? 'granted' : 'denied'; ?>',
'analytics_storage': '<?php echo ( $this->options->get( 'general', 'gcm_analytics_storage' ) ) ? 'granted' : 'denied'; ?>',
'personalization_storage': '<?php echo ( $this->options->get( 'general', 'gcm_personalization_storage' ) ) ? 'granted' : 'denied'; ?>',
'functionality_storage': '<?php echo ( $this->options->get( 'general', 'gcm_functionality_storage' ) ) ? 'granted' : 'denied'; ?>',
'security_storage': '<?php echo ( $this->options->get( 'general', 'gcm_security_storage' ) ) ? 'granted' : 'denied'; ?>',
});
} else if ( window.gtmkit_settings.console_log === 'on' ) {
console.warn('GTM Kit: gtag is already defined')
}
<?php endif; ?>
</script>
ob_start();
?>
window.gtmkit_settings = <?php echo wp_json_encode( apply_filters( 'gtmkit_header_script_settings', $settings ), JSON_FORCE_OBJECT ); ?>;
window.gtmkit_data = <?php echo wp_json_encode( apply_filters( 'gtmkit_header_script_data', [] ), JSON_FORCE_OBJECT ); ?>;
<?php if ( $this->options->get( 'general', 'gcm_default_settings' ) ) : ?>
if (typeof gtag === "undefined") {
function gtag(){<?php echo esc_attr( $this->datalayer_name ); ?>.push(arguments);}
gtag('consent', 'default', {
'ad_storage': '<?php echo ( $this->options->get( 'general', 'gcm_ad_storage' ) ) ? 'granted' : 'denied'; ?>',
'analytics_storage': '<?php echo ( $this->options->get( 'general', 'gcm_analytics_storage' ) ) ? 'granted' : 'denied'; ?>',
'personalization_storage': '<?php echo ( $this->options->get( 'general', 'gcm_personalization_storage' ) ) ? 'granted' : 'denied'; ?>',
'functionality_storage': '<?php echo ( $this->options->get( 'general', 'gcm_functionality_storage' ) ) ? 'granted' : 'denied'; ?>',
'security_storage': '<?php echo ( $this->options->get( 'general', 'gcm_security_storage' ) ) ? 'granted' : 'denied'; ?>',
});
} else if ( window.gtmkit_settings.console_log === 'on' ) {
console.warn('GTM Kit: gtag is already defined')
}<?php endif; ?>
<?php
}
$script = ob_get_clean();

/**
* Get attributes
*/
public function get_attributes(): void {
$attributes = apply_filters(
'gtmkit_header_script_attributes',
[
'data-cfasync' => 'false',
'data-nowprocket' => '',
'data-cookieconsent' => 'ignore',
]
);

foreach ( $attributes as $attribute => $value ) {
echo ' ' . esc_attr( $attribute ) . '="' . esc_attr( $value ) . '"';
}
wp_register_script( 'gtmkit', '', [], GTMKIT_VERSION, [ 'in_footer' => false ] );
wp_enqueue_script( 'gtmkit' );
wp_add_inline_script( 'gtmkit', $script, 'before' );
}

/**
* The dataLayer content included before the GTM container script
*/
public function get_datalayer_content(): void {
?>
<!-- GTM Kit -->
<script <?php $this->get_attributes(); ?>>
<?php
public function enqueue_datalayer_content(): void {

if ( $this->options->get( 'general', 'gtm_id' ) ) {
$datalayer_data = apply_filters( 'gtmkit_datalayer_content', [] );
$datalayer_data = apply_filters( 'gtmkit_datalayer_content', [] );

echo 'const gtmkit_dataLayer_content = ' . wp_json_encode( $datalayer_data ) . ";\n";
$script = 'window.' . esc_js( $this->datalayer_name ) . ' = window.' . esc_js( $this->datalayer_name ) . ' || [];' . "\n";
$script .= 'const gtmkit_dataLayer_content = ' . wp_json_encode( $datalayer_data ) . ";\n";
$script .= esc_attr( $this->datalayer_name ) . '.push( gtmkit_dataLayer_content );' . "\n";

echo esc_attr( $this->datalayer_name ) . '.push( gtmkit_dataLayer_content );' . "\n";
}

echo "</script>\n";
wp_register_script( 'gtmkit-datalayer', '', [], GTMKIT_VERSION, [ 'in_footer' => false ] );
wp_enqueue_script( 'gtmkit-datalayer' );
wp_add_inline_script( 'gtmkit-datalayer', $script, 'before' );
}

/**
* The Google Tag Manager container script
*/
public function get_header_script(): void {
public function enqueue_header_script(): void {

$gtm_id = Options::init()->get( 'general', 'gtm_id' );

Expand All @@ -155,10 +132,8 @@ public function get_header_script(): void {
}

$script_implementation = (int) Options::init()->get( 'general', 'script_implementation' );
?>
<!-- Google Tag Manager -->
<script <?php $this->get_attributes(); ?>>
<?php

ob_start();

if ( $script_implementation > 0 ) {
echo '
Expand All @@ -183,7 +158,11 @@ function (cb) {
$this->get_gtm_script( $gtm_id );
}

echo "</script>\n<!-- End Google Tag Manager -->\n";
$script = ob_get_clean();

wp_register_script( 'gtmkit-container', '', [ 'gtmkit-datalayer' ], GTMKIT_VERSION, [ 'in_footer' => false ] );
wp_enqueue_script( 'gtmkit-container' );
wp_add_inline_script( 'gtmkit-container', $script );
}

/**
Expand All @@ -195,11 +174,40 @@ public function get_gtm_script( string $gtm_id ): void {
$domain = Options::init()->get( 'general', 'sgtm_domain' ) ? Options::init()->get( 'general', 'sgtm_domain' ) : 'www.googletagmanager.com';
$loader = Options::init()->get( 'general', 'sgtm_container_identifier' ) ? Options::init()->get( 'general', 'sgtm_container_identifier' ) : 'gtm';

echo "(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://" . esc_attr( $domain ) . '/' . esc_attr( $loader ) . ".js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','" . esc_js( $this->datalayer_name ) . "','" . esc_attr( $gtm_id ) . "');";
echo "/* Google Tag Manager */\n";
echo "(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\n";
echo "new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\n";
echo "j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n";
echo "'https://" . esc_attr( $domain ) . '/' . esc_attr( $loader ) . ".js?id='+i+dl;f.parentNode.insertBefore(j,f);\n";
echo "})(window,document,'script','" . esc_js( $this->datalayer_name ) . "','" . esc_attr( $gtm_id ) . "');\n";
echo "/* End Google Tag Manager */\n";
}

/**
* Set inline script attributes
*
* @param array $attributes The script attributes.
* @param string $script The script.
*
* @return array The script attributes.
*/
public function set_inline_script_attributes( array $attributes, string $script ): array { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
if ( isset( $attributes['id'] ) && strpos( $attributes['id'], 'gtmkit-' ) === 0 ) {
$script_attributes = apply_filters(
'gtmkit_header_script_attributes',
[
'data-cfasync' => 'false',
'data-nowprocket' => '',
'data-cookieconsent' => 'ignore',
]
);

foreach ( $script_attributes as $attribute_name => $value ) {
$attributes[ $attribute_name ] = $value;
}
}

return $attributes;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Integration/ContactForm7.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public function enqueue_scripts(): void {
wp_enqueue_script(
'gtmkit-cf7',
GTMKIT_URL . 'assets/integration/contact-form-7.js',
[],
[ 'gtmkit' ],
$this->util->get_plugin_version(),
true
);
Expand Down
2 changes: 1 addition & 1 deletion src/Integration/EasyDigitalDownloads.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public function enqueue_scripts(): void {
wp_enqueue_script(
'gtmkit-edd',
GTMKIT_URL . 'assets/integration/edd.js',
[ 'jquery' ],
[ 'gtmkit', 'jquery' ],
$this->util->get_plugin_version(),
true
);
Expand Down
2 changes: 1 addition & 1 deletion src/Integration/WooCommerce.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ public function enqueue_scripts(): void {
wp_enqueue_script(
'gtmkit-woocommerce',
GTMKIT_URL . 'assets/integration/woocommerce.js',
[],
[ 'gtmkit' ],
$this->util->get_plugin_version(),
true
);
Expand Down
Loading