<!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>[52242] trunk: Docs: Miscellaneous DocBlock corrections.</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/52242">52242</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/52242","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>2021-11-24 23:58:20 +0000 (Wed, 24 Nov 2021)</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: Miscellaneous DocBlock corrections.
See <a href="https://core.trac.wordpress.org/ticket/53399">#53399</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjsmediaviewsmodaljs">trunk/src/js/media/views/modal.js</a></li>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunitincludesmockinvokablephp">trunk/tests/phpunit/includes/mock-invokable.php</a></li>
<li><a href="#trunktestsphpunitincludesspyrestserverphp">trunk/tests/phpunit/includes/spy-rest-server.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesFilephp">trunk/tests/phpunit/tests/admin/includesFile.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjsmediaviewsmodaljs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/views/modal.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/views/modal.js 2021-11-24 14:49:24 UTC (rev 52241)
+++ trunk/src/js/media/views/modal.js 2021-11-24 23:58:20 UTC (rev 52242)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,7 +138,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Enable page scrolling.
</span><span class="cx" style="display: block; padding: 0 10px"> $( 'body' ).removeClass( 'modal-open' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Hide the modal element by adding display none.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Hide the modal element by adding display:none.
</ins><span class="cx" style="display: block; padding: 0 10px"> this.$el.hide();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span></span></pre></div>
<a id="trunksrcwpadminincludesfilephp"></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/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php 2021-11-24 14:49:24 UTC (rev 52241)
+++ trunk/src/wp-admin/includes/file.php 2021-11-24 23:58:20 UTC (rev 52242)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1194,8 +1194,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tmpfname_disposition = '';
</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">- // Potential file name must be valid string
- if ( $tmpfname_disposition && is_string( $tmpfname_disposition ) && ( 0 === validate_file( $tmpfname_disposition ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Potential file name must be valid string.
+ if ( $tmpfname_disposition && is_string( $tmpfname_disposition )
+ && ( 0 === validate_file( $tmpfname_disposition ) )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( rename( $tmpfname, $tmpfname_disposition ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $tmpfname = $tmpfname_disposition;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2021-11-24 14:49:24 UTC (rev 52241)
+++ trunk/src/wp-includes/rest-api.php 2021-11-24 23:58:20 UTC (rev 52242)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3056,7 +3056,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post Post ID or post object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string The route path with a leading slash for the given post, or an empty string if there is not a route.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The route path with a leading slash for the given post,
+ * or an empty string if there is not a route.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function rest_get_route_for_post( $post ) {
</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">@@ -3089,7 +3090,8 @@
</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 string $post_type The name of a registered post type.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string The route path with a leading slash for the given post type, or an empty string if there is not a route.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The route path with a leading slash for the given post type,
+ * or an empty string if there is not a route.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function rest_get_route_for_post_type_items( $post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $post_type );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3122,7 +3124,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Term $term Term ID or term object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string The route path with a leading slash for the given term, or an empty string if there is not a route.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The route path with a leading slash for the given term,
+ * or an empty string if there is not a route.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function rest_get_route_for_term( $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $term = get_term( $term );
</span></span></pre></div>
<a id="trunktestsphpunitincludesmockinvokablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/mock-invokable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/mock-invokable.php 2021-11-24 14:49:24 UTC (rev 52241)
+++ trunk/tests/phpunit/includes/mock-invokable.php 2021-11-24 23:58:20 UTC (rev 52242)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,7 +9,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Class Mock_Invokable.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This class is using to mock a class that has __invoke method.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This class is used to mock a class that has an `__invoke` method.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Mock_Invokable {
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunitincludesspyrestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/spy-rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/spy-rest-server.php 2021-11-24 14:49:24 UTC (rev 52241)
+++ trunk/tests/phpunit/includes/spy-rest-server.php 2021-11-24 23:58:20 UTC (rev 52242)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,14 +39,6 @@
</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">- * Stores last set status.
- * @param int $code HTTP status.
- */
- public function set_status( $status ) {
- $this->status = $status;
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Removes a header from the list of sent headers.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $header Header name.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +48,15 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Stores last set status.
+ *
+ * @param int $code HTTP status.
+ */
+ public function set_status( $status ) {
+ $this->status = $status;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Overrides the dispatch method so we can get a handle on the request object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request to attempt dispatching.
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesFilephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesFile.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesFile.php 2021-11-24 14:49:24 UTC (rev 52241)
+++ trunk/tests/phpunit/tests/admin/includesFile.php 2021-11-24 23:58:20 UTC (rev 52242)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -88,7 +88,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::download_url
</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 $filter A callback containing a fake Content-Disposition header.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param $filter A callback containing a fake Content-Disposition header.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_download_url_should_respect_filename_from_content_disposition_header( $filter ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'pre_http_request', array( $this, $filter ), 10, 3 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,7 +174,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::download_url
</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 $filter A callback containing a fake Content-Disposition header.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param $filter A callback containing a fake Content-Disposition header.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_download_url_should_reject_filename_from_invalid_content_disposition_header( $filter ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'pre_http_request', array( $this, $filter ), 10, 3 );
</span></span></pre>
</div>
</div>
</body>
</html>