<!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>[54959] trunk/src/wp-includes/pomo/po.php: Code Modernization: Rename parameters that use reserved keywords in `wp-includes/pomo/po.php`.</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/54959">54959</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/54959","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>2022-12-12 19:37:43 +0000 (Mon, 12 Dec 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'>Code Modernization: Rename parameters that use reserved keywords in `wp-includes/pomo/po.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$string` parameter to `$input_string` in:
* `PO::poify()`
* `PO::unpoify()`
* `PO::prepend_each_line()`
Follow-up to <a href="https://core.trac.wordpress.org/changeset/52946">[52946]</a>, <a href="https://core.trac.wordpress.org/changeset/52996">[52996]</a>, <a href="https://core.trac.wordpress.org/changeset/52997">[52997]</a>, <a href="https://core.trac.wordpress.org/changeset/52998">[52998]</a>, <a href="https://core.trac.wordpress.org/changeset/53003">[53003]</a>, <a href="https://core.trac.wordpress.org/changeset/53014">[53014]</a>, <a href="https://core.trac.wordpress.org/changeset/53029">[53029]</a>, <a href="https://core.trac.wordpress.org/changeset/53039">[53039]</a>, <a href="https://core.trac.wordpress.org/changeset/53116">[53116]</a>, <a href="https://core.trac.wordpress.org/changeset/53117">[53117]</a>, <a href="https://core.trac.wordpress.org/changeset/53137">[53137]</a>, <a href="https://core.trac.wordpress.org/changeset/53174">[53174]</a>, <a href="https://core.trac.wordpress.org/changeset/53184">[53184]</a>, <a href="https://core.trac.wordpress.org/changeset/53185">[531
85]</a>, <a href="https://core.trac.wordpress.org/changeset/53192">[53192]</a>, <a href="https://core.trac.wordpress.org/changeset/53193">[53193]</a>, <a href="https://core.trac.wordpress.org/changeset/53198">[53198]</a>, <a href="https://core.trac.wordpress.org/changeset/53203">[53203]</a>, <a href="https://core.trac.wordpress.org/changeset/53207">[53207]</a>, <a href="https://core.trac.wordpress.org/changeset/53215">[53215]</a>, <a href="https://core.trac.wordpress.org/changeset/53216">[53216]</a>, <a href="https://core.trac.wordpress.org/changeset/53220">[53220]</a>, <a href="https://core.trac.wordpress.org/changeset/53230">[53230]</a>, <a href="https://core.trac.wordpress.org/changeset/53232">[53232]</a>, <a href="https://core.trac.wordpress.org/changeset/53236">[53236]</a>, <a href="https://core.trac.wordpress.org/changeset/53239">[53239]</a>, <a href="https://core.trac.wordpress.org/changeset/53240">[53240]</a>, <a href="https://core.trac.wordpress.org/changeset/53242">[53242]
</a>, <a href="https://core.trac.wordpress.org/changeset/53243">[53243]</a>, <a href="https://core.trac.wordpress.org/changeset/53245">[53245]</a>, <a href="https://core.trac.wordpress.org/changeset/53246">[53246]</a>, <a href="https://core.trac.wordpress.org/changeset/53257">[53257]</a>, <a href="https://core.trac.wordpress.org/changeset/53269">[53269]</a>, <a href="https://core.trac.wordpress.org/changeset/53270">[53270]</a>, <a href="https://core.trac.wordpress.org/changeset/53271">[53271]</a>, <a href="https://core.trac.wordpress.org/changeset/53272">[53272]</a>, <a href="https://core.trac.wordpress.org/changeset/53273">[53273]</a>, <a href="https://core.trac.wordpress.org/changeset/53274">[53274]</a>, <a href="https://core.trac.wordpress.org/changeset/53275">[53275]</a>, <a href="https://core.trac.wordpress.org/changeset/53276">[53276]</a>, <a href="https://core.trac.wordpress.org/changeset/53277">[53277]</a>, <a href="https://core.trac.wordpress.org/changeset/53281">[53281]</a
>, <a href="https://core.trac.wordpress.org/changeset/53283">[53283]</a>, <a href="https://core.trac.wordpress.org/changeset/53284">[53284]</a>, <a href="https://core.trac.wordpress.org/changeset/53285">[53285]</a>, <a href="https://core.trac.wordpress.org/changeset/53287">[53287]</a>, <a href="https://core.trac.wordpress.org/changeset/53364">[53364]</a>, <a href="https://core.trac.wordpress.org/changeset/53365">[53365]</a>, <a href="https://core.trac.wordpress.org/changeset/54927">[54927]</a>, <a href="https://core.trac.wordpress.org/changeset/54929">[54929]</a>, <a href="https://core.trac.wordpress.org/changeset/54930">[54930]</a>, <a href="https://core.trac.wordpress.org/changeset/54931">[54931]</a>, <a href="https://core.trac.wordpress.org/changeset/54932">[54932]</a>, <a href="https://core.trac.wordpress.org/changeset/54933">[54933]</a>, <a href="https://core.trac.wordpress.org/changeset/54938">[54938]</a>, <a href="https://core.trac.wordpress.org/changeset/54943">[54943]</a>,
<a href="https://core.trac.wordpress.org/changeset/54944">[54944]</a>, <a href="https://core.trac.wordpress.org/changeset/54945">[54945]</a>, <a href="https://core.trac.wordpress.org/changeset/54946">[54946]</a>, <a href="https://core.trac.wordpress.org/changeset/54947">[54947]</a>, <a href="https://core.trac.wordpress.org/changeset/54948">[54948]</a>, <a href="https://core.trac.wordpress.org/changeset/54950">[54950]</a>, <a href="https://core.trac.wordpress.org/changeset/54951">[54951]</a>, <a href="https://core.trac.wordpress.org/changeset/54952">[54952]</a>, <a href="https://core.trac.wordpress.org/changeset/54956">[54956]</a>.
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/56788">#56788</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespomopophp">trunk/src/wp-includes/pomo/po.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespomopophp"></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/pomo/po.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/pomo/po.php 2022-12-12 11:49:40 UTC (rev 54958)
+++ trunk/src/wp-includes/pomo/po.php 2022-12-12 19:37:43 UTC (rev 54959)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,10 +110,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Formats a string in PO-style
</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 string to format
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $input_string the string to format
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string the poified string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function poify( $string ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function poify( $input_string ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $quote = '"';
</span><span class="cx" style="display: block; padding: 0 10px"> $slash = '\\';
</span><span class="cx" style="display: block; padding: 0 10px"> $newline = "\n";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,12 +124,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "\t" => '\t',
</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">- $string = str_replace( array_keys( $replaces ), array_values( $replaces ), $string );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $input_string = str_replace( array_keys( $replaces ), array_values( $replaces ), $input_string );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $po = $quote . implode( "{$slash}n{$quote}{$newline}{$quote}", explode( $newline, $string ) ) . $quote;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $po = $quote . implode( "{$slash}n{$quote}{$newline}{$quote}", explode( $newline, $input_string ) ) . $quote;
</ins><span class="cx" style="display: block; padding: 0 10px"> // Add empty string on first line for readbility.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( false !== strpos( $string, $newline ) &&
- ( substr_count( $string, $newline ) > 1 || substr( $string, -strlen( $newline ) ) !== $newline ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false !== strpos( $input_string, $newline ) &&
+ ( substr_count( $input_string, $newline ) > 1 || substr( $input_string, -strlen( $newline ) ) !== $newline ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $po = "$quote$quote$newline$po";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove empty strings.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,10 +140,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Gives back the original string from a PO-formatted string
</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 PO-formatted string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $input_string PO-formatted string
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string enascaped string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function unpoify( $string ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function unpoify( $input_string ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $escapes = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 't' => "\t",
</span><span class="cx" style="display: block; padding: 0 10px"> 'n' => "\n",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -150,7 +150,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'r' => "\r",
</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">- $lines = array_map( 'trim', explode( "\n", $string ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $lines = array_map( 'trim', explode( "\n", $input_string ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $lines = array_map( array( 'PO', 'trim_quotes' ), $lines );
</span><span class="cx" style="display: block; padding: 0 10px"> $unpoified = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $previous_is_backslash = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,18 +178,18 @@
</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">- * Inserts $with in the beginning of every new line of $string and
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Inserts $with in the beginning of every new line of $input_string and
</ins><span class="cx" style="display: block; padding: 0 10px"> * returns the modified string
</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 prepend lines in this string
- * @param string $with prepend lines with this string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $input_string prepend lines in this string
+ * @param string $with prepend lines with this string
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function prepend_each_line( $string, $with ) {
- $lines = explode( "\n", $string );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function prepend_each_line( $input_string, $with ) {
+ $lines = explode( "\n", $input_string );
</ins><span class="cx" style="display: block; padding: 0 10px"> $append = '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( "\n" === substr( $string, -1 ) && '' === end( $lines ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( "\n" === substr( $input_string, -1 ) && '' === end( $lines ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Last line might be empty because $string was terminated
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Last line might be empty because $input_string was terminated
</ins><span class="cx" style="display: block; padding: 0 10px"> * with a newline, remove it from the $lines array,
</span><span class="cx" style="display: block; padding: 0 10px"> * we'll restore state by re-terminating the string at the end.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>