<!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>[58706] trunk/src/wp-includes/rest-api: Docs: Fix typos in various REST API DocBlocks and comments.</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/58706">58706</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/58706","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-11 06:22:51 +0000 (Thu, 11 Jul 2024)</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: Fix typos in various REST API DocBlocks and comments.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/34928">[34928]</a>, <a href="https://core.trac.wordpress.org/changeset/43739">[43739]</a>, <a href="https://core.trac.wordpress.org/changeset/46422">[46422]</a>, <a href="https://core.trac.wordpress.org/changeset/50717">[50717]</a>, <a href="https://core.trac.wordpress.org/changeset/51973">[51973]</a>, <a href="https://core.trac.wordpress.org/changeset/54528">[54528]</a>.
Props antonvlasenko.
Fixes <a href="https://core.trac.wordpress.org/ticket/61593">#61593</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiclasswprestrequestphp">trunk/src/wp-includes/rest-api/class-wp-rest-request.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswpresttermscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswpresturldetailscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapisearchclasswprestpostsearchhandlerphp">trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiclasswprestrequestphp"></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/class-wp-rest-request.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-request.php 2024-07-10 21:23:38 UTC (rev 58705)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-request.php 2024-07-11 06:22:51 UTC (rev 58706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,7 +165,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Canonicalizes the header name.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Ensures that header names are always treated the same regardless of
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * source. Header names are always case insensitive.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * source. Header names are always case-insensitive.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Note that we treat `-` (dashes) and `_` (underscores) as the same
</span><span class="cx" style="display: block; padding: 0 10px"> * character, as per header parsing rules in both Apache and nginx.
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp"></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-attachments-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-attachments-controller.php 2024-07-10 21:23:38 UTC (rev 58705)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2024-07-11 06:22:51 UTC (rev 58706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -450,7 +450,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">- * Performs post processing on an attachment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Performs post-processing on an attachment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -471,7 +471,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">- * Checks if a given request can perform post processing on an attachment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given request can perform post-processing on an attachment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -601,7 +601,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args = $modifier['args'];
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $modifier['type'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'rotate':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Rotation direction: clockwise vs. counter clockwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Rotation direction: clockwise vs. counterclockwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> $rotate = 0 - $args['angle'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 0 !== $rotate ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -661,7 +661,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = "{$image_name}.{$image_ext}";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Create the uploads sub-directory if needed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create the uploads subdirectory if needed.
</ins><span class="cx" style="display: block; padding: 0 10px"> $uploads = wp_upload_dir();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Make the file name unique in the (new) upload directory.
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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-posts-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-posts-controller.php 2024-07-10 21:23:38 UTC (rev 58705)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2024-07-11 06:22:51 UTC (rev 58706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,7 +183,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $required Whether the post requires a password check.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The post been password checked.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool Result of password check taking in to account REST API considerations.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Result of password check taking into account REST API considerations.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function check_password_required( $required, $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $required ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2051,7 +2051,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * By default, WordPress will show password protected posts with a title of
</span><span class="cx" style="display: block; padding: 0 10px"> * "Protected: %s", as the REST API communicates the protected status of a post
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * in a machine readable format, we remove the "Protected: " prefix.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * in a machine-readable format, we remove the "Protected: " prefix.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswpresttermscontrollerphp"></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-terms-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-terms-controller.php 2024-07-10 21:23:38 UTC (rev 58705)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php 2024-07-11 06:22:51 UTC (rev 58706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,7 +164,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</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">- // Otherwise grant access if the post is readable by the logged in user.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Otherwise grant access if the post is readable by the logged-in user.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( 'read_post', $post->ID ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</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 2024-07-10 21:23:38 UTC (rev 58705)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php 2024-07-11 06:22:51 UTC (rev 58706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -347,7 +347,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $meta_elements {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * A multi-dimensional indexed array on success, else empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A multidimensional indexed array on success, else empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $0 Meta elements with a content attribute.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $1 Content attribute's opening quotation mark.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -383,7 +383,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $meta_elements {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * A multi-dimensional indexed array on success, else empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A multidimensional indexed array on success, else empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $0 Meta elements with a content attribute.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $1 Content attribute's opening quotation mark.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -525,7 +525,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $html The string of HTML to be parsed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * A multi-dimensional indexed array on success, else empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A multidimensional indexed array on success, else empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $0 Meta elements with a content attribute.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $1 Content attribute's opening quotation mark.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,7 +588,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"> * These are the options:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - i : case insensitive
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - i : case-insensitive
</ins><span class="cx" style="display: block; padding: 0 10px"> * - s : allows newline characters for the . match (needed for multiline elements)
</span><span class="cx" style="display: block; padding: 0 10px"> * - U means non-greedy matching
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -637,7 +637,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"> * These are the options:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - i : case insensitive
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - i : case-insensitive
</ins><span class="cx" style="display: block; padding: 0 10px"> * - s : allows newline characters for the . match (needed for multiline elements)
</span><span class="cx" style="display: block; padding: 0 10px"> * - U means non-greedy matching
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesrestapisearchclasswprestpostsearchhandlerphp"></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/search/class-wp-rest-post-search-handler.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php 2024-07-10 21:23:38 UTC (rev 58705)
+++ trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php 2024-07-11 06:22:51 UTC (rev 58706)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,7 +187,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * By default, WordPress will show password protected posts with a title of
</span><span class="cx" style="display: block; padding: 0 10px"> * "Protected: %s". As the REST API communicates the protected status of a post
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * in a machine readable format, we remove the "Protected: " prefix.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * in a machine-readable format, we remove the "Protected: " prefix.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>