Skip to content

Commit 5cc744f

Browse files
authored
Adds documentation for WordPress.WP.CronInterval (#1823)
Adds documentation for WordPress.WP.CronInterval
2 parents 7a626f3 + 86d7dbc commit 5cc744f

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<documentation title="Cron interval">
2+
<standard>
3+
<![CDATA[
4+
Cron schedules running more often than once every 15 minutes are discouraged. Crons running that frequently can negatively impact the performance of a site.
5+
]]>
6+
</standard>
7+
<code_comparison>
8+
<code title="Valid: Cron schedule is created to run once every hour.">
9+
<![CDATA[
10+
function adjust_schedules( $schedules ) {
11+
$schedules['every_hour'] = array(
12+
'interval' => <em>HOUR_IN_SECONDS</em>,
13+
'display' => __( 'Every hour' )
14+
);
15+
return $schedules;
16+
}
17+
18+
add_filter(
19+
'cron_schedules',
20+
'adjust_schedules'
21+
);
22+
]]>
23+
</code>
24+
<code title="Invalid: Cron schedule is added to run more than once per 15 minutes.">
25+
<![CDATA[
26+
function adjust_schedules( $schedules ) {
27+
$schedules['every_9_mins'] = array(
28+
'interval' => <em>9 * 60</em>,
29+
'display' => __( 'Every 9 minutes' )
30+
);
31+
return $schedules;
32+
}
33+
34+
add_filter(
35+
'cron_schedules',
36+
'adjust_schedules'
37+
);
38+
]]>
39+
</code>
40+
</code_comparison>
41+
</documentation>

0 commit comments

Comments
 (0)