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>cronjob - 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=
"#cronjob-package-installation-plugin" 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">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
309 <li class=
"md-nav__item">
310 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
553 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
554 <label class=
"md-nav__title" for=
"__nav_3">
555 <span class=
"md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../../view/css/" class=
"md-nav__link">
610 <li class=
"md-nav__item md-nav__item--nested">
613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
615 <label class=
"md-nav__link" for=
"__nav_4">
617 <span class=
"md-nav__icon md-icon"></span>
619 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
620 <label class=
"md-nav__title" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
624 <ul class=
"md-nav__list" data-md-scrollfix
>
630 <li class=
"md-nav__item">
631 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--nested">
646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
648 <label class=
"md-nav__link" for=
"__nav_4_2">
650 <span class=
"md-nav__icon md-icon"></span>
652 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
653 <label class=
"md-nav__title" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
657 <ul class=
"md-nav__list" data-md-scrollfix
>
663 <li class=
"md-nav__item">
664 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
675 <li class=
"md-nav__item">
676 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
687 <li class=
"md-nav__item">
688 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
749 Browser and Screen Sizes
759 <li class=
"md-nav__item">
760 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
801 <li class=
"md-nav__item">
802 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
825 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
828 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
830 <label class=
"md-nav__link" for=
"__nav_5">
832 <span class=
"md-nav__icon md-icon"></span>
834 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
835 <label class=
"md-nav__title" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
839 <ul class=
"md-nav__list" data-md-scrollfix
>
845 <li class=
"md-nav__item">
846 <a href=
"../../package-xml/" class=
"md-nav__link">
860 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
863 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
865 <label class=
"md-nav__link" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
869 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
870 <label class=
"md-nav__title" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
874 <ul class=
"md-nav__list" data-md-scrollfix
>
880 <li class=
"md-nav__item">
881 <a href=
"../" class=
"md-nav__link">
892 <li class=
"md-nav__item">
893 <a href=
"../acl-option/" class=
"md-nav__link">
904 <li class=
"md-nav__item">
905 <a href=
"../acp-menu/" class=
"md-nav__link">
916 <li class=
"md-nav__item">
917 <a href=
"../acp-search-provider/" class=
"md-nav__link">
928 <li class=
"md-nav__item">
929 <a href=
"../acp-template/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../bbcode/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../box/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../clipboard-action/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../core-object/" class=
"md-nav__link">
990 <li class=
"md-nav__item md-nav__item--active">
992 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
997 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
999 <span class=
"md-nav__icon md-icon"></span>
1002 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1007 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1013 <label class=
"md-nav__title" for=
"__toc">
1014 <span class=
"md-nav__icon md-icon"></span>
1017 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1019 <li class=
"md-nav__item">
1020 <a href=
"#components" class=
"md-nav__link">
1024 <nav class=
"md-nav" aria-label=
"Components">
1025 <ul class=
"md-nav__list">
1027 <li class=
"md-nav__item">
1028 <a href=
"#classname" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"#description" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"#start" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"#canbeedited" class=
"md-nav__link">
1055 <li class=
"md-nav__item">
1056 <a href=
"#canbedisabled" class=
"md-nav__link">
1057 <canBeDisabled
>
1062 <li class=
"md-nav__item">
1063 <a href=
"#options" class=
"md-nav__link">
1074 <li class=
"md-nav__item">
1075 <a href=
"#example" class=
"md-nav__link">
1093 <li class=
"md-nav__item">
1094 <a href=
"../event-listener/" class=
"md-nav__link">
1105 <li class=
"md-nav__item">
1106 <a href=
"../file/" class=
"md-nav__link">
1117 <li class=
"md-nav__item">
1118 <a href=
"../language/" class=
"md-nav__link">
1129 <li class=
"md-nav__item">
1130 <a href=
"../media-provider/" class=
"md-nav__link">
1141 <li class=
"md-nav__item">
1142 <a href=
"../menu/" class=
"md-nav__link">
1153 <li class=
"md-nav__item">
1154 <a href=
"../menu-item/" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"../object-type/" class=
"md-nav__link">
1177 <li class=
"md-nav__item">
1178 <a href=
"../object-type-definition/" class=
"md-nav__link">
1179 objectTypeDefinition
1189 <li class=
"md-nav__item">
1190 <a href=
"../option/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../page/" class=
"md-nav__link">
1213 <li class=
"md-nav__item">
1214 <a href=
"../pip/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../script/" class=
"md-nav__link">
1237 <li class=
"md-nav__item">
1238 <a href=
"../smiley/" class=
"md-nav__link">
1249 <li class=
"md-nav__item">
1250 <a href=
"../sql/" class=
"md-nav__link">
1261 <li class=
"md-nav__item">
1262 <a href=
"../style/" class=
"md-nav__link">
1273 <li class=
"md-nav__item">
1274 <a href=
"../template/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../template-listener/" class=
"md-nav__link">
1297 <li class=
"md-nav__item">
1298 <a href=
"../user-group-option/" class=
"md-nav__link">
1309 <li class=
"md-nav__item">
1310 <a href=
"../user-menu/" class=
"md-nav__link">
1321 <li class=
"md-nav__item">
1322 <a href=
"../user-notification-event/" class=
"md-nav__link">
1323 userNotificationEvent
1333 <li class=
"md-nav__item">
1334 <a href=
"../user-option/" class=
"md-nav__link">
1345 <li class=
"md-nav__item">
1346 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1363 <li class=
"md-nav__item">
1364 <a href=
"../../database-php-api/" class=
"md-nav__link">
1385 <li class=
"md-nav__item md-nav__item--nested">
1388 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1390 <label class=
"md-nav__link" for=
"__nav_6">
1392 <span class=
"md-nav__icon md-icon"></span>
1394 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1395 <label class=
"md-nav__title" for=
"__nav_6">
1396 <span class=
"md-nav__icon md-icon"></span>
1399 <ul class=
"md-nav__list" data-md-scrollfix
>
1406 <li class=
"md-nav__item md-nav__item--nested">
1409 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1411 <label class=
"md-nav__link" for=
"__nav_6_1">
1412 Migrating from WSC
5.3
1413 <span class=
"md-nav__icon md-icon"></span>
1415 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1416 <label class=
"md-nav__title" for=
"__nav_6_1">
1417 <span class=
"md-nav__icon md-icon"></span>
1418 Migrating from WSC
5.3
1420 <ul class=
"md-nav__list" data-md-scrollfix
>
1426 <li class=
"md-nav__item">
1427 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1438 <li class=
"md-nav__item">
1439 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1440 Session Handling and Authentication
1450 <li class=
"md-nav__item">
1451 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1462 <li class=
"md-nav__item">
1463 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1474 <li class=
"md-nav__item">
1475 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1476 Third Party Libraries
1493 <li class=
"md-nav__item md-nav__item--nested">
1496 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1498 <label class=
"md-nav__link" for=
"__nav_6_2">
1499 Migrating from WSC
5.2
1500 <span class=
"md-nav__icon md-icon"></span>
1502 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1503 <label class=
"md-nav__title" for=
"__nav_6_2">
1504 <span class=
"md-nav__icon md-icon"></span>
1505 Migrating from WSC
5.2
1507 <ul class=
"md-nav__list" data-md-scrollfix
>
1513 <li class=
"md-nav__item">
1514 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1525 <li class=
"md-nav__item">
1526 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1527 Templates and Languages
1537 <li class=
"md-nav__item">
1538 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1539 Third Party Libraries
1556 <li class=
"md-nav__item md-nav__item--nested">
1559 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1561 <label class=
"md-nav__link" for=
"__nav_6_3">
1562 Migrating from WSC
3.1
1563 <span class=
"md-nav__icon md-icon"></span>
1565 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1566 <label class=
"md-nav__title" for=
"__nav_6_3">
1567 <span class=
"md-nav__icon md-icon"></span>
1568 Migrating from WSC
3.1
1570 <ul class=
"md-nav__list" data-md-scrollfix
>
1576 <li class=
"md-nav__item">
1577 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1595 <li class=
"md-nav__item md-nav__item--nested">
1598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1600 <label class=
"md-nav__link" for=
"__nav_6_4">
1601 Migrating from WSC
3.0
1602 <span class=
"md-nav__icon md-icon"></span>
1604 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1605 <label class=
"md-nav__title" for=
"__nav_6_4">
1606 <span class=
"md-nav__icon md-icon"></span>
1607 Migrating from WSC
3.0
1609 <ul class=
"md-nav__list" data-md-scrollfix
>
1615 <li class=
"md-nav__item">
1616 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1627 <li class=
"md-nav__item">
1628 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1639 <li class=
"md-nav__item">
1640 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1651 <li class=
"md-nav__item">
1652 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1663 <li class=
"md-nav__item">
1664 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1682 <li class=
"md-nav__item md-nav__item--nested">
1685 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1687 <label class=
"md-nav__link" for=
"__nav_6_5">
1688 Migrating from WCF
2.1
1689 <span class=
"md-nav__icon md-icon"></span>
1691 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1692 <label class=
"md-nav__title" for=
"__nav_6_5">
1693 <span class=
"md-nav__icon md-icon"></span>
1694 Migrating from WCF
2.1
1696 <ul class=
"md-nav__list" data-md-scrollfix
>
1702 <li class=
"md-nav__item">
1703 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1714 <li class=
"md-nav__item">
1715 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1726 <li class=
"md-nav__item">
1727 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1738 <li class=
"md-nav__item">
1739 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1766 <li class=
"md-nav__item md-nav__item--nested">
1769 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1771 <label class=
"md-nav__link" for=
"__nav_7">
1773 <span class=
"md-nav__icon md-icon"></span>
1775 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1776 <label class=
"md-nav__title" for=
"__nav_7">
1777 <span class=
"md-nav__icon md-icon"></span>
1780 <ul class=
"md-nav__list" data-md-scrollfix
>
1787 <li class=
"md-nav__item md-nav__item--nested">
1790 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1792 <label class=
"md-nav__link" for=
"__nav_7_1">
1794 <span class=
"md-nav__icon md-icon"></span>
1796 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1797 <label class=
"md-nav__title" for=
"__nav_7_1">
1798 <span class=
"md-nav__icon md-icon"></span>
1801 <ul class=
"md-nav__list" data-md-scrollfix
>
1807 <li class=
"md-nav__item">
1808 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1819 <li class=
"md-nav__item">
1820 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1831 <li class=
"md-nav__item">
1832 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1843 <li class=
"md-nav__item">
1844 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1871 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1872 <div class=
"md-sidebar__scrollwrap">
1873 <div class=
"md-sidebar__inner">
1875 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1881 <label class=
"md-nav__title" for=
"__toc">
1882 <span class=
"md-nav__icon md-icon"></span>
1885 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1887 <li class=
"md-nav__item">
1888 <a href=
"#components" class=
"md-nav__link">
1892 <nav class=
"md-nav" aria-label=
"Components">
1893 <ul class=
"md-nav__list">
1895 <li class=
"md-nav__item">
1896 <a href=
"#classname" class=
"md-nav__link">
1902 <li class=
"md-nav__item">
1903 <a href=
"#description" class=
"md-nav__link">
1909 <li class=
"md-nav__item">
1910 <a href=
"#start" class=
"md-nav__link">
1916 <li class=
"md-nav__item">
1917 <a href=
"#canbeedited" class=
"md-nav__link">
1923 <li class=
"md-nav__item">
1924 <a href=
"#canbedisabled" class=
"md-nav__link">
1925 <canBeDisabled
>
1930 <li class=
"md-nav__item">
1931 <a href=
"#options" class=
"md-nav__link">
1942 <li class=
"md-nav__item">
1943 <a href=
"#example" class=
"md-nav__link">
1957 <div class=
"md-content" data-md-component=
"content">
1958 <article class=
"md-content__inner md-typeset">
1961 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/cronjob.md" title=
"Edit this page" class=
"md-content__button md-icon">
1962 <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>
1966 <h1 id=
"cronjob-package-installation-plugin">Cronjob Package Installation Plugin
<a class=
"headerlink" href=
"#cronjob-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1967 <p>Registers new cronjobs.
1968 The cronjob schedular works similar to the
<code>cron(
8)
</code> daemon, which might not available to web applications on regular webspaces.
1969 The main difference is that WoltLab Suite’s cronjobs do not guarantee execution at the specified points in time:
1970 WoltLab Suite’s cronjobs are triggered by regular visitors in an AJAX request, once the next execution point lies in the past.
</p>
1971 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1972 <p>Each cronjob is described as an
<code><cronjob
></code> element with the mandatory attribute
<code>name
</code>.
</p>
1973 <h3 id=
"classname"><code><classname
></code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h3>
1974 <p>The name of the class providing the cronjob's behaviour,
1975 the class has to implement the
<code>wcf\system\cronjob\ICronjob
</code> interface.
</p>
1976 <h3 id=
"description"><code><description
></code><a class=
"headerlink" href=
"#description" title=
"Permanent link">#
</a></h3>
1977 <div class=
"admonition info">
1978 <p class=
"admonition-title">The
<code>language
</code> attribute is optional and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
1980 <p>Provides a human readable description for the administrator.
</p>
1981 <h3 id=
"start"><code><start*
></code><a class=
"headerlink" href=
"#start" title=
"Permanent link">#
</a></h3>
1982 <p>All of the five
<code>startMinute
</code>,
<code>startHour
</code>,
<code>startDom
</code> (Day Of Month),
<code>startMonth
</code>,
<code>startDow
</code> (Day Of Week) are required.
1983 They correspond to the fields in
<code>crontab(
5)
</code> of a cron daemon and accept the same syntax.
</p>
1984 <h3 id=
"canbeedited"><code><canBeEdited
></code><a class=
"headerlink" href=
"#canbeedited" title=
"Permanent link">#
</a></h3>
1985 <p>Controls whether the administrator may edit the fields of the cronjob.
</p>
1986 <h3 id=
"canbedisabled"><code><canBeDisabled
></code><a class=
"headerlink" href=
"#canbedisabled" title=
"Permanent link">#
</a></h3>
1987 <p>Controls whether the administrator may disable the cronjob.
</p>
1988 <h3 id=
"options"><code><options
></code><a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
1989 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the template listener to be executed.
</p>
1990 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1991 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1992 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/cronjob.xsd
"</span><span class=
"nt">></span>
1993 <span class=
"nt"><import
></span>
1994 <span class=
"nt"><cronjob
</span> <span class=
"na">name=
</span><span class=
"s">"com.example.package.example
"</span><span class=
"nt">></span>
1995 <span class=
"nt"><classname
></span>wcf\system\cronjob\ExampleCronjob
<span class=
"nt"></classname
></span>
1996 <span class=
"nt"><description
></span>Serves as an example
<span class=
"nt"></description
></span>
1997 <span class=
"nt"><description
</span> <span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>Stellt ein Beispiel dar
<span class=
"nt"></description
></span>
1998 <span class=
"nt"><startminute
></span>0<span class=
"nt"></startminute
></span>
1999 <span class=
"nt"><starthour
></span>2<span class=
"nt"></starthour
></span>
2000 <span class=
"nt"><startdom
></span>*/
2<span class=
"nt"></startdom
></span>
2001 <span class=
"nt"><startmonth
></span>*
<span class=
"nt"></startmonth
></span>
2002 <span class=
"nt"><startdow
></span>*
<span class=
"nt"></startdow
></span>
2003 <span class=
"nt"><canbeedited
></span>1<span class=
"nt"></canbeedited
></span>
2004 <span class=
"nt"><canbedisabled
></span>1<span class=
"nt"></canbedisabled
></span>
2005 <span class=
"nt"></cronjob
></span>
2006 <span class=
"nt"></import
></span>
2007 <span class=
"nt"></data
></span>
2014 <div class=
"md-source-date">
2017 Last update:
2021-
01-
08
2036 <footer class=
"md-footer">
2038 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2040 <a href=
"../core-object/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2041 <div class=
"md-footer__button md-icon">
2042 <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>
2044 <div class=
"md-footer__title">
2045 <div class=
"md-ellipsis">
2046 <span class=
"md-footer__direction">
2055 <a href=
"../event-listener/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2056 <div class=
"md-footer__title">
2057 <div class=
"md-ellipsis">
2058 <span class=
"md-footer__direction">
2064 <div class=
"md-footer__button md-icon">
2065 <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>
2071 <div class=
"md-footer-meta md-typeset">
2072 <div class=
"md-footer-meta__inner md-grid">
2073 <div class=
"md-footer-copyright">
2075 <div class=
"md-footer-copyright__highlight">
2076 Copyright ©
2020 WoltLab GmbH
2080 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2085 <div class=
"md-footer-copyright">
2086 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2087 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2094 <div class=
"md-dialog" data-md-component=
"dialog">
2095 <div class=
"md-dialog__inner md-typeset"></div>
2097 <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>
2100 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>