', '' ); } /** * Accordion groups. * * @return array */ public function groups(): array { return array( 'general' => __( 'General', 'duracelltomi-google-tag-manager' ), 'advanced' => __( 'Advanced', 'duracelltomi-google-tag-manager' ), ); } /** * Field definitions. * * @return Field[] */ public function fields(): array { // Build the list of user roles as checkboxes, as in 1.x. wp_roles() // lives in wp-includes so it is available both on the settings page // and during REST saves; the guard keeps unit tests (which never load // WordPress) working with an empty choice list. $role_choices = array(); if ( function_exists( 'wp_roles' ) ) { foreach ( wp_roles()->get_names() as $role_slug => $role_name ) { $role_choices[ $role_slug ] = translate_user_role( $role_name ); } } // Every column a valid GTM4WP_HARDCODED_* constant takes over is rendered // read-only, and the row set is frozen when the constants also decide // which containers are loaded. Without this the screen would show - and // happily save - a container setup the frontend silently overrides. $locks = HardcodedContainers::locks(); $columns = array( array( 'key' => ContainerRows::COLUMN_ID, 'label' => __( 'Container ID', 'duracelltomi-google-tag-manager' ), 'placeholder' => 'GTM-XXXXXX', ), array( 'key' => ContainerRows::COLUMN_AUTH, 'label' => __( 'Environment gtm_auth', 'duracelltomi-google-tag-manager' ), 'placeholder' => '', ), array( 'key' => ContainerRows::COLUMN_PREVIEW, 'label' => __( 'Environment gtm_preview', 'duracelltomi-google-tag-manager' ), 'placeholder' => 'env-NN', ), array( 'key' => ContainerRows::COLUMN_DOMAIN, 'label' => __( 'Custom domain', 'duracelltomi-google-tag-manager' ), 'placeholder' => 'www.googletagmanager.com', ), array( 'key' => ContainerRows::COLUMN_PATH, 'label' => __( 'Custom path', 'duracelltomi-google-tag-manager' ), 'placeholder' => 'gtm.js', ), array( 'key' => ContainerRows::COLUMN_NO_ID, 'label' => __( 'Omit container ID', 'duracelltomi-google-tag-manager' ), 'type' => 'checkbox', 'depends_on' => ContainerRows::COLUMN_PATH, ), ); foreach ( $columns as $index => $column ) { if ( isset( $locks['columns'][ $column['key'] ] ) ) { $columns[ $index ]['readonly'] = true; } } return array( new Field( key: GTM4WP_OPTION_GTM_CONTAINERS, type: Field::TYPE_TABLE, default_value: array(), label: __( 'Google Tag Manager containers', 'duracelltomi-google-tag-manager' ), description: $this->containers_description( $locks ), group: 'general', columns: $columns, sanitizer: static function ( $value ) { if ( ! is_array( $value ) ) { $value = array(); } $rows = array(); $seen_ids = array(); foreach ( $value as $raw_row ) { if ( ! is_array( $raw_row ) ) { continue; } $row = ContainerRows::normalize_row( $raw_row ); // Rows with every cell empty are dropped silently. if ( '' === implode( '', $row ) ) { continue; } $one_gtm_id = $row[ ContainerRows::COLUMN_ID ]; if ( ! preg_match( ContainerRows::GTM_ID_PATTERN, $one_gtm_id ) ) { return new \WP_Error( 'gtm4wp_invalid_gtm_id', sprintf( /* translators: %s: the invalid container ID as entered by the user. */ __( 'Invalid or missing Google Tag Manager ID in one of the container rows: "%s". Valid ID format: GTM-XXXXX.', 'duracelltomi-google-tag-manager' ), $one_gtm_id ) ); } if ( isset( $seen_ids[ $one_gtm_id ] ) ) { return new \WP_Error( 'gtm4wp_duplicate_gtm_id', sprintf( /* translators: %s: the duplicated container ID. */ __( 'The Google Tag Manager ID "%s" is listed more than once. Every container ID can only be entered in one row.', 'duracelltomi-google-tag-manager' ), $one_gtm_id ) ); } $seen_ids[ $one_gtm_id ] = true; if ( ( '' !== $row[ ContainerRows::COLUMN_AUTH ] ) && ( ! preg_match( ContainerRows::AUTH_PATTERN, $row[ ContainerRows::COLUMN_AUTH ] ) ) ) { return new \WP_Error( 'gtm4wp_invalid_gtm_auth', sprintf( /* translators: %s: the container ID of the row with the invalid value. */ __( "Invalid gtm_auth environment parameter value in the row of container %s. It should only contain letters, numbers or the '-' and '_' characters.", 'duracelltomi-google-tag-manager' ), $one_gtm_id ) ); } if ( ( '' !== $row[ ContainerRows::COLUMN_PREVIEW ] ) && ( ! preg_match( ContainerRows::PREVIEW_PATTERN, $row[ ContainerRows::COLUMN_PREVIEW ] ) ) ) { return new \WP_Error( 'gtm4wp_invalid_gtm_preview', sprintf( /* translators: %s: the container ID of the row with the invalid value. */ __( "Invalid gtm_preview environment parameter value in the row of container %s. It should have the format 'env-NN' where NN is an integer number.", 'duracelltomi-google-tag-manager' ), $one_gtm_id ) ); } // Remove https:// prefix if used. $domain = str_replace( 'https://', '', $row[ ContainerRows::COLUMN_DOMAIN ] ); $domain = trim( $domain, "/ \n\r\t\v\x00" ); if ( '' !== $domain ) { $domain = filter_var( $domain, FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME ); if ( false === $domain ) { return new \WP_Error( 'gtm4wp_invalid_gtm_domain', sprintf( /* translators: %s: the container ID of the row with the invalid value. */ __( 'Invalid custom domain name in the row of container %s. Enter a valid domain name without the https:// prefix.', 'duracelltomi-google-tag-manager' ), $one_gtm_id ) ); } } $row[ ContainerRows::COLUMN_DOMAIN ] = (string) $domain; $path = ltrim( $row[ ContainerRows::COLUMN_PATH ], '/' ); if ( ! preg_match( ContainerRows::PATH_PATTERN, $path ) ) { return new \WP_Error( 'gtm4wp_invalid_custom_path', sprintf( /* translators: %s: the container ID of the row with the invalid value. */ __( 'Invalid custom domain path in the row of container %s. Value can include anything between a-z, A-Z, 0-9 or any of the characters . - _ /', 'duracelltomi-google-tag-manager' ), $one_gtm_id ) ); } $row[ ContainerRows::COLUMN_PATH ] = $path; // The "omit container ID" flag is stored as '1' / '' and // only kept when a custom path is present: it has no // meaning for the default www.googletagmanager.com loader. $omit_id = ( '' !== $row[ ContainerRows::COLUMN_NO_ID ] ) && ( '0' !== $row[ ContainerRows::COLUMN_NO_ID ] ); $row[ ContainerRows::COLUMN_NO_ID ] = ( $omit_id && ( '' !== $path ) ) ? '1' : ''; $rows[] = $row; } return $rows; }, derive: static fn ( $rows ) => ContainerRows::legacy_values( is_array( $rows ) ? $rows : array() ), rows_locked: array() !== $locks['rows'], doc: self::DOC_PAGE ), new Field( key: GTM4WP_OPTION_GTM_PLACEMENT, type: Field::TYPE_SELECT, default_value: (string) GTM4WP_PLACEMENT_FOOTER, label: __( 'Container code placement', 'duracelltomi-google-tag-manager' ), description: wp_kses( __( 'Decides where to put the second, so called <noscript> part of the GTM container code. The main GTM container code will always be placed into the <head> section of your webpages.
If you select "Manually coded", add the following code just after the opening <body> tag in your template:
<?php if ( function_exists( \'gtm4wp_the_gtm_tag\' ) ) { gtm4wp_the_gtm_tag(); } ?>
Selecting "Off" removes both parts of the container code but leaves data layer codes working.', 'duracelltomi-google-tag-manager' ), array( 'code' => array(), 'br' => array(), ) ), group: 'general', choices: array( (string) GTM4WP_PLACEMENT_FOOTER => __( 'Footer of the page (compatible with all WP themes, no Search Console verification)', 'duracelltomi-google-tag-manager' ), (string) GTM4WP_PLACEMENT_BODYOPEN => __( 'Manually coded after the opening body tag', 'duracelltomi-google-tag-manager' ), (string) GTM4WP_PLACEMENT_BODYOPEN_AUTO => __( 'Automatically after the opening body tag (theme must support wp_body_open)', 'duracelltomi-google-tag-manager' ), (string) GTM4WP_PLACEMENT_OFF => __( 'Off - container code turned off, data layer only', 'duracelltomi-google-tag-manager' ), ), sanitizer: static function ( $value ) { $value = (int) $value; if ( ( $value < GTM4WP_PLACEMENT_FOOTER ) || ( $value > GTM4WP_PLACEMENT_OFF ) ) { return GTM4WP_PLACEMENT_FOOTER; } return $value; }, doc: self::DOC_PAGE ), new Field( key: GTM4WP_OPTION_DATALAYER_NAME, type: Field::TYPE_TEXT, default_value: '', label: __( 'dataLayer variable name', 'duracelltomi-google-tag-manager' ), description: esc_html__( 'In some cases you need to rename the dataLayer variable. You can enter your name here. Leave blank for default name: dataLayer', 'duracelltomi-google-tag-manager' ), group: 'advanced', sanitizer: static function ( $value ) { // Field::to_string() keeps the cast warning-free on non-scalar // import values (a custom sanitizer replaces the type-defensive // default in Field::sanitize(), it does not run in front of it). $value = trim( Field::to_string( $value ) ); // The reader's own predicate, not a second copy of the rule // (PA-2). The name is emitted UNQUOTED into a