false,
'wc-ga-plugin-warning' => false,
'wc-gayoast-plugin-warning' => false,
'php72-warning' => false,
'deprecated-warning' => false,
);
/**
* Generic function to safely escape translated text that outputs on the admin page.
* Allows only basic HTML tags for formatting purposes. No anchor element is allowed.
*
* @param string $text The admin text that needs escaping.
* @return string The escaped text.
*/
function gtm4wp_safe_admin_html( $text ) {
return wp_kses(
$text,
array(
'br' => array(),
'strong' => array(
'style' => array(),
'class' => array(),
),
'em' => array(
'style' => array(),
'class' => array(),
),
'p' => array(
'style' => array(),
'class' => array(),
),
'span' => array(
'style' => array(),
'class' => array(),
),
'code' => array(),
'ul' => array(
'style' => array(),
'class' => array(),
),
'li' => array(
'style' => array(),
'class' => array(),
),
)
);
}
/**
* Generic function to safely escape text that outputs on the admin page.
* Works just like gtm4wp_safe_admin_html() but also allows anchor elements.
*
* @param string $text The admin text that needs escaping.
* @return string The escaped text.
*/
function gtm4wp_safe_admin_html_with_links( $text ) {
return wp_kses(
$text,
array(
'br' => array(),
'strong' => array(
'style' => array(),
'class' => array(),
),
'em' => array(
'style' => array(),
'class' => array(),
),
'p' => array(
'style' => array(),
'class' => array(),
),
'span' => array(
'style' => array(),
'class' => array(),
),
'code' => array(),
'ul' => array(
'style' => array(),
'class' => array(),
),
'li' => array(
'style' => array(),
'class' => array(),
),
'a' => array(
'id' => array(),
'name' => array(),
'href' => array(),
'target' => array(),
'rel' => array(),
),
)
);
}
/**
* Callback function for add_settings_section(). Outputs the HTML of an admin tab.
*
* @see https://developer.wordpress.org/reference/functions/add_settings_section/
*
* @param array $args array of tab attributes.
* @return void
*/
function gtm4wp_admin_output_section( $args ) {
echo '';
switch ( $args['id'] ) {
case GTM4WP_ADMIN_GROUP_GENERAL:
sprintf(
// translators: 1: opening anchor tag linking to GTM's developer doc homepage. 2: Closing anchor tag.
esc_html__(
'This plugin is intended to be used by IT and marketing staff. Please be sure you read the
%1$sGoogle Tag Manager Help Center%2$s before you start using this plugin.
',
'duracelltomi-google-tag-manager'
),
'',
''
);
break;
case GTM4WP_ADMIN_GROUP_INCLUDES:
esc_html_e( 'Here you can check what data is needed to be included in the dataLayer to be able to access them in Google Tag Manager', 'duracelltomi-google-tag-manager' );
echo ' ';
printf(
/* translators: 1: opening anchor tag that points to WhichBrowser website. 2: closing anchor tag. */
esc_html__(
'* Browser, OS and Device data is provided using %1$sWhichBrowser%2$s library.',
'duracelltomi-google-tag-manager'
),
'',
''
);
break;
case GTM4WP_ADMIN_GROUP_EVENTS:
esc_html_e( 'Fire tags in Google Tag Manager on special events on your website', 'duracelltomi-google-tag-manager' );
break;
case GTM4WP_ADMIN_GROUP_SCROLLER:
esc_html_e( 'Fire tags based on how the visitor scrolls through your page.', 'duracelltomi-google-tag-manager' );
echo ' ';
printf(
/* translators: 1: opening anchor tag that points to the corresponding Analytics Talks blog post. 2: closing anchor tag. */
esc_html__(
'Based on the script originaly posted to %1$sAnalytics Talk%2$s',
'duracelltomi-google-tag-manager'
),
'',
''
);
break;
case GTM4WP_ADMIN_GROUP_BLACKLIST:
esc_html_e( 'Here you can control which types of tags, triggers and variables can be executed on your site regardless of what tags are included in your container on the Google Tag Manager site. Use this to increase security!', 'duracelltomi-google-tag-manager' );
echo ' ';
esc_html_e( 'Do not modify if you do not know what to do, since it can cause issues with your tag deployment!', 'duracelltomi-google-tag-manager' );
echo ' ';
esc_html_e( 'For example blacklisting everything and only whitelisting the Google Analytics tag without whitelisting the URL variable type will cause your Google Analytics tags to be blocked anyway since the attached triggers (Page View) can not fire!', 'duracelltomi-google-tag-manager' );
break;
case GTM4WP_ADMIN_GROUP_INTEGRATION:
esc_html_e( 'Google Tag Manager for WordPress can integrate with several popular plugins. Please check the plugins you would like to integrate with:', 'duracelltomi-google-tag-manager' );
break;
case GTM4WP_ADMIN_GROUP_ADVANCED:
esc_html_e( 'You usually do not need to modify thoose settings. Please be carefull while hacking here.', 'duracelltomi-google-tag-manager' );
break;
case GTM4WP_ADMIN_GROUP_CREDITS:
esc_html_e( 'Some info about the author of this plugin', 'duracelltomi-google-tag-manager' );
break;
} // end switch
echo '';
}
/**
* Callback function for add_settings_field() to output the HTML of a specific plugin option
*
* @see https://developer.wordpress.org/reference/functions/add_settings_field/
*
* @param array $args Field attributes as array key-value pairs. 'label_for' is the unique ID of the option. 'description' is usually outputed below the option field.
* @return void
*/
function gtm4wp_admin_output_field( $args ) {
global $gtm4wp_options, $gtm4wp_business_verticals;
switch ( $args['label_for'] ) {
case GTM4WP_ADMIN_GROUP_GTMID:
echo wp_kses(
sprintf(
'',
esc_attr( GTM4WP_OPTIONS . '[' . GTM4WP_OPTION_GTM_CODE . ']' ),
esc_attr( GTM4WP_OPTIONS . '[' . GTM4WP_OPTION_GTM_CODE . ']' ),
defined( 'GTM4WP_HARDCODED_GTM_ID' ) ? constant( 'GTM4WP_HARDCODED_GTM_ID' ) : $gtm4wp_options[ GTM4WP_OPTION_GTM_CODE ],
defined( 'GTM4WP_HARDCODED_GTM_ID' ) ? ' readonly="readonly"' : ''
),
array(
'input' => array(
'type' => array(),
'id' => array(),
'name' => array(),
'value' => array(),
'readonly' => array(),
),
)
);
echo ' ';
// gtm4wp_safe_admin_html_with_links() calls wp_kses().
echo gtm4wp_safe_admin_html_with_links( $args['description'] ); // phpcs:ignore
if ( defined( 'GTM4WP_HARDCODED_GTM_ID' ) ) {
echo ' WARNING! Container ID was set and fixed in wp-config.php. If you wish to change this value, please edit your wp-config.php and change the container ID or remove the GTM4WP_HARDCODED_GTM_ID constant!';
}
echo ' ' . esc_html__( 'This does not seems to be a valid Google Tag Manager ID! Valid format: GTM-XXXXX where X can be numbers and capital letters. Use comma without any space (,) to enter multpile container IDs.', 'duracelltomi-google-tag-manager' ) . '';
break;
case GTM4WP_ADMIN_GROUP_CONTAINERON:
// gtm4wp_safe_admin_html_with_links() calls wp_kses().
echo gtm4wp_safe_admin_html_with_links( $args['description'] ); // phpcs:ignore
echo '
';
echo sprintf(
// translators: 1: opening anchor element pointing to the GTM4WP options page. 2: clsing anchor element.
esc_html__(
'To start using Google Tag Manager for WordPress, please %1$senter your GTM ID%2$s',
'duracelltomi-google-tag-manager'
),
'',
''
);
echo '
';
esc_html_e(
'Incomplete Google Tag Manager environment configuration: either gtm_preview or gtm_auth parameter value is missing!',
'duracelltomi-google-tag-manager'
);
echo '
' . esc_html__( 'Notice: you should deactivate the plugin "WooCommerce Google Analytics Integration" if you are using Google Analytics tags inside Google Tag Manager!', 'duracelltomi-google-tag-manager' ) . '
' . esc_html__( 'Notice: you should deactivate the plugin "Google Analytics for WordPress by MonsterInsights" if you are using Google Analytics tags inside Google Tag Manager!', 'duracelltomi-google-tag-manager' ) . '
';
printf(
// translators: %s: PHP version number.
esc_html__(
'Warning: You are using an outdated version of PHP (%s) that might be not compatible with future versions of the plugin Google Tag Manager for WordPress (GTM4WP). Please consider to upgrade your PHP.',
'duracelltomi-google-tag-manager'
),
PHP_VERSION
);
echo '
';
}
}
/**
* Action run when users dismiss a notice of GTM4WP on the WordPress admin.
* Saves the dismissed notice ID as user meta to hide the notice on next pageview.
*
* @see https://developer.wordpress.org/reference/hooks/wp_ajax_action/
*
* @return void
*/
function gtm4wp_dismiss_notice() {
global $gtm4wp_def_user_notices_dismisses, $current_user;
check_ajax_referer( 'gtm4wp-notice-dismiss-nonce', 'nonce' );
$gtm4wp_user_notices_dismisses = get_user_meta( $current_user->ID, GTM4WP_USER_NOTICES_KEY, true );
if ( '' === $gtm4wp_user_notices_dismisses ) {
if ( is_array( $gtm4wp_def_user_notices_dismisses ) ) {
$gtm4wp_user_notices_dismisses = $gtm4wp_def_user_notices_dismisses;
} else {
$gtm4wp_user_notices_dismisses = array();
}
} else {
$gtm4wp_user_notices_dismisses = json_decode( $gtm4wp_user_notices_dismisses, true );
if ( null === $gtm4wp_user_notices_dismisses || ! is_array( $gtm4wp_user_notices_dismisses ) ) {
$gtm4wp_user_notices_dismisses = array();
}
}
$gtm4wp_user_notices_dismisses = array_merge( $gtm4wp_def_user_notices_dismisses, $gtm4wp_user_notices_dismisses );
$noticeid = isset( $_POST['noticeid'] ) ? esc_url_raw( wp_unslash( $_POST['noticeid'] ) ) : '';
$noticeid = trim( basename( $noticeid ) );
if ( array_key_exists( $noticeid, $gtm4wp_user_notices_dismisses ) ) {
$gtm4wp_user_notices_dismisses[ $noticeid ] = true;
update_user_meta( $current_user->ID, GTM4WP_USER_NOTICES_KEY, wp_json_encode( $gtm4wp_user_notices_dismisses ) );
}
}
/**
* Action hook for plugin_action_links.
* Adds link to the settings page on the Plugins page.
*
* @see https://developer.wordpress.org/reference/hooks/plugin_action_links/
*
* @param array $links Existing links that can be extended by this action.
* @param string $file Plugin ID where the links belong to.
* @return array Array of anchor HTML elements with links that will be shown below the plugin on the Plugins page.
*/
function gtm4wp_add_plugin_action_links( $links, $file ) {
global $gtp4wp_plugin_basename;
if ( $file !== $gtp4wp_plugin_basename ) {
return $links;
}
$settings_link = '' . esc_html__( 'Settings', 'duracelltomi-google-tag-manager' ) . '';
array_unshift( $links, $settings_link );
return $links;
}
/**
* Action hook for in_plugin_update_message-file.
* Shows upgrade message below plugin description.
*
* @see https://developer.wordpress.org/reference/hooks/in_plugin_update_message-file/
*
* @param array $current_plugin_metadata Meta data of the currently active plugin version.
* @param object $new_plugin_metadata Meta data of the available new plugin version.
* @return void
*/
function gtm4wp_show_upgrade_notification( $current_plugin_metadata, $new_plugin_metadata ) {
if ( isset( $new_plugin_metadata->upgrade_notice ) && strlen( trim( $new_plugin_metadata->upgrade_notice ) ) > 0 ) {
echo '
Important Upgrade Notice: ';
echo esc_html( $new_plugin_metadata->upgrade_notice ), '