<!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>[53216] trunk/src/wp-admin/includes: Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/taxonomy.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/53216">53216</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/53216","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-04-19 13:49:19 +0000 (Tue, 19 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'>Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/taxonomy.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 `$parent` parameter to `$category_parent` in `category_exists()` and `wp_create_category()`. This matches the category object property of the same name.
* Amends similar parameters in `dropdown_categories()` and `wp_dropdown_cats()` for consistency.
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>.
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/55327">#55327</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesdeprecatedphp">trunk/src/wp-admin/includes/deprecated.php</a></li>
<li><a href="#trunksrcwpadminincludestaxonomyphp">trunk/src/wp-admin/includes/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/deprecated.php 2022-04-19 12:46:24 UTC (rev 53215)
+++ trunk/src/wp-admin/includes/deprecated.php 2022-04-19 13:49:19 UTC (rev 53216)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,10 +78,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $post_ID
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $default_category Unused.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $parent_category Unused.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $category_parent Unused.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $popular_ids Unused.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function dropdown_categories( $default_category = 0, $parent_category = 0, $popular_ids = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function dropdown_categories( $default_category = 0, $category_parent = 0, $popular_ids = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '2.6.0', 'wp_category_checklist()' );
</span><span class="cx" style="display: block; padding: 0 10px"> global $post_ID;
</span><span class="cx" style="display: block; padding: 0 10px"> wp_category_checklist( $post_ID );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,14 +127,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @deprecated 3.0.0 Use wp_dropdown_categories()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_dropdown_categories()
</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 int $current_cat Optional. ID of the current category. Default 0.
- * @param int $current_parent Optional. Current parent category ID. Default 0.
- * @param int $parent_cat Optional. Parent ID to retrieve categories for. Default 0.
- * @param int $level Optional. Number of levels deep to display. Default 0.
- * @param array $categories Optional. Categories to include in the control. Default 0.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $current_cat Optional. ID of the current category. Default 0.
+ * @param int $current_parent Optional. Current parent category ID. Default 0.
+ * @param int $category_parent Optional. Parent ID to retrieve categories for. Default 0.
+ * @param int $level Optional. Number of levels deep to display. Default 0.
+ * @param array $categories Optional. Categories to include in the control. Default 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return void|false Void on success, false if no categories were found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_dropdown_cats( $current_cat = 0, $current_parent = 0, $parent_cat = 0, $level = 0, $categories = 0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_dropdown_cats( $current_cat = 0, $current_parent = 0, $category_parent = 0, $level = 0, $categories = 0 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '3.0.0', 'wp_dropdown_categories()' );
</span><span class="cx" style="display: block; padding: 0 10px"> if (!$categories )
</span><span class="cx" style="display: block; padding: 0 10px"> $categories = get_categories( array('hide_empty' => 0) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,7 +141,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $categories ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $categories as $category ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $current_cat != $category->term_id && $parent_cat == $category->parent) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $current_cat != $category->term_id && $category_parent == $category->parent) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $pad = str_repeat( '– ', $level );
</span><span class="cx" style="display: block; padding: 0 10px"> $category->name = esc_html( $category->name );
</span><span class="cx" style="display: block; padding: 0 10px"> echo "\n\t<option value='$category->term_id'";
</span></span></pre></div>
<a id="trunksrcwpadminincludestaxonomyphp"></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/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/taxonomy.php 2022-04-19 12:46:24 UTC (rev 53215)
+++ trunk/src/wp-admin/includes/taxonomy.php 2022-04-19 13:49:19 UTC (rev 53216)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,12 +17,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see term_exists()
</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 int|string $cat_name Category name.
- * @param int $parent Optional. ID of parent term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|string $cat_name Category name.
+ * @param int $category_parent Optional. ID of parent category.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|null Returns the category ID as a numeric string if the pairing exists, null if not.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function category_exists( $cat_name, $parent = null ) {
- $id = term_exists( $cat_name, 'category', $parent );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function category_exists( $cat_name, $category_parent = null ) {
+ $id = term_exists( $cat_name, 'category', $category_parent );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $id = $id['term_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,12 +48,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</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 int|string $cat_name
- * @param int $parent
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|string $cat_name Category name.
+ * @param int $category_parent Optional. ID of parent category.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int|WP_Error
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_create_category( $cat_name, $parent = 0 ) {
- $id = category_exists( $cat_name, $parent );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_create_category( $cat_name, $category_parent = 0 ) {
+ $id = category_exists( $cat_name, $category_parent );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,7 +61,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return wp_insert_category(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'cat_name' => $cat_name,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'category_parent' => $parent,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'category_parent' => $category_parent,
</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>