3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>mediaProvider - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#media-provider-package-installation-plugin" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.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>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../../php/pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
313 <li class=
"md-nav__item">
314 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
325 <li class=
"md-nav__item">
326 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
337 <li class=
"md-nav__item">
338 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
349 <li class=
"md-nav__item">
350 <a href=
"../../../php/api/events/" class=
"md-nav__link">
362 <li class=
"md-nav__item md-nav__item--nested">
365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
367 <label class=
"md-nav__link" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
371 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
372 <label class=
"md-nav__title" for=
"__nav_2_5_5">
373 <span class=
"md-nav__icon md-icon"></span>
376 <ul class=
"md-nav__list" data-md-scrollfix
>
382 <li class=
"md-nav__item">
383 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
394 <li class=
"md-nav__item">
395 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
430 <li class=
"md-nav__item">
431 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
448 <li class=
"md-nav__item">
449 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
450 Package Installation Plugins
460 <li class=
"md-nav__item">
461 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
502 <li class=
"md-nav__item">
503 <a href=
"../../../php/code-style/" class=
"md-nav__link">
514 <li class=
"md-nav__item">
515 <a href=
"../../../php/apps/" class=
"md-nav__link">
526 <li class=
"md-nav__item">
527 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
548 <li class=
"md-nav__item md-nav__item--nested">
551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
553 <label class=
"md-nav__link" for=
"__nav_3">
554 Languages, Templates & CSS
555 <span class=
"md-nav__icon md-icon"></span>
557 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
558 <label class=
"md-nav__title" for=
"__nav_3">
559 <span class=
"md-nav__icon md-icon"></span>
560 Languages, Templates & CSS
562 <ul class=
"md-nav__list" data-md-scrollfix
>
568 <li class=
"md-nav__item">
569 <a href=
"../../../view/languages/" class=
"md-nav__link">
580 <li class=
"md-nav__item">
581 <a href=
"../../../view/templates/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../../../view/css/" class=
"md-nav__link">
614 <li class=
"md-nav__item md-nav__item--nested">
617 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
619 <label class=
"md-nav__link" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
623 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
624 <label class=
"md-nav__title" for=
"__nav_4">
625 <span class=
"md-nav__icon md-icon"></span>
628 <ul class=
"md-nav__list" data-md-scrollfix
>
634 <li class=
"md-nav__item">
635 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
647 <li class=
"md-nav__item md-nav__item--nested">
650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
652 <label class=
"md-nav__link" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
656 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
657 <label class=
"md-nav__title" for=
"__nav_4_2">
658 <span class=
"md-nav__icon md-icon"></span>
661 <ul class=
"md-nav__list" data-md-scrollfix
>
667 <li class=
"md-nav__item">
668 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
679 <li class=
"md-nav__item">
680 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
691 <li class=
"md-nav__item">
692 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
703 <li class=
"md-nav__item">
704 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
715 <li class=
"md-nav__item">
716 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
753 Browser and Screen Sizes
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
781 <li class=
"md-nav__item">
782 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
793 <li class=
"md-nav__item">
794 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
829 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
832 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
834 <label class=
"md-nav__link" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
838 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
839 <label class=
"md-nav__title" for=
"__nav_5">
840 <span class=
"md-nav__icon md-icon"></span>
843 <ul class=
"md-nav__list" data-md-scrollfix
>
849 <li class=
"md-nav__item">
850 <a href=
"../../package-xml/" class=
"md-nav__link">
864 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
867 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
869 <label class=
"md-nav__link" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
873 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
874 <label class=
"md-nav__title" for=
"__nav_5_2">
875 <span class=
"md-nav__icon md-icon"></span>
878 <ul class=
"md-nav__list" data-md-scrollfix
>
884 <li class=
"md-nav__item">
885 <a href=
"../" class=
"md-nav__link">
896 <li class=
"md-nav__item">
897 <a href=
"../acl-option/" class=
"md-nav__link">
908 <li class=
"md-nav__item">
909 <a href=
"../acp-menu/" class=
"md-nav__link">
920 <li class=
"md-nav__item">
921 <a href=
"../acp-search-provider/" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"../acp-template/" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"../bbcode/" class=
"md-nav__link">
956 <li class=
"md-nav__item">
957 <a href=
"../box/" class=
"md-nav__link">
968 <li class=
"md-nav__item">
969 <a href=
"../clipboard-action/" class=
"md-nav__link">
980 <li class=
"md-nav__item">
981 <a href=
"../core-object/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../cronjob/" class=
"md-nav__link">
1004 <li class=
"md-nav__item">
1005 <a href=
"../event-listener/" class=
"md-nav__link">
1016 <li class=
"md-nav__item">
1017 <a href=
"../file/" class=
"md-nav__link">
1028 <li class=
"md-nav__item">
1029 <a href=
"../language/" class=
"md-nav__link">
1042 <li class=
"md-nav__item md-nav__item--active">
1044 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1049 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1051 <span class=
"md-nav__icon md-icon"></span>
1054 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1059 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1065 <label class=
"md-nav__title" for=
"__toc">
1066 <span class=
"md-nav__icon md-icon"></span>
1069 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1071 <li class=
"md-nav__item">
1072 <a href=
"#components" class=
"md-nav__link">
1076 <nav class=
"md-nav" aria-label=
"Components">
1077 <ul class=
"md-nav__list">
1079 <li class=
"md-nav__item">
1080 <a href=
"#title" class=
"md-nav__link">
1086 <li class=
"md-nav__item">
1087 <a href=
"#regex" class=
"md-nav__link">
1093 <li class=
"md-nav__item">
1094 <a href=
"#classname" class=
"md-nav__link">
1100 <li class=
"md-nav__item">
1101 <a href=
"#html" class=
"md-nav__link">
1112 <li class=
"md-nav__item">
1113 <a href=
"#example" class=
"md-nav__link">
1131 <li class=
"md-nav__item">
1132 <a href=
"../menu/" class=
"md-nav__link">
1143 <li class=
"md-nav__item">
1144 <a href=
"../menu-item/" class=
"md-nav__link">
1155 <li class=
"md-nav__item">
1156 <a href=
"../object-type/" class=
"md-nav__link">
1167 <li class=
"md-nav__item">
1168 <a href=
"../object-type-definition/" class=
"md-nav__link">
1169 objectTypeDefinition
1179 <li class=
"md-nav__item">
1180 <a href=
"../option/" class=
"md-nav__link">
1191 <li class=
"md-nav__item">
1192 <a href=
"../page/" class=
"md-nav__link">
1203 <li class=
"md-nav__item">
1204 <a href=
"../pip/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../script/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../smiley/" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"../sql/" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../database-php-api/" class=
"md-nav__link">
1375 <li class=
"md-nav__item md-nav__item--nested">
1378 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1380 <label class=
"md-nav__link" for=
"__nav_6">
1382 <span class=
"md-nav__icon md-icon"></span>
1384 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1385 <label class=
"md-nav__title" for=
"__nav_6">
1386 <span class=
"md-nav__icon md-icon"></span>
1389 <ul class=
"md-nav__list" data-md-scrollfix
>
1396 <li class=
"md-nav__item md-nav__item--nested">
1399 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1401 <label class=
"md-nav__link" for=
"__nav_6_1">
1402 Migrating from WSC
5.3
1403 <span class=
"md-nav__icon md-icon"></span>
1405 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1406 <label class=
"md-nav__title" for=
"__nav_6_1">
1407 <span class=
"md-nav__icon md-icon"></span>
1408 Migrating from WSC
5.3
1410 <ul class=
"md-nav__list" data-md-scrollfix
>
1416 <li class=
"md-nav__item">
1417 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1430 Session Handling and Authentication
1440 <li class=
"md-nav__item">
1441 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1452 <li class=
"md-nav__item">
1453 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1464 <li class=
"md-nav__item">
1465 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1466 Third Party Libraries
1483 <li class=
"md-nav__item md-nav__item--nested">
1486 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1488 <label class=
"md-nav__link" for=
"__nav_6_2">
1489 Migrating from WSC
5.2
1490 <span class=
"md-nav__icon md-icon"></span>
1492 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1493 <label class=
"md-nav__title" for=
"__nav_6_2">
1494 <span class=
"md-nav__icon md-icon"></span>
1495 Migrating from WSC
5.2
1497 <ul class=
"md-nav__list" data-md-scrollfix
>
1503 <li class=
"md-nav__item">
1504 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1515 <li class=
"md-nav__item">
1516 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1517 Templates and Languages
1527 <li class=
"md-nav__item">
1528 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1529 Third Party Libraries
1546 <li class=
"md-nav__item md-nav__item--nested">
1549 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1551 <label class=
"md-nav__link" for=
"__nav_6_3">
1552 Migrating from WSC
3.1
1553 <span class=
"md-nav__icon md-icon"></span>
1555 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1556 <label class=
"md-nav__title" for=
"__nav_6_3">
1557 <span class=
"md-nav__icon md-icon"></span>
1558 Migrating from WSC
3.1
1560 <ul class=
"md-nav__list" data-md-scrollfix
>
1566 <li class=
"md-nav__item">
1567 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1585 <li class=
"md-nav__item md-nav__item--nested">
1588 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1590 <label class=
"md-nav__link" for=
"__nav_6_4">
1591 Migrating from WSC
3.0
1592 <span class=
"md-nav__icon md-icon"></span>
1594 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1595 <label class=
"md-nav__title" for=
"__nav_6_4">
1596 <span class=
"md-nav__icon md-icon"></span>
1597 Migrating from WSC
3.0
1599 <ul class=
"md-nav__list" data-md-scrollfix
>
1605 <li class=
"md-nav__item">
1606 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1617 <li class=
"md-nav__item">
1618 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1629 <li class=
"md-nav__item">
1630 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1641 <li class=
"md-nav__item">
1642 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1653 <li class=
"md-nav__item">
1654 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1672 <li class=
"md-nav__item md-nav__item--nested">
1675 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1677 <label class=
"md-nav__link" for=
"__nav_6_5">
1678 Migrating from WCF
2.1
1679 <span class=
"md-nav__icon md-icon"></span>
1681 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1682 <label class=
"md-nav__title" for=
"__nav_6_5">
1683 <span class=
"md-nav__icon md-icon"></span>
1684 Migrating from WCF
2.1
1686 <ul class=
"md-nav__list" data-md-scrollfix
>
1692 <li class=
"md-nav__item">
1693 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1704 <li class=
"md-nav__item">
1705 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1716 <li class=
"md-nav__item">
1717 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1728 <li class=
"md-nav__item">
1729 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1756 <li class=
"md-nav__item md-nav__item--nested">
1759 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1761 <label class=
"md-nav__link" for=
"__nav_7">
1763 <span class=
"md-nav__icon md-icon"></span>
1765 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1766 <label class=
"md-nav__title" for=
"__nav_7">
1767 <span class=
"md-nav__icon md-icon"></span>
1770 <ul class=
"md-nav__list" data-md-scrollfix
>
1777 <li class=
"md-nav__item md-nav__item--nested">
1780 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1782 <label class=
"md-nav__link" for=
"__nav_7_1">
1784 <span class=
"md-nav__icon md-icon"></span>
1786 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1787 <label class=
"md-nav__title" for=
"__nav_7_1">
1788 <span class=
"md-nav__icon md-icon"></span>
1791 <ul class=
"md-nav__list" data-md-scrollfix
>
1797 <li class=
"md-nav__item">
1798 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1809 <li class=
"md-nav__item">
1810 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1821 <li class=
"md-nav__item">
1822 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1833 <li class=
"md-nav__item">
1834 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1861 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1862 <div class=
"md-sidebar__scrollwrap">
1863 <div class=
"md-sidebar__inner">
1865 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1871 <label class=
"md-nav__title" for=
"__toc">
1872 <span class=
"md-nav__icon md-icon"></span>
1875 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1877 <li class=
"md-nav__item">
1878 <a href=
"#components" class=
"md-nav__link">
1882 <nav class=
"md-nav" aria-label=
"Components">
1883 <ul class=
"md-nav__list">
1885 <li class=
"md-nav__item">
1886 <a href=
"#title" class=
"md-nav__link">
1892 <li class=
"md-nav__item">
1893 <a href=
"#regex" class=
"md-nav__link">
1899 <li class=
"md-nav__item">
1900 <a href=
"#classname" class=
"md-nav__link">
1906 <li class=
"md-nav__item">
1907 <a href=
"#html" class=
"md-nav__link">
1918 <li class=
"md-nav__item">
1919 <a href=
"#example" class=
"md-nav__link">
1933 <div class=
"md-content" data-md-component=
"content">
1934 <article class=
"md-content__inner md-typeset">
1937 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/master/docs/package/pip/media-provider.md" title=
"Edit this page" class=
"md-content__button md-icon">
1938 <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>
1942 <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>
1943 <div class=
"admonition info">
1944 <p class=
"admonition-title">Available since WoltLab Suite
3.1</p>
1946 <p>Media providers are responsible to detect and convert links to a
3rd party service inside messages.
</p>
1947 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1948 <p>Each item is described as a
<code><provider
></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>
1949 <h3 id=
"title"><code><title
></code><a class=
"headerlink" href=
"#title" title=
"Permanent link">#
</a></h3>
1950 <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>
1951 <h3 id=
"regex"><code><regex
></code><a class=
"headerlink" href=
"#regex" title=
"Permanent link">#
</a></h3>
1952 <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
<ID
>...)
</code> group.
</p>
1953 <h3 id=
"classname"><code><className
></code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h3>
1954 <div class=
"admonition warning">
1955 <p class=
"admonition-title"><code><className
></code> and
<code><html
></code> are mutually exclusive.
</p>
1957 <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><html
></code> element.
</p>
1958 <p>The callback-class must implement the interface
<code>\wcf\system\bbcode\media\provider\IBBCodeMediaProvider
</code>.
</p>
1959 <h3 id=
"html"><code><html
></code><a class=
"headerlink" href=
"#html" title=
"Permanent link">#
</a></h3>
1960 <div class=
"admonition warning">
1961 <p class=
"admonition-title"><code><className
></code> and
<code><html
></code> are mutually exclusive.
</p>
1963 <p>Replacement HTML that gets populated using the captured matches in
<code><regex
></code>, variables are accessed as
<code>{$VariableName}
</code>. For example, the capture group
<code>(?P
<ID
>...)
</code> is accessed using
<code>{$ID}
</code>.
</p>
1964 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1965 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1966 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/mediaProvider.xsd
"</span><span class=
"nt">></span>
1967 <span class=
"nt"><import
></span>
1968 <span class=
"nt"><provider
</span> <span class=
"na">name=
</span><span class=
"s">"youtube
"</span><span class=
"nt">></span>
1969 <span class=
"nt"><title
></span>YouTube
<span class=
"nt"></title
></span>
1970 <span class=
"nt"><regex
></span><span class=
"cp"><![CDATA[https?://(?:.+?\.)?youtu(?:\.be/|be\.com/(?:#/)?watch\?(?:.*?
&)?v=)(?P
<ID
>[a-zA-Z0-
9_-]+)(?:(?:\?|
&)t=(?P
<start
>[
0-
9hms]+)$)?]]
></span><span class=
"nt"></regex
></span>
1971 <span class=
"c"><!-- advanced PHP callback --
></span>
1972 <span class=
"nt"><className
></span><span class=
"cp"><![CDATA[wcf\system\bbcode\media\provider\YouTubeBBCodeMediaProvider]]
></span><span class=
"nt"></className
></span>
1973 <span class=
"nt"></provider
></span>
1975 <span class=
"nt"><provider
</span> <span class=
"na">name=
</span><span class=
"s">"youtube-playlist
"</span><span class=
"nt">></span>
1976 <span class=
"nt"><title
></span>YouTube Playlist
<span class=
"nt"></title
></span>
1977 <span class=
"nt"><regex
></span><span class=
"cp"><![CDATA[https?://(?:.+?\.)?youtu(?:\.be/|be\.com/)playlist\?(?:.*?
&)?list=(?P
<ID
>[a-zA-Z0-
9_-]+)]]
></span><span class=
"nt"></regex
></span>
1978 <span class=
"c"><!-- uses a simple HTML replacement --
></span>
1979 <span class=
"nt"><html
></span><span class=
"cp"><![CDATA[
<div class=
"videoContainer
"><iframe src=
"https://www.youtube.com/embed/videoseries?list={$ID}
" allowfullscreen
></iframe
></div
>]]
></span><span class=
"nt"></html
></span>
1980 <span class=
"nt"></provider
></span>
1981 <span class=
"nt"></import
></span>
1983 <span class=
"nt"><delete
></span>
1984 <span class=
"nt"><provider
</span> <span class=
"na">identifier=
</span><span class=
"s">"example
"</span> <span class=
"nt">/
></span>
1985 <span class=
"nt"></delete
></span>
1986 <span class=
"nt"></data
></span>
2001 <footer class=
"md-footer">
2003 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2005 <a href=
"../language/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2006 <div class=
"md-footer__button md-icon">
2007 <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>
2009 <div class=
"md-footer__title">
2010 <div class=
"md-ellipsis">
2011 <span class=
"md-footer__direction">
2020 <a href=
"../menu/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2021 <div class=
"md-footer__title">
2022 <div class=
"md-ellipsis">
2023 <span class=
"md-footer__direction">
2029 <div class=
"md-footer__button md-icon">
2030 <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>
2036 <div class=
"md-footer-meta md-typeset">
2037 <div class=
"md-footer-meta__inner md-grid">
2038 <div class=
"md-footer-copyright">
2040 <div class=
"md-footer-copyright__highlight">
2041 Copyright ©
2020 WoltLab GmbH
2045 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2050 <div class=
"md-footer-copyright">
2051 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2052 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2059 <div class=
"md-dialog" data-md-component=
"dialog">
2060 <div class=
"md-dialog__inner md-typeset"></div>
2062 <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.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2065 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>