Changeset 50965 for trunk/src/wp-includes/functions.php

Timestamp:

05/24/2021 12:24:14 PM (4 years ago)

Author:

SergeyBiryukov

Message:

General: Some documentation and test improvements for the _wp_array_set():

• Update the function DocBlock per the documentation standards.
• Move the unit tests to a more appropriate place.
• Rename and reorder the tests for consistency with _wp_array_get() tests.

Follow-up to [50958], [50962], [50964].

See #53175, #52625.

File:

• trunk/src/wp-includes/functions.php (modified) (4 diffs)

trunk/src/wp-includes/functions.php

@@ -4637 +4637 @@
  *     $array = array();
  *     _wp_array_set( $array, array( 'a', 'b', 'c', 1 );
+ *
  *     $array becomes:
  *     array(
@@ -4646 +4647 @@
  *     );
  *
- * @param array $array   An array that we want to mutate to include a specific value in a path.
- * @param array $path    An array of keys describing the path that we want to mutate.
- * @param mixed $value   The value that will be set.
+ * @internal
+ *
+ * @since 5.8.0
+ * @access private
+ *
+ * @param array $array An array that we want to mutate to include a specific value in a path.
+ * @param array $path  An array of keys describing the path that we want to mutate.
+ * @param mixed $value The value that will be set.
  */
 function _wp_array_set( &$array, $path, $value = null ) {
@@ -4660 +4666 @@
         return;
     }
+
     $path_length = count( $path );
+
     if ( 0 === $path_length ) {
         return;
     }
+
     foreach ( $path as $path_element ) {
         if (
@@ -4683 +4692 @@
         $array = &$array[ $path_element ]; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.VariableRedeclaration
     }
+
     $array[ $path[ $i ] ] = $value;
 }