<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"

"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />

<title>[53000] trunk/src/wp-includes/general-template.php: Docs: Correct the documented return types for date and time related functions and filters.</title>

</head>

<body>

<style type="text/css"><!--

#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }

#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }

#msg dt:after { content:':';}

#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }

#msg dl a { font-weight: bold}

#msg dl a:link    { color:#fc3; }

#msg dl a:active  { color:#ff0; }

#msg dl a:visited { color:#cc6; }

h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }

#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }

#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }

#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }

#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }

#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }

#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }

#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }

#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }

#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }

#logmsg pre { background: #eee; padding: 1em; }

#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}

#logmsg dl { margin: 0; }

#logmsg dt { font-weight: bold; }

#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }

#logmsg dd:before { content:'\00bb';}

#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }

#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }

#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }

#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }

#logmsg table th.Corner { text-align: left; }

#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }

#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }

#patch { width: 100%; }

#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}

#patch .propset h4, #patch .binary h4 {margin:0;}

#patch pre {padding:0;line-height:1.2em;margin:0;}

#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}

#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}

#patch span {display:block;padding:0 10px;}

#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}

#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}

#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}

#patch .lines, .info {color:#888;background:#fff;}

--></style>

<div id="msg">

<dl class="meta" style="font-size: 105%">

<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53000">53000</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53000","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-03-28 10:23:03 +0000 (Mon, 28 Mar 2022)</dd>

</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Correct the documented return types for date and time related functions and filters.

See <a href="https://core.trac.wordpress.org/ticket/54729">#54729</a></pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludesgeneraltemplatephp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/general-template.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php        2022-03-28 09:43:57 UTC (rev 52999)

+++ trunk/src/wp-includes/general-template.php  2022-03-28 10:23:03 UTC (rev 53000)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2555,7 +2555,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string      $format Optional. PHP date format. Defaults to the 'date_format' option.

<span class="cx" style="display: block; padding: 0 10px">  * @param int|WP_Post $post   Optional. Post ID or WP_Post object. Default current post.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string|false Date the current post was written. False on failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|int|false Date the current post was written. False on failure.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_the_date( $format = '', $post = null ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $post = get_post( $post );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2573,9 +2573,9 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 3.0.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string      $the_date The formatted date.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string|int  $the_date Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.

</ins><span class="cx" style="display: block; padding: 0 10px">          * @param string      $format   PHP date format.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param int|WP_Post $post     The post object or ID.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param WP_Post     $post     The post object.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        return apply_filters( 'get_the_date', $the_date, $format, $post );

</span><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2699,10 +2699,10 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 1.5.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string      $the_time The formatted time.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string|int  $the_time Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.

</ins><span class="cx" style="display: block; padding: 0 10px">          * @param string      $format   Format to use for retrieving the time the post

<span class="cx" style="display: block; padding: 0 10px">         *                              was written. Accepts 'G', 'U', or PHP date format.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param int|WP_Post $post     WP_Post object or ID.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param WP_Post     $post     Post object.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        return apply_filters( 'get_the_time', $the_time, $format, $post );

</span><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2756,10 +2756,10 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.6.0

</span><span class="cx" style="display: block; padding: 0 10px">         *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param string $time   The formatted time.

-        * @param string $format Format to use for retrieving the time the post was written.

-        *                       Accepts 'G', 'U', or PHP date format. Default 'U'.

-        * @param bool   $gmt    Whether to retrieve the GMT time. Default false.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param string|int $time   Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.

+        * @param string     $format Format to use for retrieving the time the post was written.

+        *                           Accepts 'G', 'U', or PHP date format.

+        * @param bool       $gmt    Whether to retrieve the GMT time.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        return apply_filters( 'get_post_time', $time, $format, $gmt );

</span><span class="cx" style="display: block; padding: 0 10px"> }

</span></span></pre>

</div>

</div>

</body>

</html>