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