<!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>[47461] trunk/src: Docs: Various docblock corrections and improvements.</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/47461">47461</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/47461","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>2020-03-16 18:38:03 +0000 (Mon, 16 Mar 2020)</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: Various docblock corrections and improvements.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasscustomimageheaderphp">trunk/src/wp-admin/includes/class-custom-image-header.php</a></li>
<li><a href="#trunksrcwpadminincludesimagephp">trunk/src/wp-admin/includes/image.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasscustomimageheaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-custom-image-header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-custom-image-header.php 2020-03-16 12:26:00 UTC (rev 47460)
+++ trunk/src/wp-admin/includes/class-custom-image-header.php 2020-03-16 18:38:03 UTC (rev 47461)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1244,7 +1244,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $object Attachment object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $cropped Cropped image URL.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $cropped File path to cropped image.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int Attachment ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> final public function insert_attachment( $object, $cropped ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesimagephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/image.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/image.php 2020-03-16 12:26:00 UTC (rev 47460)
+++ trunk/src/wp-admin/includes/image.php 2020-03-16 18:38:03 UTC (rev 47461)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -533,7 +533,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $image_attachment An array of parameters to create the thumbnail.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $metadata Current attachment metadata.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $uploaded An array containing the thumbnail path and url.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $uploaded {
+ * Information about the newly-uploaded file.
+ *
+ * @type string $file Filename of the newly-uploaded file.
+ * @type string $url URL of the uploaded file.
+ * @type string $type File type.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $image_attachment = apply_filters( 'attachment_thumbnail_args', $image_attachment, $metadata, $uploaded );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></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/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2020-03-16 12:26:00 UTC (rev 47460)
+++ trunk/src/wp-includes/formatting.php 2020-03-16 18:38:03 UTC (rev 47461)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3499,7 +3499,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Given a date in the timezone of the site, returns that date in UTC timezone.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given a date in the timezone of the site, returns that date in UTC.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Requires and returns a date in the Y-m-d H:i:s format.
</span><span class="cx" style="display: block; padding: 0 10px"> * Return format can be overridden using the $format parameter.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3508,7 +3508,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string The date to be converted, in the timezone of the site.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Formatted version of the date, in UTC timezone.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Formatted version of the date, in UTC.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $datetime = date_create( $string, wp_timezone() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3521,7 +3521,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Given a date in UTC timezone, returns that date in the timezone of the site.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given a date in UTC or GMT timezone, returns that date in the timezone of the site.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Requires and returns a date in the Y-m-d H:i:s format.
</span><span class="cx" style="display: block; padding: 0 10px"> * Return format can be overridden using the $format parameter.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3528,7 +3528,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string The date to be converted, in UTC timezone.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $string The date to be converted, in UTC or GMT timezone.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Formatted version of the date, in the site's timezone.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3543,7 +3543,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Computes an offset in seconds from an iso8601 timezone.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given an ISO 8601 timezone, returns its UTC offset in seconds.
</ins><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"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3564,7 +3564,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Converts an iso8601 (Ymd\TH:i:sO) date to MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given an ISO 8601 (Ymd\TH:i:sO) date, returns a MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
</ins><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"> *
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2020-03-16 12:26:00 UTC (rev 47460)
+++ trunk/src/wp-includes/functions.php 2020-03-16 18:38:03 UTC (rev 47461)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2616,7 +2616,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param null|string $deprecated Never used. Set to null.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $bits File content
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array {
+ * Information about the newly-uploaded file.
+ *
+ * @type string $file Filename of the newly-uploaded file.
+ * @type string $url URL of the uploaded file.
+ * @type string $type File type.
+ * @type string|false $error Error message, if there has been an error.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $deprecated ) ) {
</span></span></pre></div>
<a id="trunksrcwpincludespluggablephp"></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/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/pluggable.php 2020-03-16 12:26:00 UTC (rev 47460)
+++ trunk/src/wp-includes/pluggable.php 2020-03-16 18:38:03 UTC (rev 47461)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2643,7 +2643,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters whether to retrieve the avatar URL early.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Allows the HTML for a user's avatar to be returned early.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Passing a non-null value will effectively short-circuit get_avatar(), passing
</span><span class="cx" style="display: block; padding: 0 10px"> * the value through the {@see 'get_avatar'} filter and returning early.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2651,7 +2651,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $avatar HTML for the user's avatar. Default null.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
</ins><span class="cx" style="display: block; padding: 0 10px"> * user email, WP_User object, WP_Post object, or WP_Comment object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Arguments passed to get_avatar_url(), after processing.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2702,17 +2702,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the avatar to retrieve.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the HTML for a user's avatar.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $avatar <img> tag for the user's avatar.
- * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $avatar HTML for the user's avatar.
+ * @param mixed $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
</ins><span class="cx" style="display: block; padding: 0 10px"> * user email, WP_User object, WP_Post object, or WP_Comment object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $size Square avatar width and height in pixels to retrieve.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $default URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $alt Alternative text to use in the avatar image tag. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Arguments passed to get_avatar_data(), after processing.
</span></span></pre></div>
<a id="trunksrcwpincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2020-03-16 12:26:00 UTC (rev 47460)
+++ trunk/src/wp-includes/post.php 2020-03-16 18:38:03 UTC (rev 47461)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -515,8 +515,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $file Path to attached file.
- * @param int $attachment_id Attachment ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|false $file The file path to where the attached file should be, false otherwise.
+ * @param int $attachment_id Attachment ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_attached_file', $file, $attachment_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>