Changeset 53198

Timestamp:

04/17/2022 03:35:34 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/meta-boxes.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 $class parameter to $xfn_relationship in xfn_check().
• Renames the $value parameter to $xfn_value for clarity.
• Includes minor code layout changes for better readability.

Reference: ​XFN: Getting Started.

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.

File:

• trunk/src/wp-admin/includes/meta-boxes.php (modified) (2 diffs)

trunk/src/wp-admin/includes/meta-boxes.php

@@ -1187 +1187 @@
  * @global object $link
  *
- * @param string $class
- * @param string $value
+ * @param string $xfn_relationship
+ * @param string $xfn_value
  * @param mixed  $deprecated Never used.
  */
-function xfn_check( $class, $value = '', $deprecated = '' ) {
+function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
     global $link;
 
@@ -1201 +1201 @@
     $rels     = preg_split( '/\s+/', $link_rel );
 
-    if ( '' !== $value && in_array( $value, $rels, true ) ) {
+    if ( '' !== $xfn_value && in_array( $xfn_value, $rels, true ) ) {
         echo ' checked="checked"';
     }
 
-    if ( '' === $value ) {
-        if ( 'family' === $class && strpos( $link_rel, 'child' ) === false && strpos( $link_rel, 'parent' ) === false && strpos( $link_rel, 'sibling' ) === false && strpos( $link_rel, 'spouse' ) === false && strpos( $link_rel, 'kin' ) === false ) {
+    if ( '' === $xfn_value ) {
+        if ( 'family' === $xfn_relationship
+            && strpos( $link_rel, 'child' ) === false
+            && strpos( $link_rel, 'parent' ) === false
+            && strpos( $link_rel, 'sibling' ) === false
+            && strpos( $link_rel, 'spouse' ) === false
+            && strpos( $link_rel, 'kin' ) === false
+        ) {
             echo ' checked="checked"';
         }
-        if ( 'friendship' === $class && strpos( $link_rel, 'friend' ) === false && strpos( $link_rel, 'acquaintance' ) === false && strpos( $link_rel, 'contact' ) === false ) {
+
+        if ( 'friendship' === $xfn_relationship
+            && strpos( $link_rel, 'friend' ) === false
+            && strpos( $link_rel, 'acquaintance' ) === false
+            && strpos( $link_rel, 'contact' ) === false ) {
             echo ' checked="checked"';
         }
-        if ( 'geographical' === $class && strpos( $link_rel, 'co-resident' ) === false && strpos( $link_rel, 'neighbor' ) === false ) {
+
+        if ( 'geographical' === $xfn_relationship
+            && strpos( $link_rel, 'co-resident' ) === false
+            && strpos( $link_rel, 'neighbor' ) === false
+        ) {
             echo ' checked="checked"';
         }
-        if ( 'identity' === $class && in_array( 'me', $rels, true ) ) {
+
+        if ( 'identity' === $xfn_relationship
+            && in_array( 'me', $rels, true )
+        ) {
             echo ' checked="checked"';
         }