Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#37769 closed enhancement (fixed)

Clarify descriptions for Cron API functions

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

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 10 years ago.

Download all attachments as: .zip

Change History (3)

@johnbillion
10 years ago

#1 @johnbillion
10 years ago

  • Keywords has-patch added; needs-patch needs-docs removed
  • Milestone Awaiting Review4.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
10 years ago

  • Owner set to wonderboymusic
  • Resolutionfixed
  • Status newclosed

In 38357:

Cron: clarify descriptions for Cron API functions.

Props johnbillion.
Fixes #37769.

Note: See TracTickets for help on using tickets.