5.4/package/pip/template-listener/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
  14
  15
  16
  17         <title>templateListener - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55
  56     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  57     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  58     <label class="md-overlay" for="__drawer"></label>
  59     <div data-md-component="skip">
  60
  61
  62         <a href="#template-listener-package-installation-plugin" class="md-skip">
  63           Skip to content
  64         </a>
  65
  66     </div>
  67     <div data-md-component="announce">
  68
  69         <aside class="md-announce">
  70           <div class="md-announce__inner md-grid md-typeset">
  71
  72     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  73
  74           </div>
  75         </aside>
  76
  77     </div>
  78
  79
  80
  81 <header class="md-header" data-md-component="header">
  82   <nav class="md-header__inner md-grid" aria-label="Header">
  83     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
  84
  85   <img src="../../../assets/logo.png" alt="logo">
  86
  87     </a>
  88     <label class="md-header__button md-icon" for="__drawer">
  89       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  90     </label>
  91     <div class="md-header__title" data-md-component="header-title">
  92       <div class="md-header__ellipsis">
  93         <div class="md-header__topic">
  94           <span class="md-ellipsis">
  95             WoltLab Suite Documentation
  96           </span>
  97         </div>
  98         <div class="md-header__topic" data-md-component="header-topic">
  99           <span class="md-ellipsis">
 100
 101               templateListener
 102
 103           </span>
 104         </div>
 105       </div>
 106     </div>
 107     <div class="md-header__options">
 108
 109     </div>
 110
 111       <label class="md-header__button md-icon" for="__search">
 112         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 113       </label>
 114
 115 <div class="md-search" data-md-component="search" role="dialog">
 116   <label class="md-search__overlay" for="__search"></label>
 117   <div class="md-search__inner" role="search">
 118     <form class="md-search__form" name="search">
 119       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 120       <label class="md-search__icon md-icon" for="__search">
 121         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 122         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 123       </label>
 124       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 125         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 126       </button>
 127     </form>
 128     <div class="md-search__output">
 129       <div class="md-search__scrollwrap" data-md-scrollfix>
 130         <div class="md-search-result" data-md-component="search-result">
 131           <div class="md-search-result__meta">
 132             Initializing search
 133           </div>
 134           <ol class="md-search-result__list"></ol>
 135         </div>
 136       </div>
 137     </div>
 138   </div>
 139 </div>
 140
 141
 142       <div class="md-header__source">
 143
 144 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 145   <div class="md-source__icon md-icon">
 146
 147     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 148   </div>
 149   <div class="md-source__repository">
 150     GitHub
 151   </div>
 152 </a>
 153       </div>
 154
 155   </nav>
 156 </header>
 157
 158     <div class="md-container" data-md-component="container">
 159
 160
 161
 162
 163       <main class="md-main" data-md-component="main">
 164         <div class="md-main__inner md-grid">
 165
 166
 167
 168               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 169                 <div class="md-sidebar__scrollwrap">
 170                   <div class="md-sidebar__inner">
 171
 172
 173
 174
 175
 176 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 177   <label class="md-nav__title" for="__drawer">
 178     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
 179
 180   <img src="../../../assets/logo.png" alt="logo">
 181
 182     </a>
 183     WoltLab Suite Documentation
 184   </label>
 185
 186     <div class="md-nav__source">
 187
 188 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 189   <div class="md-source__icon md-icon">
 190
 191     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 192   </div>
 193   <div class="md-source__repository">
 194     GitHub
 195   </div>
 196 </a>
 197     </div>
 198
 199   <ul class="md-nav__list" data-md-scrollfix>
 200
 201
 202
 203
 204
 205
 206
 207
 208     <li class="md-nav__item">
 209       <a href="../../../getting-started/" class="md-nav__link">
 210         Getting Started
 211       </a>
 212     </li>
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224     <li class="md-nav__item md-nav__item--nested">
 225
 226
 227         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 228
 229       <label class="md-nav__link" for="__nav_2">
 230         PHP API
 231         <span class="md-nav__icon md-icon"></span>
 232       </label>
 233       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 234         <label class="md-nav__title" for="__nav_2">
 235           <span class="md-nav__icon md-icon"></span>
 236           PHP API
 237         </label>
 238         <ul class="md-nav__list" data-md-scrollfix>
 239
 240
 241
 242
 243
 244     <li class="md-nav__item">
 245       <a href="../../../php/pages/" class="md-nav__link">
 246         Pages
 247       </a>
 248     </li>
 249
 250
 251
 252
 253
 254
 255
 256     <li class="md-nav__item">
 257       <a href="../../../php/database-objects/" class="md-nav__link">
 258         Database Objects
 259       </a>
 260     </li>
 261
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/database-access/" class="md-nav__link">
 270         Database Access
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280     <li class="md-nav__item">
 281       <a href="../../../php/exceptions/" class="md-nav__link">
 282         Exceptions
 283       </a>
 284     </li>
 285
 286
 287
 288
 289
 290
 291
 292
 293     <li class="md-nav__item md-nav__item--nested">
 294
 295
 296         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 297
 298       <label class="md-nav__link" for="__nav_2_5">
 299         API
 300         <span class="md-nav__icon md-icon"></span>
 301       </label>
 302       <nav class="md-nav" aria-label="API" data-md-level="2">
 303         <label class="md-nav__title" for="__nav_2_5">
 304           <span class="md-nav__icon md-icon"></span>
 305           API
 306         </label>
 307         <ul class="md-nav__list" data-md-scrollfix>
 308
 309
 310
 311
 312
 313     <li class="md-nav__item">
 314       <a href="../../../php/api/caches/" class="md-nav__link">
 315         Caches
 316       </a>
 317     </li>
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item">
 326       <a href="../../../php/api/comments/" class="md-nav__link">
 327         Comments
 328       </a>
 329     </li>
 330
 331
 332
 333
 334
 335
 336
 337     <li class="md-nav__item">
 338       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 339         Cronjobs
 340       </a>
 341     </li>
 342
 343
 344
 345
 346
 347
 348
 349     <li class="md-nav__item">
 350       <a href="../../../php/api/events/" class="md-nav__link">
 351         Events
 352       </a>
 353     </li>
 354
 355
 356
 357
 358
 359
 360
 361
 362     <li class="md-nav__item md-nav__item--nested">
 363
 364
 365         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 366
 367       <label class="md-nav__link" for="__nav_2_5_5">
 368         Form Builder
 369         <span class="md-nav__icon md-icon"></span>
 370       </label>
 371       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 372         <label class="md-nav__title" for="__nav_2_5_5">
 373           <span class="md-nav__icon md-icon"></span>
 374           Form Builder
 375         </label>
 376         <ul class="md-nav__list" data-md-scrollfix>
 377
 378
 379
 380
 381
 382     <li class="md-nav__item">
 383       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 384         Overview
 385       </a>
 386     </li>
 387
 388
 389
 390
 391
 392
 393
 394     <li class="md-nav__item">
 395       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 396         Structure
 397       </a>
 398     </li>
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 408         Fields
 409       </a>
 410     </li>
 411
 412
 413
 414
 415
 416
 417
 418     <li class="md-nav__item">
 419       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 420         Validation and Data
 421       </a>
 422     </li>
 423
 424
 425
 426
 427
 428
 429
 430     <li class="md-nav__item">
 431       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 432         Dependencies
 433       </a>
 434     </li>
 435
 436
 437
 438         </ul>
 439       </nav>
 440     </li>
 441
 442
 443
 444
 445
 446
 447
 448     <li class="md-nav__item">
 449       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 450         Package Installation Plugins
 451       </a>
 452     </li>
 453
 454
 455
 456
 457
 458
 459
 460     <li class="md-nav__item">
 461       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 462         User Activity Points
 463       </a>
 464     </li>
 465
 466
 467
 468
 469
 470
 471
 472     <li class="md-nav__item">
 473       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 474         User Notifications
 475       </a>
 476     </li>
 477
 478
 479
 480
 481
 482
 483
 484     <li class="md-nav__item">
 485       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 486         Sitemaps
 487       </a>
 488     </li>
 489
 490
 491
 492         </ul>
 493       </nav>
 494     </li>
 495
 496
 497
 498
 499
 500
 501
 502     <li class="md-nav__item">
 503       <a href="../../../php/code-style/" class="md-nav__link">
 504         Code Style
 505       </a>
 506     </li>
 507
 508
 509
 510
 511
 512
 513
 514     <li class="md-nav__item">
 515       <a href="../../../php/apps/" class="md-nav__link">
 516         Apps
 517       </a>
 518     </li>
 519
 520
 521
 522
 523
 524
 525
 526     <li class="md-nav__item">
 527       <a href="../../../php/gdpr/" class="md-nav__link">
 528         GDPR
 529       </a>
 530     </li>
 531
 532
 533
 534         </ul>
 535       </nav>
 536     </li>
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548     <li class="md-nav__item md-nav__item--nested">
 549
 550
 551         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 552
 553       <label class="md-nav__link" for="__nav_3">
 554         Languages, Templates & CSS
 555         <span class="md-nav__icon md-icon"></span>
 556       </label>
 557       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 558         <label class="md-nav__title" for="__nav_3">
 559           <span class="md-nav__icon md-icon"></span>
 560           Languages, Templates & CSS
 561         </label>
 562         <ul class="md-nav__list" data-md-scrollfix>
 563
 564
 565
 566
 567
 568     <li class="md-nav__item">
 569       <a href="../../../view/languages/" class="md-nav__link">
 570         Languages
 571       </a>
 572     </li>
 573
 574
 575
 576
 577
 578
 579
 580     <li class="md-nav__item">
 581       <a href="../../../view/templates/" class="md-nav__link">
 582         Templates
 583       </a>
 584     </li>
 585
 586
 587
 588
 589
 590
 591
 592     <li class="md-nav__item">
 593       <a href="../../../view/css/" class="md-nav__link">
 594         CSS
 595       </a>
 596     </li>
 597
 598
 599
 600         </ul>
 601       </nav>
 602     </li>
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614     <li class="md-nav__item md-nav__item--nested">
 615
 616
 617         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 618
 619       <label class="md-nav__link" for="__nav_4">
 620         JavaScript API
 621         <span class="md-nav__icon md-icon"></span>
 622       </label>
 623       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 624         <label class="md-nav__title" for="__nav_4">
 625           <span class="md-nav__icon md-icon"></span>
 626           JavaScript API
 627         </label>
 628         <ul class="md-nav__list" data-md-scrollfix>
 629
 630
 631
 632
 633
 634     <li class="md-nav__item">
 635       <a href="../../../javascript/general-usage/" class="md-nav__link">
 636         General Usage
 637       </a>
 638     </li>
 639
 640
 641
 642
 643
 644
 645
 646
 647     <li class="md-nav__item md-nav__item--nested">
 648
 649
 650         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 651
 652       <label class="md-nav__link" for="__nav_4_2">
 653         New API
 654         <span class="md-nav__icon md-icon"></span>
 655       </label>
 656       <nav class="md-nav" aria-label="New API" data-md-level="2">
 657         <label class="md-nav__title" for="__nav_4_2">
 658           <span class="md-nav__icon md-icon"></span>
 659           New API
 660         </label>
 661         <ul class="md-nav__list" data-md-scrollfix>
 662
 663
 664
 665
 666
 667     <li class="md-nav__item">
 668       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 669         Writing a module
 670       </a>
 671     </li>
 672
 673
 674
 675
 676
 677
 678
 679     <li class="md-nav__item">
 680       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 681         Data Structures
 682       </a>
 683     </li>
 684
 685
 686
 687
 688
 689
 690
 691     <li class="md-nav__item">
 692       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 693         Core Functions
 694       </a>
 695     </li>
 696
 697
 698
 699
 700
 701
 702
 703     <li class="md-nav__item">
 704       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 705         DOM
 706       </a>
 707     </li>
 708
 709
 710
 711
 712
 713
 714
 715     <li class="md-nav__item">
 716       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 717         Event Handling
 718       </a>
 719     </li>
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 729         Ajax
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739     <li class="md-nav__item">
 740       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 741         Dialogs
 742       </a>
 743     </li>
 744
 745
 746
 747
 748
 749
 750
 751     <li class="md-nav__item">
 752       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 753         Browser and Screen Sizes
 754       </a>
 755     </li>
 756
 757
 758
 759
 760
 761
 762
 763     <li class="md-nav__item">
 764       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 765         User Interface
 766       </a>
 767     </li>
 768
 769
 770
 771         </ul>
 772       </nav>
 773     </li>
 774
 775
 776
 777
 778
 779
 780
 781     <li class="md-nav__item">
 782       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 783         Legacy API
 784       </a>
 785     </li>
 786
 787
 788
 789
 790
 791
 792
 793     <li class="md-nav__item">
 794       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 795         Helper Functions
 796       </a>
 797     </li>
 798
 799
 800
 801
 802
 803
 804
 805     <li class="md-nav__item">
 806       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 807         Code Snippets
 808       </a>
 809     </li>
 810
 811
 812
 813         </ul>
 814       </nav>
 815     </li>
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 830
 831
 832         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 833
 834       <label class="md-nav__link" for="__nav_5">
 835         Package Components
 836         <span class="md-nav__icon md-icon"></span>
 837       </label>
 838       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 839         <label class="md-nav__title" for="__nav_5">
 840           <span class="md-nav__icon md-icon"></span>
 841           Package Components
 842         </label>
 843         <ul class="md-nav__list" data-md-scrollfix>
 844
 845
 846
 847
 848
 849     <li class="md-nav__item">
 850       <a href="../../package-xml/" class="md-nav__link">
 851         package.xml
 852       </a>
 853     </li>
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 865
 866
 867         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 868
 869       <label class="md-nav__link" for="__nav_5_2">
 870         PIPs
 871         <span class="md-nav__icon md-icon"></span>
 872       </label>
 873       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 874         <label class="md-nav__title" for="__nav_5_2">
 875           <span class="md-nav__icon md-icon"></span>
 876           PIPs
 877         </label>
 878         <ul class="md-nav__list" data-md-scrollfix>
 879
 880
 881
 882
 883
 884     <li class="md-nav__item">
 885       <a href="../" class="md-nav__link">
 886         Overview
 887       </a>
 888     </li>
 889
 890
 891
 892
 893
 894
 895
 896     <li class="md-nav__item">
 897       <a href="../acl-option/" class="md-nav__link">
 898         aclOption
 899       </a>
 900     </li>
 901
 902
 903
 904
 905
 906
 907
 908     <li class="md-nav__item">
 909       <a href="../acp-menu/" class="md-nav__link">
 910         acpMenu
 911       </a>
 912     </li>
 913
 914
 915
 916
 917
 918
 919
 920     <li class="md-nav__item">
 921       <a href="../acp-search-provider/" class="md-nav__link">
 922         acpSearchProvider
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932     <li class="md-nav__item">
 933       <a href="../acp-template/" class="md-nav__link">
 934         acpTemplate
 935       </a>
 936     </li>
 937
 938
 939
 940
 941
 942
 943
 944     <li class="md-nav__item">
 945       <a href="../bbcode/" class="md-nav__link">
 946         bbcode
 947       </a>
 948     </li>
 949
 950
 951
 952
 953
 954
 955
 956     <li class="md-nav__item">
 957       <a href="../box/" class="md-nav__link">
 958         box
 959       </a>
 960     </li>
 961
 962
 963
 964
 965
 966
 967
 968     <li class="md-nav__item">
 969       <a href="../clipboard-action/" class="md-nav__link">
 970         clipboardAction
 971       </a>
 972     </li>
 973
 974
 975
 976
 977
 978
 979
 980     <li class="md-nav__item">
 981       <a href="../core-object/" class="md-nav__link">
 982         coreObject
 983       </a>
 984     </li>
 985
 986
 987
 988
 989
 990
 991
 992     <li class="md-nav__item">
 993       <a href="../cronjob/" class="md-nav__link">
 994         cronjob
 995       </a>
 996     </li>
 997
 998
 999
1000
1001
1002
1003
1004     <li class="md-nav__item">
1005       <a href="../event-listener/" class="md-nav__link">
1006         eventListener
1007       </a>
1008     </li>
1009
1010
1011
1012
1013
1014
1015
1016     <li class="md-nav__item">
1017       <a href="../file/" class="md-nav__link">
1018         file
1019       </a>
1020     </li>
1021
1022
1023
1024
1025
1026
1027
1028     <li class="md-nav__item">
1029       <a href="../language/" class="md-nav__link">
1030         language
1031       </a>
1032     </li>
1033
1034
1035
1036
1037
1038
1039
1040     <li class="md-nav__item">
1041       <a href="../media-provider/" class="md-nav__link">
1042         mediaProvider
1043       </a>
1044     </li>
1045
1046
1047
1048
1049
1050
1051
1052     <li class="md-nav__item">
1053       <a href="../menu/" class="md-nav__link">
1054         menu
1055       </a>
1056     </li>
1057
1058
1059
1060
1061
1062
1063
1064     <li class="md-nav__item">
1065       <a href="../menu-item/" class="md-nav__link">
1066         menuItem
1067       </a>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076     <li class="md-nav__item">
1077       <a href="../object-type/" class="md-nav__link">
1078         objectType
1079       </a>
1080     </li>
1081
1082
1083
1084
1085
1086
1087
1088     <li class="md-nav__item">
1089       <a href="../object-type-definition/" class="md-nav__link">
1090         objectTypeDefinition
1091       </a>
1092     </li>
1093
1094
1095
1096
1097
1098
1099
1100     <li class="md-nav__item">
1101       <a href="../option/" class="md-nav__link">
1102         option
1103       </a>
1104     </li>
1105
1106
1107
1108
1109
1110
1111
1112     <li class="md-nav__item">
1113       <a href="../page/" class="md-nav__link">
1114         page
1115       </a>
1116     </li>
1117
1118
1119
1120
1121
1122
1123
1124     <li class="md-nav__item">
1125       <a href="../pip/" class="md-nav__link">
1126         pip
1127       </a>
1128     </li>
1129
1130
1131
1132
1133
1134
1135
1136     <li class="md-nav__item">
1137       <a href="../script/" class="md-nav__link">
1138         script
1139       </a>
1140     </li>
1141
1142
1143
1144
1145
1146
1147
1148     <li class="md-nav__item">
1149       <a href="../smiley/" class="md-nav__link">
1150         smiley
1151       </a>
1152     </li>
1153
1154
1155
1156
1157
1158
1159
1160     <li class="md-nav__item">
1161       <a href="../sql/" class="md-nav__link">
1162         sql
1163       </a>
1164     </li>
1165
1166
1167
1168
1169
1170
1171
1172     <li class="md-nav__item">
1173       <a href="../style/" class="md-nav__link">
1174         style
1175       </a>
1176     </li>
1177
1178
1179
1180
1181
1182
1183
1184     <li class="md-nav__item">
1185       <a href="../template/" class="md-nav__link">
1186         template
1187       </a>
1188     </li>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198     <li class="md-nav__item md-nav__item--active">
1199
1200       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1201
1202
1203
1204
1205         <label class="md-nav__link md-nav__link--active" for="__toc">
1206           templateListener
1207           <span class="md-nav__icon md-icon"></span>
1208         </label>
1209
1210       <a href="./" class="md-nav__link md-nav__link--active">
1211         templateListener
1212       </a>
1213
1214
1215 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1216
1217
1218
1219
1220
1221     <label class="md-nav__title" for="__toc">
1222       <span class="md-nav__icon md-icon"></span>
1223       Table of contents
1224     </label>
1225     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1226
1227         <li class="md-nav__item">
1228   <a href="#components" class="md-nav__link">
1229     Components
1230   </a>
1231
1232     <nav class="md-nav" aria-label="Components">
1233       <ul class="md-nav__list">
1234
1235           <li class="md-nav__item">
1236   <a href="#templatename" class="md-nav__link">
1237     &lt;templatename&gt;
1238   </a>
1239
1240 </li>
1241
1242           <li class="md-nav__item">
1243   <a href="#eventname" class="md-nav__link">
1244     &lt;eventname&gt;
1245   </a>
1246
1247 </li>
1248
1249           <li class="md-nav__item">
1250   <a href="#templatecode" class="md-nav__link">
1251     &lt;templatecode&gt;
1252   </a>
1253
1254 </li>
1255
1256           <li class="md-nav__item">
1257   <a href="#environment" class="md-nav__link">
1258     &lt;environment&gt;
1259   </a>
1260
1261 </li>
1262
1263           <li class="md-nav__item">
1264   <a href="#nice" class="md-nav__link">
1265     &lt;nice&gt;
1266   </a>
1267
1268 </li>
1269
1270           <li class="md-nav__item">
1271   <a href="#options" class="md-nav__link">
1272     &lt;options&gt;
1273   </a>
1274
1275 </li>
1276
1277           <li class="md-nav__item">
1278   <a href="#permissions" class="md-nav__link">
1279     &lt;permissions&gt;
1280   </a>
1281
1282 </li>
1283
1284       </ul>
1285     </nav>
1286
1287 </li>
1288
1289         <li class="md-nav__item">
1290   <a href="#example" class="md-nav__link">
1291     Example
1292   </a>
1293
1294 </li>
1295
1296     </ul>
1297
1298 </nav>
1299
1300     </li>
1301
1302
1303
1304
1305
1306
1307
1308     <li class="md-nav__item">
1309       <a href="../user-group-option/" class="md-nav__link">
1310         userGroupOption
1311       </a>
1312     </li>
1313
1314
1315
1316
1317
1318
1319
1320     <li class="md-nav__item">
1321       <a href="../user-menu/" class="md-nav__link">
1322         userMenu
1323       </a>
1324     </li>
1325
1326
1327
1328
1329
1330
1331
1332     <li class="md-nav__item">
1333       <a href="../user-notification-event/" class="md-nav__link">
1334         userNotificationEvent
1335       </a>
1336     </li>
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../user-option/" class="md-nav__link">
1346         userOption
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356     <li class="md-nav__item">
1357       <a href="../user-profile-menu/" class="md-nav__link">
1358         userProfileMenu
1359       </a>
1360     </li>
1361
1362
1363
1364         </ul>
1365       </nav>
1366     </li>
1367
1368
1369
1370
1371
1372
1373
1374     <li class="md-nav__item">
1375       <a href="../../database-php-api/" class="md-nav__link">
1376         Database PHP API
1377       </a>
1378     </li>
1379
1380
1381
1382         </ul>
1383       </nav>
1384     </li>
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item md-nav__item--nested">
1397
1398
1399         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1400
1401       <label class="md-nav__link" for="__nav_6">
1402         Migration
1403         <span class="md-nav__icon md-icon"></span>
1404       </label>
1405       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1406         <label class="md-nav__title" for="__nav_6">
1407           <span class="md-nav__icon md-icon"></span>
1408           Migration
1409         </label>
1410         <ul class="md-nav__list" data-md-scrollfix>
1411
1412
1413
1414
1415
1416
1417     <li class="md-nav__item md-nav__item--nested">
1418
1419
1420         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1421
1422       <label class="md-nav__link" for="__nav_6_1">
1423         Migrating from WSC 5.3
1424         <span class="md-nav__icon md-icon"></span>
1425       </label>
1426       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1427         <label class="md-nav__title" for="__nav_6_1">
1428           <span class="md-nav__icon md-icon"></span>
1429           Migrating from WSC 5.3
1430         </label>
1431         <ul class="md-nav__list" data-md-scrollfix>
1432
1433
1434
1435
1436
1437     <li class="md-nav__item">
1438       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1439         PHP API
1440       </a>
1441     </li>
1442
1443
1444
1445
1446
1447
1448
1449     <li class="md-nav__item">
1450       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1451         Session Handling and Authentication
1452       </a>
1453     </li>
1454
1455
1456
1457
1458
1459
1460
1461     <li class="md-nav__item">
1462       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1463         JavaScript
1464       </a>
1465     </li>
1466
1467
1468
1469
1470
1471
1472
1473     <li class="md-nav__item">
1474       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1475         Templates
1476       </a>
1477     </li>
1478
1479
1480
1481
1482
1483
1484
1485     <li class="md-nav__item">
1486       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1487         Third Party Libraries
1488       </a>
1489     </li>
1490
1491
1492
1493         </ul>
1494       </nav>
1495     </li>
1496
1497
1498
1499
1500
1501
1502
1503
1504     <li class="md-nav__item md-nav__item--nested">
1505
1506
1507         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1508
1509       <label class="md-nav__link" for="__nav_6_2">
1510         Migrating from WSC 5.2
1511         <span class="md-nav__icon md-icon"></span>
1512       </label>
1513       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1514         <label class="md-nav__title" for="__nav_6_2">
1515           <span class="md-nav__icon md-icon"></span>
1516           Migrating from WSC 5.2
1517         </label>
1518         <ul class="md-nav__list" data-md-scrollfix>
1519
1520
1521
1522
1523
1524     <li class="md-nav__item">
1525       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1526         PHP API
1527       </a>
1528     </li>
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1538         Templates and Languages
1539       </a>
1540     </li>
1541
1542
1543
1544
1545
1546
1547
1548     <li class="md-nav__item">
1549       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1550         Third Party Libraries
1551       </a>
1552     </li>
1553
1554
1555
1556         </ul>
1557       </nav>
1558     </li>
1559
1560
1561
1562
1563
1564
1565
1566
1567     <li class="md-nav__item md-nav__item--nested">
1568
1569
1570         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1571
1572       <label class="md-nav__link" for="__nav_6_3">
1573         Migrating from WSC 3.1
1574         <span class="md-nav__icon md-icon"></span>
1575       </label>
1576       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1577         <label class="md-nav__title" for="__nav_6_3">
1578           <span class="md-nav__icon md-icon"></span>
1579           Migrating from WSC 3.1
1580         </label>
1581         <ul class="md-nav__list" data-md-scrollfix>
1582
1583
1584
1585
1586
1587     <li class="md-nav__item">
1588       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1589         PHP API
1590       </a>
1591     </li>
1592
1593
1594
1595         </ul>
1596       </nav>
1597     </li>
1598
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item md-nav__item--nested">
1607
1608
1609         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1610
1611       <label class="md-nav__link" for="__nav_6_4">
1612         Migrating from WSC 3.0
1613         <span class="md-nav__icon md-icon"></span>
1614       </label>
1615       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1616         <label class="md-nav__title" for="__nav_6_4">
1617           <span class="md-nav__icon md-icon"></span>
1618           Migrating from WSC 3.0
1619         </label>
1620         <ul class="md-nav__list" data-md-scrollfix>
1621
1622
1623
1624
1625
1626     <li class="md-nav__item">
1627       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1628         PHP API
1629       </a>
1630     </li>
1631
1632
1633
1634
1635
1636
1637
1638     <li class="md-nav__item">
1639       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1640         JavaScript API
1641       </a>
1642     </li>
1643
1644
1645
1646
1647
1648
1649
1650     <li class="md-nav__item">
1651       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1652         Templates
1653       </a>
1654     </li>
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item">
1663       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1664         CSS
1665       </a>
1666     </li>
1667
1668
1669
1670
1671
1672
1673
1674     <li class="md-nav__item">
1675       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1676         Package Components
1677       </a>
1678     </li>
1679
1680
1681
1682         </ul>
1683       </nav>
1684     </li>
1685
1686
1687
1688
1689
1690
1691
1692
1693     <li class="md-nav__item md-nav__item--nested">
1694
1695
1696         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1697
1698       <label class="md-nav__link" for="__nav_6_5">
1699         Migrating from WCF 2.1
1700         <span class="md-nav__icon md-icon"></span>
1701       </label>
1702       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1703         <label class="md-nav__title" for="__nav_6_5">
1704           <span class="md-nav__icon md-icon"></span>
1705           Migrating from WCF 2.1
1706         </label>
1707         <ul class="md-nav__list" data-md-scrollfix>
1708
1709
1710
1711
1712
1713     <li class="md-nav__item">
1714       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1715         PHP API
1716       </a>
1717     </li>
1718
1719
1720
1721
1722
1723
1724
1725     <li class="md-nav__item">
1726       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1727         Templates
1728       </a>
1729     </li>
1730
1731
1732
1733
1734
1735
1736
1737     <li class="md-nav__item">
1738       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1739         CSS
1740       </a>
1741     </li>
1742
1743
1744
1745
1746
1747
1748
1749     <li class="md-nav__item">
1750       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1751         Package Components
1752       </a>
1753     </li>
1754
1755
1756
1757         </ul>
1758       </nav>
1759     </li>
1760
1761
1762
1763         </ul>
1764       </nav>
1765     </li>
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777     <li class="md-nav__item md-nav__item--nested">
1778
1779
1780         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1781
1782       <label class="md-nav__link" for="__nav_7">
1783         Tutorials
1784         <span class="md-nav__icon md-icon"></span>
1785       </label>
1786       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1787         <label class="md-nav__title" for="__nav_7">
1788           <span class="md-nav__icon md-icon"></span>
1789           Tutorials
1790         </label>
1791         <ul class="md-nav__list" data-md-scrollfix>
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item md-nav__item--nested">
1799
1800
1801         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1802
1803       <label class="md-nav__link" for="__nav_7_1">
1804         Tutorial Series
1805         <span class="md-nav__icon md-icon"></span>
1806       </label>
1807       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1808         <label class="md-nav__title" for="__nav_7_1">
1809           <span class="md-nav__icon md-icon"></span>
1810           Tutorial Series
1811         </label>
1812         <ul class="md-nav__list" data-md-scrollfix>
1813
1814
1815
1816
1817
1818     <li class="md-nav__item">
1819       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1820         Overview
1821       </a>
1822     </li>
1823
1824
1825
1826
1827
1828
1829
1830     <li class="md-nav__item">
1831       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1832         Part 1
1833       </a>
1834     </li>
1835
1836
1837
1838
1839
1840
1841
1842     <li class="md-nav__item">
1843       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1844         Part 2
1845       </a>
1846     </li>
1847
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item">
1855       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1856         Part 3
1857       </a>
1858     </li>
1859
1860
1861
1862         </ul>
1863       </nav>
1864     </li>
1865
1866
1867
1868         </ul>
1869       </nav>
1870     </li>
1871
1872
1873
1874   </ul>
1875 </nav>
1876                   </div>
1877                 </div>
1878               </div>
1879
1880
1881
1882               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1883                 <div class="md-sidebar__scrollwrap">
1884                   <div class="md-sidebar__inner">
1885
1886 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1887
1888
1889
1890
1891
1892     <label class="md-nav__title" for="__toc">
1893       <span class="md-nav__icon md-icon"></span>
1894       Table of contents
1895     </label>
1896     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1897
1898         <li class="md-nav__item">
1899   <a href="#components" class="md-nav__link">
1900     Components
1901   </a>
1902
1903     <nav class="md-nav" aria-label="Components">
1904       <ul class="md-nav__list">
1905
1906           <li class="md-nav__item">
1907   <a href="#templatename" class="md-nav__link">
1908     &lt;templatename&gt;
1909   </a>
1910
1911 </li>
1912
1913           <li class="md-nav__item">
1914   <a href="#eventname" class="md-nav__link">
1915     &lt;eventname&gt;
1916   </a>
1917
1918 </li>
1919
1920           <li class="md-nav__item">
1921   <a href="#templatecode" class="md-nav__link">
1922     &lt;templatecode&gt;
1923   </a>
1924
1925 </li>
1926
1927           <li class="md-nav__item">
1928   <a href="#environment" class="md-nav__link">
1929     &lt;environment&gt;
1930   </a>
1931
1932 </li>
1933
1934           <li class="md-nav__item">
1935   <a href="#nice" class="md-nav__link">
1936     &lt;nice&gt;
1937   </a>
1938
1939 </li>
1940
1941           <li class="md-nav__item">
1942   <a href="#options" class="md-nav__link">
1943     &lt;options&gt;
1944   </a>
1945
1946 </li>
1947
1948           <li class="md-nav__item">
1949   <a href="#permissions" class="md-nav__link">
1950     &lt;permissions&gt;
1951   </a>
1952
1953 </li>
1954
1955       </ul>
1956     </nav>
1957
1958 </li>
1959
1960         <li class="md-nav__item">
1961   <a href="#example" class="md-nav__link">
1962     Example
1963   </a>
1964
1965 </li>
1966
1967     </ul>
1968
1969 </nav>
1970                   </div>
1971                 </div>
1972               </div>
1973
1974
1975           <div class="md-content" data-md-component="content">
1976             <article class="md-content__inner md-typeset">
1977
1978
1979                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/template-listener.md" title="Edit this page" class="md-content__button md-icon">
1980                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
1981                   </a>
1982
1983
1984                 <h1 id="template-listener-package-installation-plugin">Template Listener Package Installation Plugin<a class="headerlink" href="#template-listener-package-installation-plugin" title="Permanent link">#</a></h1>
1985 <p>Registers template listeners.
1986 Template listeners supplement <a href="../event-listener/">event listeners</a>, which modify server side behaviour, by adding additional template code to display additional elements.
1987 The added template code behaves as if it was part of the original template (i.e. it has access to all local variables).</p>
1988 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
1989 <p>Each event listener is described as an <code>&lt;templatelistener&gt;</code> element with a <code>name</code> attribute.
1990 As the <code>name</code> attribute has only be introduced with WSC 3.0, it is not yet mandatory to allow backwards compatibility.
1991 If <code>name</code> is not given, the system automatically sets the name based on the id of the event listener in the database.</p>
1992 <h3 id="templatename"><code>&lt;templatename&gt;</code><a class="headerlink" href="#templatename" title="Permanent link">#</a></h3>
1993 <p>The template name is the name of the template in which the event is fired. It correspondes to the <code>eventclassname</code> field of event listeners.</p>
1994 <h3 id="eventname"><code>&lt;eventname&gt;</code><a class="headerlink" href="#eventname" title="Permanent link">#</a></h3>
1995 <p>The event name is the name given when the event is fired to identify different events within the same template.</p>
1996 <h3 id="templatecode"><code>&lt;templatecode&gt;</code><a class="headerlink" href="#templatecode" title="Permanent link">#</a></h3>
1997 <p>The given template code is literally copied into the target template during compile time.
1998 The original template is not modified.
1999 If multiple template listeners listen to a single event their output is concatenated using the line feed character (<code>\n</code>, U+000A) in the order defined by the <a href="#niceValue"><code>niceValue</code></a>.</p>
2000 <div class="admonition warning">
2001 <p class="admonition-title">It is recommend that the only code is an <code>{include}</code> of a template to enable changes by the administrator. Names of templates included by a template listener start with two underscores by convention.</p>
2002 </div>
2003 <h3 id="environment"><code>&lt;environment&gt;</code><a class="headerlink" href="#environment" title="Permanent link">#</a></h3>
2004 <p>The value of the environment element can either be <code>admin</code> or <code>user</code> and is <code>user</code> if no value is given.
2005 The value determines if the template listener will be executed in the frontend (<code>user</code>) or the backend (<code>admin</code>).</p>
2006 <h3 id="nice"><code>&lt;nice&gt;</code><a class="headerlink" href="#nice" title="Permanent link">#</a></h3>
2007 <p><span class="label label-info">Optional</span></p>
2008 <p>The nice value element can contain an integer value out of the interval <code>[-128,127]</code> with <code>0</code> being the default value if the element is omitted.
2009 The nice value determines the execution order of template listeners.
2010 Template listeners with smaller nice values are executed first.
2011 If the nice value of two template listeners is equal, the order is undefined.</p>
2012 <div class="admonition info">
2013 <p class="admonition-title">If you pass a value out of the mentioned interval, the value will be adjusted to the closest value in the interval.</p>
2014 </div>
2015 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2016 <p><span class="label label-info">Optional</span></p>
2017 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the template listener to be executed.</p>
2018 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2019 <p><span class="label label-info">Optional</span></p>
2020 <p>The permissions element can contain a comma-separated list of permissions of which the active user needs to have at least one for the template listener to be executed.</p>
2021 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2022 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2023 <span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/templatelistener.xsd&quot;</span><span class="nt">&gt;</span>
2024     <span class="nt">&lt;import&gt;</span>
2025         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;example&quot;</span><span class="nt">&gt;</span>
2026             <span class="nt">&lt;environment&gt;</span>user<span class="nt">&lt;/environment&gt;</span>
2027             <span class="nt">&lt;templatename&gt;</span>headIncludeJavaScript<span class="nt">&lt;/templatename&gt;</span>
2028             <span class="nt">&lt;eventname&gt;</span>javascriptInclude<span class="nt">&lt;/eventname&gt;</span>
2029             <span class="nt">&lt;templatecode&gt;</span><span class="cp">&lt;![CDATA[{include file=&#39;__myCustomJavaScript&#39;}]]&gt;</span><span class="nt">&lt;/templatecode&gt;</span>
2030         <span class="nt">&lt;/templatelistener&gt;</span>
2031     <span class="nt">&lt;/import&gt;</span>
2032
2033     <span class="nt">&lt;delete&gt;</span>
2034         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;oldTemplateListenerName&quot;</span> <span class="nt">/&gt;</span>
2035     <span class="nt">&lt;/delete&gt;</span>
2036 <span class="nt">&lt;/data&gt;</span>
2037 </code></pre></div>
2038
2039
2040
2041
2042 <hr>
2043 <div class="md-source-date">
2044   <small>
2045
2046       Last update: 2021-01-08
2047
2048   </small>
2049 </div>
2050
2051
2052
2053
2054
2055
2056
2057
2058             </article>
2059           </div>
2060         </div>
2061       </main>
2062
2063
2064 <footer class="md-footer">
2065
2066     <nav class="md-footer__inner md-grid" aria-label="Footer">
2067
2068         <a href="../template/" class="md-footer__link md-footer__link--prev" rel="prev">
2069           <div class="md-footer__button md-icon">
2070             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2071           </div>
2072           <div class="md-footer__title">
2073             <div class="md-ellipsis">
2074               <span class="md-footer__direction">
2075                 Previous
2076               </span>
2077               template
2078             </div>
2079           </div>
2080         </a>
2081
2082
2083         <a href="../user-group-option/" class="md-footer__link md-footer__link--next" rel="next">
2084           <div class="md-footer__title">
2085             <div class="md-ellipsis">
2086               <span class="md-footer__direction">
2087                 Next
2088               </span>
2089               userGroupOption
2090             </div>
2091           </div>
2092           <div class="md-footer__button md-icon">
2093             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2094           </div>
2095         </a>
2096
2097     </nav>
2098
2099   <div class="md-footer-meta md-typeset">
2100     <div class="md-footer-meta__inner md-grid">
2101       <div class="md-footer-copyright">
2102
2103           <div class="md-footer-copyright__highlight">
2104             Copyright © 2020 WoltLab GmbH
2105           </div>
2106
2107         Made with
2108         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2109           Material for MkDocs
2110         </a>
2111
2112       </div>
2113       <div class="md-footer-copyright">
2114         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2115         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2116 </div>
2117     </div>
2118   </div>
2119 </footer>
2120
2121     </div>
2122     <div class="md-dialog" data-md-component="dialog">
2123       <div class="md-dialog__inner md-typeset"></div>
2124     </div>
2125     <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2126
2127
2128       <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2129
2130
2131   </body>
2132 </html>