6.0/package/pip/clipboard-action/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/package/pip/clipboard-action/">
  12
  13
  14         <link rel="prev" href="../box/">
  15
  16
  17         <link rel="next" href="../core-object/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.5">
  21
  22
  23
  24         <title>clipboardAction - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.7a7fce14.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.a0c5b2b5.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#clipboard-action-package-installation-plugin" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               clipboardAction
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125       <label class="md-header__button md-icon" for="__search">
 126         <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>
 127       </label>
 128       <div class="md-search" data-md-component="search" role="dialog">
 129   <label class="md-search__overlay" for="__search"></label>
 130   <div class="md-search__inner" role="search">
 131     <form class="md-search__form" name="search">
 132       <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" required>
 133       <label class="md-search__icon md-icon" for="__search">
 134         <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>
 135         <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>
 136       </label>
 137       <nav class="md-search__options" aria-label="Search">
 138
 139         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 140           <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>
 141         </button>
 142       </nav>
 143
 144     </form>
 145     <div class="md-search__output">
 146       <div class="md-search__scrollwrap" data-md-scrollfix>
 147         <div class="md-search-result" data-md-component="search-result">
 148           <div class="md-search-result__meta">
 149             Initializing search
 150           </div>
 151           <ol class="md-search-result__list" role="presentation"></ol>
 152         </div>
 153       </div>
 154     </div>
 155   </div>
 156 </div>
 157
 158
 159       <div class="md-header__source">
 160         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 161   <div class="md-source__icon md-icon">
 162
 163     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 164   </div>
 165   <div class="md-source__repository">
 166     GitHub
 167   </div>
 168 </a>
 169       </div>
 170
 171   </nav>
 172
 173 </header>
 174
 175     <div class="md-container" data-md-component="container">
 176
 177
 178
 179
 180
 181
 182       <main class="md-main" data-md-component="main">
 183         <div class="md-main__inner md-grid">
 184
 185
 186
 187               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 188                 <div class="md-sidebar__scrollwrap">
 189                   <div class="md-sidebar__inner">
 190
 191
 192
 193 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 194   <label class="md-nav__title" for="__drawer">
 195     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 196
 197   <img src="../../../assets/logo.png" alt="logo">
 198
 199     </a>
 200     WoltLab Suite Documentation
 201   </label>
 202
 203     <div class="md-nav__source">
 204       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 205   <div class="md-source__icon md-icon">
 206
 207     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 208   </div>
 209   <div class="md-source__repository">
 210     GitHub
 211   </div>
 212 </a>
 213     </div>
 214
 215   <ul class="md-nav__list" data-md-scrollfix>
 216
 217
 218
 219
 220
 221
 222
 223
 224     <li class="md-nav__item">
 225       <a href="../../../getting-started/" class="md-nav__link">
 226         Getting Started
 227       </a>
 228     </li>
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240     <li class="md-nav__item md-nav__item--nested">
 241
 242
 243
 244
 245       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 246
 247
 248
 249         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 250           PHP API
 251           <span class="md-nav__icon md-icon"></span>
 252         </label>
 253
 254       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 255         <label class="md-nav__title" for="__nav_2">
 256           <span class="md-nav__icon md-icon"></span>
 257           PHP API
 258         </label>
 259         <ul class="md-nav__list" data-md-scrollfix>
 260
 261
 262
 263
 264
 265
 266     <li class="md-nav__item">
 267       <a href="../../../php/pages/" class="md-nav__link">
 268         Pages
 269       </a>
 270     </li>
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280     <li class="md-nav__item">
 281       <a href="../../../php/database-objects/" class="md-nav__link">
 282         Database Objects
 283       </a>
 284     </li>
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294     <li class="md-nav__item">
 295       <a href="../../../php/database-access/" class="md-nav__link">
 296         Database Access
 297       </a>
 298     </li>
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308     <li class="md-nav__item">
 309       <a href="../../../php/exceptions/" class="md-nav__link">
 310         Exceptions
 311       </a>
 312     </li>
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323     <li class="md-nav__item md-nav__item--nested">
 324
 325
 326
 327
 328       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 329
 330
 331
 332         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 333           API
 334           <span class="md-nav__icon md-icon"></span>
 335         </label>
 336
 337       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 338         <label class="md-nav__title" for="__nav_2_5">
 339           <span class="md-nav__icon md-icon"></span>
 340           API
 341         </label>
 342         <ul class="md-nav__list" data-md-scrollfix>
 343
 344
 345
 346
 347
 348
 349
 350     <li class="md-nav__item md-nav__item--nested">
 351
 352
 353
 354
 355       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 356
 357
 358
 359         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 360           Caches
 361           <span class="md-nav__icon md-icon"></span>
 362         </label>
 363
 364       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 365         <label class="md-nav__title" for="__nav_2_5_1">
 366           <span class="md-nav__icon md-icon"></span>
 367           Caches
 368         </label>
 369         <ul class="md-nav__list" data-md-scrollfix>
 370
 371
 372
 373
 374
 375
 376     <li class="md-nav__item">
 377       <a href="../../../php/api/caches/" class="md-nav__link">
 378         Overview
 379       </a>
 380     </li>
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 392         Persistent Caches
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404     <li class="md-nav__item">
 405       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 406         Runtime Caches
 407       </a>
 408     </li>
 409
 410
 411
 412
 413         </ul>
 414       </nav>
 415     </li>
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425     <li class="md-nav__item">
 426       <a href="../../../php/api/comments/" class="md-nav__link">
 427         Comments
 428       </a>
 429     </li>
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439     <li class="md-nav__item">
 440       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 441         Cronjobs
 442       </a>
 443     </li>
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/events/" class="md-nav__link">
 455         Events
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item md-nav__item--nested">
 469
 470
 471
 472
 473       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 474
 475
 476
 477         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 478           Form Builder
 479           <span class="md-nav__icon md-icon"></span>
 480         </label>
 481
 482       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 483         <label class="md-nav__title" for="__nav_2_5_5">
 484           <span class="md-nav__icon md-icon"></span>
 485           Form Builder
 486         </label>
 487         <ul class="md-nav__list" data-md-scrollfix>
 488
 489
 490
 491
 492
 493
 494     <li class="md-nav__item">
 495       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 496         Overview
 497       </a>
 498     </li>
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508     <li class="md-nav__item">
 509       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 510         Structure
 511       </a>
 512     </li>
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 524         Fields
 525       </a>
 526     </li>
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536     <li class="md-nav__item">
 537       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 538         Validation and Data
 539       </a>
 540     </li>
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550     <li class="md-nav__item">
 551       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 552         Dependencies
 553       </a>
 554     </li>
 555
 556
 557
 558
 559         </ul>
 560       </nav>
 561     </li>
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571     <li class="md-nav__item">
 572       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 573         Package Installation Plugins
 574       </a>
 575     </li>
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585     <li class="md-nav__item">
 586       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 587         User Activity Points
 588       </a>
 589     </li>
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599     <li class="md-nav__item">
 600       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 601         User Notifications
 602       </a>
 603     </li>
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613     <li class="md-nav__item">
 614       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 615         Sitemaps
 616       </a>
 617     </li>
 618
 619
 620
 621
 622         </ul>
 623       </nav>
 624     </li>
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634     <li class="md-nav__item">
 635       <a href="../../../php/code-style/" class="md-nav__link">
 636         Code Style
 637       </a>
 638     </li>
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648     <li class="md-nav__item">
 649       <a href="../../../php/apps/" class="md-nav__link">
 650         Apps
 651       </a>
 652     </li>
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662     <li class="md-nav__item">
 663       <a href="../../../php/gdpr/" class="md-nav__link">
 664         GDPR
 665       </a>
 666     </li>
 667
 668
 669
 670
 671         </ul>
 672       </nav>
 673     </li>
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685     <li class="md-nav__item md-nav__item--nested">
 686
 687
 688
 689
 690       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 691
 692
 693
 694         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 695           Languages, Templates & CSS
 696           <span class="md-nav__icon md-icon"></span>
 697         </label>
 698
 699       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 700         <label class="md-nav__title" for="__nav_3">
 701           <span class="md-nav__icon md-icon"></span>
 702           Languages, Templates & CSS
 703         </label>
 704         <ul class="md-nav__list" data-md-scrollfix>
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../view/languages/" class="md-nav__link">
 713         Languages
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725     <li class="md-nav__item">
 726       <a href="../../../view/templates/" class="md-nav__link">
 727         Templates
 728       </a>
 729     </li>
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739     <li class="md-nav__item">
 740       <a href="../../../view/template-plugins/" class="md-nav__link">
 741         Template Plugins
 742       </a>
 743     </li>
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753     <li class="md-nav__item">
 754       <a href="../../../view/css/" class="md-nav__link">
 755         CSS
 756       </a>
 757     </li>
 758
 759
 760
 761
 762         </ul>
 763       </nav>
 764     </li>
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776     <li class="md-nav__item md-nav__item--nested">
 777
 778
 779
 780
 781       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 782
 783
 784
 785         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 786           TypeScript and JavaScript API
 787           <span class="md-nav__icon md-icon"></span>
 788         </label>
 789
 790       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 791         <label class="md-nav__title" for="__nav_4">
 792           <span class="md-nav__icon md-icon"></span>
 793           TypeScript and JavaScript API
 794         </label>
 795         <ul class="md-nav__list" data-md-scrollfix>
 796
 797
 798
 799
 800
 801
 802     <li class="md-nav__item">
 803       <a href="../../../javascript/general-usage/" class="md-nav__link">
 804         General Usage
 805       </a>
 806     </li>
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816     <li class="md-nav__item">
 817       <a href="../../../javascript/typescript/" class="md-nav__link">
 818         TypeScript
 819       </a>
 820     </li>
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831     <li class="md-nav__item md-nav__item--nested">
 832
 833
 834
 835
 836       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 837
 838
 839
 840         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 841           Components
 842           <span class="md-nav__icon md-icon"></span>
 843         </label>
 844
 845       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 846         <label class="md-nav__title" for="__nav_4_3">
 847           <span class="md-nav__icon md-icon"></span>
 848           Components
 849         </label>
 850         <ul class="md-nav__list" data-md-scrollfix>
 851
 852
 853
 854
 855
 856
 857     <li class="md-nav__item">
 858       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 859         Confirmation
 860       </a>
 861     </li>
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871     <li class="md-nav__item">
 872       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 873         Dialog
 874       </a>
 875     </li>
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885     <li class="md-nav__item">
 886       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 887         Google Maps
 888       </a>
 889     </li>
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899     <li class="md-nav__item">
 900       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 901         Pagination
 902       </a>
 903     </li>
 904
 905
 906
 907
 908         </ul>
 909       </nav>
 910     </li>
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921     <li class="md-nav__item md-nav__item--nested">
 922
 923
 924
 925
 926       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 927
 928
 929
 930         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 931           New API
 932           <span class="md-nav__icon md-icon"></span>
 933         </label>
 934
 935       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 936         <label class="md-nav__title" for="__nav_4_4">
 937           <span class="md-nav__icon md-icon"></span>
 938           New API
 939         </label>
 940         <ul class="md-nav__list" data-md-scrollfix>
 941
 942
 943
 944
 945
 946
 947     <li class="md-nav__item">
 948       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 949         Writing a module
 950       </a>
 951     </li>
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961     <li class="md-nav__item">
 962       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 963         Core Functions
 964       </a>
 965     </li>
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975     <li class="md-nav__item">
 976       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 977         DOM
 978       </a>
 979     </li>
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989     <li class="md-nav__item">
 990       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 991         Event Handling
 992       </a>
 993     </li>
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1005         Ajax
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017     <li class="md-nav__item">
1018       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1019         Dialogs
1020       </a>
1021     </li>
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031     <li class="md-nav__item">
1032       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1033         Browser and Screen Sizes
1034       </a>
1035     </li>
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045     <li class="md-nav__item">
1046       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1047         User Interface
1048       </a>
1049     </li>
1050
1051
1052
1053
1054         </ul>
1055       </nav>
1056     </li>
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066     <li class="md-nav__item">
1067       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1068         Legacy API
1069       </a>
1070     </li>
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1082         Code Snippets
1083       </a>
1084     </li>
1085
1086
1087
1088
1089         </ul>
1090       </nav>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1106
1107
1108
1109
1110       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1111
1112
1113
1114         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1115           Package Components
1116           <span class="md-nav__icon md-icon"></span>
1117         </label>
1118
1119       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1120         <label class="md-nav__title" for="__nav_5">
1121           <span class="md-nav__icon md-icon"></span>
1122           Package Components
1123         </label>
1124         <ul class="md-nav__list" data-md-scrollfix>
1125
1126
1127
1128
1129
1130
1131     <li class="md-nav__item">
1132       <a href="../../package-xml/" class="md-nav__link">
1133         package.xml
1134       </a>
1135     </li>
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1149
1150
1151
1152
1153       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1154
1155
1156
1157         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1158           PIPs
1159           <span class="md-nav__icon md-icon"></span>
1160         </label>
1161
1162       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1163         <label class="md-nav__title" for="__nav_5_2">
1164           <span class="md-nav__icon md-icon"></span>
1165           PIPs
1166         </label>
1167         <ul class="md-nav__list" data-md-scrollfix>
1168
1169
1170
1171
1172
1173
1174     <li class="md-nav__item">
1175       <a href="../" class="md-nav__link">
1176         Overview
1177       </a>
1178     </li>
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../acl-option/" class="md-nav__link">
1190         aclOption
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202     <li class="md-nav__item">
1203       <a href="../acp-menu/" class="md-nav__link">
1204         acpMenu
1205       </a>
1206     </li>
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="../acp-search-provider/" class="md-nav__link">
1218         acpSearchProvider
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230     <li class="md-nav__item">
1231       <a href="../acp-template/" class="md-nav__link">
1232         acpTemplate
1233       </a>
1234     </li>
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244     <li class="md-nav__item">
1245       <a href="../acp-template-delete/" class="md-nav__link">
1246         acpTemplateDelete
1247       </a>
1248     </li>
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258     <li class="md-nav__item">
1259       <a href="../bbcode/" class="md-nav__link">
1260         bbcode
1261       </a>
1262     </li>
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272     <li class="md-nav__item">
1273       <a href="../box/" class="md-nav__link">
1274         box
1275       </a>
1276     </li>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item md-nav__item--active">
1289
1290       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1291
1292
1293
1294
1295
1296         <label class="md-nav__link md-nav__link--active" for="__toc">
1297           clipboardAction
1298           <span class="md-nav__icon md-icon"></span>
1299         </label>
1300
1301       <a href="./" class="md-nav__link md-nav__link--active">
1302         clipboardAction
1303       </a>
1304
1305
1306
1307 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1308
1309
1310
1311
1312
1313
1314     <label class="md-nav__title" for="__toc">
1315       <span class="md-nav__icon md-icon"></span>
1316       Table of contents
1317     </label>
1318     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1319
1320         <li class="md-nav__item">
1321   <a href="#components" class="md-nav__link">
1322     Components
1323   </a>
1324
1325     <nav class="md-nav" aria-label="Components">
1326       <ul class="md-nav__list">
1327
1328           <li class="md-nav__item">
1329   <a href="#actionclassname" class="md-nav__link">
1330     &lt;actionclassname&gt;
1331   </a>
1332
1333 </li>
1334
1335           <li class="md-nav__item">
1336   <a href="#pages" class="md-nav__link">
1337     &lt;pages&gt;
1338   </a>
1339
1340 </li>
1341
1342           <li class="md-nav__item">
1343   <a href="#showorder" class="md-nav__link">
1344     &lt;showorder&gt;
1345   </a>
1346
1347 </li>
1348
1349       </ul>
1350     </nav>
1351
1352 </li>
1353
1354         <li class="md-nav__item">
1355   <a href="#example" class="md-nav__link">
1356     Example
1357   </a>
1358
1359 </li>
1360
1361     </ul>
1362
1363 </nav>
1364
1365     </li>
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375     <li class="md-nav__item">
1376       <a href="../core-object/" class="md-nav__link">
1377         coreObject
1378       </a>
1379     </li>
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389     <li class="md-nav__item">
1390       <a href="../cronjob/" class="md-nav__link">
1391         cronjob
1392       </a>
1393     </li>
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403     <li class="md-nav__item">
1404       <a href="../database/" class="md-nav__link">
1405         database
1406       </a>
1407     </li>
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417     <li class="md-nav__item">
1418       <a href="../event-listener/" class="md-nav__link">
1419         eventListener
1420       </a>
1421     </li>
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431     <li class="md-nav__item">
1432       <a href="../file/" class="md-nav__link">
1433         file
1434       </a>
1435     </li>
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445     <li class="md-nav__item">
1446       <a href="../file-delete/" class="md-nav__link">
1447         fileDelete
1448       </a>
1449     </li>
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459     <li class="md-nav__item">
1460       <a href="../language/" class="md-nav__link">
1461         language
1462       </a>
1463     </li>
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473     <li class="md-nav__item">
1474       <a href="../media-provider/" class="md-nav__link">
1475         mediaProvider
1476       </a>
1477     </li>
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487     <li class="md-nav__item">
1488       <a href="../menu/" class="md-nav__link">
1489         menu
1490       </a>
1491     </li>
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501     <li class="md-nav__item">
1502       <a href="../menu-item/" class="md-nav__link">
1503         menuItem
1504       </a>
1505     </li>
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515     <li class="md-nav__item">
1516       <a href="../object-type/" class="md-nav__link">
1517         objectType
1518       </a>
1519     </li>
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529     <li class="md-nav__item">
1530       <a href="../object-type-definition/" class="md-nav__link">
1531         objectTypeDefinition
1532       </a>
1533     </li>
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543     <li class="md-nav__item">
1544       <a href="../option/" class="md-nav__link">
1545         option
1546       </a>
1547     </li>
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557     <li class="md-nav__item">
1558       <a href="../page/" class="md-nav__link">
1559         page
1560       </a>
1561     </li>
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571     <li class="md-nav__item">
1572       <a href="../pip/" class="md-nav__link">
1573         pip
1574       </a>
1575     </li>
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585     <li class="md-nav__item">
1586       <a href="../script/" class="md-nav__link">
1587         script
1588       </a>
1589     </li>
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599     <li class="md-nav__item">
1600       <a href="../smiley/" class="md-nav__link">
1601         smiley
1602       </a>
1603     </li>
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613     <li class="md-nav__item">
1614       <a href="../sql/" class="md-nav__link">
1615         sql
1616       </a>
1617     </li>
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627     <li class="md-nav__item">
1628       <a href="../style/" class="md-nav__link">
1629         style
1630       </a>
1631     </li>
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641     <li class="md-nav__item">
1642       <a href="../template/" class="md-nav__link">
1643         template
1644       </a>
1645     </li>
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655     <li class="md-nav__item">
1656       <a href="../template-delete/" class="md-nav__link">
1657         templateDelete
1658       </a>
1659     </li>
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669     <li class="md-nav__item">
1670       <a href="../template-listener/" class="md-nav__link">
1671         templateListener
1672       </a>
1673     </li>
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683     <li class="md-nav__item">
1684       <a href="../user-group-option/" class="md-nav__link">
1685         userGroupOption
1686       </a>
1687     </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item">
1698       <a href="../user-menu/" class="md-nav__link">
1699         userMenu
1700       </a>
1701     </li>
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../user-notification-event/" class="md-nav__link">
1713         userNotificationEvent
1714       </a>
1715     </li>
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725     <li class="md-nav__item">
1726       <a href="../user-option/" class="md-nav__link">
1727         userOption
1728       </a>
1729     </li>
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739     <li class="md-nav__item">
1740       <a href="../user-profile-menu/" class="md-nav__link">
1741         userProfileMenu
1742       </a>
1743     </li>
1744
1745
1746
1747
1748         </ul>
1749       </nav>
1750     </li>
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760     <li class="md-nav__item">
1761       <a href="../../database-php-api/" class="md-nav__link">
1762         Database PHP API
1763       </a>
1764     </li>
1765
1766
1767
1768
1769         </ul>
1770       </nav>
1771     </li>
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783     <li class="md-nav__item md-nav__item--nested">
1784
1785
1786
1787
1788       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1789
1790
1791
1792         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1793           Migration
1794           <span class="md-nav__icon md-icon"></span>
1795         </label>
1796
1797       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1798         <label class="md-nav__title" for="__nav_6">
1799           <span class="md-nav__icon md-icon"></span>
1800           Migration
1801         </label>
1802         <ul class="md-nav__list" data-md-scrollfix>
1803
1804
1805
1806
1807
1808
1809
1810     <li class="md-nav__item md-nav__item--nested">
1811
1812
1813
1814
1815       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1816
1817
1818
1819         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1820           From WoltLab Suite 5.5
1821           <span class="md-nav__icon md-icon"></span>
1822         </label>
1823
1824       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1825         <label class="md-nav__title" for="__nav_6_1">
1826           <span class="md-nav__icon md-icon"></span>
1827           From WoltLab Suite 5.5
1828         </label>
1829         <ul class="md-nav__list" data-md-scrollfix>
1830
1831
1832
1833
1834
1835
1836     <li class="md-nav__item">
1837       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1838         PHP API
1839       </a>
1840     </li>
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850     <li class="md-nav__item">
1851       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1852         TypeScript and JavaScript
1853       </a>
1854     </li>
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864     <li class="md-nav__item">
1865       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1866         Templates
1867       </a>
1868     </li>
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878     <li class="md-nav__item">
1879       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1880         Icons
1881       </a>
1882     </li>
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892     <li class="md-nav__item">
1893       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1894         Dialogs
1895       </a>
1896     </li>
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906     <li class="md-nav__item">
1907       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1908         Third Party Libraries
1909       </a>
1910     </li>
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920     <li class="md-nav__item">
1921       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1922         Deprecations and Removals
1923       </a>
1924     </li>
1925
1926
1927
1928
1929         </ul>
1930       </nav>
1931     </li>
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942     <li class="md-nav__item md-nav__item--nested">
1943
1944
1945
1946
1947       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1948
1949
1950
1951         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1952           From WoltLab Suite 5.4
1953           <span class="md-nav__icon md-icon"></span>
1954         </label>
1955
1956       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1957         <label class="md-nav__title" for="__nav_6_2">
1958           <span class="md-nav__icon md-icon"></span>
1959           From WoltLab Suite 5.4
1960         </label>
1961         <ul class="md-nav__list" data-md-scrollfix>
1962
1963
1964
1965
1966
1967
1968     <li class="md-nav__item">
1969       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1970         PHP API
1971       </a>
1972     </li>
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982     <li class="md-nav__item">
1983       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
1984         TypeScript and JavaScript
1985       </a>
1986     </li>
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996     <li class="md-nav__item">
1997       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
1998         Templates
1999       </a>
2000     </li>
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010     <li class="md-nav__item">
2011       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2012         Third Party Libraries
2013       </a>
2014     </li>
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024     <li class="md-nav__item">
2025       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2026         Deprecations and Removals
2027       </a>
2028     </li>
2029
2030
2031
2032
2033         </ul>
2034       </nav>
2035     </li>
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046     <li class="md-nav__item md-nav__item--nested">
2047
2048
2049
2050
2051       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2052
2053
2054
2055         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2056           From WoltLab Suite 5.3
2057           <span class="md-nav__icon md-icon"></span>
2058         </label>
2059
2060       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2061         <label class="md-nav__title" for="__nav_6_3">
2062           <span class="md-nav__icon md-icon"></span>
2063           From WoltLab Suite 5.3
2064         </label>
2065         <ul class="md-nav__list" data-md-scrollfix>
2066
2067
2068
2069
2070
2071
2072     <li class="md-nav__item">
2073       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2074         PHP API
2075       </a>
2076     </li>
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086     <li class="md-nav__item">
2087       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2088         Session Handling and Authentication
2089       </a>
2090     </li>
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100     <li class="md-nav__item">
2101       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2102         TypeScript and JavaScript
2103       </a>
2104     </li>
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114     <li class="md-nav__item">
2115       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2116         Templates
2117       </a>
2118     </li>
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128     <li class="md-nav__item">
2129       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2130         Third Party Libraries
2131       </a>
2132     </li>
2133
2134
2135
2136
2137         </ul>
2138       </nav>
2139     </li>
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150     <li class="md-nav__item md-nav__item--nested">
2151
2152
2153
2154
2155       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2156
2157
2158
2159         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2160           From WoltLab Suite 5.2
2161           <span class="md-nav__icon md-icon"></span>
2162         </label>
2163
2164       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2165         <label class="md-nav__title" for="__nav_6_4">
2166           <span class="md-nav__icon md-icon"></span>
2167           From WoltLab Suite 5.2
2168         </label>
2169         <ul class="md-nav__list" data-md-scrollfix>
2170
2171
2172
2173
2174
2175
2176     <li class="md-nav__item">
2177       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2178         PHP API
2179       </a>
2180     </li>
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190     <li class="md-nav__item">
2191       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2192         Templates and Languages
2193       </a>
2194     </li>
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204     <li class="md-nav__item">
2205       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2206         Third Party Libraries
2207       </a>
2208     </li>
2209
2210
2211
2212
2213         </ul>
2214       </nav>
2215     </li>
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226     <li class="md-nav__item md-nav__item--nested">
2227
2228
2229
2230
2231       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2232
2233
2234
2235         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2236           From WoltLab Suite 3.1
2237           <span class="md-nav__icon md-icon"></span>
2238         </label>
2239
2240       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2241         <label class="md-nav__title" for="__nav_6_5">
2242           <span class="md-nav__icon md-icon"></span>
2243           From WoltLab Suite 3.1
2244         </label>
2245         <ul class="md-nav__list" data-md-scrollfix>
2246
2247
2248
2249
2250
2251
2252     <li class="md-nav__item">
2253       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2254         PHP API
2255       </a>
2256     </li>
2257
2258
2259
2260
2261         </ul>
2262       </nav>
2263     </li>
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274     <li class="md-nav__item md-nav__item--nested">
2275
2276
2277
2278
2279       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2280
2281
2282
2283         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2284           From WoltLab Suite 3.0
2285           <span class="md-nav__icon md-icon"></span>
2286         </label>
2287
2288       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2289         <label class="md-nav__title" for="__nav_6_6">
2290           <span class="md-nav__icon md-icon"></span>
2291           From WoltLab Suite 3.0
2292         </label>
2293         <ul class="md-nav__list" data-md-scrollfix>
2294
2295
2296
2297
2298
2299
2300     <li class="md-nav__item">
2301       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2302         PHP API
2303       </a>
2304     </li>
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314     <li class="md-nav__item">
2315       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2316         JavaScript API
2317       </a>
2318     </li>
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328     <li class="md-nav__item">
2329       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2330         Templates
2331       </a>
2332     </li>
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342     <li class="md-nav__item">
2343       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2344         CSS
2345       </a>
2346     </li>
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356     <li class="md-nav__item">
2357       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2358         Package Components
2359       </a>
2360     </li>
2361
2362
2363
2364
2365         </ul>
2366       </nav>
2367     </li>
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378     <li class="md-nav__item md-nav__item--nested">
2379
2380
2381
2382
2383       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2384
2385
2386
2387         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2388           From WCF 2.1
2389           <span class="md-nav__icon md-icon"></span>
2390         </label>
2391
2392       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2393         <label class="md-nav__title" for="__nav_6_7">
2394           <span class="md-nav__icon md-icon"></span>
2395           From WCF 2.1
2396         </label>
2397         <ul class="md-nav__list" data-md-scrollfix>
2398
2399
2400
2401
2402
2403
2404     <li class="md-nav__item">
2405       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2406         PHP API
2407       </a>
2408     </li>
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418     <li class="md-nav__item">
2419       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2420         Templates
2421       </a>
2422     </li>
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432     <li class="md-nav__item">
2433       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2434         CSS
2435       </a>
2436     </li>
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446     <li class="md-nav__item">
2447       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2448         Package Components
2449       </a>
2450     </li>
2451
2452
2453
2454
2455         </ul>
2456       </nav>
2457     </li>
2458
2459
2460
2461
2462         </ul>
2463       </nav>
2464     </li>
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476     <li class="md-nav__item md-nav__item--nested">
2477
2478
2479
2480
2481       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2482
2483
2484
2485         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2486           Tutorials
2487           <span class="md-nav__icon md-icon"></span>
2488         </label>
2489
2490       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2491         <label class="md-nav__title" for="__nav_7">
2492           <span class="md-nav__icon md-icon"></span>
2493           Tutorials
2494         </label>
2495         <ul class="md-nav__list" data-md-scrollfix>
2496
2497
2498
2499
2500
2501
2502
2503     <li class="md-nav__item md-nav__item--nested">
2504
2505
2506
2507
2508       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2509
2510
2511
2512         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2513           Tutorial Series
2514           <span class="md-nav__icon md-icon"></span>
2515         </label>
2516
2517       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2518         <label class="md-nav__title" for="__nav_7_1">
2519           <span class="md-nav__icon md-icon"></span>
2520           Tutorial Series
2521         </label>
2522         <ul class="md-nav__list" data-md-scrollfix>
2523
2524
2525
2526
2527
2528
2529     <li class="md-nav__item">
2530       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2531         Overview
2532       </a>
2533     </li>
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543     <li class="md-nav__item">
2544       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2545         Part 1
2546       </a>
2547     </li>
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557     <li class="md-nav__item">
2558       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2559         Part 2
2560       </a>
2561     </li>
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571     <li class="md-nav__item">
2572       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2573         Part 3
2574       </a>
2575     </li>
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585     <li class="md-nav__item">
2586       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2587         Part 4
2588       </a>
2589     </li>
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599     <li class="md-nav__item">
2600       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2601         Part 5
2602       </a>
2603     </li>
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613     <li class="md-nav__item">
2614       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2615         Part 6
2616       </a>
2617     </li>
2618
2619
2620
2621
2622         </ul>
2623       </nav>
2624     </li>
2625
2626
2627
2628
2629         </ul>
2630       </nav>
2631     </li>
2632
2633
2634
2635   </ul>
2636 </nav>
2637                   </div>
2638                 </div>
2639               </div>
2640
2641
2642
2643               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2644                 <div class="md-sidebar__scrollwrap">
2645                   <div class="md-sidebar__inner">
2646
2647
2648 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2649
2650
2651
2652
2653
2654
2655     <label class="md-nav__title" for="__toc">
2656       <span class="md-nav__icon md-icon"></span>
2657       Table of contents
2658     </label>
2659     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2660
2661         <li class="md-nav__item">
2662   <a href="#components" class="md-nav__link">
2663     Components
2664   </a>
2665
2666     <nav class="md-nav" aria-label="Components">
2667       <ul class="md-nav__list">
2668
2669           <li class="md-nav__item">
2670   <a href="#actionclassname" class="md-nav__link">
2671     &lt;actionclassname&gt;
2672   </a>
2673
2674 </li>
2675
2676           <li class="md-nav__item">
2677   <a href="#pages" class="md-nav__link">
2678     &lt;pages&gt;
2679   </a>
2680
2681 </li>
2682
2683           <li class="md-nav__item">
2684   <a href="#showorder" class="md-nav__link">
2685     &lt;showorder&gt;
2686   </a>
2687
2688 </li>
2689
2690       </ul>
2691     </nav>
2692
2693 </li>
2694
2695         <li class="md-nav__item">
2696   <a href="#example" class="md-nav__link">
2697     Example
2698   </a>
2699
2700 </li>
2701
2702     </ul>
2703
2704 </nav>
2705                   </div>
2706                 </div>
2707               </div>
2708
2709
2710
2711             <div class="md-content" data-md-component="content">
2712               <article class="md-content__inner md-typeset">
2713
2714
2715
2716
2717
2718
2719
2720 <h1 id="clipboard-action-package-installation-plugin">Clipboard Action Package Installation Plugin<a class="headerlink" href="#clipboard-action-package-installation-plugin" title="Permanent link">#</a></h1>
2721 <p>Registers clipboard actions.</p>
2722 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2723 <p>Each clipboard action is described as an <code>&lt;action&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2724 <h3 id="actionclassname"><code>&lt;actionclassname&gt;</code><a class="headerlink" href="#actionclassname" title="Permanent link">#</a></h3>
2725 <p>The name of the class used by the clipboard API to process the concrete action.
2726 The class has to implement the <code>wcf\system\clipboard\action\IClipboardAction</code> interface, best by extending <code>wcf\system\clipboard\action\AbstractClipboardAction</code>.</p>
2727 <h3 id="pages"><code>&lt;pages&gt;</code><a class="headerlink" href="#pages" title="Permanent link">#</a></h3>
2728 <p>Element with <code>&lt;page&gt;</code> children whose value contains the class name of the controller of the page on which the clipboard action is available.</p>
2729 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2730 <p><span class="label label-info">Optional</span></p>
2731 <p>Determines at which position of the clipboard action list the action is shown.</p>
2732 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2733 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">clipboardAction.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/clipboardAction.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2734 <span class="normal"> 2</span>
2735 <span class="normal"> 3</span>
2736 <span class="normal"> 4</span>
2737 <span class="normal"> 5</span>
2738 <span class="normal"> 6</span>
2739 <span class="normal"> 7</span>
2740 <span class="normal"> 8</span>
2741 <span class="normal"> 9</span>
2742 <span class="normal">10</span>
2743 <span class="normal">11</span>
2744 <span class="normal">12</span>
2745 <span class="normal">13</span>
2746 <span class="normal">14</span>
2747 <span class="normal">15</span>
2748 <span class="normal">16</span>
2749 <span class="normal">17</span>
2750 <span class="normal">18</span>
2751 <span class="normal">19</span>
2752 <span class="normal">20</span>
2753 <span class="normal">21</span>
2754 <span class="normal">22</span>
2755 <span class="normal">23</span>
2756 <span class="normal">24</span>
2757 <span class="normal">25</span>
2758 <span class="normal">26</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2759 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/clipboardAction.xsd&quot;</span><span class="nt">&gt;</span>
2760 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
2761 <span class="w">        </span><span class="nt">&lt;action</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;delete&quot;</span><span class="nt">&gt;</span>
2762 <span class="w">            </span><span class="nt">&lt;actionclassname&gt;</span>wcf\system\clipboard\action\ExampleClipboardAction<span class="nt">&lt;/actionclassname&gt;</span>
2763 <span class="w">            </span><span class="nt">&lt;showorder&gt;</span>1<span class="nt">&lt;/showorder&gt;</span>
2764 <span class="w">            </span><span class="nt">&lt;pages&gt;</span>
2765 <span class="w">                </span><span class="nt">&lt;page&gt;</span>wcf\acp\page\ExampleListPage<span class="nt">&lt;/page&gt;</span>
2766 <span class="w">            </span><span class="nt">&lt;/pages&gt;</span>
2767 <span class="w">        </span><span class="nt">&lt;/action&gt;</span>
2768 <span class="w">        </span><span class="nt">&lt;action</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;foo&quot;</span><span class="nt">&gt;</span>
2769 <span class="w">            </span><span class="nt">&lt;actionclassname&gt;</span>wcf\system\clipboard\action\ExampleClipboardAction<span class="nt">&lt;/actionclassname&gt;</span>
2770 <span class="w">            </span><span class="nt">&lt;showorder&gt;</span>2<span class="nt">&lt;/showorder&gt;</span>
2771 <span class="w">            </span><span class="nt">&lt;pages&gt;</span>
2772 <span class="w">                </span><span class="nt">&lt;page&gt;</span>wcf\acp\page\ExampleListPage<span class="nt">&lt;/page&gt;</span>
2773 <span class="w">            </span><span class="nt">&lt;/pages&gt;</span>
2774 <span class="w">        </span><span class="nt">&lt;/action&gt;</span>
2775 <span class="w">        </span><span class="nt">&lt;action</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;bar&quot;</span><span class="nt">&gt;</span>
2776 <span class="w">            </span><span class="nt">&lt;actionclassname&gt;</span>wcf\system\clipboard\action\ExampleClipboardAction<span class="nt">&lt;/actionclassname&gt;</span>
2777 <span class="w">            </span><span class="nt">&lt;showorder&gt;</span>3<span class="nt">&lt;/showorder&gt;</span>
2778 <span class="w">            </span><span class="nt">&lt;pages&gt;</span>
2779 <span class="w">                </span><span class="nt">&lt;page&gt;</span>wcf\acp\page\ExampleListPage<span class="nt">&lt;/page&gt;</span>
2780 <span class="w">            </span><span class="nt">&lt;/pages&gt;</span>
2781 <span class="w">        </span><span class="nt">&lt;/action&gt;</span>
2782 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
2783 <span class="nt">&lt;/data&gt;</span>
2784 </code></pre></div></td></tr></table></div>
2785
2786   <hr>
2787 <div class="md-source-file">
2788   <small>
2789
2790       Last update:
2791       2021-04-23
2792
2793   </small>
2794 </div>
2795
2796
2797
2798
2799
2800
2801               </article>
2802             </div>
2803
2804
2805         </div>
2806
2807       </main>
2808
2809         <footer class="md-footer">
2810
2811   <div class="md-footer-meta md-typeset">
2812     <div class="md-footer-meta__inner md-grid">
2813       <div class="md-copyright">
2814
2815     <div class="md-copyright__highlight">
2816       Copyright © 2020 WoltLab GmbH
2817     </div>
2818
2819
2820     Made with
2821     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2822       Material for MkDocs
2823     </a>
2824
2825 </div>
2826
2827         <div class="md-copyright">
2828         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2829         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2830 </div>
2831
2832     </div>
2833   </div>
2834 </footer>
2835
2836     </div>
2837     <div class="md-dialog" data-md-component="dialog">
2838       <div class="md-dialog__inner md-typeset"></div>
2839     </div>
2840
2841     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
2842
2843
2844       <script src="../../../assets/javascripts/bundle.407015b8.min.js"></script>
2845
2846
2847   </body>
2848 </html>