Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds documentation for WordPress.WP.CronInterval #1823

Merged
merged 1 commit into from Nov 4, 2019
Merged

Adds documentation for WordPress.WP.CronInterval #1823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 41 additions & 0 deletions WordPress/Docs/WP/CronIntervalStandard.xml
View file
Open in desktop
@@ -0,0 +1,41 @@
<documentation title="Cron interval">
<standard>
<![CDATA[
Cron schedules running more often than once every 15 minutes are discouraged. Crons running that frequently can negatively impact the performance of a site.
]]>
</standard>
<code_comparison>
<code title="Valid: Cron schedule is created to run once every hour.">
<![CDATA[
function adjust_schedules( $schedules ) {
$schedules['every_hour'] = array(
'interval' => <em>HOUR_IN_SECONDS</em>,
'display' => __( 'Every hour' )
);
return $schedules;
}

add_filter(
'cron_schedules',
'adjust_schedules'
);
]]>
</code>
<code title="Invalid: Cron schedule is added to run more than once per 15 minutes.">
<![CDATA[
function adjust_schedules( $schedules ) {
$schedules['every_9_mins'] = array(
'interval' => <em>9 * 60</em>,
'display' => __( 'Every 9 minutes' )
);
return $schedules;
}

add_filter(
'cron_schedules',
'adjust_schedules'
);
]]>
</code>
</code_comparison>
</documentation>