<!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>[53317] trunk/src/wp-includes: Docs: Formatting corrections for various docblocks.</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/53317">53317</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/53317","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-04-29 19:22:56 +0000 (Fri, 29 Apr 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: Formatting corrections for various docblocks.
See <a href="https://core.trac.wordpress.org/ticket/54729">#54729</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpimageeditorgdphp">trunk/src/wp-includes/class-wp-image-editor-gd.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorimagickphp">trunk/src/wp-includes/class-wp-image-editor-imagick.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorphp">trunk/src/wp-includes/class-wp-image-editor.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswpresturldetailscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpimageeditorgdphp"></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/class-wp-image-editor-gd.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor-gd.php 2022-04-29 19:15:57 UTC (rev 53316)
+++ trunk/src/wp-includes/class-wp-image-editor-gd.php 2022-04-29 19:22:56 UTC (rev 53317)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,7 +233,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If one of the two is set to null, the resize will
</span><span class="cx" style="display: block; padding: 0 10px"> * maintain aspect ratio according to the source image.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $size {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array ...$0 {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Array of height, width values, and whether to crop.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $width Image width. Optional if `$height` is specified.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorimagickphp"></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/class-wp-image-editor-imagick.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor-imagick.php 2022-04-29 19:15:57 UTC (rev 53316)
+++ trunk/src/wp-includes/class-wp-image-editor-imagick.php 2022-04-29 19:22:56 UTC (rev 53317)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -444,7 +444,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If one of the two is set to null, the resize will
</span><span class="cx" style="display: block; padding: 0 10px"> * maintain aspect ratio according to the provided dimension.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $size {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array ...$0 {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Array of height, width values, and whether to crop.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $width Image width. Optional if `$height` is specified.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorphp"></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/class-wp-image-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor.php 2022-04-29 19:15:57 UTC (rev 53316)
+++ trunk/src/wp-includes/class-wp-image-editor.php 2022-04-29 19:22:56 UTC (rev 53317)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,7 +109,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $sizes {
</span><span class="cx" style="display: block; padding: 0 10px"> * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $size {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array ...$0 {
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type int $width Image width.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $height Image height.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $crop Optional. Whether to crop the image. Default false.
</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 2022-04-29 19:15:57 UTC (rev 53316)
+++ trunk/src/wp-includes/functions.php 2022-04-29 19:22:56 UTC (rev 53317)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4515,8 +4515,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $options {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Options to be used with `json_decode()`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool associative Optional. When `true`, JSON objects will be returned as associative arrays.
- * When `false`, JSON objects will be returned as objects.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $associative Optional. When `true`, JSON objects will be returned as associative arrays.
+ * When `false`, JSON objects will be returned as objects.
</ins><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"> * @return mixed Returns the value encoded in JSON in appropriate PHP type.
</span></span></pre></div>
<a id="trunksrcwpincludesoptionphp"></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/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2022-04-29 19:15:57 UTC (rev 53316)
+++ trunk/src/wp-includes/option.php 2022-04-29 19:22:56 UTC (rev 53317)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,10 +28,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * as string equivalents.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Exceptions:
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * 1. When the option has not been saved in the database, the `$default` value
</span><span class="cx" style="display: block; padding: 0 10px"> * is returned if provided. If not, boolean `false` is returned.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 2. When one of the Options API filters is used: {@see 'pre_option_{$option}'},
- * {@see 'default_option_{$option}'}, or {@see 'option_{$option}'}, the returned
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 2. When one of the Options API filters is used: {@see 'pre_option_$option'},
+ * {@see 'default_option_$option'}, or {@see 'option_$option'}, the returned
</ins><span class="cx" style="display: block; padding: 0 10px"> * value may not match the expected type.
</span><span class="cx" style="display: block; padding: 0 10px"> * 3. When the option has just been saved in the database, and get_option()
</span><span class="cx" style="display: block; padding: 0 10px"> * is used right after, non-string scalar and null values are not converted to
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,28 +40,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Examples:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * When adding options like this: `add_option( 'my_option_name', 'value' );`
- * and then retrieving them with `get_option( 'my_option_name' );`, the returned
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * When adding options like this: `add_option( 'my_option_name', 'value' )`
+ * and then retrieving them with `get_option( 'my_option_name' )`, the returned
</ins><span class="cx" style="display: block; padding: 0 10px"> * values will be:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * `false` returns `string(0) ""`
- * `true` returns `string(1) "1"`
- * `0` returns `string(1) "0"`
- * `1` returns `string(1) "1"`
- * `'0'` returns `string(1) "0"`
- * `'1'` returns `string(1) "1"`
- * `null` returns `string(0) ""`
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `false` returns `string(0) ""`
+ * - `true` returns `string(1) "1"`
+ * - `0` returns `string(1) "0"`
+ * - `1` returns `string(1) "1"`
+ * - `'0'` returns `string(1) "0"`
+ * - `'1'` returns `string(1) "1"`
+ * - `null` returns `string(0) ""`
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When adding options with non-scalar values like
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * `add_option( 'my_array', array( false, 'str', null ) );`, the returned value
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `add_option( 'my_array', array( false, 'str', null ) )`, the returned value
</ins><span class="cx" style="display: block; padding: 0 10px"> * will be identical to the original as it is serialized before saving
</span><span class="cx" style="display: block; padding: 0 10px"> * it in the database:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * array(3) {
- * [0] => bool(false)
- * [1] => string(3) "str"
- * [2] => NULL
- * }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * array(3) {
+ * [0] => bool(false)
+ * [1] => string(3) "str"
+ * [2] => NULL
+ * }
</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="trunksrcwpincludesrestapiendpointsclasswpresturldetailscontrollerphp"></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/rest-api/endpoints/class-wp-rest-url-details-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php 2022-04-29 19:15:57 UTC (rev 53316)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php 2022-04-29 19:22:56 UTC (rev 53317)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -349,9 +349,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $meta_elements {
</span><span class="cx" style="display: block; padding: 0 10px"> * A multi-dimensional indexed array on success, else empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string[] 0 Meta elements with a content attribute.
- * @type string[] 1 Content attribute's opening quotation mark.
- * @type string[] 2 Content attribute's value for each meta element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string[] $0 Meta elements with a content attribute.
+ * @type string[] $1 Content attribute's opening quotation mark.
+ * @type string[] $2 Content attribute's value for each meta element.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The meta description contents on success. Empty string if not found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -385,9 +385,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $meta_elements {
</span><span class="cx" style="display: block; padding: 0 10px"> * A multi-dimensional indexed array on success, else empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string[] 0 Meta elements with a content attribute.
- * @type string[] 1 Content attribute's opening quotation mark.
- * @type string[] 2 Content attribute's value for each meta element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string[] $0 Meta elements with a content attribute.
+ * @type string[] $1 Content attribute's opening quotation mark.
+ * @type string[] $2 Content attribute's value for each meta element.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The target website URL.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The OG image on success. Empty string if not found.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -527,9 +527,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * A multi-dimensional indexed array on success, else empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string[] 0 Meta elements with a content attribute.
- * @type string[] 1 Content attribute's opening quotation mark.
- * @type string[] 2 Content attribute's value for each meta element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string[] $0 Meta elements with a content attribute.
+ * @type string[] $1 Content attribute's opening quotation mark.
+ * @type string[] $2 Content attribute's value for each meta element.
</ins><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"> private function get_meta_with_content_elements( $html ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -607,9 +607,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $meta_elements {
</span><span class="cx" style="display: block; padding: 0 10px"> * A multi-dimensional indexed array on success, else empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string[] 0 Meta elements with a content attribute.
- * @type string[] 1 Content attribute's opening quotation mark.
- * @type string[] 2 Content attribute's value for each meta element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string[] $0 Meta elements with a content attribute.
+ * @type string[] $1 Content attribute's opening quotation mark.
+ * @type string[] $2 Content attribute's value for each meta element.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $attr Attribute that identifies the element with the target metadata.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $attr_value The attribute's value that identifies the element with the target metadata.
</span></span></pre>
</div>
</div>
</body>
</html>