WordPress.org
Get WordPress

Make WordPress Core

Opened 8 years ago

Closed 8 years ago

#37769 closed enhancement (fixed)

Clarify descriptions for Cron API functions

Reported by: johnbillion's profile johnbillion Owned by: wonderboymusic's profile wonderboymusic
Milestone: 4.7 Priority: normal
Severity: normal Version:
Component: Cron API Keywords: has-patch
Focuses: docs Cc:

Description

The $timestamp parameter for the various WP-Cron functions expects a Unix timestamp (ie. UTC time), not a timestamp but this isn't made super clear.

In addition, the general inline docs for the cron functions needs some improvement.

Attachments (1)

37769.patch​ (8.5 KB) - added by johnbillion 8 years ago.

Download all attachments as: .zip

Change History (3)

@johnbillion
8 years ago

#1 @johnbillion
8 years ago

  • Keywords has-patch added; needs-patch needs-docs removed
  • Milestone changed from Awaiting Review to 4.7

37769.patch​ does the following:

  • Standardises terminology to use 'event' instead of 'hook' or 'cron job'.
  • Clarifies that $timestamp parameters expect a Unix timestamp.
  • Documents the properties of the $event parameter of the schedule_event filter.
  • Other misc improvements.

#2 @wonderboymusic
8 years ago

  • Owner set to wonderboymusic
  • Resolution set to fixed
  • Status changed from new to closed

In 38357:

Cron: clarify descriptions for Cron API functions.

Props johnbillion.
Fixes #37769.

Note: See TracTickets for help on using tickets.