<!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>[57099] trunk/tests/phpunit/tests: Docs: Fix various incorrect WP-flavored array specifications.</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/57099">57099</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/57099","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>2023-11-09 09:49:41 +0000 (Thu, 09 Nov 2023)</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 various incorrect WP-flavored array specifications.
Tags like `@string` or `@array` do not exist and are not supported. The way these were used here, also meant duplicate information being documented.
Fixed now by using the `@type` tag as per the WP flavor of array documentation.
Includes some fixes to the documentation formatting.
Reference: [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/<a href="https://core.trac.wordpress.org/ticket/1">#1</a>-1-parameters-that-are-arrays PHP Documentation Standards: Parameters That Are Arrays].
Follow-up to <a href="https://core.trac.wordpress.org/changeset/33322">[33322]</a>, <a href="https://core.trac.wordpress.org/changeset/42880">[42880]</a>, <a href="https://core.trac.wordpress.org/changeset/42971">[42971]</a>, <a href="https://core.trac.wordpress.org/changeset/44786">[44786]</a>.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/59651">#59651</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsajaxwpCustomizeNavMenusphp">trunk/tests/phpunit/tests/ajax/wpCustomizeNavMenus.php</a></li>
<li><a href="#trunktestsphpunittestsfunctionsanonymizationphp">trunk/tests/phpunit/tests/functions/anonymization.php</a></li>
<li><a href="#trunktestsphpunittestsksesphp">trunk/tests/phpunit/tests/kses.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacyProcessPersonalDataExportPagephp">trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsajaxwpCustomizeNavMenusphp"></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/ajax/wpCustomizeNavMenus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/ajax/wpCustomizeNavMenus.php 2023-11-09 01:47:37 UTC (rev 57098)
+++ trunk/tests/phpunit/tests/ajax/wpCustomizeNavMenus.php 2023-11-09 09:49:41 UTC (rev 57099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,8 +119,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $role The role that will test caps for.
- * @array array $expected_results The expected results from the Ajax call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $role The role that will test caps for.
+ * @type array $expected_results The expected results from the Ajax call.
</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"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,8 +191,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @array array $post_args The arguments that will merged with the $_POST array.
- * @array array $expected_results The expected results from the Ajax call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $post_args The arguments that will merged with the $_POST array.
+ * @type array $expected_results The expected results from the Ajax call.
</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"> */
</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"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $role The role that will test caps for.
- * @array array $expected_results The expected results from the Ajax call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $role The role that will test caps for.
+ * @type array $expected_results The expected results from the Ajax call.
</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"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -610,8 +610,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $post_args The args that will be passed to Ajax.
- * @array array $expected_results The expected results from the Ajax call.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $post_args The args that will be passed to Ajax.
+ * @type array $expected_results The expected results from the Ajax call.
</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"> */
</span></span></pre></div>
<a id="trunktestsphpunittestsfunctionsanonymizationphp"></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/functions/anonymization.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions/anonymization.php 2023-11-09 01:47:37 UTC (rev 57098)
+++ trunk/tests/phpunit/tests/functions/anonymization.php 2023-11-09 09:49:41 UTC (rev 57099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -41,8 +41,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $raw_ip Raw IP address.
- * @string string $expected_result Expected result.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $raw_ip Raw IP address.
+ * @type string $expected_result Expected result.
</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"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -195,8 +195,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $raw_ip Raw IP address.
- * @string string $expected_result Expected result.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $raw_ip Raw IP address.
+ * @type string $expected_result Expected result.
</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"> */
</span></span></pre></div>
<a id="trunktestsphpunittestsksesphp"></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/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/kses.php 2023-11-09 01:47:37 UTC (rev 57098)
+++ trunk/tests/phpunit/tests/kses.php 2023-11-09 09:49:41 UTC (rev 57099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -952,8 +952,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $css A string of CSS rules.
- * @string string $expected Expected string of CSS rules.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $css A string of CSS rules.
+ * @type string $expected Expected string of CSS rules.
</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"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1614,8 +1614,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $css A string of CSS rules.
- * @string string $expected Expected string of CSS rules.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $css A string of CSS rules.
+ * @type string $expected Expected string of CSS rules.
</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"> */
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacyProcessPersonalDataExportPagephp"></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/privacy/wpPrivacyProcessPersonalDataExportPage.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php 2023-11-09 01:47:37 UTC (rev 57098)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php 2023-11-09 09:49:41 UTC (rev 57099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -626,12 +626,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @string string $expected_status The expected post status after calling the function.
- * @string string $response_page The exporter page to pass. Options are 'first' and 'last'. Default 'first'.
- * @string string $exporter_index The exporter index to pass. Options are 'first' and 'last'. Default 'first'.
- * @string string $page_index The page index to pass. Options are 'first' and 'last'. Default 'first'.
- * @bool bool $send_as_email If the response should be sent as an email.
- * @string string $exporter_key The slug (key) of the exporter to pass.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $expected_status The expected post status after calling the function.
+ * @type string $response_page The exporter page to pass. Options are 'first' and 'last'. Default 'first'.
+ * @type string $exporter_index The exporter index to pass. Options are 'first' and 'last'. Default 'first'.
+ * @type string $page_index The page index to pass. Options are 'first' and 'last'. Default 'first'.
+ * @type bool $send_as_email If the response should be sent as an email.
+ * @type string $exporter_key The slug (key) of the exporter to pass.
</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"> */
</span></span></pre>
</div>
</div>
</body>
</html>