GH-139 Add documentation note about callback's expected return

mdziekon · May 30, 2022 · d11c399 · d11c399
1 parent c599193
commit d11c399
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/includes/unlocalised.php b/includes/unlocalised.php
@@ -28,7 +28,8 @@ function array_any(array $inputArray, callable $callback) {
 }
 
 /**
- * Maps an object, allowing to access the key of each value, and change both key & value
+ * Maps an object, allowing to access the key of each value, and change both key & value.
+ * The callback should return a pair of [ $value, $key ]
  */
 function object_map(array $inputObject, callable $callback) {
     return array_column(