-
Notifications
You must be signed in to change notification settings - Fork 277
/
Web_Tag.php
177 lines (150 loc) · 3.78 KB
/
Web_Tag.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<?php
/**
* Class Google\Site_Kit\Modules\Analytics_4\Web_Tag
*
* @package Google\Site_Kit\Modules\Analytics_4
* @copyright 2021 Google LLC
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @link https://sitekit.withgoogle.com
*/
namespace Google\Site_Kit\Modules\Analytics_4;
use Google\Site_Kit\Core\Modules\Tags\Module_Web_Tag;
use Google\Site_Kit\Core\Tags\GTag;
use Google\Site_Kit\Core\Tags\Tag_With_DNS_Prefetch_Trait;
use Google\Site_Kit\Core\Util\Method_Proxy_Trait;
/**
* Class for Web tag.
*
* @since 1.31.0
* @access private
* @ignore
*/
class Web_Tag extends Module_Web_Tag implements Tag_Interface {
use Method_Proxy_Trait, Tag_With_DNS_Prefetch_Trait;
/**
* Custom dimensions data.
*
* @since 1.113.0
* @var array
*/
private $custom_dimensions;
/**
* Home domain name.
*
* @since 1.24.0
* @var string
*/
private $home_domain;
/**
* Ads conversion ID.
*
* @since 1.32.0
* @var string
*/
private $ads_conversion_id;
/**
* Sets custom dimensions data.
*
* @since 1.113.0
*
* @param string $custom_dimensions Custom dimensions data.
*/
public function set_custom_dimensions( $custom_dimensions ) {
$this->custom_dimensions = $custom_dimensions;
}
/**
* Sets the current home domain.
*
* @since 1.24.0
*
* @param string $domain Domain name.
*/
public function set_home_domain( $domain ) {
$this->home_domain = $domain;
}
/**
* Sets the ads conversion ID.
*
* @since 1.32.0
*
* @param string $ads_conversion_id Ads ID.
*/
public function set_ads_conversion_id( $ads_conversion_id ) {
$this->ads_conversion_id = $ads_conversion_id;
}
/**
* Registers tag hooks.
*
* @since 1.31.0
*/
public function register() {
add_action( 'googlesitekit_setup_gtag', $this->get_method_proxy( 'setup_gtag' ) );
$this->do_init_tag_action();
}
/**
* Outputs gtag snippet.
*
* @since 1.24.0
*/
protected function render() {
// Do nothing, gtag script is enqueued.
}
/**
* Configures gtag script.
*
* @since 1.24.0
* @since n.e.x.t Changed name and refactored.
*
* @param GTag $gtag GTag instance.
*/
protected function setup_gtag( $gtag ) {
$gtag_opt = $this->get_tag_config();
/**
* Filters the gtag configuration options for the Analytics snippet.
*
* You can use the {@see 'googlesitekit_amp_gtag_opt'} filter to do the same for gtag in AMP.
*
* @since 1.24.0
*
* @see https://developers.google.com/gtagjs/devguide/configure
*
* @param array $gtag_opt gtag config options.
*/
$gtag_opt = apply_filters( 'googlesitekit_gtag_opt', $gtag_opt );
if ( ! empty( $gtag_opt['linker'] ) ) {
$gtag->add_command( 'set', 'linker', $gtag_opt['linker'] );
unset( $gtag_opt['linker'] );
}
$gtag->add_tag( $this->tag_id, $gtag_opt );
// TODO: Lift this out to the Ads module when it's ready.
if ( $this->ads_conversion_id ) {
$gtag->add_tag( $this->ads_conversion_id );
}
$filter_google_gtagjs = function ( $tag, $handle ) {
if ( GTag::HANDLE !== $handle ) {
return $tag;
}
// Retain this comment for detection of Site Kit placed tag.
$snippet_comment = sprintf( "\n<!-- %s -->\n", esc_html__( 'Google Analytics snippet added by Site Kit', 'google-site-kit' ) );
return $snippet_comment . $tag;
};
add_filter( 'script_loader_tag', $filter_google_gtagjs, 10, 2 );
}
/**
* Gets the tag config as used in the gtag data vars.
*
* @since 1.113.0
*
* @return array Tag configuration.
*/
protected function get_tag_config() {
$config = array();
if ( ! empty( $this->home_domain ) ) {
$config['linker'] = array( 'domains' => array( $this->home_domain ) );
}
if ( ! empty( $this->custom_dimensions ) ) {
$config = array_merge( $config, $this->custom_dimensions );
}
return $config;
}
}