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.2">
17 <title>Cronjobs - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.6f955dcd.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=
"#cronjobs" 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">
390 <li class=
"md-nav__item md-nav__item--active">
392 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
398 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
400 <span class=
"md-nav__icon md-icon"></span>
403 <a href=
"./" class=
"md-nav__link md-nav__link--active">
408 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
415 <label class=
"md-nav__title" for=
"__toc">
416 <span class=
"md-nav__icon md-icon"></span>
419 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
421 <li class=
"md-nav__item">
422 <a href=
"#example" class=
"md-nav__link">
428 <li class=
"md-nav__item">
429 <a href=
"#icronjob-interface" class=
"md-nav__link">
435 <li class=
"md-nav__item">
436 <a href=
"#executing-cronjobs-through-cli" class=
"md-nav__link">
437 Executing Cronjobs Through CLI
454 <li class=
"md-nav__item">
455 <a href=
"../events/" class=
"md-nav__link">
467 <li class=
"md-nav__item md-nav__item--nested">
470 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
472 <label class=
"md-nav__link" for=
"__nav_2_5_5">
474 <span class=
"md-nav__icon md-icon"></span>
476 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
477 <label class=
"md-nav__title" for=
"__nav_2_5_5">
478 <span class=
"md-nav__icon md-icon"></span>
481 <ul class=
"md-nav__list" data-md-scrollfix
>
487 <li class=
"md-nav__item">
488 <a href=
"../form_builder/overview/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../form_builder/structure/" class=
"md-nav__link">
511 <li class=
"md-nav__item">
512 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
523 <li class=
"md-nav__item">
524 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
535 <li class=
"md-nav__item">
536 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
555 Package Installation Plugins
565 <li class=
"md-nav__item">
566 <a href=
"../user_activity_points/" class=
"md-nav__link">
577 <li class=
"md-nav__item">
578 <a href=
"../user_notifications/" class=
"md-nav__link">
589 <li class=
"md-nav__item">
590 <a href=
"../sitemaps/" class=
"md-nav__link">
607 <li class=
"md-nav__item">
608 <a href=
"../../code-style/" class=
"md-nav__link">
619 <li class=
"md-nav__item">
620 <a href=
"../../apps/" class=
"md-nav__link">
631 <li class=
"md-nav__item">
632 <a href=
"../../gdpr/" class=
"md-nav__link">
653 <li class=
"md-nav__item md-nav__item--nested">
656 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
658 <label class=
"md-nav__link" for=
"__nav_3">
659 Languages, Templates & CSS
660 <span class=
"md-nav__icon md-icon"></span>
662 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
663 <label class=
"md-nav__title" for=
"__nav_3">
664 <span class=
"md-nav__icon md-icon"></span>
665 Languages, Templates & CSS
667 <ul class=
"md-nav__list" data-md-scrollfix
>
673 <li class=
"md-nav__item">
674 <a href=
"../../../view/languages/" class=
"md-nav__link">
685 <li class=
"md-nav__item">
686 <a href=
"../../../view/templates/" class=
"md-nav__link">
697 <li class=
"md-nav__item">
698 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"../../../view/css/" class=
"md-nav__link">
731 <li class=
"md-nav__item md-nav__item--nested">
734 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
736 <label class=
"md-nav__link" for=
"__nav_4">
737 TypeScript and JavaScript API
738 <span class=
"md-nav__icon md-icon"></span>
740 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
741 <label class=
"md-nav__title" for=
"__nav_4">
742 <span class=
"md-nav__icon md-icon"></span>
743 TypeScript and JavaScript API
745 <ul class=
"md-nav__list" data-md-scrollfix
>
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
776 <li class=
"md-nav__item md-nav__item--nested">
779 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
781 <label class=
"md-nav__link" for=
"__nav_4_3">
783 <span class=
"md-nav__icon md-icon"></span>
785 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
786 <label class=
"md-nav__title" for=
"__nav_4_3">
787 <span class=
"md-nav__icon md-icon"></span>
790 <ul class=
"md-nav__list" data-md-scrollfix
>
796 <li class=
"md-nav__item">
797 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
808 <li class=
"md-nav__item">
809 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
820 <li class=
"md-nav__item">
821 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
832 <li class=
"md-nav__item">
833 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
844 <li class=
"md-nav__item">
845 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
856 <li class=
"md-nav__item">
857 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
868 <li class=
"md-nav__item">
869 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
880 <li class=
"md-nav__item">
881 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
882 Browser and Screen Sizes
892 <li class=
"md-nav__item">
893 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
910 <li class=
"md-nav__item">
911 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
922 <li class=
"md-nav__item">
923 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
934 <li class=
"md-nav__item">
935 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
956 <li class=
"md-nav__item md-nav__item--nested">
959 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
961 <label class=
"md-nav__link" for=
"__nav_5">
963 <span class=
"md-nav__icon md-icon"></span>
965 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
966 <label class=
"md-nav__title" for=
"__nav_5">
967 <span class=
"md-nav__icon md-icon"></span>
970 <ul class=
"md-nav__list" data-md-scrollfix
>
976 <li class=
"md-nav__item">
977 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
989 <li class=
"md-nav__item md-nav__item--nested">
992 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
994 <label class=
"md-nav__link" for=
"__nav_5_2">
996 <span class=
"md-nav__icon md-icon"></span>
998 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
999 <label class=
"md-nav__title" for=
"__nav_5_2">
1000 <span class=
"md-nav__icon md-icon"></span>
1003 <ul class=
"md-nav__list" data-md-scrollfix
>
1009 <li class=
"md-nav__item">
1010 <a href=
"../../../package/pip/" class=
"md-nav__link">
1021 <li class=
"md-nav__item">
1022 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1045 <li class=
"md-nav__item">
1046 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1057 <li class=
"md-nav__item">
1058 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1069 <li class=
"md-nav__item">
1070 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1081 <li class=
"md-nav__item">
1082 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1093 <li class=
"md-nav__item">
1094 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1105 <li class=
"md-nav__item">
1106 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1117 <li class=
"md-nav__item">
1118 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1129 <li class=
"md-nav__item">
1130 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1141 <li class=
"md-nav__item">
1142 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1153 <li class=
"md-nav__item">
1154 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1177 <li class=
"md-nav__item">
1178 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1189 <li class=
"md-nav__item">
1190 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1213 <li class=
"md-nav__item">
1214 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1227 objectTypeDefinition
1237 <li class=
"md-nav__item">
1238 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1249 <li class=
"md-nav__item">
1250 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1261 <li class=
"md-nav__item">
1262 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1273 <li class=
"md-nav__item">
1274 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1297 <li class=
"md-nav__item">
1298 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1309 <li class=
"md-nav__item">
1310 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1321 <li class=
"md-nav__item">
1322 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1333 <li class=
"md-nav__item">
1334 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1345 <li class=
"md-nav__item">
1346 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1357 <li class=
"md-nav__item">
1358 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1369 <li class=
"md-nav__item">
1370 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1371 userNotificationEvent
1381 <li class=
"md-nav__item">
1382 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1393 <li class=
"md-nav__item">
1394 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1411 <li class=
"md-nav__item">
1412 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1433 <li class=
"md-nav__item md-nav__item--nested">
1436 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1438 <label class=
"md-nav__link" for=
"__nav_6">
1440 <span class=
"md-nav__icon md-icon"></span>
1442 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1443 <label class=
"md-nav__title" for=
"__nav_6">
1444 <span class=
"md-nav__icon md-icon"></span>
1447 <ul class=
"md-nav__list" data-md-scrollfix
>
1454 <li class=
"md-nav__item md-nav__item--nested">
1457 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1459 <label class=
"md-nav__link" for=
"__nav_6_1">
1460 Migrating from WSC
5.3
1461 <span class=
"md-nav__icon md-icon"></span>
1463 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1464 <label class=
"md-nav__title" for=
"__nav_6_1">
1465 <span class=
"md-nav__icon md-icon"></span>
1466 Migrating from WSC
5.3
1468 <ul class=
"md-nav__list" data-md-scrollfix
>
1474 <li class=
"md-nav__item">
1475 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1486 <li class=
"md-nav__item">
1487 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1488 Session Handling and Authentication
1498 <li class=
"md-nav__item">
1499 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1500 TypeScript and JavaScript
1510 <li class=
"md-nav__item">
1511 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1522 <li class=
"md-nav__item">
1523 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1524 Third Party Libraries
1541 <li class=
"md-nav__item md-nav__item--nested">
1544 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1546 <label class=
"md-nav__link" for=
"__nav_6_2">
1547 Migrating from WSC
5.2
1548 <span class=
"md-nav__icon md-icon"></span>
1550 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1551 <label class=
"md-nav__title" for=
"__nav_6_2">
1552 <span class=
"md-nav__icon md-icon"></span>
1553 Migrating from WSC
5.2
1555 <ul class=
"md-nav__list" data-md-scrollfix
>
1561 <li class=
"md-nav__item">
1562 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1573 <li class=
"md-nav__item">
1574 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1575 Templates and Languages
1585 <li class=
"md-nav__item">
1586 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1587 Third Party Libraries
1604 <li class=
"md-nav__item md-nav__item--nested">
1607 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1609 <label class=
"md-nav__link" for=
"__nav_6_3">
1610 Migrating from WSC
3.1
1611 <span class=
"md-nav__icon md-icon"></span>
1613 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1614 <label class=
"md-nav__title" for=
"__nav_6_3">
1615 <span class=
"md-nav__icon md-icon"></span>
1616 Migrating from WSC
3.1
1618 <ul class=
"md-nav__list" data-md-scrollfix
>
1624 <li class=
"md-nav__item">
1625 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1643 <li class=
"md-nav__item md-nav__item--nested">
1646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1648 <label class=
"md-nav__link" for=
"__nav_6_4">
1649 Migrating from WSC
3.0
1650 <span class=
"md-nav__icon md-icon"></span>
1652 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1653 <label class=
"md-nav__title" for=
"__nav_6_4">
1654 <span class=
"md-nav__icon md-icon"></span>
1655 Migrating from WSC
3.0
1657 <ul class=
"md-nav__list" data-md-scrollfix
>
1663 <li class=
"md-nav__item">
1664 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1675 <li class=
"md-nav__item">
1676 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1687 <li class=
"md-nav__item">
1688 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1699 <li class=
"md-nav__item">
1700 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1711 <li class=
"md-nav__item">
1712 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1730 <li class=
"md-nav__item md-nav__item--nested">
1733 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1735 <label class=
"md-nav__link" for=
"__nav_6_5">
1736 Migrating from WCF
2.1
1737 <span class=
"md-nav__icon md-icon"></span>
1739 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1740 <label class=
"md-nav__title" for=
"__nav_6_5">
1741 <span class=
"md-nav__icon md-icon"></span>
1742 Migrating from WCF
2.1
1744 <ul class=
"md-nav__list" data-md-scrollfix
>
1750 <li class=
"md-nav__item">
1751 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1762 <li class=
"md-nav__item">
1763 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1774 <li class=
"md-nav__item">
1775 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1786 <li class=
"md-nav__item">
1787 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1814 <li class=
"md-nav__item md-nav__item--nested">
1817 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1819 <label class=
"md-nav__link" for=
"__nav_7">
1821 <span class=
"md-nav__icon md-icon"></span>
1823 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1824 <label class=
"md-nav__title" for=
"__nav_7">
1825 <span class=
"md-nav__icon md-icon"></span>
1828 <ul class=
"md-nav__list" data-md-scrollfix
>
1835 <li class=
"md-nav__item md-nav__item--nested">
1838 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1840 <label class=
"md-nav__link" for=
"__nav_7_1">
1842 <span class=
"md-nav__icon md-icon"></span>
1844 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1845 <label class=
"md-nav__title" for=
"__nav_7_1">
1846 <span class=
"md-nav__icon md-icon"></span>
1849 <ul class=
"md-nav__list" data-md-scrollfix
>
1855 <li class=
"md-nav__item">
1856 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1867 <li class=
"md-nav__item">
1868 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1879 <li class=
"md-nav__item">
1880 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1891 <li class=
"md-nav__item">
1892 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1903 <li class=
"md-nav__item">
1904 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1915 <li class=
"md-nav__item">
1916 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
1943 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1944 <div class=
"md-sidebar__scrollwrap">
1945 <div class=
"md-sidebar__inner">
1947 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1954 <label class=
"md-nav__title" for=
"__toc">
1955 <span class=
"md-nav__icon md-icon"></span>
1958 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1960 <li class=
"md-nav__item">
1961 <a href=
"#example" class=
"md-nav__link">
1967 <li class=
"md-nav__item">
1968 <a href=
"#icronjob-interface" class=
"md-nav__link">
1974 <li class=
"md-nav__item">
1975 <a href=
"#executing-cronjobs-through-cli" class=
"md-nav__link">
1976 Executing Cronjobs Through CLI
1989 <div class=
"md-content" data-md-component=
"content">
1990 <article class=
"md-content__inner md-typeset">
1993 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/cronjobs.md" title=
"Edit this page" class=
"md-content__button md-icon">
1994 <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>
1998 <h1 id=
"cronjobs">Cronjobs
<a class=
"headerlink" href=
"#cronjobs" title=
"Permanent link">#
</a></h1>
1999 <p>Cronjobs offer an easy way to execute actions periodically, like cleaning up the database.
</p>
2000 <div class=
"admonition warning">
2001 <p class=
"admonition-title">The execution of cronjobs is not guaranteed but requires someone to access the page with JavaScript enabled.
</p>
2003 <p>This page focuses on the technical aspects of cronjobs,
<a href=
"../../../package/pip/cronjob/">the cronjob package installation plugin page
</a> covers how you can actually register a cronjob.
</p>
2004 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2005 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2006 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\cronjob
</span><span class=
"p">;
</span>
2007 <span class=
"k">use
</span> <span class=
"nx">wcf\data\cronjob\Cronjob
</span><span class=
"p">;
</span>
2008 <span class=
"k">use
</span> <span class=
"nx">wcf\system\WCF
</span><span class=
"p">;
</span>
2010 <span class=
"sd">/**
</span>
2011 <span class=
"sd"> * Updates the last activity timestamp in the user table.
</span>
2012 <span class=
"sd"> *
</span>
2013 <span class=
"sd"> * @author Marcel Werk
</span>
2014 <span class=
"sd"> * @copyright
2001-
2016 WoltLab GmbH
</span>
2015 <span class=
"sd"> * @license GNU Lesser General Public License
<http://opensource.org/licenses/lgpl-license.php
></span>
2016 <span class=
"sd"> * @package WoltLabSuite\Core\System\Cronjob
</span>
2017 <span class=
"sd"> */
</span>
2018 <span class=
"k">class
</span> <span class=
"nc">LastActivityCronjob
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractCronjob
</span> <span class=
"p">{
</span>
2019 <span class=
"sd">/**
</span>
2020 <span class=
"sd"> * @inheritDoc
</span>
2021 <span class=
"sd"> */
</span>
2022 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">execute
</span><span class=
"p">(
</span><span class=
"nx">Cronjob
</span> <span class=
"nv">$cronjob
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2023 <span class=
"k">parent
</span><span class=
"o">::
</span><span class=
"na">execute
</span><span class=
"p">(
</span><span class=
"nv">$cronjob
</span><span class=
"p">);
</span>
2025 <span class=
"nv">$sql
</span> <span class=
"o">=
</span> <span class=
"s2">"UPDATE wcf
"</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s2">"_user user_table,
</span>
2026 <span class=
"s2"> wcf
"</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s2">"_session session
</span>
2027 <span class=
"s2"> SET user_table.lastActivityTime = session.lastActivityTime
</span>
2028 <span class=
"s2"> WHERE user_table.userID = session.userID
</span>
2029 <span class=
"s2"> AND session.userID
<> 0"</span><span class=
"p">;
</span>
2030 <span class=
"nv">$statement
</span> <span class=
"o">=
</span> <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getDB
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">prepareStatement
</span><span class=
"p">(
</span><span class=
"nv">$sql
</span><span class=
"p">);
</span>
2031 <span class=
"nv">$statement
</span><span class=
"o">-
></span><span class=
"na">execute
</span><span class=
"p">();
</span>
2032 <span class=
"p">}
</span>
2033 <span class=
"p">}
</span>
2035 <h2 id=
"icronjob-interface"><code>ICronjob
</code> Interface
<a class=
"headerlink" href=
"#icronjob-interface" title=
"Permanent link">#
</a></h2>
2036 <p>Every cronjob needs to implement the
<code>wcf\system\cronjob\ICronjob
</code> interface which requires the
<code>execute(Cronjob $cronjob)
</code> method to be implemented.
2037 This method is called by
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/cronjob/CronjobScheduler.class.php">wcf\system\cronjob\CronjobScheduler
</a> when executing the cronjobs.
</p>
2038 <p>In practice, however, you should extend the
<code>AbstractCronjob
</code> class and also call the
<code>AbstractCronjob::execute()
</code> method as it fires an event which makes cronjobs extendable by plugins (see
<a href=
"../events/">event documentation
</a>).
</p>
2039 <h2 id=
"executing-cronjobs-through-cli">Executing Cronjobs Through CLI
<a class=
"headerlink" href=
"#executing-cronjobs-through-cli" title=
"Permanent link">#
</a></h2>
2040 <p>Cronjobs can be executed through the command-line interface (CLI):
</p>
2041 <div class=
"highlight"><pre><span></span><code>php /path/to/wcf/cli.php
<< 'EOT
'
2052 <div class=
"md-source-date">
2055 Last update:
2021-
01-
08
2074 <footer class=
"md-footer">
2076 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2078 <a href=
"../comments/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2079 <div class=
"md-footer__button md-icon">
2080 <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>
2082 <div class=
"md-footer__title">
2083 <div class=
"md-ellipsis">
2084 <span class=
"md-footer__direction">
2093 <a href=
"../events/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2094 <div class=
"md-footer__title">
2095 <div class=
"md-ellipsis">
2096 <span class=
"md-footer__direction">
2102 <div class=
"md-footer__button md-icon">
2103 <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>
2109 <div class=
"md-footer-meta md-typeset">
2110 <div class=
"md-footer-meta__inner md-grid">
2111 <div class=
"md-footer-copyright">
2113 <div class=
"md-footer-copyright__highlight">
2114 Copyright ©
2020 WoltLab GmbH
2118 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2123 <div class=
"md-footer-copyright">
2124 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2125 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2132 <div class=
"md-dialog" data-md-component=
"dialog">
2133 <div class=
"md-dialog__inner md-typeset"></div>
2135 <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>
2138 <script src=
"../../../assets/javascripts/bundle.4ea5477f.min.js"></script>