3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>Cronjobs - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.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=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#cronjobs" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <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>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <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
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <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>
122 <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>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.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>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../../getting-started/" class=
"md-nav__link">
226 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
229 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
231 <label class=
"md-nav__link" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
235 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
236 <label class=
"md-nav__title" for=
"__nav_2">
237 <span class=
"md-nav__icon md-icon"></span>
240 <ul class=
"md-nav__list" data-md-scrollfix
>
246 <li class=
"md-nav__item">
247 <a href=
"../../pages/" class=
"md-nav__link">
258 <li class=
"md-nav__item">
259 <a href=
"../../database-objects/" class=
"md-nav__link">
270 <li class=
"md-nav__item">
271 <a href=
"../../database-access/" class=
"md-nav__link">
282 <li class=
"md-nav__item">
283 <a href=
"../../exceptions/" class=
"md-nav__link">
297 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
300 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
302 <label class=
"md-nav__link" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
306 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
307 <label class=
"md-nav__title" for=
"__nav_2_5">
308 <span class=
"md-nav__icon md-icon"></span>
311 <ul class=
"md-nav__list" data-md-scrollfix
>
317 <li class=
"md-nav__item">
318 <a href=
"../caches/" class=
"md-nav__link">
329 <li class=
"md-nav__item">
330 <a href=
"../comments/" class=
"md-nav__link">
343 <li class=
"md-nav__item md-nav__item--active">
345 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
350 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
352 <span class=
"md-nav__icon md-icon"></span>
355 <a href=
"./" class=
"md-nav__link md-nav__link--active">
360 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
366 <label class=
"md-nav__title" for=
"__toc">
367 <span class=
"md-nav__icon md-icon"></span>
370 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
372 <li class=
"md-nav__item">
373 <a href=
"#example" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"#icronjob-interface" class=
"md-nav__link">
386 <li class=
"md-nav__item">
387 <a href=
"#executing-cronjobs-through-cli" class=
"md-nav__link">
388 Executing Cronjobs Through CLI
405 <li class=
"md-nav__item">
406 <a href=
"../events/" class=
"md-nav__link">
418 <li class=
"md-nav__item md-nav__item--nested">
421 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
423 <label class=
"md-nav__link" for=
"__nav_2_5_5">
425 <span class=
"md-nav__icon md-icon"></span>
427 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
428 <label class=
"md-nav__title" for=
"__nav_2_5_5">
429 <span class=
"md-nav__icon md-icon"></span>
432 <ul class=
"md-nav__list" data-md-scrollfix
>
438 <li class=
"md-nav__item">
439 <a href=
"../form_builder/overview/" class=
"md-nav__link">
450 <li class=
"md-nav__item">
451 <a href=
"../form_builder/structure/" class=
"md-nav__link">
462 <li class=
"md-nav__item">
463 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
474 <li class=
"md-nav__item">
475 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
486 <li class=
"md-nav__item">
487 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
504 <li class=
"md-nav__item">
505 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
506 Package Installation Plugins
516 <li class=
"md-nav__item">
517 <a href=
"../user_activity_points/" class=
"md-nav__link">
528 <li class=
"md-nav__item">
529 <a href=
"../user_notifications/" class=
"md-nav__link">
540 <li class=
"md-nav__item">
541 <a href=
"../sitemaps/" class=
"md-nav__link">
558 <li class=
"md-nav__item">
559 <a href=
"../../code-style/" class=
"md-nav__link">
570 <li class=
"md-nav__item">
571 <a href=
"../../apps/" class=
"md-nav__link">
582 <li class=
"md-nav__item">
583 <a href=
"../../gdpr/" class=
"md-nav__link">
604 <li class=
"md-nav__item md-nav__item--nested">
607 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
609 <label class=
"md-nav__link" for=
"__nav_3">
610 Languages, Templates & CSS
611 <span class=
"md-nav__icon md-icon"></span>
613 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
614 <label class=
"md-nav__title" for=
"__nav_3">
615 <span class=
"md-nav__icon md-icon"></span>
616 Languages, Templates & CSS
618 <ul class=
"md-nav__list" data-md-scrollfix
>
624 <li class=
"md-nav__item">
625 <a href=
"../../../view/languages/" class=
"md-nav__link">
636 <li class=
"md-nav__item">
637 <a href=
"../../../view/templates/" class=
"md-nav__link">
648 <li class=
"md-nav__item">
649 <a href=
"../../../view/css/" class=
"md-nav__link">
670 <li class=
"md-nav__item md-nav__item--nested">
673 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
675 <label class=
"md-nav__link" for=
"__nav_4">
677 <span class=
"md-nav__icon md-icon"></span>
679 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
680 <label class=
"md-nav__title" for=
"__nav_4">
681 <span class=
"md-nav__icon md-icon"></span>
684 <ul class=
"md-nav__list" data-md-scrollfix
>
690 <li class=
"md-nav__item">
691 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
703 <li class=
"md-nav__item md-nav__item--nested">
706 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
708 <label class=
"md-nav__link" for=
"__nav_4_2">
710 <span class=
"md-nav__icon md-icon"></span>
712 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
713 <label class=
"md-nav__title" for=
"__nav_4_2">
714 <span class=
"md-nav__icon md-icon"></span>
717 <ul class=
"md-nav__list" data-md-scrollfix
>
723 <li class=
"md-nav__item">
724 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
759 <li class=
"md-nav__item">
760 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
771 <li class=
"md-nav__item">
772 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
783 <li class=
"md-nav__item">
784 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
795 <li class=
"md-nav__item">
796 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
807 <li class=
"md-nav__item">
808 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
809 Browser and Screen Sizes
819 <li class=
"md-nav__item">
820 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
837 <li class=
"md-nav__item">
838 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
849 <li class=
"md-nav__item">
850 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
861 <li class=
"md-nav__item">
862 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
883 <li class=
"md-nav__item md-nav__item--nested">
886 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
888 <label class=
"md-nav__link" for=
"__nav_5">
890 <span class=
"md-nav__icon md-icon"></span>
892 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
893 <label class=
"md-nav__title" for=
"__nav_5">
894 <span class=
"md-nav__icon md-icon"></span>
897 <ul class=
"md-nav__list" data-md-scrollfix
>
903 <li class=
"md-nav__item">
904 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
916 <li class=
"md-nav__item md-nav__item--nested">
919 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
921 <label class=
"md-nav__link" for=
"__nav_5_2">
923 <span class=
"md-nav__icon md-icon"></span>
925 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
926 <label class=
"md-nav__title" for=
"__nav_5_2">
927 <span class=
"md-nav__icon md-icon"></span>
930 <ul class=
"md-nav__list" data-md-scrollfix
>
936 <li class=
"md-nav__item">
937 <a href=
"../../../package/pip/" class=
"md-nav__link">
948 <li class=
"md-nav__item">
949 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
960 <li class=
"md-nav__item">
961 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
972 <li class=
"md-nav__item">
973 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
984 <li class=
"md-nav__item">
985 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
996 <li class=
"md-nav__item">
997 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1008 <li class=
"md-nav__item">
1009 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1020 <li class=
"md-nav__item">
1021 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1032 <li class=
"md-nav__item">
1033 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1044 <li class=
"md-nav__item">
1045 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1056 <li class=
"md-nav__item">
1057 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1068 <li class=
"md-nav__item">
1069 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1080 <li class=
"md-nav__item">
1081 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1092 <li class=
"md-nav__item">
1093 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1104 <li class=
"md-nav__item">
1105 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1116 <li class=
"md-nav__item">
1117 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1128 <li class=
"md-nav__item">
1129 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1140 <li class=
"md-nav__item">
1141 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1142 objectTypeDefinition
1152 <li class=
"md-nav__item">
1153 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1164 <li class=
"md-nav__item">
1165 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1176 <li class=
"md-nav__item">
1177 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1188 <li class=
"md-nav__item">
1189 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1212 <li class=
"md-nav__item">
1213 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1224 <li class=
"md-nav__item">
1225 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1236 <li class=
"md-nav__item">
1237 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1272 <li class=
"md-nav__item">
1273 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1284 <li class=
"md-nav__item">
1285 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1286 userNotificationEvent
1296 <li class=
"md-nav__item">
1297 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1308 <li class=
"md-nav__item">
1309 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1326 <li class=
"md-nav__item">
1327 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1348 <li class=
"md-nav__item md-nav__item--nested">
1351 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1353 <label class=
"md-nav__link" for=
"__nav_6">
1355 <span class=
"md-nav__icon md-icon"></span>
1357 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1358 <label class=
"md-nav__title" for=
"__nav_6">
1359 <span class=
"md-nav__icon md-icon"></span>
1362 <ul class=
"md-nav__list" data-md-scrollfix
>
1369 <li class=
"md-nav__item md-nav__item--nested">
1372 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1374 <label class=
"md-nav__link" for=
"__nav_6_1">
1375 Migrating from WSC
5.3
1376 <span class=
"md-nav__icon md-icon"></span>
1378 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1379 <label class=
"md-nav__title" for=
"__nav_6_1">
1380 <span class=
"md-nav__icon md-icon"></span>
1381 Migrating from WSC
5.3
1383 <ul class=
"md-nav__list" data-md-scrollfix
>
1389 <li class=
"md-nav__item">
1390 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1401 <li class=
"md-nav__item">
1402 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1403 Session Handling and Authentication
1413 <li class=
"md-nav__item">
1414 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1425 <li class=
"md-nav__item">
1426 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1437 <li class=
"md-nav__item">
1438 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1439 Third Party Libraries
1456 <li class=
"md-nav__item md-nav__item--nested">
1459 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1461 <label class=
"md-nav__link" for=
"__nav_6_2">
1462 Migrating from WSC
5.2
1463 <span class=
"md-nav__icon md-icon"></span>
1465 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1466 <label class=
"md-nav__title" for=
"__nav_6_2">
1467 <span class=
"md-nav__icon md-icon"></span>
1468 Migrating from WSC
5.2
1470 <ul class=
"md-nav__list" data-md-scrollfix
>
1476 <li class=
"md-nav__item">
1477 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1488 <li class=
"md-nav__item">
1489 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1490 Templates and Languages
1500 <li class=
"md-nav__item">
1501 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1502 Third Party Libraries
1519 <li class=
"md-nav__item md-nav__item--nested">
1522 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1524 <label class=
"md-nav__link" for=
"__nav_6_3">
1525 Migrating from WSC
3.1
1526 <span class=
"md-nav__icon md-icon"></span>
1528 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1529 <label class=
"md-nav__title" for=
"__nav_6_3">
1530 <span class=
"md-nav__icon md-icon"></span>
1531 Migrating from WSC
3.1
1533 <ul class=
"md-nav__list" data-md-scrollfix
>
1539 <li class=
"md-nav__item">
1540 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1558 <li class=
"md-nav__item md-nav__item--nested">
1561 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1563 <label class=
"md-nav__link" for=
"__nav_6_4">
1564 Migrating from WSC
3.0
1565 <span class=
"md-nav__icon md-icon"></span>
1567 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1568 <label class=
"md-nav__title" for=
"__nav_6_4">
1569 <span class=
"md-nav__icon md-icon"></span>
1570 Migrating from WSC
3.0
1572 <ul class=
"md-nav__list" data-md-scrollfix
>
1578 <li class=
"md-nav__item">
1579 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1590 <li class=
"md-nav__item">
1591 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1602 <li class=
"md-nav__item">
1603 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1614 <li class=
"md-nav__item">
1615 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1626 <li class=
"md-nav__item">
1627 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1645 <li class=
"md-nav__item md-nav__item--nested">
1648 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1650 <label class=
"md-nav__link" for=
"__nav_6_5">
1651 Migrating from WCF
2.1
1652 <span class=
"md-nav__icon md-icon"></span>
1654 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1655 <label class=
"md-nav__title" for=
"__nav_6_5">
1656 <span class=
"md-nav__icon md-icon"></span>
1657 Migrating from WCF
2.1
1659 <ul class=
"md-nav__list" data-md-scrollfix
>
1665 <li class=
"md-nav__item">
1666 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1677 <li class=
"md-nav__item">
1678 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1689 <li class=
"md-nav__item">
1690 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1701 <li class=
"md-nav__item">
1702 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1729 <li class=
"md-nav__item md-nav__item--nested">
1732 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1734 <label class=
"md-nav__link" for=
"__nav_7">
1736 <span class=
"md-nav__icon md-icon"></span>
1738 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1739 <label class=
"md-nav__title" for=
"__nav_7">
1740 <span class=
"md-nav__icon md-icon"></span>
1743 <ul class=
"md-nav__list" data-md-scrollfix
>
1750 <li class=
"md-nav__item md-nav__item--nested">
1753 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1755 <label class=
"md-nav__link" for=
"__nav_7_1">
1757 <span class=
"md-nav__icon md-icon"></span>
1759 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1760 <label class=
"md-nav__title" for=
"__nav_7_1">
1761 <span class=
"md-nav__icon md-icon"></span>
1764 <ul class=
"md-nav__list" data-md-scrollfix
>
1770 <li class=
"md-nav__item">
1771 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1782 <li class=
"md-nav__item">
1783 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1794 <li class=
"md-nav__item">
1795 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1806 <li class=
"md-nav__item">
1807 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1834 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1835 <div class=
"md-sidebar__scrollwrap">
1836 <div class=
"md-sidebar__inner">
1838 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1844 <label class=
"md-nav__title" for=
"__toc">
1845 <span class=
"md-nav__icon md-icon"></span>
1848 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1850 <li class=
"md-nav__item">
1851 <a href=
"#example" class=
"md-nav__link">
1857 <li class=
"md-nav__item">
1858 <a href=
"#icronjob-interface" class=
"md-nav__link">
1864 <li class=
"md-nav__item">
1865 <a href=
"#executing-cronjobs-through-cli" class=
"md-nav__link">
1866 Executing Cronjobs Through CLI
1879 <div class=
"md-content" data-md-component=
"content">
1880 <article class=
"md-content__inner md-typeset">
1883 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/master/docs/php/api/cronjobs.md" title=
"Edit this page" class=
"md-content__button md-icon">
1884 <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>
1888 <h1 id=
"cronjobs">Cronjobs
<a class=
"headerlink" href=
"#cronjobs" title=
"Permanent link">#
</a></h1>
1889 <p>Cronjobs offer an easy way to execute actions periodically, like cleaning up the database.
</p>
1890 <div class=
"admonition warning">
1891 <p class=
"admonition-title">The execution of cronjobs is not guaranteed but requires someone to access the page with JavaScript enabled.
</p>
1893 <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>
1894 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1895 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
1896 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\cronjob
</span><span class=
"p">;
</span>
1897 <span class=
"k">use
</span> <span class=
"nx">wcf\data\cronjob\Cronjob
</span><span class=
"p">;
</span>
1898 <span class=
"k">use
</span> <span class=
"nx">wcf\system\WCF
</span><span class=
"p">;
</span>
1900 <span class=
"sd">/**
</span>
1901 <span class=
"sd"> * Updates the last activity timestamp in the user table.
</span>
1902 <span class=
"sd"> *
</span>
1903 <span class=
"sd"> * @author Marcel Werk
</span>
1904 <span class=
"sd"> * @copyright
2001-
2016 WoltLab GmbH
</span>
1905 <span class=
"sd"> * @license GNU Lesser General Public License
<http://opensource.org/licenses/lgpl-license.php
></span>
1906 <span class=
"sd"> * @package WoltLabSuite\Core\System\Cronjob
</span>
1907 <span class=
"sd"> */
</span>
1908 <span class=
"k">class
</span> <span class=
"nc">LastActivityCronjob
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractCronjob
</span> <span class=
"p">{
</span>
1909 <span class=
"sd">/**
</span>
1910 <span class=
"sd"> * @inheritDoc
</span>
1911 <span class=
"sd"> */
</span>
1912 <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>
1913 <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>
1915 <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>
1916 <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>
1917 <span class=
"s2"> SET user_table.lastActivityTime = session.lastActivityTime
</span>
1918 <span class=
"s2"> WHERE user_table.userID = session.userID
</span>
1919 <span class=
"s2"> AND session.userID
<> 0"</span><span class=
"p">;
</span>
1920 <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>
1921 <span class=
"nv">$statement
</span><span class=
"o">-
></span><span class=
"na">execute
</span><span class=
"p">();
</span>
1922 <span class=
"p">}
</span>
1923 <span class=
"p">}
</span>
1925 <h2 id=
"icronjob-interface"><code>ICronjob
</code> Interface
<a class=
"headerlink" href=
"#icronjob-interface" title=
"Permanent link">#
</a></h2>
1926 <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.
1927 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>
1928 <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>
1929 <h2 id=
"executing-cronjobs-through-cli">Executing Cronjobs Through CLI
<a class=
"headerlink" href=
"#executing-cronjobs-through-cli" title=
"Permanent link">#
</a></h2>
1930 <p>Cronjobs can be executed through the command-line interface (CLI):
</p>
1931 <div class=
"highlight"><pre><span></span><code>php /path/to/wcf/cli.php
<< 'EOT
'
1950 <footer class=
"md-footer">
1952 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1954 <a href=
"../comments/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1955 <div class=
"md-footer__button md-icon">
1956 <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>
1958 <div class=
"md-footer__title">
1959 <div class=
"md-ellipsis">
1960 <span class=
"md-footer__direction">
1969 <a href=
"../events/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1970 <div class=
"md-footer__title">
1971 <div class=
"md-ellipsis">
1972 <span class=
"md-footer__direction">
1978 <div class=
"md-footer__button md-icon">
1979 <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>
1985 <div class=
"md-footer-meta md-typeset">
1986 <div class=
"md-footer-meta__inner md-grid">
1987 <div class=
"md-footer-copyright">
1989 <div class=
"md-footer-copyright__highlight">
1990 Copyright ©
2020 WoltLab GmbH
1994 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1999 <div class=
"md-footer-copyright">
2000 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2001 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2008 <div class=
"md-dialog" data-md-component=
"dialog">
2009 <div class=
"md-dialog__inner md-typeset"></div>
2011 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2014 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>