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