├── CHANGELOG.md ├── LICENSE ├── README.md ├── assets ├── blocks.js └── events.js ├── composer.json ├── inc ├── namespace.php └── template-tags.php └── plugin.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | The changelog is now included in [GitHub Releases](https://github.com/humanmade/hm-gtm/releases). 4 | 5 | ## Prior versions 6 | 7 | v2.0.2 8 | 9 | - Fix fatal error on user signup / account activation 10 | 11 | v2.0.1 12 | 13 | - Fix author output on post types that don't support them #17 14 | 15 | v2.0.0 16 | 17 | This major version contains breaking changes for any projects that reference the `HM_GTM` namespace or the function `HM_GTM\tag()`. 18 | 19 | Additionally the `dataLayer` format has been completely overhauled to be more useful. 20 | 21 | - Fully rewritten API 22 | - Namespace changed to `HM\GTM` 23 | - Custom event tracking JS added 24 | - `dataLayer` completely overhauled 25 | - New non-namespaced template tags, `gtm_tag()`, `get_gtm_data_layer()`, `get_gtm_data_attributes()` 26 | 27 | v1.1.0 28 | 29 | Initial version 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Google Tag Manager Tools 2 | 3 | Google Tag Manager template tags and settings tool. Now supports [Server Side GTM](https://developers.google.com/tag-platform/tag-manager/server-side). 4 | 5 | ## v3 Breaking Changes 6 | 7 | There are some breaking changes in v3.0.0: 8 | 9 | * data layer no longer passes `post.author_id` by default 10 | * data layer `post.ID` renamed to `post.id` 11 | * data layer `term.ID` renamed to `term.id` 12 | * data layer `author.ID` renamed to `author.id` 13 | * data layer `user.role` is no longer an array but a comma separated list of roles 14 | * data layer `post.` is no longer an array but a comma separated list of term names 15 | * data layer `post.author_slug` is no longer available by default, use `post.author_name` instead 16 | 17 | ## Usage 18 | 19 | Once the plugin is installed and activated there are 2 places you can configure: 20 | 21 | 1. On the general settings page in admin add your container ID eg. `GTM-123ABC` 22 | 2. For a multisite install you can set a network wide container ID on the network settings screen 23 | 24 | ### Server Side GTM 25 | 26 | You can optionally specify the following: 27 | 28 | 1. Server container URL - this should the absolute path to the server container, even if you are using a reverse proxy. 29 | 2. Custom code snippet - this is a block of code that will be added to the `` of the page. Some server side container providers have subtle or extensive changes to the standard GTM snippet so you can override it fully if needed. 30 | 3. Cookie preservation - you can set a special UUID cookie that lasts a long time, some server side providers allow restoring cookies set by 3rd parties or client side code in this way. 31 | 32 | ### No script fallback 33 | 34 | **NOTE:** This is not needed for block themes. 35 | 36 | If your theme is a classic theme, and you wish to support the fallback iframe for devices without javascript, add the following code just after the opening `` tag in your theme: 37 | 38 | ```php 39 | 40 | ``` 41 | 42 | ## Data Layer 43 | 44 | GTM offers a `dataLayer` which allows you pass arbitrary data that can be used to modify which tags are added to your site. 45 | 46 | This plugin adds some default information such as page author, tags and categories and provides a simple filter for adding in your own custom key/value pairs. 47 | 48 | ```php 49 | 57 | ``` 58 | 59 | Find out more about [using the `dataLayer` variable here](https://developers.google.com/tag-manager/devguide#datalayer). 60 | 61 | You can explore and view the `dataLayer` variables by previewing your container and using the overlay on your website. 62 | 63 | ### Custom event tracking 64 | 65 | In the block editor you can add event tracking to any block via the settings panel in the block sidebar. This calls `dataLayer.push()` with the event data specified. 66 | 67 | All blocks are opted in to support this by default, but you can set block support to false with the following during block registration, or via `block.json`. For example: 68 | 69 | ```php 70 | register_block_type( 'my-plugin/my-block', [ 71 | 'supports' => [ 72 | 'gtm' => false, 73 | ], 74 | ) ); 75 | ``` 76 | 77 | By default the plugin will look for elements with special data attributes in your markup and listen to the specified event to push events to the data layer. 78 | 79 | The data attributes are: 80 | 81 | - `data-gtm-on`: _enum_ [click|submit|keyup|focusin|focusout|mouseenter|mouseleave] The JS event to listen for, defaults to 'click'. 82 | - `data-gtm-event`: _string_ The name or action of the event eg. "play". 83 | - `data-gtm-category`: _string_ Optional group the event belongs to. 84 | - `data-gtm-label`: _string_ Optional human readable label for the event. 85 | - `data-gtm-value`: _number_ Optional numeric value associated with the event eg. product price. 86 | - `data-gtm-fields`: _string_ Optional extra data provided as encoded JSON. 87 | - `data-gtm-var`: _string_ Optionally override the default dataLayer variable name for this event. 88 | 89 | Example: 90 | 91 | ```html 92 | 100 | ``` 101 | 102 | There is also a helper function to return these data attributes called `get_gtm_data_attributes()`. 103 | 104 | To deactivate custom event tracking use the following code: 105 | 106 | ```php 107 | add_filter( 'hm_gtm_enable_event_tracking', '__return_false' ); 108 | ``` 109 | -------------------------------------------------------------------------------- /assets/blocks.js: -------------------------------------------------------------------------------- 1 | const addFilter = wp.hooks.addFilter; 2 | const InspectorControls = wp.blockEditor.InspectorControls; 3 | const hasBlockSupport = wp.blocks.hasBlockSupport; 4 | const TextControl = wp.components.TextControl; 5 | const SelectControl = wp.components.SelectControl; 6 | const PanelBody = wp.components.PanelBody; 7 | const __ = wp.i18n.__; 8 | 9 | function HMGTMEvents(BlockEdit) { 10 | return function (props) { 11 | const attributes = props.attributes; 12 | const setAttributes = props.setAttributes; 13 | 14 | const supportsGTM = attributes?.gtm !== undefined; 15 | 16 | // Check if the block supports "gtm" 17 | if (!supportsGTM) { 18 | return wp.element.createElement(BlockEdit, props); 19 | } 20 | 21 | function update( settings ) { 22 | setAttributes({ gtm: { ...(attributes.gtm || {}), ...settings } }); 23 | } 24 | 25 | return ( 26 | wp.element.createElement( 27 | wp.element.Fragment, 28 | null, 29 | wp.element.createElement( 30 | BlockEdit, 31 | props 32 | ), 33 | wp.element.createElement( 34 | InspectorControls, 35 | null, 36 | wp.element.createElement( 37 | PanelBody, 38 | { title: __( 'Google Tag Manager', 'hm-gtm' ), initialOpen: false }, 39 | wp.element.createElement( 40 | 'p', 41 | {}, 42 | __( 'The following options allow you to push an event to GTM when this block is interacted with.', 'hm-gtm' ) 43 | ), 44 | wp.element.createElement( 45 | SelectControl, 46 | { 47 | label: __( 'Event Trigger', 'hm-gtm' ), 48 | value: attributes?.gtm?.trigger || 'click', 49 | options: [ 50 | { label: __( 'Click', 'hm-gtm' ), value: 'click' }, 51 | { label: __( 'Submit', 'hm-gtm' ), value: 'submit' }, 52 | { label: __( 'Focus', 'hm-gtm' ), value: 'focusin' }, 53 | { label: __( 'Blur', 'hm-gtm' ), value: 'focusout' }, 54 | { label: __( 'Key up', 'hm-gtm' ), value: 'keyup' }, 55 | { label: __( 'Mouseover', 'hm-gtm' ), value: 'mouseenter' }, 56 | { label: __( 'Mouseout', 'hm-gtm' ), value: 'mouseleave' } 57 | ], 58 | onChange: function (value) { 59 | update({ trigger: value }); 60 | } 61 | } 62 | ), 63 | wp.element.createElement( 64 | TextControl, 65 | { 66 | label: __( 'Event Name', 'hm-gtm' ), 67 | value: attributes.gtm?.event || '', 68 | onChange: function (value) { 69 | update({ event: value }); 70 | } 71 | } 72 | ), 73 | wp.element.createElement( 74 | TextControl, 75 | { 76 | label: __( 'Action', 'hm-gtm' ), 77 | value: attributes.gtm?.action || '', 78 | onChange: function (value) { 79 | update({ action: value }); 80 | } 81 | } 82 | ), 83 | wp.element.createElement( 84 | TextControl, 85 | { 86 | label: __( 'Category', 'hm-gtm' ), 87 | value: attributes.gtm?.category || '', 88 | onChange: function (value) { 89 | update({ category: value }); 90 | } 91 | } 92 | ), 93 | wp.element.createElement( 94 | TextControl, 95 | { 96 | label: __( 'Label', 'hm-gtm' ), 97 | value: attributes.gtm?.label || '', 98 | onChange: function (value) { 99 | update({ label: value }); 100 | } 101 | } 102 | ), 103 | wp.element.createElement( 104 | TextControl, 105 | { 106 | label: __( 'Value', 'hm-gtm' ), 107 | value: attributes.gtm?.value || '', 108 | onChange: function (value) { 109 | update({ value: value }); 110 | } 111 | } 112 | ) 113 | ) 114 | ) 115 | ) 116 | ); 117 | }; 118 | } 119 | 120 | addFilter( 121 | 'editor.BlockEdit', 122 | 'hm-gtm/events', 123 | HMGTMEvents, 124 | 5000 125 | ); 126 | 127 | function addGTMAttribute(settings) { 128 | if ( ! hasBlockSupport( settings.name, 'gtm', true ) ) { 129 | return settings; 130 | } 131 | 132 | return { 133 | ...settings, 134 | attributes: { 135 | ...settings.attributes, 136 | gtm: { 137 | type: 'object', 138 | default: {}, 139 | properties: { 140 | trigger: { 141 | type: 'string', 142 | enum: [ 'click', 'submit', 'focusin', 'focusout', 'keyup', 'mouseenter', 'mouseleave' ] 143 | }, 144 | event: { 145 | type: 'string' 146 | }, 147 | action: { 148 | type: 'string' 149 | }, 150 | category: { 151 | type: 'string' 152 | }, 153 | label: { 154 | type: 'string' 155 | }, 156 | value: { 157 | type: 'string' 158 | } 159 | } 160 | }, 161 | }, 162 | }; 163 | } 164 | 165 | wp.hooks.addFilter( 166 | 'blocks.registerBlockType', 167 | 'hm-gtm/add-gtm-attribute', 168 | addGTMAttribute, 169 | 5000 170 | ); 171 | -------------------------------------------------------------------------------- /assets/events.js: -------------------------------------------------------------------------------- 1 | "use strict" 2 | 3 | document.addEventListener('DOMContentLoaded', function () { 4 | // IE11 Support: https://developer.mozilla.org/en-US/docs/Web/API/NodeList/forEach#Polyfill 5 | if ( window.NodeList && ! NodeList.prototype.forEach ) { 6 | NodeList.prototype.forEach = Array.prototype.forEach; 7 | } 8 | 9 | document.querySelectorAll('[data-gtm-on]').forEach(function (element) { 10 | var data = element.dataset, 11 | trigger = data.gtmOn; 12 | 13 | // Set the event listener. 14 | element.addEventListener(trigger, function () { 15 | // Check for custom variable. 16 | var variable = data.gtmVar || 'dataLayer', 17 | entry = {}; 18 | 19 | // Instantiate the dataLayer variable if it doesn't exist. 20 | window[variable] = window[variable] || []; 21 | 22 | data.gtmEvent && (entry.event = String(data.gtmEvent)); 23 | data.gtmAction && (entry.action = String(data.gtmAction)); 24 | data.gtmCategory && (entry.category = String(data.gtmCategory)); 25 | data.gtmLabel && (entry.label = String(data.gtmLabel)); 26 | data.gtmValue && (entry.value = Number(data.gtmValue)); 27 | data.gtmFields && (entry.fields = JSON.parse(data.gtmFields)); 28 | 29 | // Push the entry onto the dataLayer. 30 | window[variable].push(entry); 31 | }); 32 | }); 33 | }); 34 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "humanmade/hm-gtm", 3 | "description": "Google Tag Manager Tools for WordPress", 4 | "type": "wordpress-plugin", 5 | "license": "GPL-3.0", 6 | "authors": [ 7 | { 8 | "name": "Robert O'Rourke", 9 | "email": "rob@humanmade.com" 10 | } 11 | ], 12 | "require": { 13 | "composer/installers": "^1.0 || ^2.0" 14 | }, 15 | "config": { 16 | "allow-plugins": { 17 | "composer/installers": true 18 | } 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /inc/namespace.php: -------------------------------------------------------------------------------- 1 | register( 50 | 'gtm', 51 | [ 52 | 'register_attribute' => function ( WP_Block_Type $block_type ) { 53 | if ( ! block_has_support( $block_type, 'gtm', true ) ) { 54 | return []; 55 | } 56 | 57 | if ( ! $block_type->attributes ) { 58 | $block_type->attributes = []; 59 | } 60 | 61 | $block_type->attributes['gtm'] = [ 62 | 'type' => 'object', 63 | 'properties' => [ 64 | 'trigger' => [ 65 | 'type' => 'string', 66 | 'enum' => [ 'click', 'submit', 'focusin', 'focusout', 'mouseenter', 'mouseleave' ], 67 | ], 68 | 'event' => [ 69 | 'type' => 'string', 70 | ], 71 | 'action' => [ 72 | 'type' => 'string', 73 | ], 74 | 'category' => [ 75 | 'type' => 'string', 76 | ], 77 | 'label' => [ 78 | 'type' => 'string', 79 | ], 80 | 'value' => [ 81 | 'type' => 'string', 82 | ], 83 | ], 84 | ]; 85 | }, 86 | ] 87 | ); 88 | } 89 | 90 | // dataLayer display. 91 | /** 92 | * Toggle whether to show the dataLayer UI or not. 93 | * 94 | * @param $show bool If true the UI is displayed. 95 | */ 96 | $show_data_layer_ui = apply_filters( 'hm_gtm_show_data_layer_ui', true ); 97 | 98 | if ( $show_data_layer_ui ) { 99 | add_action( 'admin_bar_menu', __NAMESPACE__ . '\\admin_bar_data_layer_ui', 100 ); 100 | add_filter( 'map_meta_cap', __NAMESPACE__ . '\\view_data_layer_cap', 10, 3 ); 101 | } 102 | } 103 | 104 | /** 105 | * Outputs the gtm tag, place this immediately after the opening tag 106 | */ 107 | function output_tag() { 108 | if ( doing_action( 'after_body' ) ) { 109 | _deprecated_hook( 'after_body', '3.0.0', 'wp_body_open', 'From version 3.0.0 of the HM GTM plugin you should use the `wp_open_body()` function instead of `do_action(\'after_body\')` for classic themes.' ); 110 | } 111 | 112 | /** 113 | * Filter the hm_gtm_id variable to support other methods of setting this value. 114 | * 115 | * @param string $site_container_id The GTM container ID. 116 | */ 117 | $site_container_id = apply_filters( 'hm_gtm_id', get_option( 'hm_gtm_id', false ) ); 118 | 119 | $site_container_url = get_option( 'hm_gtm_url', '' ); 120 | $site_container_snippet = get_option( 'hm_gtm_snippet', '' ); 121 | $site_container_snippet_iframe = get_option( 'hm_gtm_snippet_iframe', '' ); 122 | 123 | /** 124 | * Filter the hm_gtm_network_id variable to support other methods of setting this value. 125 | * 126 | * @param string $network_container_id The network GTM container ID. 127 | */ 128 | $network_container_id = apply_filters( 'hm_gtm_network_id', get_site_option( 'hm_gtm_network_id', false ) ); 129 | 130 | $network_container_url = get_site_option( 'hm_gtm_network_url', '' ); 131 | $network_container_snippet = get_site_option( 'hm_gtm_network_snippet', '' ); 132 | $network_container_snippet_iframe = get_site_option( 'hm_gtm_network_snippet_iframe', '' ); 133 | 134 | /** 135 | * Filter the dataLayer variable name. Tag manager allow for 136 | * custom variable names to avoid collisions and scope container events. 137 | * 138 | * @param string $data_layer The name to use for the dataLayer variable. 139 | */ 140 | $data_layer_var = apply_filters( 'hm_gtm_data_layer_var', 'dataLayer' ); 141 | 142 | if ( doing_action( 'wp_head' ) ) { 143 | // If it's the head action output the JS and dataLayer. 144 | if ( $network_container_id ) { 145 | gtm_tag( $network_container_id, get_gtm_data_layer(), $data_layer_var, $network_container_url, $network_container_snippet ); 146 | } 147 | 148 | if ( $site_container_id ) { 149 | gtm_tag( $site_container_id, $network_container_id ? [] : get_gtm_data_layer(), $data_layer_var, $site_container_url, $site_container_snippet ); 150 | } 151 | } else { 152 | // If the tag is called directly or on another action output the noscript fallback. 153 | // This gives us back compat and noscript support in one go. 154 | if ( $network_container_id ) { 155 | gtm_tag_iframe( $network_container_id, $network_container_url, $network_container_snippet_iframe ); 156 | } 157 | 158 | if ( $site_container_id ) { 159 | gtm_tag_iframe( $site_container_id, $site_container_url, $site_container_snippet_iframe ); 160 | } 161 | } 162 | } 163 | 164 | /** 165 | * Add admin settings. 166 | */ 167 | function add_site_settings() { 168 | add_settings_section( 169 | 'hm_gtm', 170 | esc_html__( 'Google Tag Manager', 'hm_gtm' ), 171 | __NAMESPACE__ . '\\settings_section', 172 | 'general' 173 | ); 174 | 175 | // Fields. 176 | add_settings_field( 177 | 'hm_gtm_id_field', 178 | esc_html__( 'Container ID (Required)', 'hm_gtm' ), 179 | __NAMESPACE__ . '\\text_settings_field', 180 | 'general', 181 | 'hm_gtm', 182 | [ 183 | 'value' => get_option( 'hm_gtm_id', '' ), 184 | 'name' => 'hm_gtm_id', 185 | 'description' => esc_html__( 'Enter your container ID eg. GTM-123ABC', 'hm_gtm' ), 186 | ] 187 | ); 188 | 189 | register_setting( 190 | 'general', 191 | 'hm_gtm_id', 192 | [ 193 | 'type' => 'string', 194 | 'description' => esc_html__( 'Google Tag Manager Container ID', 'hm_gtm' ), 195 | 'sanitize_callback' => 'sanitize_text_field', 196 | 'default' => '', 197 | ] 198 | ); 199 | 200 | add_settings_field( 201 | 'hm_gtm_url_field', 202 | esc_html__( 'Container URL', 'hm_gtm' ), 203 | __NAMESPACE__ . '\\text_settings_field', 204 | 'general', 205 | 'hm_gtm', 206 | [ 207 | 'value' => get_option( 'hm_gtm_url', '' ), 208 | 'name' => 'hm_gtm_url', 209 | 'description' => esc_html__( 'If you are using server side Tag Manager, enter the server container URL here, typically just the custom domain, or path if using a reverse proxy.', 'hm_gtm' ), 210 | ] 211 | ); 212 | 213 | register_setting( 214 | 'general', 215 | 'hm_gtm_url', 216 | [ 217 | 'type' => 'string', 218 | 'description' => esc_html__( 'Google Tag Manager Container URL', 'hm_gtm' ), 219 | 'sanitize_callback' => function ( $value ) { 220 | if ( empty( $value ) ) { 221 | return $value; 222 | } 223 | 224 | // If a relative path is provided then make it absolute. 225 | if ( strpos( $value, 'http' ) === false ) { 226 | $value = home_url( $value ); 227 | } 228 | 229 | return sanitize_url( $value ); 230 | }, 231 | 'default' => '', 232 | ] 233 | ); 234 | 235 | add_settings_field( 236 | 'hm_gtm_cookie_field', 237 | esc_html__( 'Cookie restoration / master cookie name', 'hm_gtm' ), 238 | __NAMESPACE__ . '\\text_settings_field', 239 | 'general', 240 | 'hm_gtm', 241 | [ 242 | 'value' => get_uuid_cookie_name(), 243 | 'name' => 'hm_gtm_cookie', 244 | 'description' => esc_html__( 'Some server side Tag Manager providers support restoring expired cookies from a master cookie value, you can set the name of the cookie here.', 'hm_gtm' ), 245 | ] 246 | ); 247 | 248 | register_setting( 249 | 'general', 250 | 'hm_gtm_cookie', 251 | [ 252 | 'type' => 'string', 253 | 'description' => esc_html__( 'Google Tag Manager cookie restoration / master cookie name', 'hm_gtm' ), 254 | 'sanitize_callback' => 'sanitize_key', 255 | 'default' => '', 256 | ] 257 | ); 258 | 259 | // Extra permissions check for super admin privilege on multisite to enter custom JS code. 260 | if ( ( ! is_multisite() && current_user_can( 'manage_options' ) ) || is_super_admin() ) { 261 | add_settings_field( 262 | 'hm_gtm_snippet_field', 263 | esc_html__( 'Custom code snippet', 'hm_gtm' ), 264 | __NAMESPACE__ . '\\textarea_settings_field', 265 | 'general', 266 | 'hm_gtm', 267 | [ 268 | 'value' => get_option( 'hm_gtm_snippet', '' ), 269 | 'name' => 'hm_gtm_snippet', 270 | 'description' => esc_html__( 'Some server side Tag Manager providers use a code snippet that is different to the standard one. Paste it here if you are provided with one or if you are unsure.', 'hm_gtm' ), 271 | ] 272 | ); 273 | 274 | register_setting( 275 | 'general', 276 | 'hm_gtm_snippet', 277 | [ 278 | 'type' => 'string', 279 | 'description' => esc_html__( 'Google Tag Manager Container Snippet', 'hm_gtm' ), 280 | 'sanitize_callback' => function ( $value ) { 281 | return trim( $value ); 282 | }, 283 | 'default' => '', 284 | ] 285 | ); 286 | 287 | add_settings_field( 288 | 'hm_gtm_snippet_iframe_field', 289 | esc_html__( 'Custom iframe code snippet', 'hm_gtm' ), 290 | __NAMESPACE__ . '\\textarea_settings_field', 291 | 'general', 292 | 'hm_gtm', 293 | [ 294 | 'value' => get_option( 'hm_gtm_snippet_iframe', '' ), 295 | 'name' => 'hm_gtm_snippet_iframe', 296 | 'description' => esc_html__( 'Some server side Tag Manager providers use a code snippet that is different to the standard one. Usually it is enough to provide the custom container URL value above.', 'hm_gtm' ), 297 | ] 298 | ); 299 | 300 | register_setting( 301 | 'general', 302 | 'hm_gtm_snippet_iframe', 303 | [ 304 | 'type' => 'string', 305 | 'description' => esc_html__( 'Google Tag Manager Iframe Container Snippet', 'hm_gtm' ), 306 | 'sanitize_callback' => function ( $value ) { 307 | return trim( $value ); 308 | }, 309 | 'default' => '', 310 | ] 311 | ); 312 | } 313 | 314 | add_settings_field( 315 | 'hm_gtm_show_datalayer_field', 316 | esc_html__( 'Show data layer in admin bar', 'hm_gtm' ), 317 | __NAMESPACE__ . '\\checkbox_settings_field', 318 | 'general', 319 | 'hm_gtm', 320 | [ 321 | 'value' => get_option( 'hm_gtm_show_datalayer', false ), 322 | 'name' => 'hm_gtm_show_datalayer', 323 | 'description' => esc_html__( 'Show the available data layer values for the current page in the admin bar', 'hm_gtm' ), 324 | ] 325 | ); 326 | 327 | register_setting( 328 | 'general', 329 | 'hm_gtm_show_datalayer', 330 | [ 331 | 'type' => 'string', 332 | 'description' => esc_html__( 'Show Google Tag Manager Data Layer', 'hm_gtm' ), 333 | 'sanitize_callback' => 'absint', 334 | 'default' => '', 335 | ] 336 | ); 337 | } 338 | 339 | /** 340 | * Display Network Settings for Google Tag Manager 341 | */ 342 | function add_network_settings() { 343 | ?> 344 |

345 | 346 | 347 | 350 | 359 | 360 | 361 | 364 | 373 | 374 | 375 | 378 | 387 | 388 | 389 | 392 | 401 | 402 | 403 | %s

', esc_html__( 'If you need to enter a custom code snippet for server side Tag Manager, please contact a network super admin to add this for you.', 'hm_gtm' ) ); 430 | } 431 | } 432 | 433 | /** 434 | * Text field for GTM container IDs. 435 | * 436 | * @param array $args The field settings. 437 | */ 438 | function text_settings_field( array $args ) { 439 | $args = wp_parse_args( $args, [ 440 | 'name' => '', 441 | 'value' => '', 442 | 'description' => '', 443 | ] ); 444 | 445 | printf( '%4$s', 446 | esc_attr( $args['name'] ), 447 | esc_attr( $args['value'] ), 448 | $args['description'] ? 'aria-describedby="' . esc_attr( $args['name'] ) . '-description" ' : '', 449 | $args['description'] ? '

' . esc_html( $args['description'] ) . '

' : '' 450 | ); 451 | } 452 | 453 | /** 454 | * Textarea field for GTM container IDs. 455 | * 456 | * @param array $args The field settings. 457 | */ 458 | function textarea_settings_field( array $args ) { 459 | $args = wp_parse_args( $args, [ 460 | 'name' => '', 461 | 'value' => '', 462 | 'description' => '', 463 | ] ); 464 | 465 | printf( '%4$s', 466 | esc_attr( $args['name'] ), 467 | esc_textarea( $args['value'] ), 468 | $args['description'] ? 'aria-describedby="' . esc_attr( $args['name'] ) . '-description" ' : '', 469 | $args['description'] ? '

' . esc_html( $args['description'] ) . '

' : '' 470 | ); 471 | } 472 | 473 | /** 474 | * Checkbox field for GTM container IDs. 475 | * 476 | * @param array $args The field settings. 477 | */ 478 | function checkbox_settings_field( array $args ) { 479 | $args = wp_parse_args( $args, [ 480 | 'name' => '', 481 | 'value' => '', 482 | 'description' => '', 483 | ] ); 484 | 485 | printf( '', 486 | esc_attr( $args['name'] ), 487 | checked( true, (bool) get_option( 'hm_gtm_show_datalayer', false ), false ), 488 | $args['description'] ? esc_html( $args['description'] ) : '' 489 | ); 490 | } 491 | 492 | /** 493 | * Retrieve the service UUID cookie name for cookie restoration. 494 | * 495 | * @return string 496 | */ 497 | function get_uuid_cookie_name() : string { 498 | return (string) get_option( 'hm_gtm_cookie', '' ); 499 | } 500 | 501 | /** 502 | * Fires when preparing to serve a REST API request. 503 | */ 504 | function uuid_cookie_endpoint() : void { 505 | register_rest_route( 506 | 'service/v1', 507 | 'id', 508 | [ 509 | 'methods' => 'GET', 510 | 'callback' => function ( WP_REST_Request $request ) { 511 | $cookie_name = get_uuid_cookie_name(); 512 | 513 | // Short-circuit early if we're not using this feature. 514 | if ( empty( $cookie_name ) ) { 515 | return rest_ensure_response( null ); 516 | } 517 | 518 | $cookie_value = $_COOKIE[ $cookie_name ] ?? ''; 519 | 520 | // Generate or get param from localStorage if defined. 521 | if ( ! wp_is_uuid( $cookie_value ) ) { 522 | $restored_value = $request->get_param( 'id' ); 523 | $cookie_value = wp_is_uuid( $restored_value ) ? $restored_value : wp_generate_uuid4(); 524 | } 525 | 526 | // Preserve UUID for logged in users. 527 | if ( is_user_logged_in() ) { 528 | $uuid = get_user_meta( get_current_user_id(), '_hm_gtm_uuid', true ); 529 | if ( ! wp_is_uuid( $uuid ) ) { 530 | update_user_meta( get_current_user_id(), '_hm_gtm_uuid', $cookie_value ); 531 | } else { 532 | $cookie_value = $uuid; 533 | } 534 | } 535 | 536 | setcookie( $cookie_name, $cookie_value, [ 537 | 'expires' => time() + ( YEAR_IN_SECONDS * 2 ), 538 | 'path' => '/', 539 | 'domain' => '.' . str_replace( 'www.', '', wp_parse_url( home_url(), PHP_URL_HOST ) ), 540 | 'secure' => true, 541 | 'httponly' => false, 542 | 'samesite' => 'lax', 543 | ] ); 544 | 545 | // Endpoint cannot be cached by CDN or batcache. 546 | nocache_headers(); 547 | 548 | return rest_ensure_response( [ 'id' => $cookie_value ] ); 549 | }, 550 | 'permission_callback' => '__return_true', 551 | ] 552 | ); 553 | } 554 | 555 | /** 556 | * Enqueue data attribute tracking script. 557 | */ 558 | function enqueue_scripts() { 559 | wp_enqueue_script( 'hm-gtm', plugins_url( '/assets/events.js', dirname( __FILE__ ) ), [], VERSION, [ 560 | 'in_footer' => false, 561 | 'strategy' => 'defer', 562 | ] ); 563 | } 564 | 565 | /** 566 | * Enqueue block editor settings panel. 567 | */ 568 | function block_editor_enqueue_scripts() { 569 | wp_enqueue_script( 'hm-gtm-blocks', plugins_url( '/assets/blocks.js', dirname( __FILE__ ) ), [ 570 | 'wp-blocks', 571 | 'wp-block-editor', 572 | 'wp-hooks', 573 | 'wp-components', 574 | ], VERSION, [ 575 | 'in_footer' => false, 576 | 'strategy' => 'defer', 577 | ] ); 578 | } 579 | 580 | /** 581 | * Filters the content of a single block. 582 | * 583 | * @param string $block_content The block content. 584 | * @param array $block The full block, including name and attributes. 585 | * @return string The block content. 586 | */ 587 | function filter_render_block( string $block_content, array $block ) : string { 588 | 589 | // Check minimum requirements. 590 | if ( empty( $block['attrs']['gtm'] ) || empty( $block['attrs']['gtm']['event'] ) ) { 591 | return $block_content; 592 | } 593 | 594 | $attributes = []; 595 | $attributes['data-gtm-on'] = $block['attrs']['gtm']['trigger'] ?? 'click'; 596 | 597 | foreach ( [ 'event', 'action', 'category', 'label', 'value' ] as $key ) { 598 | if ( ! empty( $block['attrs']['gtm'][ $key ] ) ) { 599 | $attributes["data-gtm-{$key}"] = $block['attrs']['gtm'][ $key ]; 600 | } 601 | } 602 | 603 | $block = new WP_HTML_Tag_Processor( $block_content ); 604 | $block->set_bookmark( 'root' ); 605 | 606 | $query = null; 607 | 608 | switch ( $attributes['data-gtm-on'] ) { 609 | case 'click': 610 | $query = [ 'tag_name' => 'a' ]; 611 | // Test for an anchor tag. 612 | if ( ! $block->next_tag( [ 'tag_name' => $query ] ) ) { 613 | // Update to test for a button. 614 | $query['tag_name'] = 'button'; 615 | $block->seek( 'root' ); 616 | } 617 | // Test for a button tag. 618 | if ( ! $block->next_tag( [ 'tag_name' => $query ] ) ) { 619 | // Reset to first/wrapper tag. 620 | $query = null; 621 | } 622 | $block->seek( 'root' ); 623 | $block->next_tag( $query ); 624 | break; 625 | case 'submit': 626 | // Must be a form tag. 627 | $block->next_tag( [ 'tag_name' => 'form' ] ); 628 | break; 629 | default: 630 | $block->next_tag(); 631 | } 632 | 633 | foreach ( $attributes as $name => $value ) { 634 | $block->set_attribute( $name, $value ); 635 | } 636 | 637 | return (string) $block; 638 | } 639 | 640 | /** 641 | * Modify the admin bar to show dataLayer variables. 642 | * 643 | * @param WP_Admin_Bar $admin_bar 644 | */ 645 | function admin_bar_data_layer_ui( WP_Admin_Bar $admin_bar ) { 646 | // Front end only. 647 | if ( is_admin() ) { 648 | return; 649 | } 650 | 651 | // Settings check. 652 | if ( ! ( (bool) get_option( 'hm_gtm_show_datalayer', false ) ) ) { 653 | return; 654 | } 655 | 656 | // Capability check. 657 | if ( ! current_user_can( 'hm_gtm_data_layer' ) ) { 658 | return; 659 | } 660 | 661 | // Get the data layer object. 662 | $data_layer = get_gtm_data_layer(); 663 | $data_layer = flatten_array( $data_layer ); 664 | 665 | $admin_bar->add_menu( [ 666 | 'id' => 'hm-gtm', 667 | 'title' => ' 668 | 669 | ' . __( 'GTM Data Layer', 'hm-gtm' ) . '', 670 | ] ); 671 | 672 | foreach ( $data_layer as $key => $value ) { 673 | $admin_bar->add_node( [ 674 | 'id' => sanitize_key( "hm-gtm-$key" ), 675 | 'title' => "{$key}: " . wp_unslash( $value ), 676 | 'parent' => 'hm-gtm', 677 | ] ); 678 | } 679 | } 680 | 681 | /** 682 | * Flattens an array recursively and sets the keys for nested values 683 | * as a dot separated path. 684 | * 685 | * @param array $data The array to flatten. 686 | * @param string $prefix The current key prefix. 687 | * @return array 688 | */ 689 | function flatten_array( array $data, string $prefix = '' ) : array { 690 | $flattened = []; 691 | $prefix = ! empty( $prefix ) ? "{$prefix}." : ''; 692 | 693 | foreach ( $data as $key => $value ) { 694 | if ( is_array( $value ) ) { 695 | $flattened = array_merge( $flattened, flatten_array( $value, "{$prefix}{$key}" ) ); 696 | } else { 697 | $flattened[ "{$prefix}{$key}" ] = trim( json_encode( $value ), '"' ); 698 | } 699 | } 700 | 701 | return $flattened; 702 | } 703 | 704 | /** 705 | * Allow site admins to view the dataLayer by default. 706 | * 707 | * @param array $caps Required capabilities for current check. 708 | * @param string $cap Capability being checked. 709 | * @return array 710 | */ 711 | function view_data_layer_cap( array $caps, string $cap, int $user_id ) { 712 | if ( $cap === 'hm_gtm_data_layer' && user_can( $user_id, 'manage_options' ) ) { 713 | $caps[] = 'hm_gtm_data_layer'; 714 | } 715 | 716 | return $caps; 717 | } 718 | -------------------------------------------------------------------------------- /inc/template-tags.php: -------------------------------------------------------------------------------- 1 | (function(d,f,l){!d.cookie.match("%1$s=")&&f&&f("%2$s?id="+(l&&l.getItem("%1$s"))).then(function(r){return r.json()}).then(function(d){l&&l.setItem("%1$s",d.id)})})(document,window.fetch,window.localStorage)', 28 | esc_js( get_uuid_cookie_name() ), 29 | esc_js( rest_url( 'service/v1/id' ) ) 30 | ); 31 | } 32 | 33 | if ( ! empty( $data_layer ) ) { 34 | $tag .= sprintf( 35 | '', 36 | $data_layer_var, 37 | wp_json_encode( $data_layer ) 38 | ); 39 | } 40 | 41 | $snippet = $snippet ?: ' 42 | 43 | 48 | 49 | '; 50 | 51 | // Ensure requested data layer var name is used. 52 | $snippet = str_replace( '\'script\',\'dataLayer\'', "'script','$data_layer_var'", $snippet ); 53 | 54 | $tag .= sprintf( 55 | $snippet, 56 | esc_attr( $container_id ), 57 | esc_js( untrailingslashit( $container_url ?: 'https://www.googletagmanager.com' ) ), 58 | $data_layer_var 59 | ); 60 | 61 | /** 62 | * Filter the tag. 63 | * 64 | * @param string $tag HTML script tag(s) for gtag and datalayer. 65 | * @param string $container_id The container's ID eg. GTM-XXXXXXX. 66 | * @param array $data_layer Array of data to set as the initial dataLayer variable value. 67 | * @param string $data_layer_var Optional alternative name for the dataLayer variable. 68 | */ 69 | return apply_filters( 'hm_gtm_script_tag', $tag, $container_id, $data_layer, $data_layer_var ); 70 | } 71 | 72 | /** 73 | * Output the tag manager container JavaScript. 74 | * 75 | * @param string $container_id The container's ID eg. GTM-XXXXXXX. 76 | * @param array $data_layer Array of data to set as the initial dataLayer variable value. 77 | * @param string $data_layer_var Optional alternative name for the dataLayer variable. 78 | * @param string $container_url Optional container URL for server side tag manager. 79 | * @param string $snippet Optional custom code snippet. 80 | */ 81 | function gtm_tag( string $container_id, array $data_layer = [], string $data_layer_var = 'dataLayer', string $container_url = '', string $snippet = '' ) { 82 | echo get_gtm_tag( ...func_get_args() ); 83 | } 84 | 85 | /** 86 | * Return the tag manager container iframe. 87 | * 88 | * @param string $container_id The container's ID eg. GTM-XXXXXXX. 89 | * @param string $container_url Optional container URL for server side tag manager. 90 | * @param string $snippet Optional custom code snippet to use. 91 | * @return string 92 | */ 93 | function get_gtm_tag_iframe( string $container_id, string $container_url = '', string $snippet = '' ) : string { 94 | $snippet = $snippet ?: ' 95 | 96 | 98 | 99 | '; 100 | 101 | return sprintf( 102 | $snippet, 103 | esc_attr( $container_id ), 104 | esc_attr( untrailingslashit( $container_url ?: 'https://www.googletagmanager.com' ) ), 105 | ); 106 | } 107 | 108 | /** 109 | * Output the tag manager container JavaScript. 110 | * 111 | * @param string $container_id The container's ID eg. GTM-XXXXXXX. 112 | * @param string $container_url Optional container URL for server side tag manager. 113 | * @param string $snippet Optional custom code snippet to use. 114 | */ 115 | function gtm_tag_iframe( string $container_id, string $container_url = '', string $snippet = '' ) { 116 | echo get_gtm_tag_iframe( ...func_get_args() ); 117 | } 118 | 119 | /** 120 | * Get contextual data for the dataLayer. 121 | * 122 | * @return array 123 | */ 124 | function get_gtm_data_layer() { 125 | /** 126 | * Default data. 127 | */ 128 | $data = [ 129 | 'type' => 'default', 130 | 'subtype' => 'default', 131 | 'context' => [ 132 | 'is_front_page' => is_front_page(), 133 | 'is_singular' => is_singular(), 134 | 'is_archive' => is_archive(), 135 | 'is_home' => is_home(), 136 | 'is_search' => is_search(), 137 | 'is_404' => is_404(), 138 | 'is_post_type_archive' => is_post_type_archive(), 139 | 'is_tax' => is_tax(), 140 | ], 141 | 'user' => [ 142 | 'logged_in' => false, 143 | ], 144 | 'blog' => [ 145 | 'url' => home_url(), 146 | 'id' => is_multisite() ? get_current_blog_id() : 0, 147 | ], 148 | ]; 149 | 150 | /** 151 | * Multisite specific options. 152 | */ 153 | if ( is_multisite() ) { 154 | $data['network'] = [ 155 | 'url' => get_site_url( get_main_site_id() ), 156 | 'id' => get_main_site_id(), 157 | ]; 158 | } 159 | 160 | /** 161 | * Logged in user data. 162 | */ 163 | if ( is_user_logged_in() ) { 164 | $user = wp_get_current_user(); 165 | $data['user']['logged_in'] = true; 166 | $data['user']['id'] = get_current_user_id(); 167 | $data['user']['role'] = implode( ',', array_keys( $user->caps ) ); 168 | } 169 | 170 | /** 171 | * Single post view data. 172 | */ 173 | if ( is_singular() ) { 174 | $post = get_queried_object(); 175 | 176 | $data['type'] = 'post'; 177 | $data['subtype'] = $post->post_type; 178 | $data['post'] = [ 179 | 'id' => $post->ID, 180 | 'title' => $post->post_title, 181 | 'slug' => $post->post_name, 182 | 'published' => $post->post_date_gmt, 183 | 'modified' => $post->post_modified_gmt, 184 | 'template' => get_page_template_slug( $post->ID ), 185 | 'thumbnail' => get_the_post_thumbnail_url( $post->ID, 'full' ), 186 | ]; 187 | 188 | if ( comments_open( $post ) ) { 189 | $data['post']['comments'] = wp_count_comments( $post->ID )->approved ?? 0; 190 | } 191 | 192 | if ( post_type_supports( $post->post_type, 'author' ) ) { 193 | // Support Authorship plugin out of the box. 194 | if ( function_exists( '\\Authorship\\get_authors' ) ) { 195 | $authors = \Authorship\get_authors( $post ); 196 | if ( ! empty( $authors ) ) { 197 | $data['post']['author_name'] = $authors[0]->display_name; 198 | $data['post']['author_names'] = implode( ',', wp_list_pluck( $authors, 'display_name' ) ); 199 | } 200 | } else { 201 | $user = get_user_by( 'id', $post->post_author ); 202 | 203 | if ( is_a( $user, 'WP_User' ) ) { 204 | $data['post']['author_name'] = $user->display_name; 205 | } 206 | } 207 | } 208 | 209 | 210 | foreach ( get_object_taxonomies( $post->post_type, 'objects' ) as $taxonomy ) { 211 | if ( ! $taxonomy->public ) { 212 | continue; 213 | } 214 | 215 | $terms = get_the_terms( $post->ID, $taxonomy->name ); 216 | 217 | if ( $terms && ! is_wp_error( $terms ) ) { 218 | $data['post'][ $taxonomy->name ] = implode( ',', wp_list_pluck( $terms, 'name' ) ); 219 | } 220 | } 221 | } 222 | 223 | /** 224 | * Add archive type data. 225 | */ 226 | if ( is_archive() ) { 227 | $data['type'] = 'archive'; 228 | 229 | if ( is_date() ) { 230 | $data['subtype'] = 'date'; 231 | $data['date'] = get_the_date(); 232 | } 233 | 234 | if ( is_search() ) { 235 | $data['subtype'] = 'search'; 236 | $data['search_term'] = get_search_query(); 237 | } 238 | 239 | if ( is_post_type_archive() ) { 240 | $data['subtype'] = get_post_type(); 241 | } 242 | 243 | if ( is_tag() || is_category() || is_tax() ) { 244 | $term = get_queried_object(); 245 | 246 | $data['type'] = 'term'; 247 | $data['subtype'] = $term->taxonomy; 248 | $data['term'] = [ 249 | 'id' => $term->term_id, 250 | 'name' => $term->name, 251 | 'slug' => $term->slug, 252 | ]; 253 | } 254 | 255 | if ( is_author() ) { 256 | $user = get_queried_object(); 257 | 258 | $data['subtype'] = 'author'; 259 | $data['author'] = [ 260 | 'id' => $user->ID, 261 | 'name' => $user->display_name, 262 | 'slug' => $user->user_nicename, 263 | ]; 264 | } 265 | } 266 | 267 | // Special case for 'home' page. 268 | if ( is_home() ) { 269 | $data['type'] = 'archive'; 270 | $data['subtype'] = 'post'; 271 | } 272 | 273 | /** 274 | * Filter the dataLayer array. 275 | * 276 | * @param array $data An array of data to pass to Tag Manager. 277 | */ 278 | $data = apply_filters( 'hm_gtm_data_layer', $data ); 279 | 280 | return $data; 281 | } 282 | 283 | /** 284 | * Helper for outputting tag manager data attributes. 285 | * 286 | * @param string $event The custom event name. 287 | * @param string $on The JS event listener, default to 'click'. Supports 288 | * any value that can be passed to addEventListener. 289 | * @param string $category Optional event category. 290 | * @param string $label Optional event label. 291 | * @param float $value Optional numeric event value. 292 | * @param array $fields Optional array of custom data. 293 | * @param string $var Optionally override the dataLayer variable name for this event. 294 | * @return string 295 | */ 296 | function get_gtm_data_attributes( string $event, string $on = 'click', string $category = '', string $label = '', ?float $value = null, array $fields = [], string $var = '' ) : string { 297 | $attrs = [ 298 | 'data-gtm-on' => $on, 299 | 'data-gtm-event' => $event, 300 | ]; 301 | 302 | if ( ! empty( $category ) ) { 303 | $attrs['data-gtm-category'] = $category; 304 | } 305 | 306 | if ( ! empty( $label ) ) { 307 | $attrs['data-gtm-label'] = $label; 308 | } 309 | 310 | if ( ! empty( $value ) ) { 311 | $attrs['data-gtm-value'] = $value; 312 | } 313 | 314 | if ( ! empty( $fields ) ) { 315 | $attrs['data-gtm-fields'] = wp_json_encode( $fields ); 316 | } 317 | 318 | if ( ! empty( $var ) ) { 319 | $attrs['data-gtm-var'] = preg_replace( '/[^a-z0-9_\-]/i', '', $var ); 320 | } 321 | 322 | return array_reduce( array_keys( $attrs ), function ( $key ) use ( $attrs ) : string { 323 | return sprintf( '%s="%s" ', sanitize_key( $key ), esc_attr( $attrs[ $key ] ) ); 324 | }, ' ' ); 325 | } 326 | -------------------------------------------------------------------------------- /plugin.php: -------------------------------------------------------------------------------- 1 |