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