WordPress.org

Make WordPress Core

Opened 10 months ago

Closed 8 months ago

#45323 closed defect (bug) (fixed)

Docs: parameter name is wrong in the return descriptions of get_the_time(), get_post_time(), and get_post_modified_time()

Reported by: behzod Owned by: desrosj
Milestone: 5.1 Priority: normal
Severity: normal Version: 5.1
Component: Date/Time Keywords: has-patch commit
Focuses: docs Cc:

Description

Parameter name ($id) is wrong in the return descriptions of get_the_time(), get_post_time(), and get_post_modified_time()

current description is:

* @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.

must be:

* @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.

Attachments (1)

typo-in-the-docblocks.diff (2.2 KB) - added by behzod 10 months ago.
patch

Download all attachments as: .zip

Change History (5)

#1 @behzod
10 months ago

  • Focuses docs added

#2 @SergeyBiryukov
10 months ago

  • Component changed from General to Date/Time
  • Keywords commit added
  • Milestone changed from Awaiting Review to 5.1
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#3 @desrosj
8 months ago

  • Owner changed from SergeyBiryukov to desrosj

#4 @desrosj
8 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 44592:

Docs: Update inaccurate return descriptions.

In the @return tag description for get_post_modified_time(), get_the_time(), and get_post_time(), the $d parameter is incorrectly referred to as $id.

Props behzod.
Fixes #45323.

Note: See TracTickets for help on using tickets.