WordPress.org
Get WordPress

Make WordPress Core

Opened 13 years ago

Closed 13 years ago

#26682 closed defect (bug) (fixed)

Improve phpdocs for get_the_time and get_post_time

Reported by: ruud@… Owned by: DrewAPicture
Priority: normal Milestone: 3.9
Component: Posts, Post Types Version:
Severity: normal Keywords: has-patch commit
Cc: Focuses: docs, template

Description

get_the_time utilizes get_the_post, get_the_post uses mysql2date, mysql2date can return a string or an int in the specific case that an Unix timestamp is requested.

( * @return string|int Formatted date string, or Unix timestamp. )

In the added patch I've changed the inline documentation to better reflect that possibility.

Of course via the filters they can return also other types.., but I don't know how that is supposed to be handled with the inline docs.

Attachments (2)

get_the_time_inline_docs.patch​ (1.1 KB ) - added by ruud@… 13 years ago.
get_the_time, get_post_time inline docs patch
26682.diff​ (2.2 KB ) - added by DrewAPicture 13 years ago.
Other phpdoc fixes

Download all attachments as: .zip

Change History (10)

@ruud@…
13 years ago

get_the_time, get_post_time inline docs patch

#1 @ruud@…
13 years ago

  • Keywords has-patch added

#2 @ruud@…
13 years ago

  • Cc ruud@… added

#3 @kpdesign
13 years ago

  • Type enhancement → defect (bug)
  • Version 3.8

#4 @DrewAPicture
13 years ago

  • Keywords commit added
  • Milestone Awaiting Review → 3.9
  • Summary get_the_time and get_post_time both say to only return a string when in fact they can also return an int. → Improve phpdocs for get_the_time and get_post_time

26682.diff​ also fixes some other issues with the phpdocs for these two functions. Might as well fix them while we're in there :)

@DrewAPicture
13 years ago

Other phpdoc fixes

#5 @ruud@…
13 years ago

Thanks DrewAPicture, for picking this up.
Does this mean its actually getting into version 3.9? :)

#6 @nacin
13 years ago

  • Component Inline Docs → Template
  • Focuses docs added

#7 @nacin
13 years ago

  • Component Template → Posts, Post Types
  • Focuses template added

#8 @DrewAPicture
13 years ago

  • Owner set to DrewAPicture
  • Resolution → fixed
  • Status new → closed

In 27148:

Improve inline documenation for get_the_time() and `get_post_time().

Props ruud@joyo for the initial patch.
Fixes #26682.

Note: See TracTickets for help on using tickets.