From 8f47c944d887bf561859f081cdf5c48f3148c1d9 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov.ru@gmail.com>
Date: Mon, 24 May 2021 12:25:55 +0000
Subject: [PATCH] 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.
Built from https://develop.svn.wordpress.org/trunk@50965


git-svn-id: http://core.svn.wordpress.org/trunk@50574 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/functions.php | 16 +++++++++++++---
 wp-includes/version.php   |  2 +-
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/wp-includes/functions.php b/wp-includes/functions.php
index 0c6f44591f..fc1dd011e1 100644
--- a/wp-includes/functions.php
+++ b/wp-includes/functions.php
@@ -4636,6 +4636,7 @@ function _wp_array_get( $array, $path, $default = null ) {
  *
  *     $array = array();
  *     _wp_array_set( $array, array( 'a', 'b', 'c', 1 );
+ *
  *     $array becomes:
  *     array(
  *         'a' => array(
@@ -4645,9 +4646,14 @@ function _wp_array_get( $array, $path, $default = null ) {
  *         ),
  *     );
  *
- * @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 ) {
 	// Confirm $array is valid.
@@ -4659,10 +4665,13 @@ function _wp_array_set( &$array, $path, $value = null ) {
 	if ( ! is_array( $path ) ) {
 		return;
 	}
+
 	$path_length = count( $path );
+
 	if ( 0 === $path_length ) {
 		return;
 	}
+
 	foreach ( $path as $path_element ) {
 		if (
 			! is_string( $path_element ) && ! is_integer( $path_element ) &&
@@ -4682,6 +4691,7 @@ function _wp_array_set( &$array, $path, $value = null ) {
 		}
 		$array = &$array[ $path_element ]; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.VariableRedeclaration
 	}
+
 	$array[ $path[ $i ] ] = $value;
 }
 
diff --git a/wp-includes/version.php b/wp-includes/version.php
index 47b24b9bba..091e6b96bc 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -13,7 +13,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '5.8-alpha-50964';
+$wp_version = '5.8-alpha-50965';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.