latest/php/api/events/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>Events - 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="#events" 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               Events
 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
 221
 222     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 223
 224
 225         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 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="../../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="../../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="../../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="../../exceptions/" class="md-nav__link">
 280         Exceptions
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 294
 295
 296         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" checked>
 297
 298       <label class="md-nav__link" for="__nav_2_5">
 299         API
 300         <span class="md-nav__icon md-icon"></span>
 301       </label>
 302       <nav class="md-nav" aria-label="API" data-md-level="2">
 303         <label class="md-nav__title" for="__nav_2_5">
 304           <span class="md-nav__icon md-icon"></span>
 305           API
 306         </label>
 307         <ul class="md-nav__list" data-md-scrollfix>
 308
 309
 310
 311
 312
 313     <li class="md-nav__item">
 314       <a href="../caches/" class="md-nav__link">
 315         Caches
 316       </a>
 317     </li>
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item">
 326       <a href="../comments/" class="md-nav__link">
 327         Comments
 328       </a>
 329     </li>
 330
 331
 332
 333
 334
 335
 336
 337     <li class="md-nav__item">
 338       <a href="../cronjobs/" class="md-nav__link">
 339         Cronjobs
 340       </a>
 341     </li>
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351     <li class="md-nav__item md-nav__item--active">
 352
 353       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 354
 355
 356
 357
 358         <label class="md-nav__link md-nav__link--active" for="__toc">
 359           Events
 360           <span class="md-nav__icon md-icon"></span>
 361         </label>
 362
 363       <a href="./" class="md-nav__link md-nav__link--active">
 364         Events
 365       </a>
 366
 367
 368 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 369
 370
 371
 372
 373
 374     <label class="md-nav__title" for="__toc">
 375       <span class="md-nav__icon md-icon"></span>
 376       Table of contents
 377     </label>
 378     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 379
 380         <li class="md-nav__item">
 381   <a href="#introductory-example" class="md-nav__link">
 382     Introductory Example
 383   </a>
 384
 385 </li>
 386
 387         <li class="md-nav__item">
 388   <a href="#listening-to-events" class="md-nav__link">
 389     Listening to Events
 390   </a>
 391
 392 </li>
 393
 394         <li class="md-nav__item">
 395   <a href="#firing-events" class="md-nav__link">
 396     Firing Events
 397   </a>
 398
 399     <nav class="md-nav" aria-label="Firing Events">
 400       <ul class="md-nav__list">
 401
 402           <li class="md-nav__item">
 403   <a href="#example-using-parameters-argument" class="md-nav__link">
 404     Example: Using $parameters argument
 405   </a>
 406
 407 </li>
 408
 409       </ul>
 410     </nav>
 411
 412 </li>
 413
 414         <li class="md-nav__item">
 415   <a href="#advanced-example-additional-form-field" class="md-nav__link">
 416     Advanced Example: Additional Form Field
 417   </a>
 418
 419 </li>
 420
 421     </ul>
 422
 423 </nav>
 424
 425     </li>
 426
 427
 428
 429
 430
 431
 432
 433
 434     <li class="md-nav__item md-nav__item--nested">
 435
 436
 437         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 438
 439       <label class="md-nav__link" for="__nav_2_5_5">
 440         Form Builder
 441         <span class="md-nav__icon md-icon"></span>
 442       </label>
 443       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 444         <label class="md-nav__title" for="__nav_2_5_5">
 445           <span class="md-nav__icon md-icon"></span>
 446           Form Builder
 447         </label>
 448         <ul class="md-nav__list" data-md-scrollfix>
 449
 450
 451
 452
 453
 454     <li class="md-nav__item">
 455       <a href="../form_builder/overview/" class="md-nav__link">
 456         Overview
 457       </a>
 458     </li>
 459
 460
 461
 462
 463
 464
 465
 466     <li class="md-nav__item">
 467       <a href="../form_builder/structure/" class="md-nav__link">
 468         Structure
 469       </a>
 470     </li>
 471
 472
 473
 474
 475
 476
 477
 478     <li class="md-nav__item">
 479       <a href="../form_builder/form_fields/" class="md-nav__link">
 480         Fields
 481       </a>
 482     </li>
 483
 484
 485
 486
 487
 488
 489
 490     <li class="md-nav__item">
 491       <a href="../form_builder/validation_data/" class="md-nav__link">
 492         Validation and Data
 493       </a>
 494     </li>
 495
 496
 497
 498
 499
 500
 501
 502     <li class="md-nav__item">
 503       <a href="../form_builder/dependencies/" class="md-nav__link">
 504         Dependencies
 505       </a>
 506     </li>
 507
 508
 509
 510         </ul>
 511       </nav>
 512     </li>
 513
 514
 515
 516
 517
 518
 519
 520     <li class="md-nav__item">
 521       <a href="../package_installation_plugins/" class="md-nav__link">
 522         Package Installation Plugins
 523       </a>
 524     </li>
 525
 526
 527
 528
 529
 530
 531
 532     <li class="md-nav__item">
 533       <a href="../user_activity_points/" class="md-nav__link">
 534         User Activity Points
 535       </a>
 536     </li>
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item">
 545       <a href="../user_notifications/" class="md-nav__link">
 546         User Notifications
 547       </a>
 548     </li>
 549
 550
 551
 552
 553
 554
 555
 556     <li class="md-nav__item">
 557       <a href="../sitemaps/" class="md-nav__link">
 558         Sitemaps
 559       </a>
 560     </li>
 561
 562
 563
 564         </ul>
 565       </nav>
 566     </li>
 567
 568
 569
 570
 571
 572
 573
 574     <li class="md-nav__item">
 575       <a href="../../code-style/" class="md-nav__link">
 576         Code Style
 577       </a>
 578     </li>
 579
 580
 581
 582
 583
 584
 585
 586     <li class="md-nav__item">
 587       <a href="../../apps/" class="md-nav__link">
 588         Apps
 589       </a>
 590     </li>
 591
 592
 593
 594
 595
 596
 597
 598     <li class="md-nav__item">
 599       <a href="../../gdpr/" class="md-nav__link">
 600         GDPR
 601       </a>
 602     </li>
 603
 604
 605
 606         </ul>
 607       </nav>
 608     </li>
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620     <li class="md-nav__item md-nav__item--nested">
 621
 622
 623         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 624
 625       <label class="md-nav__link" for="__nav_3">
 626         Languages, Templates & CSS
 627         <span class="md-nav__icon md-icon"></span>
 628       </label>
 629       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 630         <label class="md-nav__title" for="__nav_3">
 631           <span class="md-nav__icon md-icon"></span>
 632           Languages, Templates & CSS
 633         </label>
 634         <ul class="md-nav__list" data-md-scrollfix>
 635
 636
 637
 638
 639
 640     <li class="md-nav__item">
 641       <a href="../../../view/languages/" class="md-nav__link">
 642         Languages
 643       </a>
 644     </li>
 645
 646
 647
 648
 649
 650
 651
 652     <li class="md-nav__item">
 653       <a href="../../../view/templates/" class="md-nav__link">
 654         Templates
 655       </a>
 656     </li>
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../view/css/" class="md-nav__link">
 666         CSS
 667       </a>
 668     </li>
 669
 670
 671
 672         </ul>
 673       </nav>
 674     </li>
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686     <li class="md-nav__item md-nav__item--nested">
 687
 688
 689         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 690
 691       <label class="md-nav__link" for="__nav_4">
 692         JavaScript API
 693         <span class="md-nav__icon md-icon"></span>
 694       </label>
 695       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 696         <label class="md-nav__title" for="__nav_4">
 697           <span class="md-nav__icon md-icon"></span>
 698           JavaScript API
 699         </label>
 700         <ul class="md-nav__list" data-md-scrollfix>
 701
 702
 703
 704
 705
 706     <li class="md-nav__item">
 707       <a href="../../../javascript/general-usage/" class="md-nav__link">
 708         General Usage
 709       </a>
 710     </li>
 711
 712
 713
 714
 715
 716
 717
 718
 719     <li class="md-nav__item md-nav__item--nested">
 720
 721
 722         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 723
 724       <label class="md-nav__link" for="__nav_4_2">
 725         New API
 726         <span class="md-nav__icon md-icon"></span>
 727       </label>
 728       <nav class="md-nav" aria-label="New API" data-md-level="2">
 729         <label class="md-nav__title" for="__nav_4_2">
 730           <span class="md-nav__icon md-icon"></span>
 731           New API
 732         </label>
 733         <ul class="md-nav__list" data-md-scrollfix>
 734
 735
 736
 737
 738
 739     <li class="md-nav__item">
 740       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 741         Writing a module
 742       </a>
 743     </li>
 744
 745
 746
 747
 748
 749
 750
 751     <li class="md-nav__item">
 752       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 753         Data Structures
 754       </a>
 755     </li>
 756
 757
 758
 759
 760
 761
 762
 763     <li class="md-nav__item">
 764       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 765         Core Functions
 766       </a>
 767     </li>
 768
 769
 770
 771
 772
 773
 774
 775     <li class="md-nav__item">
 776       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 777         DOM
 778       </a>
 779     </li>
 780
 781
 782
 783
 784
 785
 786
 787     <li class="md-nav__item">
 788       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 789         Event Handling
 790       </a>
 791     </li>
 792
 793
 794
 795
 796
 797
 798
 799     <li class="md-nav__item">
 800       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 801         Ajax
 802       </a>
 803     </li>
 804
 805
 806
 807
 808
 809
 810
 811     <li class="md-nav__item">
 812       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 813         Dialogs
 814       </a>
 815     </li>
 816
 817
 818
 819
 820
 821
 822
 823     <li class="md-nav__item">
 824       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 825         Browser and Screen Sizes
 826       </a>
 827     </li>
 828
 829
 830
 831
 832
 833
 834
 835     <li class="md-nav__item">
 836       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 837         User Interface
 838       </a>
 839     </li>
 840
 841
 842
 843         </ul>
 844       </nav>
 845     </li>
 846
 847
 848
 849
 850
 851
 852
 853     <li class="md-nav__item">
 854       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 855         Legacy API
 856       </a>
 857     </li>
 858
 859
 860
 861
 862
 863
 864
 865     <li class="md-nav__item">
 866       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 867         Helper Functions
 868       </a>
 869     </li>
 870
 871
 872
 873
 874
 875
 876
 877     <li class="md-nav__item">
 878       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 879         Code Snippets
 880       </a>
 881     </li>
 882
 883
 884
 885         </ul>
 886       </nav>
 887     </li>
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899     <li class="md-nav__item md-nav__item--nested">
 900
 901
 902         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 903
 904       <label class="md-nav__link" for="__nav_5">
 905         Package Components
 906         <span class="md-nav__icon md-icon"></span>
 907       </label>
 908       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 909         <label class="md-nav__title" for="__nav_5">
 910           <span class="md-nav__icon md-icon"></span>
 911           Package Components
 912         </label>
 913         <ul class="md-nav__list" data-md-scrollfix>
 914
 915
 916
 917
 918
 919     <li class="md-nav__item">
 920       <a href="../../../package/package-xml/" class="md-nav__link">
 921         package.xml
 922       </a>
 923     </li>
 924
 925
 926
 927
 928
 929
 930
 931
 932     <li class="md-nav__item md-nav__item--nested">
 933
 934
 935         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 936
 937       <label class="md-nav__link" for="__nav_5_2">
 938         PIPs
 939         <span class="md-nav__icon md-icon"></span>
 940       </label>
 941       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 942         <label class="md-nav__title" for="__nav_5_2">
 943           <span class="md-nav__icon md-icon"></span>
 944           PIPs
 945         </label>
 946         <ul class="md-nav__list" data-md-scrollfix>
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="../../../package/pip/" class="md-nav__link">
 954         Overview
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 966         aclOption
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 978         acpMenu
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 990         acpSearchProvider
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1002         acpTemplate
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1014         bbcode
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../../../package/pip/box/" class="md-nav__link">
1026         box
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1038         clipboardAction
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="../../../package/pip/core-object/" class="md-nav__link">
1050         coreObject
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1062         cronjob
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1074         eventListener
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="../../../package/pip/file/" class="md-nav__link">
1086         file
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../package/pip/language/" class="md-nav__link">
1098         language
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1110         mediaProvider
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120     <li class="md-nav__item">
1121       <a href="../../../package/pip/menu/" class="md-nav__link">
1122         menu
1123       </a>
1124     </li>
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item">
1133       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1134         menuItem
1135       </a>
1136     </li>
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item">
1145       <a href="../../../package/pip/object-type/" class="md-nav__link">
1146         objectType
1147       </a>
1148     </li>
1149
1150
1151
1152
1153
1154
1155
1156     <li class="md-nav__item">
1157       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1158         objectTypeDefinition
1159       </a>
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../../../package/pip/option/" class="md-nav__link">
1170         option
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../../../package/pip/page/" class="md-nav__link">
1182         page
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../../../package/pip/pip/" class="md-nav__link">
1194         pip
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../../../package/pip/script/" class="md-nav__link">
1206         script
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="../../../package/pip/smiley/" class="md-nav__link">
1218         smiley
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../../../package/pip/sql/" class="md-nav__link">
1230         sql
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240     <li class="md-nav__item">
1241       <a href="../../../package/pip/style/" class="md-nav__link">
1242         style
1243       </a>
1244     </li>
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../../../package/pip/template/" class="md-nav__link">
1254         template
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1266         templateListener
1267       </a>
1268     </li>
1269
1270
1271
1272
1273
1274
1275
1276     <li class="md-nav__item">
1277       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1278         userGroupOption
1279       </a>
1280     </li>
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1290         userMenu
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300     <li class="md-nav__item">
1301       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1302         userNotificationEvent
1303       </a>
1304     </li>
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../../package/pip/user-option/" class="md-nav__link">
1314         userOption
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324     <li class="md-nav__item">
1325       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1326         userProfileMenu
1327       </a>
1328     </li>
1329
1330
1331
1332         </ul>
1333       </nav>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342     <li class="md-nav__item">
1343       <a href="../../../package/database-php-api/" class="md-nav__link">
1344         Database PHP API
1345       </a>
1346     </li>
1347
1348
1349
1350         </ul>
1351       </nav>
1352     </li>
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364     <li class="md-nav__item md-nav__item--nested">
1365
1366
1367         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1368
1369       <label class="md-nav__link" for="__nav_6">
1370         Migration
1371         <span class="md-nav__icon md-icon"></span>
1372       </label>
1373       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1374         <label class="md-nav__title" for="__nav_6">
1375           <span class="md-nav__icon md-icon"></span>
1376           Migration
1377         </label>
1378         <ul class="md-nav__list" data-md-scrollfix>
1379
1380
1381
1382
1383
1384
1385     <li class="md-nav__item md-nav__item--nested">
1386
1387
1388         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1389
1390       <label class="md-nav__link" for="__nav_6_1">
1391         Migrating from WSC 5.3
1392         <span class="md-nav__icon md-icon"></span>
1393       </label>
1394       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1395         <label class="md-nav__title" for="__nav_6_1">
1396           <span class="md-nav__icon md-icon"></span>
1397           Migrating from WSC 5.3
1398         </label>
1399         <ul class="md-nav__list" data-md-scrollfix>
1400
1401
1402
1403
1404
1405     <li class="md-nav__item">
1406       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1407         PHP API
1408       </a>
1409     </li>
1410
1411
1412
1413
1414
1415
1416
1417     <li class="md-nav__item">
1418       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1419         Session Handling and Authentication
1420       </a>
1421     </li>
1422
1423
1424
1425
1426
1427
1428
1429     <li class="md-nav__item">
1430       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1431         JavaScript
1432       </a>
1433     </li>
1434
1435
1436
1437
1438
1439
1440
1441     <li class="md-nav__item">
1442       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1443         Templates
1444       </a>
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453     <li class="md-nav__item">
1454       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1455         Third Party Libraries
1456       </a>
1457     </li>
1458
1459
1460
1461         </ul>
1462       </nav>
1463     </li>
1464
1465
1466
1467
1468
1469
1470
1471
1472     <li class="md-nav__item md-nav__item--nested">
1473
1474
1475         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1476
1477       <label class="md-nav__link" for="__nav_6_2">
1478         Migrating from WSC 5.2
1479         <span class="md-nav__icon md-icon"></span>
1480       </label>
1481       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1482         <label class="md-nav__title" for="__nav_6_2">
1483           <span class="md-nav__icon md-icon"></span>
1484           Migrating from WSC 5.2
1485         </label>
1486         <ul class="md-nav__list" data-md-scrollfix>
1487
1488
1489
1490
1491
1492     <li class="md-nav__item">
1493       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1494         PHP API
1495       </a>
1496     </li>
1497
1498
1499
1500
1501
1502
1503
1504     <li class="md-nav__item">
1505       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1506         Templates and Languages
1507       </a>
1508     </li>
1509
1510
1511
1512
1513
1514
1515
1516     <li class="md-nav__item">
1517       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1518         Third Party Libraries
1519       </a>
1520     </li>
1521
1522
1523
1524         </ul>
1525       </nav>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535     <li class="md-nav__item md-nav__item--nested">
1536
1537
1538         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1539
1540       <label class="md-nav__link" for="__nav_6_3">
1541         Migrating from WSC 3.1
1542         <span class="md-nav__icon md-icon"></span>
1543       </label>
1544       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1545         <label class="md-nav__title" for="__nav_6_3">
1546           <span class="md-nav__icon md-icon"></span>
1547           Migrating from WSC 3.1
1548         </label>
1549         <ul class="md-nav__list" data-md-scrollfix>
1550
1551
1552
1553
1554
1555     <li class="md-nav__item">
1556       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1557         PHP API
1558       </a>
1559     </li>
1560
1561
1562
1563         </ul>
1564       </nav>
1565     </li>
1566
1567
1568
1569
1570
1571
1572
1573
1574     <li class="md-nav__item md-nav__item--nested">
1575
1576
1577         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1578
1579       <label class="md-nav__link" for="__nav_6_4">
1580         Migrating from WSC 3.0
1581         <span class="md-nav__icon md-icon"></span>
1582       </label>
1583       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1584         <label class="md-nav__title" for="__nav_6_4">
1585           <span class="md-nav__icon md-icon"></span>
1586           Migrating from WSC 3.0
1587         </label>
1588         <ul class="md-nav__list" data-md-scrollfix>
1589
1590
1591
1592
1593
1594     <li class="md-nav__item">
1595       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1596         PHP API
1597       </a>
1598     </li>
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1608         JavaScript API
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1620         Templates
1621       </a>
1622     </li>
1623
1624
1625
1626
1627
1628
1629
1630     <li class="md-nav__item">
1631       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1632         CSS
1633       </a>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642     <li class="md-nav__item">
1643       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1644         Package Components
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_5" type="checkbox" id="__nav_6_5" >
1665
1666       <label class="md-nav__link" for="__nav_6_5">
1667         Migrating from WCF 2.1
1668         <span class="md-nav__icon md-icon"></span>
1669       </label>
1670       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1671         <label class="md-nav__title" for="__nav_6_5">
1672           <span class="md-nav__icon md-icon"></span>
1673           Migrating from WCF 2.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/wcf21/php/" class="md-nav__link">
1683         PHP API
1684       </a>
1685     </li>
1686
1687
1688
1689
1690
1691
1692
1693     <li class="md-nav__item">
1694       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1695         Templates
1696       </a>
1697     </li>
1698
1699
1700
1701
1702
1703
1704
1705     <li class="md-nav__item">
1706       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1707         CSS
1708       </a>
1709     </li>
1710
1711
1712
1713
1714
1715
1716
1717     <li class="md-nav__item">
1718       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1719         Package Components
1720       </a>
1721     </li>
1722
1723
1724
1725         </ul>
1726       </nav>
1727     </li>
1728
1729
1730
1731         </ul>
1732       </nav>
1733     </li>
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745     <li class="md-nav__item md-nav__item--nested">
1746
1747
1748         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1749
1750       <label class="md-nav__link" for="__nav_7">
1751         Tutorials
1752         <span class="md-nav__icon md-icon"></span>
1753       </label>
1754       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1755         <label class="md-nav__title" for="__nav_7">
1756           <span class="md-nav__icon md-icon"></span>
1757           Tutorials
1758         </label>
1759         <ul class="md-nav__list" data-md-scrollfix>
1760
1761
1762
1763
1764
1765
1766     <li class="md-nav__item md-nav__item--nested">
1767
1768
1769         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1770
1771       <label class="md-nav__link" for="__nav_7_1">
1772         Tutorial Series
1773         <span class="md-nav__icon md-icon"></span>
1774       </label>
1775       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1776         <label class="md-nav__title" for="__nav_7_1">
1777           <span class="md-nav__icon md-icon"></span>
1778           Tutorial Series
1779         </label>
1780         <ul class="md-nav__list" data-md-scrollfix>
1781
1782
1783
1784
1785
1786     <li class="md-nav__item">
1787       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1788         Overview
1789       </a>
1790     </li>
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1800         Part 1
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810     <li class="md-nav__item">
1811       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1812         Part 2
1813       </a>
1814     </li>
1815
1816
1817
1818
1819
1820
1821
1822     <li class="md-nav__item">
1823       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1824         Part 3
1825       </a>
1826     </li>
1827
1828
1829
1830         </ul>
1831       </nav>
1832     </li>
1833
1834
1835
1836         </ul>
1837       </nav>
1838     </li>
1839
1840
1841
1842   </ul>
1843 </nav>
1844                   </div>
1845                 </div>
1846               </div>
1847
1848
1849
1850               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1851                 <div class="md-sidebar__scrollwrap">
1852                   <div class="md-sidebar__inner">
1853
1854 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1855
1856
1857
1858
1859
1860     <label class="md-nav__title" for="__toc">
1861       <span class="md-nav__icon md-icon"></span>
1862       Table of contents
1863     </label>
1864     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1865
1866         <li class="md-nav__item">
1867   <a href="#introductory-example" class="md-nav__link">
1868     Introductory Example
1869   </a>
1870
1871 </li>
1872
1873         <li class="md-nav__item">
1874   <a href="#listening-to-events" class="md-nav__link">
1875     Listening to Events
1876   </a>
1877
1878 </li>
1879
1880         <li class="md-nav__item">
1881   <a href="#firing-events" class="md-nav__link">
1882     Firing Events
1883   </a>
1884
1885     <nav class="md-nav" aria-label="Firing Events">
1886       <ul class="md-nav__list">
1887
1888           <li class="md-nav__item">
1889   <a href="#example-using-parameters-argument" class="md-nav__link">
1890     Example: Using $parameters argument
1891   </a>
1892
1893 </li>
1894
1895       </ul>
1896     </nav>
1897
1898 </li>
1899
1900         <li class="md-nav__item">
1901   <a href="#advanced-example-additional-form-field" class="md-nav__link">
1902     Advanced Example: Additional Form Field
1903   </a>
1904
1905 </li>
1906
1907     </ul>
1908
1909 </nav>
1910                   </div>
1911                 </div>
1912               </div>
1913
1914
1915           <div class="md-content" data-md-component="content">
1916             <article class="md-content__inner md-typeset">
1917
1918
1919                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/events.md" title="Edit this page" class="md-content__button md-icon">
1920                     <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>
1921                   </a>
1922
1923
1924                 <h1 id="events">Events<a class="headerlink" href="#events" title="Permanent link">#</a></h1>
1925 <p>WoltLab Suite's event system allows manipulation of program flows and data without having to change any of the original source code.
1926 At many locations throughout the PHP code of WoltLab Suite Core and mainly through inheritance also in the applications and plugins, so called <em>events</em> are fired which trigger registered <em>event listeners</em> that get access to the object firing the event (or at least the class name if the event has been fired in a static method).</p>
1927 <p>This page focuses on the technical aspects of events and event listeners, <a href="../../../package/pip/event-listener/">the eventListener package installation plugin page</a> covers how you can actually register an event listener.
1928 A comprehensive list of all available events is provided <a href="../event_list/">here</a>.</p>
1929 <h2 id="introductory-example">Introductory Example<a class="headerlink" href="#introductory-example" title="Permanent link">#</a></h2>
1930 <p>Let's start with a simple example to illustrate how the event system works.
1931 Consider this pre-existing class:</p>
1932 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1933 <span class="k">namespace</span> <span class="nx">wcf\system\example</span><span class="p">;</span>
1934 <span class="k">use</span> <span class="nx">wcf\system\event\EventHandler</span><span class="p">;</span>
1935
1936 <span class="k">class</span> <span class="nc">ExampleComponent</span> <span class="p">{</span>
1937     <span class="k">public</span> <span class="nv">$var</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
1938
1939     <span class="k">public</span> <span class="k">function</span> <span class="nf">getVar</span><span class="p">()</span> <span class="p">{</span>
1940         <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireAction</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">&#39;getVar&#39;</span><span class="p">);</span>
1941
1942         <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span><span class="p">;</span>
1943     <span class="p">}</span>
1944 <span class="p">}</span>
1945 </code></pre></div>
1946 <p>where an event with event name <code>getVar</code> is fired in the <code>getVar()</code> method.</p>
1947 <p>If you create an object of this class and call the <code>getVar()</code> method, the return value will be <code>1</code>, of course:</p>
1948 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1949
1950 <span class="nv">$example</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">wcf\system\example\ExampleComponent</span><span class="p">();</span>
1951 <span class="k">if</span> <span class="p">(</span><span class="nv">$example</span><span class="o">-&gt;</span><span class="na">getVar</span><span class="p">()</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
1952     <span class="k">echo</span> <span class="s2">&quot;var is 1!&quot;</span><span class="p">;</span>
1953 <span class="p">}</span>
1954 <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nv">$example</span><span class="o">-&gt;</span><span class="na">getVar</span><span class="p">()</span> <span class="o">==</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
1955     <span class="k">echo</span> <span class="s2">&quot;var is 2!&quot;</span><span class="p">;</span>
1956 <span class="p">}</span>
1957 <span class="k">else</span> <span class="p">{</span>
1958     <span class="k">echo</span> <span class="s2">&quot;No, var is neither 1 nor 2.&quot;</span><span class="p">;</span>
1959 <span class="p">}</span>
1960
1961 <span class="c1">// output: var is 1!</span>
1962 </code></pre></div>
1963 <p>Now, consider that we have registered the following event listener to this event:</p>
1964 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1965 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
1966
1967 <span class="k">class</span> <span class="nc">ExampleEventListener</span> <span class="k">implements</span> <span class="nx">IParameterizedEventListener</span> <span class="p">{</span>
1968     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">(</span><span class="nv">$eventObj</span><span class="p">,</span> <span class="nv">$className</span><span class="p">,</span> <span class="nv">$eventName</span><span class="p">,</span> <span class="k">array</span> <span class="o">&amp;</span><span class="nv">$parameters</span><span class="p">)</span> <span class="p">{</span>
1969         <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">var</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span>
1970     <span class="p">}</span>
1971 <span class="p">}</span>
1972 </code></pre></div>
1973 <p>Whenever the event in the <code>getVar()</code> method is called, this method (of the same event listener object) is called.
1974 In this case, the value of the method's first parameter is the <code>ExampleComponent</code> object passed as the first argument of the <code>EventHandler::fireAction()</code> call in <code>ExampleComponent::getVar()</code>.
1975 As <code>ExampleComponent::$var</code> is a public property, the event listener code can change it and set it to <code>2</code>.</p>
1976 <p>If you now execute the example code from above again, the output will change from <code>var is 1!</code> to <code>var is 2!</code> because prior to returning the value, the event listener code changes the value from <code>1</code> to <code>2</code>.</p>
1977 <p>This introductory example illustrates how event listeners can change data in a non-intrusive way.
1978 Program flow can be changed, for example, by throwing a <code>wcf\system\exception\PermissionDeniedException</code> if some additional constraint to access a page is not fulfilled.</p>
1979 <h2 id="listening-to-events">Listening to Events<a class="headerlink" href="#listening-to-events" title="Permanent link">#</a></h2>
1980 <p>In order to listen to events, you need to register the event listener and the event listener itself needs to implement the interface <code>wcf\system\event\listener\IParameterizedEventListener</code> which only contains the <code>execute</code> method (see example above).</p>
1981 <p>The first parameter <code>$eventObj</code> of the method contains the passed object where the event is fired or the name of the class in which the event is fired if it is fired from a static method.
1982 The second parameter <code>$className</code> always contains the name of the class where the event has been fired.
1983 The third parameter <code>$eventName</code> provides the name of the event within a class to uniquely identify the exact location in the class where the event has been fired.
1984 The last parameter <code>$parameters</code> is a reference to the array which contains additional data passed by the method firing the event.
1985 If no additional data is passed, <code>$parameters</code> is empty.</p>
1986 <h2 id="firing-events">Firing Events<a class="headerlink" href="#firing-events" title="Permanent link">#</a></h2>
1987 <p>If you write code and want plugins to have access at certain points, you can fire an event on your own.
1988 The only thing to do is to call the <code>wcf\system\event\EventHandler::fireAction($eventObj, $eventName, array &amp;$parameters = [])</code> method and pass the following parameters:</p>
1989 <ol>
1990 <li><code>$eventObj</code> should be <code>$this</code> if you fire from an object context, otherwise pass the class name <code>static::class</code>.</li>
1991 <li><code>$eventName</code> identifies the event within the class and generally has the same name as the method.
1992    In cases, were you might fire more than one event in a method, for example before and after a certain piece of code, you can use the prefixes <code>before*</code> and <code>after*</code> in your event names.</li>
1993 <li><code>$parameters</code> is an optional array which allows you to pass additional data to the event listeners without having to make this data accessible via a property explicitly only created for this purpose.
1994    This additional data can either be just additional information for the event listeners about the context of the method call or allow the event listener to manipulate local data if the code, where the event has been fired, uses the passed data afterwards.  </li>
1995 </ol>
1996 <h3 id="example-using-parameters-argument">Example: Using <code>$parameters</code> argument<a class="headerlink" href="#example-using-parameters-argument" title="Permanent link">#</a></h3>
1997 <p>Consider the following method which gets some text that the methods parses.</p>
1998 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1999 <span class="k">namespace</span> <span class="nx">wcf\system\example</span><span class="p">;</span>
2000 <span class="k">use</span> <span class="nx">wcf\system\event\EventHandler</span><span class="p">;</span>
2001
2002 <span class="k">class</span> <span class="nc">ExampleParser</span> <span class="p">{</span>
2003     <span class="k">public</span> <span class="k">function</span> <span class="nf">parse</span><span class="p">(</span><span class="nv">$text</span><span class="p">)</span> <span class="p">{</span>
2004         <span class="c1">// [some parsing done by default]</span>
2005
2006         <span class="nv">$parameters</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;text&#39;</span> <span class="o">=&gt;</span> <span class="nv">$text</span><span class="p">];</span>
2007         <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireAction</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">&#39;parse&#39;</span><span class="p">,</span> <span class="nv">$parameters</span><span class="p">);</span>
2008
2009         <span class="k">return</span> <span class="nv">$parameters</span><span class="p">[</span><span class="s1">&#39;text&#39;</span><span class="p">];</span>
2010     <span class="p">}</span>
2011 <span class="p">}</span>
2012 </code></pre></div>
2013 <p>After the default parsing by the method itself, the author wants to enable plugins to do additional parsing and thus fires an event and passes the parsed text as an additional parameter.
2014 Then, a plugin can deliver the following event listener</p>
2015 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2016 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
2017
2018 <span class="k">class</span> <span class="nc">ExampleParserEventListener</span> <span class="k">implements</span> <span class="nx">IParameterizedEventListener</span> <span class="p">{</span>
2019     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">(</span><span class="nv">$eventObj</span><span class="p">,</span> <span class="nv">$className</span><span class="p">,</span> <span class="nv">$eventName</span><span class="p">,</span> <span class="k">array</span> <span class="o">&amp;</span><span class="nv">$parameters</span><span class="p">)</span> <span class="p">{</span>
2020         <span class="nv">$text</span> <span class="o">=</span> <span class="nv">$parameters</span><span class="p">[</span><span class="s1">&#39;text&#39;</span><span class="p">];</span>
2021
2022         <span class="c1">// [some additional parsing which changes $text]</span>
2023
2024         <span class="nv">$parameters</span><span class="p">[</span><span class="s1">&#39;text&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nv">$text</span><span class="p">;</span>
2025     <span class="p">}</span>
2026 <span class="p">}</span>
2027 </code></pre></div>
2028 <p>which can access the text via <code>$parameters['text']</code>.</p>
2029 <p>This example can also be perfectly used to illustrate how to name multiple events in the same method.
2030 Let's assume that the author wants to enable plugins to change the text before and after the method does its own parsing and thus fires two events:</p>
2031 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2032 <span class="k">namespace</span> <span class="nx">wcf\system\example</span><span class="p">;</span>
2033 <span class="k">use</span> <span class="nx">wcf\system\event\EventHandler</span><span class="p">;</span>
2034
2035 <span class="k">class</span> <span class="nc">ExampleParser</span> <span class="p">{</span>
2036     <span class="k">public</span> <span class="k">function</span> <span class="nf">parse</span><span class="p">(</span><span class="nv">$text</span><span class="p">)</span> <span class="p">{</span>
2037         <span class="nv">$parameters</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;text&#39;</span> <span class="o">=&gt;</span> <span class="nv">$text</span><span class="p">];</span>
2038         <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireAction</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">&#39;beforeParsing&#39;</span><span class="p">,</span> <span class="nv">$parameters</span><span class="p">);</span>
2039         <span class="nv">$text</span> <span class="o">=</span> <span class="nv">$parameters</span><span class="p">[</span><span class="s1">&#39;text&#39;</span><span class="p">];</span>
2040
2041         <span class="c1">// [some parsing done by default]</span>
2042
2043         <span class="nv">$parameters</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;text&#39;</span> <span class="o">=&gt;</span> <span class="nv">$text</span><span class="p">];</span>
2044         <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireAction</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">&#39;afterParsing&#39;</span><span class="p">,</span> <span class="nv">$parameters</span><span class="p">);</span>
2045
2046         <span class="k">return</span> <span class="nv">$parameters</span><span class="p">[</span><span class="s1">&#39;text&#39;</span><span class="p">];</span>
2047     <span class="p">}</span>
2048 <span class="p">}</span>
2049 </code></pre></div>
2050 <h2 id="advanced-example-additional-form-field">Advanced Example: Additional Form Field<a class="headerlink" href="#advanced-example-additional-form-field" title="Permanent link">#</a></h2>
2051 <p>One common reason to use event listeners is to add an additional field to a pre-existing form (in combination with template listeners, which we will not cover here).
2052 We will assume that users are able to do both, create and edit the objects via this form.
2053 The points in the program flow of <a href="../../pages/#abstractform">AbstractForm</a> that are relevant here are:</p>
2054 <ul>
2055 <li>adding object (after the form has been submitted):</li>
2056 <li>reading the value of the field</li>
2057 <li>validating the read value</li>
2058 <li>
2059 <p>saving the additional value after successful validation and resetting locally stored value or assigning the current value of the field to the template after unsuccessful validation</p>
2060 </li>
2061 <li>
2062 <p>editing object:</p>
2063 </li>
2064 <li>on initial form request:<ol>
2065 <li>reading the pre-existing value of the edited object</li>
2066 <li>assigning the field value to the template</li>
2067 </ol>
2068 </li>
2069 <li>after the form has been submitted:<ol>
2070 <li>reading the value of the field</li>
2071 <li>validating the read value</li>
2072 <li>saving the additional value after successful validation</li>
2073 <li>assigning the current value of the field to the template</li>
2074 </ol>
2075 </li>
2076 </ul>
2077 <p>All of these cases can be covered the by following code in which we assume that <code>wcf\form\ExampleAddForm</code> is the form to create example objects and that <code>wcf\form\ExampleEditForm</code> extends <code>wcf\form\ExampleAddForm</code> and is used for editing existing example objects.</p>
2078 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2079 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
2080 <span class="k">use</span> <span class="nx">wcf\form\ExampleAddForm</span><span class="p">;</span>
2081 <span class="k">use</span> <span class="nx">wcf\form\ExampleEditForm</span><span class="p">;</span>
2082 <span class="k">use</span> <span class="nx">wcf\system\exception\UserInputException</span><span class="p">;</span>
2083 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2084
2085 <span class="k">class</span> <span class="nc">ExampleAddFormListener</span> <span class="k">implements</span> <span class="nx">IParameterizedEventListener</span> <span class="p">{</span>
2086     <span class="k">protected</span> <span class="nv">$var</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
2087
2088     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">(</span><span class="nv">$eventObj</span><span class="p">,</span> <span class="nv">$className</span><span class="p">,</span> <span class="nv">$eventName</span><span class="p">,</span> <span class="k">array</span> <span class="o">&amp;</span><span class="nv">$parameters</span><span class="p">)</span> <span class="p">{</span>
2089         <span class="nv">$this</span><span class="o">-&gt;</span><span class="nv">$eventName</span><span class="p">(</span><span class="nv">$eventObj</span><span class="p">);</span>
2090     <span class="p">}</span>
2091
2092     <span class="k">protected</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
2093         <span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">assign</span><span class="p">(</span><span class="s1">&#39;var&#39;</span><span class="p">,</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span><span class="p">);</span>
2094     <span class="p">}</span>
2095
2096     <span class="k">protected</span> <span class="k">function</span> <span class="nf">readData</span><span class="p">(</span><span class="nx">ExampleEditForm</span> <span class="nv">$eventObj</span><span class="p">)</span> <span class="p">{</span>
2097         <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">))</span> <span class="p">{</span>
2098             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span> <span class="o">=</span> <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">example</span><span class="o">-&gt;</span><span class="na">var</span><span class="p">;</span>
2099         <span class="p">}</span>
2100     <span class="p">}</span>
2101
2102     <span class="k">protected</span> <span class="k">function</span> <span class="nf">readFormParameters</span><span class="p">()</span> <span class="p">{</span>
2103         <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;var&#39;</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span> <span class="o">=</span> <span class="nb">intval</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;var&#39;</span><span class="p">]);</span>
2104     <span class="p">}</span>
2105
2106     <span class="k">protected</span> <span class="k">function</span> <span class="nf">save</span><span class="p">(</span><span class="nx">ExampleAddForm</span> <span class="nv">$eventObj</span><span class="p">)</span> <span class="p">{</span>
2107         <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">additionalFields</span> <span class="o">=</span> <span class="nb">array_merge</span><span class="p">(</span><span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">additionalFields</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;var&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span><span class="p">]);</span>
2108     <span class="p">}</span>
2109
2110     <span class="k">protected</span> <span class="k">function</span> <span class="nf">saved</span><span class="p">()</span> <span class="p">{</span>
2111         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
2112     <span class="p">}</span>
2113
2114     <span class="k">protected</span> <span class="k">function</span> <span class="nf">validate</span><span class="p">()</span> <span class="p">{</span>
2115         <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">var</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
2116             <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;var&#39;</span><span class="p">,</span> <span class="s1">&#39;isNegative&#39;</span><span class="p">);</span>
2117         <span class="p">}</span>
2118     <span class="p">}</span>
2119 <span class="p">}</span>
2120 </code></pre></div>
2121 <p>The <code>execute</code> method in this example just delegates the call to a method with the same name as the event so that this class mimics the structure of a form class itself.
2122 The form object is passed to the methods but is only given in the method signatures as a parameter here whenever the form object is actually used.
2123 Furthermore, the type-hinting of the parameter illustrates in which contexts the method is actually called which will become clear in the following discussion of the individual methods:</p>
2124 <ul>
2125 <li><code>assignVariables()</code> is called for the add and the edit form and simply assigns the current value of the variable to the template.</li>
2126 <li><code>readData()</code> reads the pre-existing value of <code>$var</code> if the form has not been submitted and thus is only relevant when editing objects which is illustrated by the explicit type-hint of <code>ExampleEditForm</code>.</li>
2127 <li><code>readFormParameters()</code> reads the value for both, the add and the edit form.</li>
2128 <li><code>save()</code> is, of course, also relevant in both cases but requires the form object to store the additional value in the <code>wcf\form\AbstractForm::$additionalFields</code> array which can be used if a <code>var</code> column has been added to the database table in which the example objects are stored.</li>
2129 <li><code>saved()</code> is only called for the add form as it clears the internal value so that in the <code>assignVariables()</code> call, the default value will be assigned to the template to create an "empty" form.
2130   During edits, this current value is the actual value that should be shown.</li>
2131 <li><code>validate()</code> also needs to be called in both cases as the input data always has to be validated.</li>
2132 </ul>
2133 <p>Lastly, the following XML file has to be used to register the event listeners (you can find more information about how to register event listeners on <a href="../../../package/pip/event-listener/">the eventListener package installation plugin page</a>):</p>
2134 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2135 <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>
2136     <span class="nt">&lt;import&gt;</span>
2137         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;exampleAddInherited&quot;</span><span class="nt">&gt;</span>
2138             <span class="nt">&lt;eventclassname&gt;</span>wcf\form\ExampleAddForm<span class="nt">&lt;/eventclassname&gt;</span>
2139             <span class="nt">&lt;eventname&gt;</span>assignVariables,readFormParameters,save,validate<span class="nt">&lt;/eventname&gt;</span>
2140             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\ExampleAddFormListener<span class="nt">&lt;/listenerclassname&gt;</span>
2141             <span class="nt">&lt;inherit&gt;</span>1<span class="nt">&lt;/inherit&gt;</span>
2142         <span class="nt">&lt;/eventlistener&gt;</span>
2143
2144         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;exampleAdd&quot;</span><span class="nt">&gt;</span>
2145             <span class="nt">&lt;eventclassname&gt;</span>wcf\form\ExampleAddForm<span class="nt">&lt;/eventclassname&gt;</span>
2146             <span class="nt">&lt;eventname&gt;</span>saved<span class="nt">&lt;/eventname&gt;</span>
2147             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\ExampleAddFormListener<span class="nt">&lt;/listenerclassname&gt;</span>
2148         <span class="nt">&lt;/eventlistener&gt;</span>
2149
2150         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;exampleEdit&quot;</span><span class="nt">&gt;</span>
2151             <span class="nt">&lt;eventclassname&gt;</span>wcf\form\ExampleEditForm<span class="nt">&lt;/eventclassname&gt;</span>
2152             <span class="nt">&lt;eventname&gt;</span>readData<span class="nt">&lt;/eventname&gt;</span>
2153             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\ExampleAddFormListener<span class="nt">&lt;/listenerclassname&gt;</span>
2154         <span class="nt">&lt;/eventlistener&gt;</span>
2155     <span class="nt">&lt;/import&gt;</span>
2156 <span class="nt">&lt;/data&gt;</span>
2157 </code></pre></div>
2158
2159
2160
2161
2162 <hr>
2163 <div class="md-source-date">
2164   <small>
2165
2166       Last update: 2021-01-08
2167
2168   </small>
2169 </div>
2170
2171
2172
2173
2174
2175
2176
2177
2178             </article>
2179           </div>
2180         </div>
2181
2182       </main>
2183
2184
2185 <footer class="md-footer">
2186
2187     <nav class="md-footer__inner md-grid" aria-label="Footer">
2188
2189         <a href="../cronjobs/" class="md-footer__link md-footer__link--prev" rel="prev">
2190           <div class="md-footer__button md-icon">
2191             <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>
2192           </div>
2193           <div class="md-footer__title">
2194             <div class="md-ellipsis">
2195               <span class="md-footer__direction">
2196                 Previous
2197               </span>
2198               Cronjobs
2199             </div>
2200           </div>
2201         </a>
2202
2203
2204         <a href="../form_builder/overview/" class="md-footer__link md-footer__link--next" rel="next">
2205           <div class="md-footer__title">
2206             <div class="md-ellipsis">
2207               <span class="md-footer__direction">
2208                 Next
2209               </span>
2210               Overview
2211             </div>
2212           </div>
2213           <div class="md-footer__button md-icon">
2214             <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>
2215           </div>
2216         </a>
2217
2218     </nav>
2219
2220   <div class="md-footer-meta md-typeset">
2221     <div class="md-footer-meta__inner md-grid">
2222       <div class="md-footer-copyright">
2223
2224           <div class="md-footer-copyright__highlight">
2225             Copyright © 2020 WoltLab GmbH
2226           </div>
2227
2228         Made with
2229         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2230           Material for MkDocs
2231         </a>
2232
2233       </div>
2234       <div class="md-footer-copyright">
2235         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2236         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2237 </div>
2238     </div>
2239   </div>
2240 </footer>
2241
2242     </div>
2243     <div class="md-dialog" data-md-component="dialog">
2244       <div class="md-dialog__inner md-typeset"></div>
2245     </div>
2246     <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>
2247
2248
2249       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2250
2251
2252   </body>
2253 </html>