3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Fields - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../../assets/stylesheets/palette.ef6f36e2.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=
"">
55 <script>function __prefix(e){return new URL(
"../../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
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">
63 <a href=
"#form-builder-fields" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
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">
84 <img src=
"../../../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
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>
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>
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>
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">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
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">
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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
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">
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">
176 <img src=
"../../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
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">
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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../../getting-started/" class=
"md-nav__link">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../../pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../../database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../../database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../../exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
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
>
314 <li class=
"md-nav__item md-nav__item--nested">
317 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
319 <label class=
"md-nav__link" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
323 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
324 <label class=
"md-nav__title" for=
"__nav_2_5_1">
325 <span class=
"md-nav__icon md-icon"></span>
328 <ul class=
"md-nav__list" data-md-scrollfix
>
334 <li class=
"md-nav__item">
335 <a href=
"../../caches/" class=
"md-nav__link">
346 <li class=
"md-nav__item">
347 <a href=
"../../caches_persistent-caches/" class=
"md-nav__link">
358 <li class=
"md-nav__item">
359 <a href=
"../../caches_runtime-caches/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../../comments/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../../cronjobs/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../../events/" class=
"md-nav__link">
415 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
418 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" checked
>
420 <label class=
"md-nav__link" for=
"__nav_2_5_5">
422 <span class=
"md-nav__icon md-icon"></span>
424 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
425 <label class=
"md-nav__title" for=
"__nav_2_5_5">
426 <span class=
"md-nav__icon md-icon"></span>
429 <ul class=
"md-nav__list" data-md-scrollfix
>
435 <li class=
"md-nav__item">
436 <a href=
"../overview/" class=
"md-nav__link">
447 <li class=
"md-nav__item">
448 <a href=
"../structure/" class=
"md-nav__link">
461 <li class=
"md-nav__item md-nav__item--active">
463 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
468 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
470 <span class=
"md-nav__icon md-icon"></span>
473 <a href=
"./" class=
"md-nav__link md-nav__link--active">
478 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
484 <label class=
"md-nav__title" for=
"__toc">
485 <span class=
"md-nav__icon md-icon"></span>
488 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
490 <li class=
"md-nav__item">
491 <a href=
"#abstract-form-fields" class=
"md-nav__link">
495 <nav class=
"md-nav" aria-label=
"Abstract Form Fields">
496 <ul class=
"md-nav__list">
498 <li class=
"md-nav__item">
499 <a href=
"#abstractformfield" class=
"md-nav__link">
505 <li class=
"md-nav__item">
506 <a href=
"#abstractnumericformfield" class=
"md-nav__link">
507 AbstractNumericFormField
517 <li class=
"md-nav__item">
518 <a href=
"#general-form-fields" class=
"md-nav__link">
522 <nav class=
"md-nav" aria-label=
"General Form Fields">
523 <ul class=
"md-nav__list">
525 <li class=
"md-nav__item">
526 <a href=
"#booleanformfield" class=
"md-nav__link">
532 <li class=
"md-nav__item">
533 <a href=
"#checkboxformfield" class=
"md-nav__link">
539 <li class=
"md-nav__item">
540 <a href=
"#classnameformfield" class=
"md-nav__link">
546 <li class=
"md-nav__item">
547 <a href=
"#dateformfield" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"#descriptionformfield" class=
"md-nav__link">
560 <li class=
"md-nav__item">
561 <a href=
"#emailformfield" class=
"md-nav__link">
567 <li class=
"md-nav__item">
568 <a href=
"#floatformfield" class=
"md-nav__link">
574 <li class=
"md-nav__item">
575 <a href=
"#iconformfield" class=
"md-nav__link">
581 <li class=
"md-nav__item">
582 <a href=
"#integerformfield" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"#isdisabledformfield" class=
"md-nav__link">
595 <li class=
"md-nav__item">
596 <a href=
"#itemlistformfield" class=
"md-nav__link">
602 <li class=
"md-nav__item">
603 <a href=
"#multilinetextformfield" class=
"md-nav__link">
604 MultilineTextFormField
609 <li class=
"md-nav__item">
610 <a href=
"#multipleselectionformfield" class=
"md-nav__link">
611 MultipleSelectionFormField
616 <li class=
"md-nav__item">
617 <a href=
"#radiobuttonformfield" class=
"md-nav__link">
623 <li class=
"md-nav__item">
624 <a href=
"#ratingformfield" class=
"md-nav__link">
630 <li class=
"md-nav__item">
631 <a href=
"#showorderformfield" class=
"md-nav__link">
637 <li class=
"md-nav__item">
638 <a href=
"#singleselectionformfield" class=
"md-nav__link">
639 SingleSelectionFormField
644 <li class=
"md-nav__item">
645 <a href=
"#sortorderformfield" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"#textformfield" class=
"md-nav__link">
658 <li class=
"md-nav__item">
659 <a href=
"#titleformfield" class=
"md-nav__link">
665 <li class=
"md-nav__item">
666 <a href=
"#urlformfield" class=
"md-nav__link">
677 <li class=
"md-nav__item">
678 <a href=
"#specific-fields" class=
"md-nav__link">
682 <nav class=
"md-nav" aria-label=
"Specific Fields">
683 <ul class=
"md-nav__list">
685 <li class=
"md-nav__item">
686 <a href=
"#aclformfield" class=
"md-nav__link">
692 <li class=
"md-nav__item">
693 <a href=
"#buttonformfield" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"#captchaformfield" class=
"md-nav__link">
706 <li class=
"md-nav__item">
707 <a href=
"#contentlanguageformfield" class=
"md-nav__link">
708 ContentLanguageFormField
713 <li class=
"md-nav__item">
714 <a href=
"#labelformfield" class=
"md-nav__link">
720 <li class=
"md-nav__item">
721 <a href=
"#optionformfield" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"#simpleaclformfield" class=
"md-nav__link">
734 <li class=
"md-nav__item">
735 <a href=
"#singlemediaselectionformfield" class=
"md-nav__link">
736 SingleMediaSelectionFormField
741 <li class=
"md-nav__item">
742 <a href=
"#tagformfield" class=
"md-nav__link">
748 <li class=
"md-nav__item">
749 <a href=
"#uploadformfield" class=
"md-nav__link">
753 <nav class=
"md-nav" aria-label=
"UploadFormField">
754 <ul class=
"md-nav__list">
756 <li class=
"md-nav__item">
757 <a href=
"#provide-value-from-database-object" class=
"md-nav__link">
758 Provide value from database object
763 <li class=
"md-nav__item">
764 <a href=
"#process-files" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"#userformfield" class=
"md-nav__link">
782 <li class=
"md-nav__item">
783 <a href=
"#userpasswordfield" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"#usergroupoptionformfield" class=
"md-nav__link">
791 UserGroupOptionFormField
796 <li class=
"md-nav__item">
797 <a href=
"#usernameformfield" class=
"md-nav__link">
808 <li class=
"md-nav__item">
809 <a href=
"#wysiwyg-form-container" class=
"md-nav__link">
810 Wysiwyg form container
813 <nav class=
"md-nav" aria-label=
"Wysiwyg form container">
814 <ul class=
"md-nav__list">
816 <li class=
"md-nav__item">
817 <a href=
"#wysiwygattachmentformfield" class=
"md-nav__link">
818 WysiwygAttachmentFormField
823 <li class=
"md-nav__item">
824 <a href=
"#wysiwygpollformcontainer" class=
"md-nav__link">
825 WysiwygPollFormContainer
830 <li class=
"md-nav__item">
831 <a href=
"#wysiwygsmileyformcontainer" class=
"md-nav__link">
832 WysiwygSmileyFormContainer
835 <nav class=
"md-nav" aria-label=
"WysiwygSmileyFormContainer">
836 <ul class=
"md-nav__list">
838 <li class=
"md-nav__item">
839 <a href=
"#wysiwygsmileyformnode" class=
"md-nav__link">
840 WysiwygSmileyFormNode
850 <li class=
"md-nav__item">
851 <a href=
"#example" class=
"md-nav__link">
857 <li class=
"md-nav__item">
858 <a href=
"#wysiwygformfield" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"#twysiwygformnode" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"#single-use-form-fields" class=
"md-nav__link">
878 Single-Use Form Fields
881 <nav class=
"md-nav" aria-label=
"Single-Use Form Fields">
882 <ul class=
"md-nav__list">
884 <li class=
"md-nav__item">
885 <a href=
"#bbcodeattributesformfield" class=
"md-nav__link">
886 BBCodeAttributesFormField
891 <li class=
"md-nav__item">
892 <a href=
"#devtoolsprojectexcludedpackagesformfield" class=
"md-nav__link">
893 DevtoolsProjectExcludedPackagesFormField
898 <li class=
"md-nav__item">
899 <a href=
"#devtoolsprojectinstructionsformfield" class=
"md-nav__link">
900 DevtoolsProjectInstructionsFormField
905 <li class=
"md-nav__item">
906 <a href=
"#devtoolsprojectoptionalpackagesformfield" class=
"md-nav__link">
907 DevtoolsProjectOptionalPackagesFormField
912 <li class=
"md-nav__item">
913 <a href=
"#devtoolsprojectrequiredpackagesformfield" class=
"md-nav__link">
914 DevtoolsProjectRequiredPackagesFormField
936 <li class=
"md-nav__item">
937 <a href=
"../validation_data/" class=
"md-nav__link">
948 <li class=
"md-nav__item">
949 <a href=
"../dependencies/" class=
"md-nav__link">
966 <li class=
"md-nav__item">
967 <a href=
"../../package_installation_plugins/" class=
"md-nav__link">
968 Package Installation Plugins
978 <li class=
"md-nav__item">
979 <a href=
"../../user_activity_points/" class=
"md-nav__link">
990 <li class=
"md-nav__item">
991 <a href=
"../../user_notifications/" class=
"md-nav__link">
1002 <li class=
"md-nav__item">
1003 <a href=
"../../sitemaps/" class=
"md-nav__link">
1020 <li class=
"md-nav__item">
1021 <a href=
"../../../code-style/" class=
"md-nav__link">
1032 <li class=
"md-nav__item">
1033 <a href=
"../../../apps/" class=
"md-nav__link">
1044 <li class=
"md-nav__item">
1045 <a href=
"../../../gdpr/" class=
"md-nav__link">
1066 <li class=
"md-nav__item md-nav__item--nested">
1069 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
1071 <label class=
"md-nav__link" for=
"__nav_3">
1072 Languages, Templates & CSS
1073 <span class=
"md-nav__icon md-icon"></span>
1075 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
1076 <label class=
"md-nav__title" for=
"__nav_3">
1077 <span class=
"md-nav__icon md-icon"></span>
1078 Languages, Templates & CSS
1080 <ul class=
"md-nav__list" data-md-scrollfix
>
1086 <li class=
"md-nav__item">
1087 <a href=
"../../../../view/languages/" class=
"md-nav__link">
1098 <li class=
"md-nav__item">
1099 <a href=
"../../../../view/templates/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"../../../../view/template-plugins/" class=
"md-nav__link">
1122 <li class=
"md-nav__item">
1123 <a href=
"../../../../view/css/" class=
"md-nav__link">
1144 <li class=
"md-nav__item md-nav__item--nested">
1147 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
1149 <label class=
"md-nav__link" for=
"__nav_4">
1150 TypeScript and JavaScript API
1151 <span class=
"md-nav__icon md-icon"></span>
1153 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
1154 <label class=
"md-nav__title" for=
"__nav_4">
1155 <span class=
"md-nav__icon md-icon"></span>
1156 TypeScript and JavaScript API
1158 <ul class=
"md-nav__list" data-md-scrollfix
>
1164 <li class=
"md-nav__item">
1165 <a href=
"../../../../javascript/general-usage/" class=
"md-nav__link">
1176 <li class=
"md-nav__item">
1177 <a href=
"../../../../javascript/typescript/" class=
"md-nav__link">
1189 <li class=
"md-nav__item md-nav__item--nested">
1192 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
1194 <label class=
"md-nav__link" for=
"__nav_4_3">
1196 <span class=
"md-nav__icon md-icon"></span>
1198 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
1199 <label class=
"md-nav__title" for=
"__nav_4_3">
1200 <span class=
"md-nav__icon md-icon"></span>
1203 <ul class=
"md-nav__list" data-md-scrollfix
>
1209 <li class=
"md-nav__item">
1210 <a href=
"../../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
1221 <li class=
"md-nav__item">
1222 <a href=
"../../../../javascript/new-api_data-structures/" class=
"md-nav__link">
1233 <li class=
"md-nav__item">
1234 <a href=
"../../../../javascript/new-api_core/" class=
"md-nav__link">
1245 <li class=
"md-nav__item">
1246 <a href=
"../../../../javascript/new-api_dom/" class=
"md-nav__link">
1257 <li class=
"md-nav__item">
1258 <a href=
"../../../../javascript/new-api_events/" class=
"md-nav__link">
1269 <li class=
"md-nav__item">
1270 <a href=
"../../../../javascript/new-api_ajax/" class=
"md-nav__link">
1281 <li class=
"md-nav__item">
1282 <a href=
"../../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1293 <li class=
"md-nav__item">
1294 <a href=
"../../../../javascript/new-api_browser/" class=
"md-nav__link">
1295 Browser and Screen Sizes
1305 <li class=
"md-nav__item">
1306 <a href=
"../../../../javascript/new-api_ui/" class=
"md-nav__link">
1323 <li class=
"md-nav__item">
1324 <a href=
"../../../../javascript/legacy-api/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../../../../javascript/helper-functions/" class=
"md-nav__link">
1347 <li class=
"md-nav__item">
1348 <a href=
"../../../../javascript/code-snippets/" class=
"md-nav__link">
1369 <li class=
"md-nav__item md-nav__item--nested">
1372 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1374 <label class=
"md-nav__link" for=
"__nav_5">
1376 <span class=
"md-nav__icon md-icon"></span>
1378 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1379 <label class=
"md-nav__title" for=
"__nav_5">
1380 <span class=
"md-nav__icon md-icon"></span>
1383 <ul class=
"md-nav__list" data-md-scrollfix
>
1389 <li class=
"md-nav__item">
1390 <a href=
"../../../../package/package-xml/" class=
"md-nav__link">
1402 <li class=
"md-nav__item md-nav__item--nested">
1405 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1407 <label class=
"md-nav__link" for=
"__nav_5_2">
1409 <span class=
"md-nav__icon md-icon"></span>
1411 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1412 <label class=
"md-nav__title" for=
"__nav_5_2">
1413 <span class=
"md-nav__icon md-icon"></span>
1416 <ul class=
"md-nav__list" data-md-scrollfix
>
1422 <li class=
"md-nav__item">
1423 <a href=
"../../../../package/pip/" class=
"md-nav__link">
1434 <li class=
"md-nav__item">
1435 <a href=
"../../../../package/pip/acl-option/" class=
"md-nav__link">
1446 <li class=
"md-nav__item">
1447 <a href=
"../../../../package/pip/acp-menu/" class=
"md-nav__link">
1458 <li class=
"md-nav__item">
1459 <a href=
"../../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1470 <li class=
"md-nav__item">
1471 <a href=
"../../../../package/pip/acp-template/" class=
"md-nav__link">
1482 <li class=
"md-nav__item">
1483 <a href=
"../../../../package/pip/bbcode/" class=
"md-nav__link">
1494 <li class=
"md-nav__item">
1495 <a href=
"../../../../package/pip/box/" class=
"md-nav__link">
1506 <li class=
"md-nav__item">
1507 <a href=
"../../../../package/pip/clipboard-action/" class=
"md-nav__link">
1518 <li class=
"md-nav__item">
1519 <a href=
"../../../../package/pip/core-object/" class=
"md-nav__link">
1530 <li class=
"md-nav__item">
1531 <a href=
"../../../../package/pip/cronjob/" class=
"md-nav__link">
1542 <li class=
"md-nav__item">
1543 <a href=
"../../../../package/pip/database/" class=
"md-nav__link">
1554 <li class=
"md-nav__item">
1555 <a href=
"../../../../package/pip/event-listener/" class=
"md-nav__link">
1566 <li class=
"md-nav__item">
1567 <a href=
"../../../../package/pip/file/" class=
"md-nav__link">
1578 <li class=
"md-nav__item">
1579 <a href=
"../../../../package/pip/language/" class=
"md-nav__link">
1590 <li class=
"md-nav__item">
1591 <a href=
"../../../../package/pip/media-provider/" class=
"md-nav__link">
1602 <li class=
"md-nav__item">
1603 <a href=
"../../../../package/pip/menu/" class=
"md-nav__link">
1614 <li class=
"md-nav__item">
1615 <a href=
"../../../../package/pip/menu-item/" class=
"md-nav__link">
1626 <li class=
"md-nav__item">
1627 <a href=
"../../../../package/pip/object-type/" class=
"md-nav__link">
1638 <li class=
"md-nav__item">
1639 <a href=
"../../../../package/pip/object-type-definition/" class=
"md-nav__link">
1640 objectTypeDefinition
1650 <li class=
"md-nav__item">
1651 <a href=
"../../../../package/pip/option/" class=
"md-nav__link">
1662 <li class=
"md-nav__item">
1663 <a href=
"../../../../package/pip/page/" class=
"md-nav__link">
1674 <li class=
"md-nav__item">
1675 <a href=
"../../../../package/pip/pip/" class=
"md-nav__link">
1686 <li class=
"md-nav__item">
1687 <a href=
"../../../../package/pip/script/" class=
"md-nav__link">
1698 <li class=
"md-nav__item">
1699 <a href=
"../../../../package/pip/smiley/" class=
"md-nav__link">
1710 <li class=
"md-nav__item">
1711 <a href=
"../../../../package/pip/sql/" class=
"md-nav__link">
1722 <li class=
"md-nav__item">
1723 <a href=
"../../../../package/pip/style/" class=
"md-nav__link">
1734 <li class=
"md-nav__item">
1735 <a href=
"../../../../package/pip/template/" class=
"md-nav__link">
1746 <li class=
"md-nav__item">
1747 <a href=
"../../../../package/pip/template-listener/" class=
"md-nav__link">
1758 <li class=
"md-nav__item">
1759 <a href=
"../../../../package/pip/user-group-option/" class=
"md-nav__link">
1770 <li class=
"md-nav__item">
1771 <a href=
"../../../../package/pip/user-menu/" class=
"md-nav__link">
1782 <li class=
"md-nav__item">
1783 <a href=
"../../../../package/pip/user-notification-event/" class=
"md-nav__link">
1784 userNotificationEvent
1794 <li class=
"md-nav__item">
1795 <a href=
"../../../../package/pip/user-option/" class=
"md-nav__link">
1806 <li class=
"md-nav__item">
1807 <a href=
"../../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1824 <li class=
"md-nav__item">
1825 <a href=
"../../../../package/database-php-api/" class=
"md-nav__link">
1846 <li class=
"md-nav__item md-nav__item--nested">
1849 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1851 <label class=
"md-nav__link" for=
"__nav_6">
1853 <span class=
"md-nav__icon md-icon"></span>
1855 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1856 <label class=
"md-nav__title" for=
"__nav_6">
1857 <span class=
"md-nav__icon md-icon"></span>
1860 <ul class=
"md-nav__list" data-md-scrollfix
>
1867 <li class=
"md-nav__item md-nav__item--nested">
1870 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1872 <label class=
"md-nav__link" for=
"__nav_6_1">
1873 Migrating from WSC
5.3
1874 <span class=
"md-nav__icon md-icon"></span>
1876 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1877 <label class=
"md-nav__title" for=
"__nav_6_1">
1878 <span class=
"md-nav__icon md-icon"></span>
1879 Migrating from WSC
5.3
1881 <ul class=
"md-nav__list" data-md-scrollfix
>
1887 <li class=
"md-nav__item">
1888 <a href=
"../../../../migration/wsc53/php/" class=
"md-nav__link">
1899 <li class=
"md-nav__item">
1900 <a href=
"../../../../migration/wsc53/session/" class=
"md-nav__link">
1901 Session Handling and Authentication
1911 <li class=
"md-nav__item">
1912 <a href=
"../../../../migration/wsc53/javascript/" class=
"md-nav__link">
1913 TypeScript and JavaScript
1923 <li class=
"md-nav__item">
1924 <a href=
"../../../../migration/wsc53/templates/" class=
"md-nav__link">
1935 <li class=
"md-nav__item">
1936 <a href=
"../../../../migration/wsc53/libraries/" class=
"md-nav__link">
1937 Third Party Libraries
1954 <li class=
"md-nav__item md-nav__item--nested">
1957 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1959 <label class=
"md-nav__link" for=
"__nav_6_2">
1960 Migrating from WSC
5.2
1961 <span class=
"md-nav__icon md-icon"></span>
1963 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1964 <label class=
"md-nav__title" for=
"__nav_6_2">
1965 <span class=
"md-nav__icon md-icon"></span>
1966 Migrating from WSC
5.2
1968 <ul class=
"md-nav__list" data-md-scrollfix
>
1974 <li class=
"md-nav__item">
1975 <a href=
"../../../../migration/wsc52/php/" class=
"md-nav__link">
1986 <li class=
"md-nav__item">
1987 <a href=
"../../../../migration/wsc52/templates/" class=
"md-nav__link">
1988 Templates and Languages
1998 <li class=
"md-nav__item">
1999 <a href=
"../../../../migration/wsc52/libraries/" class=
"md-nav__link">
2000 Third Party Libraries
2017 <li class=
"md-nav__item md-nav__item--nested">
2020 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
2022 <label class=
"md-nav__link" for=
"__nav_6_3">
2023 Migrating from WSC
3.1
2024 <span class=
"md-nav__icon md-icon"></span>
2026 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
2027 <label class=
"md-nav__title" for=
"__nav_6_3">
2028 <span class=
"md-nav__icon md-icon"></span>
2029 Migrating from WSC
3.1
2031 <ul class=
"md-nav__list" data-md-scrollfix
>
2037 <li class=
"md-nav__item">
2038 <a href=
"../../../../migration/wsc31/php/" class=
"md-nav__link">
2056 <li class=
"md-nav__item md-nav__item--nested">
2059 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
2061 <label class=
"md-nav__link" for=
"__nav_6_4">
2062 Migrating from WSC
3.0
2063 <span class=
"md-nav__icon md-icon"></span>
2065 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
2066 <label class=
"md-nav__title" for=
"__nav_6_4">
2067 <span class=
"md-nav__icon md-icon"></span>
2068 Migrating from WSC
3.0
2070 <ul class=
"md-nav__list" data-md-scrollfix
>
2076 <li class=
"md-nav__item">
2077 <a href=
"../../../../migration/wsc30/php/" class=
"md-nav__link">
2088 <li class=
"md-nav__item">
2089 <a href=
"../../../../migration/wsc30/javascript/" class=
"md-nav__link">
2100 <li class=
"md-nav__item">
2101 <a href=
"../../../../migration/wsc30/templates/" class=
"md-nav__link">
2112 <li class=
"md-nav__item">
2113 <a href=
"../../../../migration/wsc30/css/" class=
"md-nav__link">
2124 <li class=
"md-nav__item">
2125 <a href=
"../../../../migration/wsc30/package/" class=
"md-nav__link">
2143 <li class=
"md-nav__item md-nav__item--nested">
2146 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
2148 <label class=
"md-nav__link" for=
"__nav_6_5">
2149 Migrating from WCF
2.1
2150 <span class=
"md-nav__icon md-icon"></span>
2152 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
2153 <label class=
"md-nav__title" for=
"__nav_6_5">
2154 <span class=
"md-nav__icon md-icon"></span>
2155 Migrating from WCF
2.1
2157 <ul class=
"md-nav__list" data-md-scrollfix
>
2163 <li class=
"md-nav__item">
2164 <a href=
"../../../../migration/wcf21/php/" class=
"md-nav__link">
2175 <li class=
"md-nav__item">
2176 <a href=
"../../../../migration/wcf21/templates/" class=
"md-nav__link">
2187 <li class=
"md-nav__item">
2188 <a href=
"../../../../migration/wcf21/css/" class=
"md-nav__link">
2199 <li class=
"md-nav__item">
2200 <a href=
"../../../../migration/wcf21/package/" class=
"md-nav__link">
2227 <li class=
"md-nav__item md-nav__item--nested">
2230 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2232 <label class=
"md-nav__link" for=
"__nav_7">
2234 <span class=
"md-nav__icon md-icon"></span>
2236 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
2237 <label class=
"md-nav__title" for=
"__nav_7">
2238 <span class=
"md-nav__icon md-icon"></span>
2241 <ul class=
"md-nav__list" data-md-scrollfix
>
2248 <li class=
"md-nav__item md-nav__item--nested">
2251 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2253 <label class=
"md-nav__link" for=
"__nav_7_1">
2255 <span class=
"md-nav__icon md-icon"></span>
2257 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
2258 <label class=
"md-nav__title" for=
"__nav_7_1">
2259 <span class=
"md-nav__icon md-icon"></span>
2262 <ul class=
"md-nav__list" data-md-scrollfix
>
2268 <li class=
"md-nav__item">
2269 <a href=
"../../../../tutorial/series/overview/" class=
"md-nav__link">
2280 <li class=
"md-nav__item">
2281 <a href=
"../../../../tutorial/series/part_1/" class=
"md-nav__link">
2292 <li class=
"md-nav__item">
2293 <a href=
"../../../../tutorial/series/part_2/" class=
"md-nav__link">
2304 <li class=
"md-nav__item">
2305 <a href=
"../../../../tutorial/series/part_3/" class=
"md-nav__link">
2332 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2333 <div class=
"md-sidebar__scrollwrap">
2334 <div class=
"md-sidebar__inner">
2336 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2342 <label class=
"md-nav__title" for=
"__toc">
2343 <span class=
"md-nav__icon md-icon"></span>
2346 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2348 <li class=
"md-nav__item">
2349 <a href=
"#abstract-form-fields" class=
"md-nav__link">
2350 Abstract Form Fields
2353 <nav class=
"md-nav" aria-label=
"Abstract Form Fields">
2354 <ul class=
"md-nav__list">
2356 <li class=
"md-nav__item">
2357 <a href=
"#abstractformfield" class=
"md-nav__link">
2363 <li class=
"md-nav__item">
2364 <a href=
"#abstractnumericformfield" class=
"md-nav__link">
2365 AbstractNumericFormField
2375 <li class=
"md-nav__item">
2376 <a href=
"#general-form-fields" class=
"md-nav__link">
2380 <nav class=
"md-nav" aria-label=
"General Form Fields">
2381 <ul class=
"md-nav__list">
2383 <li class=
"md-nav__item">
2384 <a href=
"#booleanformfield" class=
"md-nav__link">
2390 <li class=
"md-nav__item">
2391 <a href=
"#checkboxformfield" class=
"md-nav__link">
2397 <li class=
"md-nav__item">
2398 <a href=
"#classnameformfield" class=
"md-nav__link">
2404 <li class=
"md-nav__item">
2405 <a href=
"#dateformfield" class=
"md-nav__link">
2411 <li class=
"md-nav__item">
2412 <a href=
"#descriptionformfield" class=
"md-nav__link">
2413 DescriptionFormField
2418 <li class=
"md-nav__item">
2419 <a href=
"#emailformfield" class=
"md-nav__link">
2425 <li class=
"md-nav__item">
2426 <a href=
"#floatformfield" class=
"md-nav__link">
2432 <li class=
"md-nav__item">
2433 <a href=
"#iconformfield" class=
"md-nav__link">
2439 <li class=
"md-nav__item">
2440 <a href=
"#integerformfield" class=
"md-nav__link">
2446 <li class=
"md-nav__item">
2447 <a href=
"#isdisabledformfield" class=
"md-nav__link">
2453 <li class=
"md-nav__item">
2454 <a href=
"#itemlistformfield" class=
"md-nav__link">
2460 <li class=
"md-nav__item">
2461 <a href=
"#multilinetextformfield" class=
"md-nav__link">
2462 MultilineTextFormField
2467 <li class=
"md-nav__item">
2468 <a href=
"#multipleselectionformfield" class=
"md-nav__link">
2469 MultipleSelectionFormField
2474 <li class=
"md-nav__item">
2475 <a href=
"#radiobuttonformfield" class=
"md-nav__link">
2476 RadioButtonFormField
2481 <li class=
"md-nav__item">
2482 <a href=
"#ratingformfield" class=
"md-nav__link">
2488 <li class=
"md-nav__item">
2489 <a href=
"#showorderformfield" class=
"md-nav__link">
2495 <li class=
"md-nav__item">
2496 <a href=
"#singleselectionformfield" class=
"md-nav__link">
2497 SingleSelectionFormField
2502 <li class=
"md-nav__item">
2503 <a href=
"#sortorderformfield" class=
"md-nav__link">
2509 <li class=
"md-nav__item">
2510 <a href=
"#textformfield" class=
"md-nav__link">
2516 <li class=
"md-nav__item">
2517 <a href=
"#titleformfield" class=
"md-nav__link">
2523 <li class=
"md-nav__item">
2524 <a href=
"#urlformfield" class=
"md-nav__link">
2535 <li class=
"md-nav__item">
2536 <a href=
"#specific-fields" class=
"md-nav__link">
2540 <nav class=
"md-nav" aria-label=
"Specific Fields">
2541 <ul class=
"md-nav__list">
2543 <li class=
"md-nav__item">
2544 <a href=
"#aclformfield" class=
"md-nav__link">
2550 <li class=
"md-nav__item">
2551 <a href=
"#buttonformfield" class=
"md-nav__link">
2557 <li class=
"md-nav__item">
2558 <a href=
"#captchaformfield" class=
"md-nav__link">
2564 <li class=
"md-nav__item">
2565 <a href=
"#contentlanguageformfield" class=
"md-nav__link">
2566 ContentLanguageFormField
2571 <li class=
"md-nav__item">
2572 <a href=
"#labelformfield" class=
"md-nav__link">
2578 <li class=
"md-nav__item">
2579 <a href=
"#optionformfield" class=
"md-nav__link">
2585 <li class=
"md-nav__item">
2586 <a href=
"#simpleaclformfield" class=
"md-nav__link">
2592 <li class=
"md-nav__item">
2593 <a href=
"#singlemediaselectionformfield" class=
"md-nav__link">
2594 SingleMediaSelectionFormField
2599 <li class=
"md-nav__item">
2600 <a href=
"#tagformfield" class=
"md-nav__link">
2606 <li class=
"md-nav__item">
2607 <a href=
"#uploadformfield" class=
"md-nav__link">
2611 <nav class=
"md-nav" aria-label=
"UploadFormField">
2612 <ul class=
"md-nav__list">
2614 <li class=
"md-nav__item">
2615 <a href=
"#provide-value-from-database-object" class=
"md-nav__link">
2616 Provide value from database object
2621 <li class=
"md-nav__item">
2622 <a href=
"#process-files" class=
"md-nav__link">
2633 <li class=
"md-nav__item">
2634 <a href=
"#userformfield" class=
"md-nav__link">
2640 <li class=
"md-nav__item">
2641 <a href=
"#userpasswordfield" class=
"md-nav__link">
2647 <li class=
"md-nav__item">
2648 <a href=
"#usergroupoptionformfield" class=
"md-nav__link">
2649 UserGroupOptionFormField
2654 <li class=
"md-nav__item">
2655 <a href=
"#usernameformfield" class=
"md-nav__link">
2666 <li class=
"md-nav__item">
2667 <a href=
"#wysiwyg-form-container" class=
"md-nav__link">
2668 Wysiwyg form container
2671 <nav class=
"md-nav" aria-label=
"Wysiwyg form container">
2672 <ul class=
"md-nav__list">
2674 <li class=
"md-nav__item">
2675 <a href=
"#wysiwygattachmentformfield" class=
"md-nav__link">
2676 WysiwygAttachmentFormField
2681 <li class=
"md-nav__item">
2682 <a href=
"#wysiwygpollformcontainer" class=
"md-nav__link">
2683 WysiwygPollFormContainer
2688 <li class=
"md-nav__item">
2689 <a href=
"#wysiwygsmileyformcontainer" class=
"md-nav__link">
2690 WysiwygSmileyFormContainer
2693 <nav class=
"md-nav" aria-label=
"WysiwygSmileyFormContainer">
2694 <ul class=
"md-nav__list">
2696 <li class=
"md-nav__item">
2697 <a href=
"#wysiwygsmileyformnode" class=
"md-nav__link">
2698 WysiwygSmileyFormNode
2708 <li class=
"md-nav__item">
2709 <a href=
"#example" class=
"md-nav__link">
2715 <li class=
"md-nav__item">
2716 <a href=
"#wysiwygformfield" class=
"md-nav__link">
2722 <li class=
"md-nav__item">
2723 <a href=
"#twysiwygformnode" class=
"md-nav__link">
2734 <li class=
"md-nav__item">
2735 <a href=
"#single-use-form-fields" class=
"md-nav__link">
2736 Single-Use Form Fields
2739 <nav class=
"md-nav" aria-label=
"Single-Use Form Fields">
2740 <ul class=
"md-nav__list">
2742 <li class=
"md-nav__item">
2743 <a href=
"#bbcodeattributesformfield" class=
"md-nav__link">
2744 BBCodeAttributesFormField
2749 <li class=
"md-nav__item">
2750 <a href=
"#devtoolsprojectexcludedpackagesformfield" class=
"md-nav__link">
2751 DevtoolsProjectExcludedPackagesFormField
2756 <li class=
"md-nav__item">
2757 <a href=
"#devtoolsprojectinstructionsformfield" class=
"md-nav__link">
2758 DevtoolsProjectInstructionsFormField
2763 <li class=
"md-nav__item">
2764 <a href=
"#devtoolsprojectoptionalpackagesformfield" class=
"md-nav__link">
2765 DevtoolsProjectOptionalPackagesFormField
2770 <li class=
"md-nav__item">
2771 <a href=
"#devtoolsprojectrequiredpackagesformfield" class=
"md-nav__link">
2772 DevtoolsProjectRequiredPackagesFormField
2790 <div class=
"md-content" data-md-component=
"content">
2791 <article class=
"md-content__inner md-typeset">
2794 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/form_builder/form_fields.md" title=
"Edit this page" class=
"md-content__button md-icon">
2795 <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>
2799 <h1 id=
"form-builder-fields">Form Builder Fields
<a class=
"headerlink" href=
"#form-builder-fields" title=
"Permanent link">#
</a></h1>
2800 <h2 id=
"abstract-form-fields">Abstract Form Fields
<a class=
"headerlink" href=
"#abstract-form-fields" title=
"Permanent link">#
</a></h2>
2801 <p>The following form field classes cannot be instantiated directly because they are abstract, but they can/must be used when creating own form field classes.
</p>
2802 <h3 id=
"abstractformfield"><code>AbstractFormField
</code><a class=
"headerlink" href=
"#abstractformfield" title=
"Permanent link">#
</a></h3>
2803 <p><code>AbstractFormField
</code> is the abstract default implementation of the
<code>IFormField
</code> interface and it is expected that every implementation of
<code>IFormField
</code> implements the interface by extending this class.
</p>
2804 <h3 id=
"abstractnumericformfield"><code>AbstractNumericFormField
</code><a class=
"headerlink" href=
"#abstractnumericformfield" title=
"Permanent link">#
</a></h3>
2805 <p><code>AbstractNumericFormField
</code> is the abstract implementation of a form field handling a single numeric value.
2806 The class implements
<code>IAttributeFormField
</code>,
<code>IAutoCompleteFormField
</code>,
<code>ICssClassFormField
</code>,
<code>IImmutableFormField
</code>,
<code>IInputModeFormField
</code>,
<code>IMaximumFormField
</code>,
<code>IMinimumFormField
</code>,
<code>INullableFormField
</code>,
<code>IPlaceholderFormField
</code> and
<code>ISuffixedFormField
</code>.
2807 If the property
<code>$integerValues
</code> is
<code>true
</code>, the form field works with integer values, otherwise it works with floating point numbers.
2808 The methods
<code>step($step = null)
</code> and
<code>getStep()
</code> can be used to set and get the step attribute of the
<code>input
</code> element.
2809 The default step for form fields with integer values is
<code>1</code>.
2810 Otherwise, the default step is
<code>any
</code>.
</p>
2811 <h2 id=
"general-form-fields">General Form Fields
<a class=
"headerlink" href=
"#general-form-fields" title=
"Permanent link">#
</a></h2>
2812 <p>The following form fields are general reusable fields without any underlying context.
</p>
2813 <h3 id=
"booleanformfield"><code>BooleanFormField
</code><a class=
"headerlink" href=
"#booleanformfield" title=
"Permanent link">#
</a></h3>
2814 <p><code>BooleanFormField
</code> is used for boolean (
<code>0</code> or
<code>1</code>,
<code>yes
</code> or
<code>no
</code>) values.
2815 Objects of this class require a label.
2816 The return value of
<code>getSaveValue()
</code> is the integer representation of the boolean value, i.e.
<code>0</code> or
<code>1</code>.
2817 The class implements
<code>IAttributeFormField
</code>,
<code>IAutoFocusFormField
</code>,
<code>ICssClassFormField
</code>, and
<code>IImmutableFormField
</code>.
</p>
2818 <h3 id=
"checkboxformfield"><code>CheckboxFormField
</code><a class=
"headerlink" href=
"#checkboxformfield" title=
"Permanent link">#
</a></h3>
2819 <div class=
"admonition info">
2820 <p class=
"admonition-title">Only available since version
5.3.2.
</p>
2822 <p><code>CheckboxFormField
</code> extends
<code>BooleanFormField
</code> and offers a simple HTML checkbox.
</p>
2823 <h3 id=
"classnameformfield"><code>ClassNameFormField
</code><a class=
"headerlink" href=
"#classnameformfield" title=
"Permanent link">#
</a></h3>
2824 <p><code>ClassNameFormField
</code> is a
<a href=
"#textformfield">text form field
</a> that supports additional settings, specific to entering a PHP class name:
</p>
2826 <li><code>classExists($classExists = true)
</code> and
<code>getClassExists()
</code> can be used to ensure that the entered class currently exists in the installation.
2827 By default, the existance of the entered class is required.
</li>
2828 <li><code>implementedInterface($interface)
</code> and
<code>getImplementedInterface()
</code> can be used to ensure that the entered class implements the specified interface.
2829 By default, no interface is required.
</li>
2830 <li><code>parentClass($parentClass)
</code> and
<code>getParentClass()
</code> can be used to ensure that the entered class extends the specified class.
2831 By default, no parent class is required.
</li>
2832 <li><code>instantiable($instantiable = true)
</code> and
<code>isInstantiable()
</code> can be used to ensure that the entered class is instantiable.
2833 By default, entered classes have to instantiable.
</li>
2835 <p>Additionally, the default id of a
<code>ClassNameFormField
</code> object is
<code>className
</code>, the default label is
<code>wcf.form.field.className
</code>, and if either an interface or a parent class is required, a default description is set if no description has already been set (
<code>wcf.form.field.className.description.interface
</code> and
<code>wcf.form.field.className.description.parentClass
</code>, respectively).
</p>
2836 <h3 id=
"dateformfield"><code>DateFormField
</code><a class=
"headerlink" href=
"#dateformfield" title=
"Permanent link">#
</a></h3>
2837 <p><code>DateFormField
</code> is a form field to enter a date (and optionally a time).
2838 The class implements
<code>IAttributeFormField
</code>,
<code>IAutoFocusFormField
</code>,
<code>ICssClassFormField
</code>,
<code>IImmutableFormField
</code>, and
<code>INullableFormField
</code>.
2839 The following methods are specific to this form field class:
</p>
2841 <li><code>earliestDate($earliestDate)
</code> and
<code>getEarliestDate()
</code> can be used to get and set the earliest selectable/valid date and
<code>latestDate($latestDate)
</code> and
<code>getLatestDate()
</code> can be used to get and set the latest selectable/valid date.
2842 The date passed to the setters must have the same format as set via
<code>saveValueFormat()
</code>.
2843 If a custom format is used, that format has to be set via
<code>saveValueFormat()
</code> before calling any of the setters.
</li>
2844 <li><code>saveValueFormat($saveValueFormat)
</code> and
<code>getSaveValueFormat()
</code> can be used to specify the date format of the value returned by
<code>getSaveValue()
</code>.
2845 By default,
<code>U
</code> is used as format.
2846 The
<a href=
"https://secure.php.net/manual/en/function.date.php">PHP manual
</a> provides an overview of supported formats.
</li>
2847 <li><code>supportTime($supportsTime = true)
</code> and
<code>supportsTime()
</code> can be used to toggle whether, in addition to a date, a time can also be specified.
2848 By default, specifying a time is disabled.
</li>
2850 <h3 id=
"descriptionformfield"><code>DescriptionFormField
</code><a class=
"headerlink" href=
"#descriptionformfield" title=
"Permanent link">#
</a></h3>
2851 <p><code>DescriptionFormField
</code> is a
<a href=
"#multilinetextformfield">multi-line text form field
</a> with
<code>description
</code> as the default id and
<code>wcf.global.description
</code> as the default label.
</p>
2852 <h3 id=
"emailformfield"><code>EmailFormField
</code><a class=
"headerlink" href=
"#emailformfield" title=
"Permanent link">#
</a></h3>
2853 <p><code>EmailFormField
</code> is a form field to enter an email address which is internally validated using
<code>UserUtil::isValidEmail()
</code>.
2854 The class implements
<code>IAttributeFormField
</code>,
<code>IAutoCompleteFormField
</code>,
<code>IAutoFocusFormField
</code>,
<code>ICssClassFormField
</code>,
<code>II18nFormField
</code>,
<code>IImmutableFormField
</code>,
<code>IInputModeFormField
</code>,
<code>IPatternFormField
</code>, and
<code>IPlaceholderFormField
</code>.
</p>
2855 <h3 id=
"floatformfield"><code>FloatFormField
</code><a class=
"headerlink" href=
"#floatformfield" title=
"Permanent link">#
</a></h3>
2856 <p><code>FloatFormField
</code> is an implementation of
<a href=
"#abstractnumericformfield">AbstractNumericFormField
</a> for floating point numbers.
</p>
2857 <h3 id=
"iconformfield"><code>IconFormField
</code><a class=
"headerlink" href=
"#iconformfield" title=
"Permanent link">#
</a></h3>
2858 <p><code>IconFormField
</code> is a form field to select a FontAwesome icon.
</p>
2859 <h3 id=
"integerformfield"><code>IntegerFormField
</code><a class=
"headerlink" href=
"#integerformfield" title=
"Permanent link">#
</a></h3>
2860 <p><code>IntegerFormField
</code> is an implementation of
<a href=
"#abstractnumericformfield">AbstractNumericFormField
</a> for integers.
</p>
2861 <h3 id=
"isdisabledformfield"><code>IsDisabledFormField
</code><a class=
"headerlink" href=
"#isdisabledformfield" title=
"Permanent link">#
</a></h3>
2862 <p><code>IsDisabledFormField
</code> is a
<a href=
"#booleanformfield">boolean form field
</a> with
<code>isDisabled
</code> as the default id.
</p>
2863 <h3 id=
"itemlistformfield"><code>ItemListFormField
</code><a class=
"headerlink" href=
"#itemlistformfield" title=
"Permanent link">#
</a></h3>
2864 <p><code>ItemListFormField
</code> is a form field in which multiple values can be entered and returned in different formats as save value.
2865 The class implements
<code>IAttributeFormField
</code>,
<code>IAutoFocusFormField
</code>,
<code>ICssClassFormField
</code>,
<code>IImmutableFormField
</code>, and
<code>IMultipleFormField
</code>.
2866 The
<code>saveValueType($saveValueType)
</code> and
<code>getSaveValueType()
</code> methods are specific to this form field class and determine the format of the save value.
2867 The following save value types are supported:
</p>
2869 <li><code>ItemListFormField::SAVE_VALUE_TYPE_ARRAY
</code> adds a custom data processor that writes the form field data directly in the parameters array and not in the data sub-array of the parameters array.
</li>
2870 <li><code>ItemListFormField::SAVE_VALUE_TYPE_CSV
</code> lets the value be returned as a string in which the values are concatenated by commas.
</li>
2871 <li><code>ItemListFormField::SAVE_VALUE_TYPE_NSV
</code> lets the value be returned as a string in which the values are concatenated by
<code>\n
</code>.
</li>
2872 <li><code>ItemListFormField::SAVE_VALUE_TYPE_SSV
</code> lets the value be returned as a string in which the values are concatenated by spaces.
</li>
2874 <p>By default,
<code>ItemListFormField::SAVE_VALUE_TYPE_CSV
</code> is used.
</p>
2875 <p>If
<code>ItemListFormField::SAVE_VALUE_TYPE_ARRAY
</code> is used as save value type,
<code>ItemListFormField
</code> objects register a
<a href=
"../validation_data/#customformfielddataprocessor">custom form field data processor
</a> to add the relevant array into the
<code>$parameters
</code> array directly using the object property as the array key.
</p>
2876 <h3 id=
"multilinetextformfield"><code>MultilineTextFormField
</code><a class=
"headerlink" href=
"#multilinetextformfield" title=
"Permanent link">#
</a></h3>
2877 <p><code>MultilineTextFormField
</code> is a
<a href=
"#textformfield">text form field
</a> that supports multiple rows of text.
2878 The methods
<code>rows($rows)
</code> and
<code>getRows()
</code> can be used to set and get the number of rows of the
<code>textarea
</code> elements.
2879 The default number of rows is
<code>10</code>.
2880 These methods do
<strong>not
</strong>, however, restrict the number of text rows that canbe entered.
</p>
2881 <h3 id=
"multipleselectionformfield"><code>MultipleSelectionFormField
</code><a class=
"headerlink" href=
"#multipleselectionformfield" title=
"Permanent link">#
</a></h3>
2882 <p><code>MultipleSelectionFormField
</code> is a form fields that allows the selection of multiple options out of a predefined list of available options.
2883 The class implements
<code>IAttributeFormField
</code>,
<code>ICssClassFormField
</code>,
<code>IFilterableSelectionFormField
</code>,
<code>IImmutableFormField
</code>, and
<code>INullableFormField
</code>.
2884 If the field is nullable and no option is selected,
<code>null
</code> is returned as the save value.
</p>
2885 <h3 id=
"radiobuttonformfield"><code>RadioButtonFormField
</code><a class=
"headerlink" href=
"#radiobuttonformfield" title=
"Permanent link">#
</a></h3>
2886 <p><code>RadioButtonFormField
</code> is a form fields that allows the selection of a single option out of a predefined list of available options using radiobuttons.
2887 The class implements
<code>IAttributeFormField
</code>,
<code>ICssClassFormField
</code>,
<code>IImmutableFormField
</code>, and
<code>ISelectionFormField
</code>.
</p>
2888 <h3 id=
"ratingformfield"><code>RatingFormField
</code><a class=
"headerlink" href=
"#ratingformfield" title=
"Permanent link">#
</a></h3>
2889 <p><code>RatingFormField
</code> is a form field to set a rating for an object.
2890 The class implements
<code>IImmutableFormField
</code>,
<code>IMaximumFormField
</code>,
<code>IMinimumFormField
</code>, and
<code>INullableFormField
</code>.
2891 Form fields of this class have
<code>rating
</code> as their default id,
<code>wcf.form.field.rating
</code> as their default label,
<code>1</code> as their default minimum, and
<code>5</code> as their default maximum.
2892 For this field, the minimum and maximum refer to the minimum and maximum rating an object can get.
2893 When the field is shown, there will be
<code>maximum() - minimum() +
1</code> icons be shown with additional CSS classes that can be set and gotten via
<code>defaultCssClasses(array $cssClasses)
</code> and
<code>getDefaultCssClasses()
</code>.
2894 If a rating values is set, the first
<code>getValue()
</code> icons will instead use the classes that can be set and gotten via
<code>activeCssClasses(array $cssClasses)
</code> and
<code>getActiveCssClasses()
</code>.
2895 By default, the only default class is
<code>fa-star-o
</code> and the active classes are
<code>fa-star
</code> and
<code>orange
</code>.
</p>
2896 <h3 id=
"showorderformfield"><code>ShowOrderFormField
</code><a class=
"headerlink" href=
"#showorderformfield" title=
"Permanent link">#
</a></h3>
2897 <p><code>ShowOrderFormField
</code> is a
<a href=
"#singleselectionformfield">single selection form field
</a> for which the selected value determines the position at which an object is shown.
2898 The show order field provides a list of all siblings and the object will be positioned
<strong>after
</strong> the selected sibling.
2899 To insert objects at the very beginning, the
<code>options()
</code> automatically method prepends an additional option for that case so that only the existing siblings need to be passed.
2900 The default id of instances of this class is
<code>showOrder
</code> and their default label is
<code>wcf.form.field.showOrder
</code>.
</p>
2901 <div class=
"admonition info">
2902 <p class=
"admonition-title">It is important that the relevant object property is always kept updated. Whenever a new object is added or an existing object is edited or delete, the values of the other objects have to be adjusted to ensure consecutive numbering.
</p>
2904 <h3 id=
"singleselectionformfield"><code>SingleSelectionFormField
</code><a class=
"headerlink" href=
"#singleselectionformfield" title=
"Permanent link">#
</a></h3>
2905 <p><code>SingleSelectionFormField
</code> is a form fields that allows the selection of a single option out of a predefined list of available options.
2906 The class implements
<code>ICssClassFormField
</code>,
<code>IFilterableSelectionFormField
</code>,
<code>IImmutableFormField
</code>, and
<code>INullableFormField
</code>.
2907 If the field is nullable and the current form field value is considered
<code>empty
</code> by PHP,
<code>null
</code> is returned as the save value.
</p>
2908 <h3 id=
"sortorderformfield"><code>SortOrderFormField
</code><a class=
"headerlink" href=
"#sortorderformfield" title=
"Permanent link">#
</a></h3>
2909 <p><code>SingleSelectionFormField
</code> is a
<a href=
"#singleselectionformfield">single selection form field
</a> with default id
<code>sortOrder
</code>, default label
<code>wcf.global.showOrder
</code> and default options
<code>ASC: wcf.global.sortOrder.ascending
</code> and
<code>DESC: wcf.global.sortOrder.descending
</code>.
</p>
2910 <h3 id=
"textformfield"><code>TextFormField
</code><a class=
"headerlink" href=
"#textformfield" title=
"Permanent link">#
</a></h3>
2911 <p><code>TextFormField
</code> is a form field that allows entering a single line of text.
2912 The class implements
<code>IAttributeFormField
</code>,
<code>IAutoCompleteFormField
</code>,
<code>ICssClassFormField
</code>,
<code>IImmutableFormField
</code>,
<code>II18nFormField
</code>,
<code>IInputModeFormField
</code>,
<code>IMaximumLengthFormField
</code>,
<code>IMinimumLengthFormField
</code>,
<code>IPatternFormField
</code>, and
<code>IPlaceholderFormField
</code>.
</p>
2913 <h3 id=
"titleformfield"><code>TitleFormField
</code><a class=
"headerlink" href=
"#titleformfield" title=
"Permanent link">#
</a></h3>
2914 <p><code>TitleFormField
</code> is a
<a href=
"#textformfield">text form field
</a> with
<code>title
</code> as the default id and
<code>wcf.global.title
</code> as the default label.
</p>
2915 <h3 id=
"urlformfield"><code>UrlFormField
</code><a class=
"headerlink" href=
"#urlformfield" title=
"Permanent link">#
</a></h3>
2916 <p><code>UrlFormField
</code> is a
<a href=
"#textformfield">text form field
</a> whose values are checked via
<code>Url::is()
</code>.
</p>
2917 <h2 id=
"specific-fields">Specific Fields
<a class=
"headerlink" href=
"#specific-fields" title=
"Permanent link">#
</a></h2>
2918 <p>The following form fields are reusable fields that generally are bound to a certain API or
<code>DatabaseObject
</code> implementation.
</p>
2919 <h3 id=
"aclformfield"><code>AclFormField
</code><a class=
"headerlink" href=
"#aclformfield" title=
"Permanent link">#
</a></h3>
2920 <p><code>AclFormField
</code> is used for setting up acl values for specific objects.
2921 The class implements
<code>IObjectTypeFormField
</code> and requires an object type of the object type definition
<code>com.woltlab.wcf.acl
</code>.
2922 Additionally, the class provides the methods
<code>categoryName($categoryName)
</code> and
<code>getCategoryName()
</code> that allow setting a specific name or filter for the acl option categories whose acl options are shown.
2923 A category name of
<code>null
</code> signals that no category filter is used.
</p>
2924 <p><code>AclFormField
</code> objects register a
<a href=
"../validation_data/#customformfielddataprocessor">custom form field data processor
</a> to add the relevant ACL object type id into the
<code>$parameters
</code> array directly using
<code>{$objectProperty}_aclObjectTypeID
</code> as the array key.
2925 The relevant database object action method is expected, based on the given ACL object type id, to save the ACL option values appropriately.
</p>
2926 <h3 id=
"buttonformfield"><code>ButtonFormField
</code><a class=
"headerlink" href=
"#buttonformfield" title=
"Permanent link">#
</a></h3>
2927 <div class=
"admonition info">
2928 <p class=
"admonition-title">Only available since version
5.4.
</p>
2930 <p><code>ButtonFormField
</code> shows a submit button as part of the form.
2931 The class implements
<code>IAttributeFormField
</code> and
<code>ICssClassFormField
</code>.
</p>
2932 <p>Specifically for this form field, there is the
<code>IsNotClickedFormFieldDependency
</code> dependency with which certain parts of the form will only be processed if the relevent button has not clicked.
</p>
2933 <h3 id=
"captchaformfield"><code>CaptchaFormField
</code><a class=
"headerlink" href=
"#captchaformfield" title=
"Permanent link">#
</a></h3>
2934 <p><code>CaptchaFormField
</code> is used to add captcha protection to the form.
</p>
2935 <p>You must specify a captcha object type (
<code>com.woltlab.wcf.captcha
</code>) using the
<code>objectType()
</code> method.
</p>
2936 <h3 id=
"contentlanguageformfield"><code>ContentLanguageFormField
</code><a class=
"headerlink" href=
"#contentlanguageformfield" title=
"Permanent link">#
</a></h3>
2937 <p><code>ContentLanguageFormField
</code> is used to select the content language of an object.
2938 Fields of this class are only available if multilingualism is enabled and if there are content languages.
2939 The class implements
<code>IImmutableFormField
</code>.
</p>
2940 <h3 id=
"labelformfield"><code>LabelFormField
</code><a class=
"headerlink" href=
"#labelformfield" title=
"Permanent link">#
</a></h3>
2941 <p><code>LabelFormField
</code> is used to select a label from a specific label group.
2942 The class implements
<code>IObjectTypeFormNode
</code>.
</p>
2943 <p>The
<code>labelGroup(ViewableLabelGroup $labelGroup)
</code> and
<code>getLabelGroup()
</code> methods are specific to this form field class and can be used to set and get the label group whose labels can be selected.
2944 Additionally, there is the static method
<code>createFields($objectType, array $labelGroups, $objectProperty = 'labelIDs)
</code> that can be used to create all relevant label form fields for a given list of label groups.
2945 In most cases,
<code>LabelFormField::createFields()
</code> should be used.
</p>
2946 <h3 id=
"optionformfield"><code>OptionFormField
</code><a class=
"headerlink" href=
"#optionformfield" title=
"Permanent link">#
</a></h3>
2947 <p><code>OptionFormField
</code> is an
<a href=
"#itemlistformfield">item list form field
</a> to set a list of options.
2948 The class implements
<code>IPackagesFormField
</code> and only options of the set packages are considered available.
2949 The default label of instances of this class is
<code>wcf.form.field.option
</code> and their default id is
<code>options
</code>.
</p>
2950 <h3 id=
"simpleaclformfield"><code>SimpleAclFormField
</code><a class=
"headerlink" href=
"#simpleaclformfield" title=
"Permanent link">#
</a></h3>
2951 <p><code>SimpleAclFormField
</code> is used for setting up simple acl values (one
<code>yes
</code>/
<code>no
</code> option per user and user group) for specific objects.
</p>
2952 <p><code>SimpleAclFormField
</code> objects register a
<a href=
"../validation_data/#customformfielddataprocessor">custom form field data processor
</a> to add the relevant simple ACL data array into the
<code>$parameters
</code> array directly using the object property as the array key.
</p>
2953 <h3 id=
"singlemediaselectionformfield"><code>SingleMediaSelectionFormField
</code><a class=
"headerlink" href=
"#singlemediaselectionformfield" title=
"Permanent link">#
</a></h3>
2954 <p><code>SingleMediaSelectionFormField
</code> is used to select a specific media file.
2955 The class implements
<code>IImmutableFormField
</code>.
</p>
2956 <p>The following methods are specific to this form field class:
</p>
2958 <li><code>imageOnly($imageOnly = true)
</code> and
<code>isImageOnly()
</code> can be used to set and check if only images may be selected.
</li>
2959 <li><code>getMedia()
</code> returns the media file based on the current field value if a field is set.
</li>
2961 <h3 id=
"tagformfield"><code>TagFormField
</code><a class=
"headerlink" href=
"#tagformfield" title=
"Permanent link">#
</a></h3>
2962 <p><code>TagFormField
</code> is a form field to enter tags.
2963 The class implements
<code>IAttributeFormField
</code> and
<code>IObjectTypeFormNode
</code>.
2964 Arrays passed to
<code>TagFormField::values()
</code> can contain tag names as strings and
<code>Tag
</code> objects.
2965 The default label of instances of this class is
<code>wcf.tagging.tags
</code> and their default description is
<code>wcf.tagging.tags.description
</code>.
</p>
2966 <p><code>TagFormField
</code> objects register a
<a href=
"../validation_data/#customformfielddataprocessor">custom form field data processor
</a> to add the array with entered tag names into the
<code>$parameters
</code> array directly using the object property as the array key.
</p>
2967 <h3 id=
"uploadformfield"><code>UploadFormField
</code><a class=
"headerlink" href=
"#uploadformfield" title=
"Permanent link">#
</a></h3>
2968 <p><code>UploadFormField
</code> is a form field that allows uploading files by the user.
</p>
2969 <p><code>UploadFormField
</code> objects register a
<a href=
"../validation_data/#customformfielddataprocessor">custom form field data processor
</a> to add the array of
<code>wcf\system\file\upload\UploadFile\UploadFile
</code> into the
<code>$parameters
</code> array directly using the object property as the array key. Also it registers the removed files as an array of
<code>wcf\system\file\upload\UploadFile\UploadFile
</code> into the
<code>$parameters
</code> array directly using the object property with the suffix
<code>_removedFiles
</code> as the array key.
</p>
2970 <p>The field supports additional settings:
2971 -
<code>imageOnly($imageOnly = true)
</code> and
<code>isImageOnly()
</code> can be used to ensure that the uploaded files are only images.
2972 -
<code>allowSvgImage($allowSvgImages = true)
</code> and
<code>svgImageAllowed()
</code> can be used to allow SVG images, if the image only mode is enabled (otherwise, the method will throw an exception). By default, SVG images are not allowed.
</p>
2973 <h4 id=
"provide-value-from-database-object">Provide value from database object
<a class=
"headerlink" href=
"#provide-value-from-database-object" title=
"Permanent link">#
</a></h4>
2974 <p>To provide values from a database object, you should implement the method
<code>get{$objectProperty}UploadFileLocations()
</code> to your database object class. This method must return an array of strings with the locations of the files.
</p>
2975 <h4 id=
"process-files">Process files
<a class=
"headerlink" href=
"#process-files" title=
"Permanent link">#
</a></h4>
2976 <p>To process files in the database object action class, you must
<a href=
"https://secure.php.net/manual/en/function.rename.php"><code>rename
</code></a> the file to the final destination. You get the temporary location, by calling the method
<code>getLocation()
</code> on the given
<code>UploadFile
</code> objects. After that, you call
<code>setProcessed($location)
</code> with
<code>$location
</code> contains the new file location. This method sets the
<code>isProcessed
</code> flag to true and saves the new location. For updating files, it is relevant, whether a given file is already processed or not. For this case, the
<code>UploadFile
</code> object has an method
<code>isProcessed()
</code> which indicates, whether a file is already processed or new uploaded.
</p>
2977 <h3 id=
"userformfield"><code>UserFormField
</code><a class=
"headerlink" href=
"#userformfield" title=
"Permanent link">#
</a></h3>
2978 <p><code>UserFormField
</code> is a form field to enter existing users.
2979 The class implements
<code>IAutoCompleteFormField
</code>,
<code>IAutoFocusFormField
</code>,
<code>IImmutableFormField
</code>,
<code>IMultipleFormField
</code>, and
<code>INullableFormField
</code>.
2980 While the user is presented the names of the specified users in the user interface, the field returns the ids of the users as data.
2981 The relevant
<code>UserProfile
</code> objects can be accessed via the
<code>getUsers()
</code> method.
</p>
2982 <h3 id=
"userpasswordfield"><code>UserPasswordField
</code><a class=
"headerlink" href=
"#userpasswordfield" title=
"Permanent link">#
</a></h3>
2983 <div class=
"admonition info">
2984 <p class=
"admonition-title">Only available since version
5.4.
</p>
2986 <p><code>UserPasswordField
</code> is a form field for users' to enter their current password.
2987 The class implements
<code>IAttributeFormField
</code>,
<code>IAttributeFormField
</code>,
<code>IAutoCompleteFormField
</code>,
<code>IAutoFocusFormField
</code>, and
<code>IPlaceholderFormField
</code></p>
2988 <h3 id=
"usergroupoptionformfield"><code>UserGroupOptionFormField
</code><a class=
"headerlink" href=
"#usergroupoptionformfield" title=
"Permanent link">#
</a></h3>
2989 <p><code>UserGroupOptionFormField
</code> is an
<a href=
"#itemlistformfield">item list form field
</a> to set a list of user group options/permissions.
2990 The class implements
<code>IPackagesFormField
</code> and only user group options of the set packages are considered available.
2991 The default label of instances of this class is
<code>wcf.form.field.userGroupOption
</code> and their default id is
<code>permissions
</code>.
</p>
2992 <h3 id=
"usernameformfield"><code>UsernameFormField
</code><a class=
"headerlink" href=
"#usernameformfield" title=
"Permanent link">#
</a></h3>
2993 <p><code>UsernameFormField
</code> is used for entering one non-existing username.
2994 The class implements
<code>IAttributeFormField
</code>,
<code>IImmutableFormField
</code>,
<code>IMaximumLengthFormField
</code>,
<code>IMinimumLengthFormField
</code>,
<code>INullableFormField
</code>, and
<code>IPlaceholderFormField
</code>.
2995 As usernames have a system-wide restriction of a minimum length of
3 and a maximum length of
100 characters, these values are also used as the default value for the field’s minimum and maximum length.
</p>
2996 <h2 id=
"wysiwyg-form-container">Wysiwyg form container
<a class=
"headerlink" href=
"#wysiwyg-form-container" title=
"Permanent link">#
</a></h2>
2997 <p>To integrate a wysiwyg editor into a form, you have to create a
<code>WysiwygFormContainer
</code> object.
2998 This container takes care of creating all necessary form nodes listed below for a wysiwyg editor.
</p>
2999 <div class=
"admonition warning">
3000 <p class=
"admonition-title">When creating the container object, its id has to be the id of the form field that will manage the actual text.
</p>
3002 <p>The following methods are specific to this form container class:
</p>
3004 <li><code>addSettingsNode(IFormChildNode $settingsNode)
</code> and
<code>addSettingsNodes(array $settingsNodes)
</code> can be used to add nodes to the settings tab container.
</li>
3005 <li><code>attachmentData($objectType, $parentObjectID)
</code> can be used to set the data relevant for attachment support.
3006 By default, not attachment data is set, thus attachments are not supported.
</li>
3007 <li><code>getAttachmentField()
</code>,
<code>getPollContainer()
</code>,
<code>getSettingsContainer()
</code>,
<code>getSmiliesContainer()
</code>, and
<code>getWysiwygField()
</code> can be used to get the different components of the wysiwyg form container once the form has been built.
</li>
3008 <li><code>enablePreviewButton($enablePreviewButton)
</code> can be used to set whether the preview button for the message is shown or not.
3009 By default, the preview button is shown.
3010 This method is only relevant before the form is built.
3011 Afterwards, the preview button availability can not be changed.
3012 Only available since WoltLab Suite Core
5.3.
</li>
3013 <li><code>getObjectId()
</code> returns the id of the edited object or
<code>0</code> if no object is edited.
</li>
3014 <li><code>getPreselect()
</code>,
<code>preselect($preselect)
</code> can be used to set the value of the wysiwyg tab menu's
<code>data-preselect
</code> attribute used to determine which tab is preselected.
3015 By default, the preselect is
<code>'true'
</code> which is used to pre-select the first tab.
</li>
3016 <li><code>messageObjectType($messageObjectType)
</code> can be used to set the message object type.
</li>
3017 <li><code>pollObjectType($pollObjectType)
</code> can be used to set the poll object type.
3018 By default, no poll object type is set, thus the poll form field container is not available.
</li>
3019 <li><code>supportMentions($supportMentions)
</code> can be used to set if mentions are supported.
3020 By default, mentions are not supported.
3021 This method is only relevant before the form is built.
3022 Afterwards, mention support can only be changed via the wysiwyg form field.
</li>
3023 <li><code>supportSmilies($supportSmilies)
</code> can be used to set if smilies are supported.
3024 By default, smilies are supported.
3025 This method is only relevant before the form is built.
3026 Afterwards, smiley availability can only be changed via changing the availability of the smilies form container.
</li>
3028 <h3 id=
"wysiwygattachmentformfield"><code>WysiwygAttachmentFormField
</code><a class=
"headerlink" href=
"#wysiwygattachmentformfield" title=
"Permanent link">#
</a></h3>
3029 <p><code>WysiwygAttachmentFormField
</code> provides attachment support for a wysiwyg editor via a tab in the menu below the editor.
3030 This class should not be used directly but only via
<code>WysiwygFormContainer
</code>.
3031 The methods
<code>attachmentHandler(AttachmentHandler $attachmentHandler)
</code> and
<code>getAttachmentHandler()
</code> can be used to set and get the
<code>AttachmentHandler
</code> object that is used for uploaded attachments.
</p>
3032 <h3 id=
"wysiwygpollformcontainer"><code>WysiwygPollFormContainer
</code><a class=
"headerlink" href=
"#wysiwygpollformcontainer" title=
"Permanent link">#
</a></h3>
3033 <p><code>WysiwygPollFormContainer
</code> provides poll support for a wysiwyg editor via a tab in the menu below the editor.
3034 This class should not be used directly but only via
<code>WysiwygFormContainer
</code>.
3035 <code>WysiwygPollFormContainer
</code> contains all form fields that are required to create polls and requires edited objects to implement
<code>IPollContainer
</code>.
</p>
3036 <p>The following methods are specific to this form container class:
</p>
3038 <li><code>getEndTimeField()
</code> returns the form field to set the end time of the poll once the form has been built.
</li>
3039 <li><code>getIsChangeableField()
</code> returns the form field to set if poll votes can be changed once the form has been built.
</li>
3040 <li><code>getIsPublicField()
</code> returns the form field to set if poll results are public once the form has been built.
</li>
3041 <li><code>getMaxVotesField()
</code> returns the form field to set the maximum number of votes once the form has been built.
</li>
3042 <li><code>getOptionsField()
</code> returns the form field to set the poll options once the form has been built.
</li>
3043 <li><code>getQuestionField()
</code> returns the form field to set the poll question once the form has been built.
</li>
3044 <li><code>getResultsRequireVoteField()
</code> returns the form field to set if viewing the poll results requires voting once the form has been built.
</li>
3045 <li><code>getSortByVotesField()
</code> returns the form field to set if the results are sorted by votes once the form has been built.
</li>
3047 <h3 id=
"wysiwygsmileyformcontainer"><code>WysiwygSmileyFormContainer
</code><a class=
"headerlink" href=
"#wysiwygsmileyformcontainer" title=
"Permanent link">#
</a></h3>
3048 <p><code>WysiwygSmileyFormContainer
</code> provides smiley support for a wysiwyg editor via a tab in the menu below the editor.
3049 This class should not be used directly but only via
<code>WysiwygFormContainer
</code>.
3050 <code>WysiwygSmileyFormContainer
</code> creates a sub-tab for each smiley category.
</p>
3051 <h4 id=
"wysiwygsmileyformnode"><code>WysiwygSmileyFormNode
</code><a class=
"headerlink" href=
"#wysiwygsmileyformnode" title=
"Permanent link">#
</a></h4>
3052 <p><code>WysiwygSmileyFormNode
</code> is contains the smilies of a specific category.
3053 This class should not be used directly but only via
<code>WysiwygSmileyFormContainer
</code>.
</p>
3054 <h3 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h3>
3055 <p>The following code creates a WYSIWYG editor component for a
<code>message
</code> object property.
3056 As smilies are supported by default and an attachment object type is given, the tab menu below the editor has two tabs: “Smilies” and “Attachments”.
3057 Additionally, mentions and quotes are supported.
</p>
3058 <div class=
"highlight"><pre><span></span><code><span class=
"nx">WysiwygFormContainer
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'message
'</span><span class=
"p">)
</span>
3059 <span class=
"o">-
></span><span class=
"na">label
</span><span class=
"p">(
</span><span class=
"s1">'foo.bar.message
'</span><span class=
"p">)
</span>
3060 <span class=
"o">-
></span><span class=
"na">messageObjectType
</span><span class=
"p">(
</span><span class=
"s1">'com.example.foo.bar
'</span><span class=
"p">)
</span>
3061 <span class=
"o">-
></span><span class=
"na">attachmentData
</span><span class=
"p">(
</span><span class=
"s1">'com.example.foo.bar
'</span><span class=
"p">)
</span>
3062 <span class=
"o">-
></span><span class=
"na">supportMentions
</span><span class=
"p">()
</span>
3063 <span class=
"o">-
></span><span class=
"na">supportQuotes
</span><span class=
"p">()
</span>
3065 <h3 id=
"wysiwygformfield"><code>WysiwygFormField
</code><a class=
"headerlink" href=
"#wysiwygformfield" title=
"Permanent link">#
</a></h3>
3066 <p><code>WysiwygFormField
</code> is used for wysiwyg editor form fields.
3067 This class should, in general, not be used directly but only via
<code>WysiwygFormContainer
</code>.
3068 The class implements
<code>IAttributeFormField
</code>,
<code>IMaximumLengthFormField
</code>,
<code>IMinimumLengthFormField
</code>, and
<code>IObjectTypeFormNode
</code> and requires an object type of the object type definition
<code>com.woltlab.wcf.message
</code>.
3069 The following methods are specific to this form field class:
</p>
3071 <li><code>autosaveId($autosaveId)
</code> and
<code>getAutosaveId()
</code> can be used enable automatically saving the current editor contents in the browser using the given id.
3072 An empty string signals that autosaving is disabled.
</li>
3073 <li><code>lastEditTime($lastEditTime)
</code> and
<code>getLastEditTime()
</code> can be used to set the last time the contents have been edited and saved so that the JavaScript can determine if the contents stored in the browser are older or newer.
3074 <code>0</code> signals that no last edit time has been set.
</li>
3075 <li><code>supportAttachments($supportAttachments)
</code> and
<code>supportsAttachments()
</code> can be used to set and check if the form field supports attachments.
</li>
3077 <p>!!! warning
"It is not sufficient to simply signal attachment support via these methods for attachments to work. These methods are relevant internally to signal the Javascript code that the editor supports attachments. Actual attachment support is provided by <code>WysiwygAttachmentFormField</code>."
3078 -
<code>supportMentions($supportMentions)
</code> and
<code>supportsMentions()
</code> can be used to set and check if the form field supports mentions of other users.
</p>
3079 <p><code>WysiwygFormField
</code> objects register a
<a href=
"../validation_data/#customformfielddataprocessor">custom form field data processor
</a> to add the relevant simple ACL data array into the
<code>$parameters
</code> array directly using the object property as the array key.
</p>
3080 <h3 id=
"twysiwygformnode"><code>TWysiwygFormNode
</code><a class=
"headerlink" href=
"#twysiwygformnode" title=
"Permanent link">#
</a></h3>
3081 <p>All form nodes that need to know the id of the
<code>WysiwygFormField
</code> field should use
<code>TWysiwygFormNode
</code>.
3082 This trait provides
<code>getWysiwygId()
</code> and
<code>wysiwygId($wysiwygId)
</code> to get and set the relevant wysiwyg editor id.
</p>
3083 <h2 id=
"single-use-form-fields">Single-Use Form Fields
<a class=
"headerlink" href=
"#single-use-form-fields" title=
"Permanent link">#
</a></h2>
3084 <p>The following form fields are specific for certain forms and hardly reusable in other contexts.
</p>
3085 <h3 id=
"bbcodeattributesformfield"><code>BBCodeAttributesFormField
</code><a class=
"headerlink" href=
"#bbcodeattributesformfield" title=
"Permanent link">#
</a></h3>
3086 <p><code>DevtoolsProjectExcludedPackagesFormField
</code> is a form field for setting the attributes of a BBCode.
</p>
3087 <h3 id=
"devtoolsprojectexcludedpackagesformfield"><code>DevtoolsProjectExcludedPackagesFormField
</code><a class=
"headerlink" href=
"#devtoolsprojectexcludedpackagesformfield" title=
"Permanent link">#
</a></h3>
3088 <p><code>DevtoolsProjectExcludedPackagesFormField
</code> is a form field for setting the excluded packages of a devtools project.
</p>
3089 <h3 id=
"devtoolsprojectinstructionsformfield"><code>DevtoolsProjectInstructionsFormField
</code><a class=
"headerlink" href=
"#devtoolsprojectinstructionsformfield" title=
"Permanent link">#
</a></h3>
3090 <p><code>DevtoolsProjectExcludedPackagesFormField
</code> is a form field for setting the installation and update instructions of a devtools project.
</p>
3091 <h3 id=
"devtoolsprojectoptionalpackagesformfield"><code>DevtoolsProjectOptionalPackagesFormField
</code><a class=
"headerlink" href=
"#devtoolsprojectoptionalpackagesformfield" title=
"Permanent link">#
</a></h3>
3092 <p><code>DevtoolsProjectExcludedPackagesFormField
</code> is a form field for setting the optional packages of a devtools project.
</p>
3093 <h3 id=
"devtoolsprojectrequiredpackagesformfield"><code>DevtoolsProjectRequiredPackagesFormField
</code><a class=
"headerlink" href=
"#devtoolsprojectrequiredpackagesformfield" title=
"Permanent link">#
</a></h3>
3094 <p><code>DevtoolsProjectExcludedPackagesFormField
</code> is a form field for setting the required packages of a devtools project.
</p>
3100 <div class=
"md-source-date">
3103 Last update:
2021-
01-
16
3122 <footer class=
"md-footer">
3124 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
3126 <a href=
"../structure/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
3127 <div class=
"md-footer__button md-icon">
3128 <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>
3130 <div class=
"md-footer__title">
3131 <div class=
"md-ellipsis">
3132 <span class=
"md-footer__direction">
3141 <a href=
"../validation_data/" class=
"md-footer__link md-footer__link--next" rel=
"next">
3142 <div class=
"md-footer__title">
3143 <div class=
"md-ellipsis">
3144 <span class=
"md-footer__direction">
3150 <div class=
"md-footer__button md-icon">
3151 <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>
3157 <div class=
"md-footer-meta md-typeset">
3158 <div class=
"md-footer-meta__inner md-grid">
3159 <div class=
"md-footer-copyright">
3161 <div class=
"md-footer-copyright__highlight">
3162 Copyright ©
2020 WoltLab GmbH
3166 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
3171 <div class=
"md-footer-copyright">
3172 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
3173 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
3180 <div class=
"md-dialog" data-md-component=
"dialog">
3181 <div class=
"md-dialog__inner md-typeset"></div>
3183 <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>
3186 <script src=
"../../../../assets/javascripts/bundle.d892486b.min.js"></script>