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