Skip to content

Commit 1e9a5c6

Browse files
committed
Rename standard array function parameters to $array
This is targeting 8.0. `$arg` seems like a poor choice of a name, especially if the function were to have arguments added. In many cases, the php.net documentation already has $array for these functions. E.g. https://www.php.net/manual/en/function.array-intersect.php I'd assume that since named arguments was added to 8.0 near the feature freeze, PHP's maintainers had planned to make the names consistent and gradually use the same name for docs and implementation.
1 parent 10f660f commit 1e9a5c6

File tree

48 files changed

+1403
-1403
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1403
-1403
lines changed

Zend/tests/call_user_func_009.phpt

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ var_dump(\call_user_func('sort', []));
1010

1111
?>
1212
--EXPECTF--
13-
Warning: sort(): Argument #1 ($arg) must be passed by reference, value given in %s on line %d
13+
Warning: sort(): Argument #1 ($array) must be passed by reference, value given in %s on line %d
1414
bool(true)
1515

16-
Warning: sort(): Argument #1 ($arg) must be passed by reference, value given in %s on line %d
16+
Warning: sort(): Argument #1 ($array) must be passed by reference, value given in %s on line %d
1717
bool(true)

Zend/tests/named_params/internal.phpt

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Named params on internal functions
33
--FILE--
44
<?php
55

6-
var_dump(array_slice(arg: [1, 2, 3, 4, 5], offset: 2, length: 2));
7-
var_dump(array_slice(length: 2, offset: 2, arg: [1, 2, 3, 4, 5]));
6+
var_dump(array_slice(array: [1, 2, 3, 4, 5], offset: 2, length: 2));
7+
var_dump(array_slice(length: 2, offset: 2, array: [1, 2, 3, 4, 5]));
88

9-
var_dump(array_slice(arg: ['a' => 0, 'b' => 1], offset: 1, preserve_keys: true));
9+
var_dump(array_slice(array: ['a' => 0, 'b' => 1], offset: 1, preserve_keys: true));
1010
var_dump(array_slice(['a' => 0, 'b' => 1], preserve_keys: true, offset: 1));
1111
var_dump(str_pad("foo", 6, pad_type: STR_PAD_LEFT));
1212

Zend/tests/named_params/missing_param.phpt

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var_dump(array_keys([41, 42], search_value: 42, strict: true));
3030
?>
3131
--EXPECT--
3232
test(): Argument #2 ($b) not passed
33-
array_keys(): Argument #1 ($arg) not passed
33+
array_keys(): Argument #1 ($array) not passed
3434
array_keys(): Argument #2 ($search_value) must be passed explicitly, because the default value is not known
3535
array(1) {
3636
[0]=>

Zend/tests/nullsafe_operator/013.phpt

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ string(56) "get_called_class() expects exactly 0 parameters, 1 given"
5454
string(4) "NULL"
5555
string(53) "func_num_args() expects exactly 0 parameters, 1 given"
5656
string(53) "func_get_args() expects exactly 0 parameters, 1 given"
57-
string(67) "array_slice(): Argument #1 ($arg) must be of type array, null given"
57+
string(69) "array_slice(): Argument #1 ($array) must be of type array, null given"
5858
array(1) {
5959
[0]=>
6060
string(3) "foo"

ext/reflection/tests/ReflectionParameter_canBePassedByValue.phpt

+6-6
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ aux('sort');
2727

2828
echo "=> user function:\n\n";
2929

30-
function ufunc(&$arg1, $arg2) {}
30+
function ufunc(&$array1, $array2) {}
3131

3232
aux('ufunc');
3333

@@ -37,7 +37,7 @@ echo "Done.\n";
3737
--EXPECT--
3838
=> array_multisort:
3939

40-
Name: arr1
40+
Name: array1
4141
Is passed by reference: yes
4242
Can be passed by value: yes
4343

@@ -49,13 +49,13 @@ Name: sort_flags
4949
Is passed by reference: yes
5050
Can be passed by value: yes
5151

52-
Name: arr2
52+
Name: arrays
5353
Is passed by reference: yes
5454
Can be passed by value: yes
5555

5656
=> sort:
5757

58-
Name: arg
58+
Name: array
5959
Is passed by reference: yes
6060
Can be passed by value: no
6161

@@ -65,11 +65,11 @@ Can be passed by value: yes
6565

6666
=> user function:
6767

68-
Name: arg1
68+
Name: array1
6969
Is passed by reference: yes
7070
Can be passed by value: no
7171

72-
Name: arg2
72+
Name: array2
7373
Is passed by reference: no
7474
Can be passed by value: yes
7575

ext/standard/array.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -5811,7 +5811,7 @@ PHP_FUNCTION(array_rand)
58115811
}
58125812

58135813
if (num_req <= 0 || num_req > num_avail) {
5814-
zend_argument_value_error(2, "must be between 1 and the number of elements in argument #1 ($arg)");
5814+
zend_argument_value_error(2, "must be between 1 and the number of elements in argument #1 ($array)");
58155815
RETURN_THROWS();
58165816
}
58175817

ext/standard/basic_functions.stub.php

+55-55
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ function stream_wrapper_restore(string $protocol): bool {}
5959

6060
function array_push(array &$stack, mixed ...$args): int {}
6161

62-
function krsort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
62+
function krsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
6363

64-
function ksort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
64+
function ksort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
6565

6666
/** @param array|Countable|null $var */
6767
function count($var, int $mode = COUNT_NORMAL): int {}
@@ -72,23 +72,23 @@ function count($var, int $mode = COUNT_NORMAL): int {}
7272
*/
7373
function sizeof($var, int $mode = COUNT_NORMAL): int {}
7474

75-
function natsort(array &$arg): bool {}
75+
function natsort(array &$array): bool {}
7676

77-
function natcasesort(array &$arg): bool {}
77+
function natcasesort(array &$array): bool {}
7878

79-
function asort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
79+
function asort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
8080

81-
function arsort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
81+
function arsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
8282

83-
function sort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
83+
function sort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
8484

85-
function rsort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
85+
function rsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
8686

87-
function usort(array &$arg, callable $cmp_function): bool {}
87+
function usort(array &$array, callable $cmp_function): bool {}
8888

89-
function uasort(array &$arg, callable $cmp_function): bool {}
89+
function uasort(array &$array, callable $cmp_function): bool {}
9090

91-
function uksort(array &$arg, callable $cmp_function): bool {}
91+
function uksort(array &$array, callable $cmp_function): bool {}
9292

9393
function end(array|object &$arg): mixed {}
9494

@@ -117,8 +117,8 @@ function in_array(mixed $needle, array $haystack, bool $strict = false): bool {}
117117

118118
function array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false {}
119119

120-
/** @prefer-ref $arg */
121-
function extract(array &$arg, int $extract_type = EXTR_OVERWRITE, string $prefix = ""): int {}
120+
/** @prefer-ref $array */
121+
function extract(array &$array, int $extract_type = EXTR_OVERWRITE, string $prefix = ""): int {}
122122

123123
function compact($var_name, ...$var_names): array {}
124124

@@ -133,103 +133,103 @@ function array_fill_keys(array $keys, mixed $val): array {}
133133
*/
134134
function range($low, $high, $step = 1): array {}
135135

136-
function shuffle(array &$arg): bool {}
136+
function shuffle(array &$array): bool {}
137137

138138
function array_pop(array &$stack): mixed {}
139139

140140
function array_shift(array &$stack): mixed {}
141141

142142
function array_unshift(array &$stack, mixed ...$vars): int {}
143143

144-
function array_splice(array &$arg, int $offset, ?int $length = null, mixed $replacement = []): array {}
144+
function array_splice(array &$array, int $offset, ?int $length = null, mixed $replacement = []): array {}
145145

146-
function array_slice(array $arg, int $offset, ?int $length = null, bool $preserve_keys = false): array {}
146+
function array_slice(array $array, int $offset, ?int $length = null, bool $preserve_keys = false): array {}
147147

148148
function array_merge(array ...$arrays): array {}
149149

150150
function array_merge_recursive(array ...$arrays): array {}
151151

152-
function array_replace(array $arr1, array ...$arrays): array {}
152+
function array_replace(array $array1, array ...$arrays): array {}
153153

154-
function array_replace_recursive(array $arr1, array ...$arrays): array {}
154+
function array_replace_recursive(array $array1, array ...$arrays): array {}
155155

156-
function array_keys(array $arg, mixed $search_value = UNKNOWN, bool $strict = false): array {}
156+
function array_keys(array $array, mixed $search_value = UNKNOWN, bool $strict = false): array {}
157157

158-
function array_key_first(array $arg): int|string|null {}
158+
function array_key_first(array $array): int|string|null {}
159159

160-
function array_key_last(array $arg): int|string|null {}
160+
function array_key_last(array $array): int|string|null {}
161161

162-
function array_values(array $arg): array {}
162+
function array_values(array $array): array {}
163163

164-
function array_count_values(array $arg): array {}
164+
function array_count_values(array $array): array {}
165165

166-
function array_column(array $arg, int|string|null $column_key, int|string|null $index_key = null): array {}
166+
function array_column(array $array, int|string|null $column_key, int|string|null $index_key = null): array {}
167167

168168
function array_reverse(array $input, bool $preserve_keys = false): array {}
169169

170-
function array_pad(array $arg, int $pad_size, mixed $pad_value): array {}
170+
function array_pad(array $array, int $pad_size, mixed $pad_value): array {}
171171

172-
function array_flip(array $arg): array {}
172+
function array_flip(array $array): array {}
173173

174174
function array_change_key_case(array $input, int $case = CASE_LOWER): array {}
175175

176-
function array_unique(array $arg, int $flags = SORT_STRING): array {}
176+
function array_unique(array $array, int $flags = SORT_STRING): array {}
177177

178-
function array_intersect_key(array $arr1, array $arr2, array ...$arrays): array {}
178+
function array_intersect_key(array $array1, array $array2, array ...$arrays): array {}
179179

180-
function array_intersect_ukey(array $arr1, array $arr2, ...$rest): array {}
180+
function array_intersect_ukey(array $array1, array $array2, ...$rest): array {}
181181

182-
function array_intersect(array $arr1, array $arr2, array ...$arrays): array {}
182+
function array_intersect(array $array1, array $array2, array ...$arrays): array {}
183183

184-
function array_uintersect(array $arr1, array $arr2, ...$rest): array {}
184+
function array_uintersect(array $array1, array $array2, ...$rest): array {}
185185

186-
function array_intersect_assoc(array $arr1, array $arr2, array ...$arrays): array {}
186+
function array_intersect_assoc(array $array1, array $array2, array ...$arrays): array {}
187187

188-
function array_uintersect_assoc(array $arr1, array $arr2, ...$rest): array {}
188+
function array_uintersect_assoc(array $array1, array $array2, ...$rest): array {}
189189

190-
function array_intersect_uassoc(array $arr1, array $arr2, ...$rest): array {}
190+
function array_intersect_uassoc(array $array1, array $array2, ...$rest): array {}
191191

192-
function array_uintersect_uassoc(array $arr1, array $arr2, ...$rest): array {}
192+
function array_uintersect_uassoc(array $array1, array $array2, ...$rest): array {}
193193

194-
function array_diff_key(array $arr1, array $arr2, array ...$arrays): array {}
194+
function array_diff_key(array $array1, array $array2, array ...$arrays): array {}
195195

196-
function array_diff_ukey(array $arr1, array $arr2, ...$rest): array {}
196+
function array_diff_ukey(array $array1, array $array2, ...$rest): array {}
197197

198-
function array_diff(array $arr1, array $arr2, array ...$arrays): array {}
198+
function array_diff(array $array1, array $array2, array ...$arrays): array {}
199199

200-
function array_udiff(array $arr1, array $arr2, ...$rest): array {}
200+
function array_udiff(array $array1, array $array2, ...$rest): array {}
201201

202-
function array_diff_assoc(array $arr1, array $arr2, array ...$arrays): array {}
202+
function array_diff_assoc(array $array1, array $array2, array ...$arrays): array {}
203203

204-
function array_diff_uassoc(array $arr1, array $arr2, ...$rest): array {}
204+
function array_diff_uassoc(array $array1, array $array2, ...$rest): array {}
205205

206-
function array_udiff_assoc(array $arr1, array $arr2, ...$rest): array {}
206+
function array_udiff_assoc(array $array1, array $array2, ...$rest): array {}
207207

208-
function array_udiff_uassoc(array $arr1, array $arr2, ...$rest): array {}
208+
function array_udiff_uassoc(array $array1, array $array2, ...$rest): array {}
209209

210210
/**
211-
* @param array $arr1
211+
* @param array $array1
212212
* @param int $sort_order
213213
* @param int $sort_flags
214-
* @param array $arr2
215-
* @prefer-ref $arr1
214+
* @param array $array2
215+
* @prefer-ref $array1
216216
* @prefer-ref $sort_order
217217
* @prefer-ref $sort_flags
218-
* @prefer-ref $arr2
218+
* @prefer-ref $arrays
219219
*/
220-
function array_multisort(&$arr1, $sort_order = SORT_ASC, $sort_flags = SORT_REGULAR, &...$arr2): bool {}
220+
function array_multisort(&$array1, $sort_order = SORT_ASC, $sort_flags = SORT_REGULAR, &...$arrays): bool {}
221221

222-
function array_rand(array $arg, int $num_req = 1): int|string|array {}
222+
function array_rand(array $array, int $num_req = 1): int|string|array {}
223223

224-
function array_sum(array $arg): int|float {}
224+
function array_sum(array $array): int|float {}
225225

226-
function array_product(array $arg): int|float {}
226+
function array_product(array $array): int|float {}
227227

228-
function array_reduce(array $arg, callable $callback, mixed $initial = null): mixed {}
228+
function array_reduce(array $array, callable $callback, mixed $initial = null): mixed {}
229229

230-
function array_filter(array $arg, ?callable $callback = null, int $use_keys = 0): array {}
230+
function array_filter(array $array, ?callable $callback = null, int $use_keys = 0): array {}
231231

232-
function array_map(?callable $callback, array $arr1, array ...$arrays): array {}
232+
function array_map(?callable $callback, array $array1, array ...$arrays): array {}
233233

234234
/** @param int|string $key */
235235
function array_key_exists($key, array $search): bool {}
@@ -240,7 +240,7 @@ function array_key_exists($key, array $search): bool {}
240240
*/
241241
function key_exists($key, array $search): bool {}
242242

243-
function array_chunk(array $arg, int $size, bool $preserve_keys = false): array {}
243+
function array_chunk(array $array, int $size, bool $preserve_keys = false): array {}
244244

245245
function array_combine(array $keys, array $values): array {}
246246

0 commit comments

Comments
 (0)