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>Cronjobs - 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=
"#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">
397 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
399 <span class=
"md-nav__icon md-icon"></span>
402 <a href=
"./" class=
"md-nav__link md-nav__link--active">
407 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
413 <label class=
"md-nav__title" for=
"__toc">
414 <span class=
"md-nav__icon md-icon"></span>
417 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
419 <li class=
"md-nav__item">
420 <a href=
"#example" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"#icronjob-interface" class=
"md-nav__link">
433 <li class=
"md-nav__item">
434 <a href=
"#executing-cronjobs-through-cli" class=
"md-nav__link">
435 Executing Cronjobs Through CLI
452 <li class=
"md-nav__item">
453 <a href=
"../events/" class=
"md-nav__link">
465 <li class=
"md-nav__item md-nav__item--nested">
468 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
470 <label class=
"md-nav__link" for=
"__nav_2_5_5">
472 <span class=
"md-nav__icon md-icon"></span>
474 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
475 <label class=
"md-nav__title" for=
"__nav_2_5_5">
476 <span class=
"md-nav__icon md-icon"></span>
479 <ul class=
"md-nav__list" data-md-scrollfix
>
485 <li class=
"md-nav__item">
486 <a href=
"../form_builder/overview/" class=
"md-nav__link">
497 <li class=
"md-nav__item">
498 <a href=
"../form_builder/structure/" class=
"md-nav__link">
509 <li class=
"md-nav__item">
510 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
521 <li class=
"md-nav__item">
522 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
551 <li class=
"md-nav__item">
552 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
553 Package Installation Plugins
563 <li class=
"md-nav__item">
564 <a href=
"../user_activity_points/" class=
"md-nav__link">
575 <li class=
"md-nav__item">
576 <a href=
"../user_notifications/" class=
"md-nav__link">
587 <li class=
"md-nav__item">
588 <a href=
"../sitemaps/" class=
"md-nav__link">
605 <li class=
"md-nav__item">
606 <a href=
"../../code-style/" class=
"md-nav__link">
617 <li class=
"md-nav__item">
618 <a href=
"../../apps/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../../gdpr/" class=
"md-nav__link">
651 <li class=
"md-nav__item md-nav__item--nested">
654 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
656 <label class=
"md-nav__link" for=
"__nav_3">
657 Languages, Templates & CSS
658 <span class=
"md-nav__icon md-icon"></span>
660 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
661 <label class=
"md-nav__title" for=
"__nav_3">
662 <span class=
"md-nav__icon md-icon"></span>
663 Languages, Templates & CSS
665 <ul class=
"md-nav__list" data-md-scrollfix
>
671 <li class=
"md-nav__item">
672 <a href=
"../../../view/languages/" class=
"md-nav__link">
683 <li class=
"md-nav__item">
684 <a href=
"../../../view/templates/" class=
"md-nav__link">
695 <li class=
"md-nav__item">
696 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../../../view/css/" class=
"md-nav__link">
729 <li class=
"md-nav__item md-nav__item--nested">
732 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
734 <label class=
"md-nav__link" for=
"__nav_4">
735 TypeScript and JavaScript API
736 <span class=
"md-nav__icon md-icon"></span>
738 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
739 <label class=
"md-nav__title" for=
"__nav_4">
740 <span class=
"md-nav__icon md-icon"></span>
741 TypeScript and JavaScript API
743 <ul class=
"md-nav__list" data-md-scrollfix
>
749 <li class=
"md-nav__item">
750 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
761 <li class=
"md-nav__item">
762 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
774 <li class=
"md-nav__item md-nav__item--nested">
777 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
779 <label class=
"md-nav__link" for=
"__nav_4_3">
781 <span class=
"md-nav__icon md-icon"></span>
783 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
784 <label class=
"md-nav__title" for=
"__nav_4_3">
785 <span class=
"md-nav__icon md-icon"></span>
788 <ul class=
"md-nav__list" data-md-scrollfix
>
794 <li class=
"md-nav__item">
795 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
806 <li class=
"md-nav__item">
807 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
818 <li class=
"md-nav__item">
819 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
830 <li class=
"md-nav__item">
831 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
842 <li class=
"md-nav__item">
843 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
854 <li class=
"md-nav__item">
855 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
880 Browser and Screen Sizes
890 <li class=
"md-nav__item">
891 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
908 <li class=
"md-nav__item">
909 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
920 <li class=
"md-nav__item">
921 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
954 <li class=
"md-nav__item md-nav__item--nested">
957 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
959 <label class=
"md-nav__link" for=
"__nav_5">
961 <span class=
"md-nav__icon md-icon"></span>
963 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
964 <label class=
"md-nav__title" for=
"__nav_5">
965 <span class=
"md-nav__icon md-icon"></span>
968 <ul class=
"md-nav__list" data-md-scrollfix
>
974 <li class=
"md-nav__item">
975 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
987 <li class=
"md-nav__item md-nav__item--nested">
990 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
992 <label class=
"md-nav__link" for=
"__nav_5_2">
994 <span class=
"md-nav__icon md-icon"></span>
996 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
997 <label class=
"md-nav__title" for=
"__nav_5_2">
998 <span class=
"md-nav__icon md-icon"></span>
1001 <ul class=
"md-nav__list" data-md-scrollfix
>
1007 <li class=
"md-nav__item">
1008 <a href=
"../../../package/pip/" class=
"md-nav__link">
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1031 <li class=
"md-nav__item">
1032 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1043 <li class=
"md-nav__item">
1044 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1055 <li class=
"md-nav__item">
1056 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1067 <li class=
"md-nav__item">
1068 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1079 <li class=
"md-nav__item">
1080 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1091 <li class=
"md-nav__item">
1092 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1103 <li class=
"md-nav__item">
1104 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1115 <li class=
"md-nav__item">
1116 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1127 <li class=
"md-nav__item">
1128 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1139 <li class=
"md-nav__item">
1140 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1151 <li class=
"md-nav__item">
1152 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1163 <li class=
"md-nav__item">
1164 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1175 <li class=
"md-nav__item">
1176 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1187 <li class=
"md-nav__item">
1188 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1199 <li class=
"md-nav__item">
1200 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1211 <li class=
"md-nav__item">
1212 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1223 <li class=
"md-nav__item">
1224 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1225 objectTypeDefinition
1235 <li class=
"md-nav__item">
1236 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1247 <li class=
"md-nav__item">
1248 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1259 <li class=
"md-nav__item">
1260 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1271 <li class=
"md-nav__item">
1272 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1283 <li class=
"md-nav__item">
1284 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1295 <li class=
"md-nav__item">
1296 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1307 <li class=
"md-nav__item">
1308 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1319 <li class=
"md-nav__item">
1320 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1331 <li class=
"md-nav__item">
1332 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1343 <li class=
"md-nav__item">
1344 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1369 userNotificationEvent
1379 <li class=
"md-nav__item">
1380 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1391 <li class=
"md-nav__item">
1392 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1409 <li class=
"md-nav__item">
1410 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1431 <li class=
"md-nav__item md-nav__item--nested">
1434 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1436 <label class=
"md-nav__link" for=
"__nav_6">
1438 <span class=
"md-nav__icon md-icon"></span>
1440 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1441 <label class=
"md-nav__title" for=
"__nav_6">
1442 <span class=
"md-nav__icon md-icon"></span>
1445 <ul class=
"md-nav__list" data-md-scrollfix
>
1452 <li class=
"md-nav__item md-nav__item--nested">
1455 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1457 <label class=
"md-nav__link" for=
"__nav_6_1">
1458 Migrating from WSC
5.3
1459 <span class=
"md-nav__icon md-icon"></span>
1461 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1462 <label class=
"md-nav__title" for=
"__nav_6_1">
1463 <span class=
"md-nav__icon md-icon"></span>
1464 Migrating from WSC
5.3
1466 <ul class=
"md-nav__list" data-md-scrollfix
>
1472 <li class=
"md-nav__item">
1473 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1484 <li class=
"md-nav__item">
1485 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1486 Session Handling and Authentication
1496 <li class=
"md-nav__item">
1497 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1498 TypeScript and JavaScript
1508 <li class=
"md-nav__item">
1509 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1520 <li class=
"md-nav__item">
1521 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1522 Third Party Libraries
1539 <li class=
"md-nav__item md-nav__item--nested">
1542 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1544 <label class=
"md-nav__link" for=
"__nav_6_2">
1545 Migrating from WSC
5.2
1546 <span class=
"md-nav__icon md-icon"></span>
1548 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1549 <label class=
"md-nav__title" for=
"__nav_6_2">
1550 <span class=
"md-nav__icon md-icon"></span>
1551 Migrating from WSC
5.2
1553 <ul class=
"md-nav__list" data-md-scrollfix
>
1559 <li class=
"md-nav__item">
1560 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1571 <li class=
"md-nav__item">
1572 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1573 Templates and Languages
1583 <li class=
"md-nav__item">
1584 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1585 Third Party Libraries
1602 <li class=
"md-nav__item md-nav__item--nested">
1605 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1607 <label class=
"md-nav__link" for=
"__nav_6_3">
1608 Migrating from WSC
3.1
1609 <span class=
"md-nav__icon md-icon"></span>
1611 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1612 <label class=
"md-nav__title" for=
"__nav_6_3">
1613 <span class=
"md-nav__icon md-icon"></span>
1614 Migrating from WSC
3.1
1616 <ul class=
"md-nav__list" data-md-scrollfix
>
1622 <li class=
"md-nav__item">
1623 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1641 <li class=
"md-nav__item md-nav__item--nested">
1644 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1646 <label class=
"md-nav__link" for=
"__nav_6_4">
1647 Migrating from WSC
3.0
1648 <span class=
"md-nav__icon md-icon"></span>
1650 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1651 <label class=
"md-nav__title" for=
"__nav_6_4">
1652 <span class=
"md-nav__icon md-icon"></span>
1653 Migrating from WSC
3.0
1655 <ul class=
"md-nav__list" data-md-scrollfix
>
1661 <li class=
"md-nav__item">
1662 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1673 <li class=
"md-nav__item">
1674 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1685 <li class=
"md-nav__item">
1686 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1697 <li class=
"md-nav__item">
1698 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1709 <li class=
"md-nav__item">
1710 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1728 <li class=
"md-nav__item md-nav__item--nested">
1731 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1733 <label class=
"md-nav__link" for=
"__nav_6_5">
1734 Migrating from WCF
2.1
1735 <span class=
"md-nav__icon md-icon"></span>
1737 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1738 <label class=
"md-nav__title" for=
"__nav_6_5">
1739 <span class=
"md-nav__icon md-icon"></span>
1740 Migrating from WCF
2.1
1742 <ul class=
"md-nav__list" data-md-scrollfix
>
1748 <li class=
"md-nav__item">
1749 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1760 <li class=
"md-nav__item">
1761 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1772 <li class=
"md-nav__item">
1773 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1784 <li class=
"md-nav__item">
1785 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1812 <li class=
"md-nav__item md-nav__item--nested">
1815 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1817 <label class=
"md-nav__link" for=
"__nav_7">
1819 <span class=
"md-nav__icon md-icon"></span>
1821 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1822 <label class=
"md-nav__title" for=
"__nav_7">
1823 <span class=
"md-nav__icon md-icon"></span>
1826 <ul class=
"md-nav__list" data-md-scrollfix
>
1833 <li class=
"md-nav__item md-nav__item--nested">
1836 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1838 <label class=
"md-nav__link" for=
"__nav_7_1">
1840 <span class=
"md-nav__icon md-icon"></span>
1842 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1843 <label class=
"md-nav__title" for=
"__nav_7_1">
1844 <span class=
"md-nav__icon md-icon"></span>
1847 <ul class=
"md-nav__list" data-md-scrollfix
>
1853 <li class=
"md-nav__item">
1854 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1865 <li class=
"md-nav__item">
1866 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1877 <li class=
"md-nav__item">
1878 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1889 <li class=
"md-nav__item">
1890 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1901 <li class=
"md-nav__item">
1902 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1929 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1930 <div class=
"md-sidebar__scrollwrap">
1931 <div class=
"md-sidebar__inner">
1933 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1939 <label class=
"md-nav__title" for=
"__toc">
1940 <span class=
"md-nav__icon md-icon"></span>
1943 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1945 <li class=
"md-nav__item">
1946 <a href=
"#example" class=
"md-nav__link">
1952 <li class=
"md-nav__item">
1953 <a href=
"#icronjob-interface" class=
"md-nav__link">
1959 <li class=
"md-nav__item">
1960 <a href=
"#executing-cronjobs-through-cli" class=
"md-nav__link">
1961 Executing Cronjobs Through CLI
1974 <div class=
"md-content" data-md-component=
"content">
1975 <article class=
"md-content__inner md-typeset">
1978 <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">
1979 <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>
1983 <h1 id=
"cronjobs">Cronjobs
<a class=
"headerlink" href=
"#cronjobs" title=
"Permanent link">#
</a></h1>
1984 <p>Cronjobs offer an easy way to execute actions periodically, like cleaning up the database.
</p>
1985 <div class=
"admonition warning">
1986 <p class=
"admonition-title">The execution of cronjobs is not guaranteed but requires someone to access the page with JavaScript enabled.
</p>
1988 <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>
1989 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1990 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
1991 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\cronjob
</span><span class=
"p">;
</span>
1992 <span class=
"k">use
</span> <span class=
"nx">wcf\data\cronjob\Cronjob
</span><span class=
"p">;
</span>
1993 <span class=
"k">use
</span> <span class=
"nx">wcf\system\WCF
</span><span class=
"p">;
</span>
1995 <span class=
"sd">/**
</span>
1996 <span class=
"sd"> * Updates the last activity timestamp in the user table.
</span>
1997 <span class=
"sd"> *
</span>
1998 <span class=
"sd"> * @author Marcel Werk
</span>
1999 <span class=
"sd"> * @copyright
2001-
2016 WoltLab GmbH
</span>
2000 <span class=
"sd"> * @license GNU Lesser General Public License
<http://opensource.org/licenses/lgpl-license.php
></span>
2001 <span class=
"sd"> * @package WoltLabSuite\Core\System\Cronjob
</span>
2002 <span class=
"sd"> */
</span>
2003 <span class=
"k">class
</span> <span class=
"nc">LastActivityCronjob
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractCronjob
</span> <span class=
"p">{
</span>
2004 <span class=
"sd">/**
</span>
2005 <span class=
"sd"> * @inheritDoc
</span>
2006 <span class=
"sd"> */
</span>
2007 <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>
2008 <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>
2010 <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>
2011 <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>
2012 <span class=
"s2"> SET user_table.lastActivityTime = session.lastActivityTime
</span>
2013 <span class=
"s2"> WHERE user_table.userID = session.userID
</span>
2014 <span class=
"s2"> AND session.userID
<> 0"</span><span class=
"p">;
</span>
2015 <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>
2016 <span class=
"nv">$statement
</span><span class=
"o">-
></span><span class=
"na">execute
</span><span class=
"p">();
</span>
2017 <span class=
"p">}
</span>
2018 <span class=
"p">}
</span>
2020 <h2 id=
"icronjob-interface"><code>ICronjob
</code> Interface
<a class=
"headerlink" href=
"#icronjob-interface" title=
"Permanent link">#
</a></h2>
2021 <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.
2022 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>
2023 <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>
2024 <h2 id=
"executing-cronjobs-through-cli">Executing Cronjobs Through CLI
<a class=
"headerlink" href=
"#executing-cronjobs-through-cli" title=
"Permanent link">#
</a></h2>
2025 <p>Cronjobs can be executed through the command-line interface (CLI):
</p>
2026 <div class=
"highlight"><pre><span></span><code>php /path/to/wcf/cli.php
<< 'EOT
'
2037 <div class=
"md-source-date">
2040 Last update:
2021-
01-
08
2059 <footer class=
"md-footer">
2061 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2063 <a href=
"../comments/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2064 <div class=
"md-footer__button md-icon">
2065 <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>
2067 <div class=
"md-footer__title">
2068 <div class=
"md-ellipsis">
2069 <span class=
"md-footer__direction">
2078 <a href=
"../events/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2079 <div class=
"md-footer__title">
2080 <div class=
"md-ellipsis">
2081 <span class=
"md-footer__direction">
2087 <div class=
"md-footer__button md-icon">
2088 <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>
2094 <div class=
"md-footer-meta md-typeset">
2095 <div class=
"md-footer-meta__inner md-grid">
2096 <div class=
"md-footer-copyright">
2098 <div class=
"md-footer-copyright__highlight">
2099 Copyright ©
2020 WoltLab GmbH
2103 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2108 <div class=
"md-footer-copyright">
2109 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2110 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2117 <div class=
"md-dialog" data-md-component=
"dialog">
2118 <div class=
"md-dialog__inner md-typeset"></div>
2120 <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>
2123 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>