PHP arrays... What is/are the meaning(s) of an empty bracket?
Asked Answered
T

3

7

I ran across some example code that looks like this:

$form['#submit'][] = 'annotate_admin_settings_submit';

Why is there a bracket after ['#submit'] that is empty with nothing inside? What does this imply? Can anyone give me an example? Normally (from my understanding which is probably wrong) is that arrays have keys and in this case the the $form array key '#submit' is equal to 'annotate_admin_settings_submit' but what is the deal with the second set of brackets. I've seen examples where an array might look like:

$form['actions']['#type'] = 'actions';

I know this is a very basic question about php in general but I ran across this question while learning Drupal so hopefully someone in the Drupal community can clarify this question that I'm obsessing over.

Tashia answered 20/12, 2013 at 17:36 Comment(5)
check php.net/array_pushMelancon
That's still array appending. In this case pushes an entry to an subarray just.Yacov
Oh so it is essentially placing 'annotate_admin_settings_submit' at the end of the $form array?Tashia
Now that you know the meaning of [], note that adding such elements to #submit means you ask Drupal to execute that function in addition to current ones. If you don't want to remove existing submit handlers but further process the form values, this is how you do it.Event
great thanks for the supplementary info Ayesh.Tashia
S
10

When you say $form['actions']['#type'] = 'actions', it assigns a value to $form['actions']['#type'], but when you say $form['#submit'][] = 'annotate_admin_settings_submit', if $form['#submit'] is an array, it appends 'annotate_admin_settings_submit' to the end of it, and if it's empty, it will be an array with one single element that is 'annotate_admin_settings_submit'.

Schoolman answered 20/12, 2013 at 17:43 Comment(1)
Thank you very much! This is what the others (mario and UnLoCo) said in the comments just below my question. I was hoping someone would turn it into an answer instead of a comment :). Thanks.Tashia
D
5

The empty brackets mean that when the string is added to the array, php will automatically generate a key for the entry instead of it being specified in the brackets when populating the array. So $form['#submit'][] = 'annotate_admin_settings_submit'; is the same thing as $form['#submit'][0] = 'annotate_admin_settings_submit'; if it's the first time you do it. Next time it will be $form['#submit'][1] = 'annotate_admin_settings_submit';, etc.

Donaugh answered 20/12, 2013 at 17:47 Comment(0)
K
4

The empty bracket adds an auto increment index to an array. The new index will be +1 to the last index.

Please check this example.

$form['#submit'][0] = 'zero';
$form['#submit'][1] = 'One';
$form['#submit'][] = 'Two'; // this will be considered as $form['#submit'][2] = 'Two';
$form['#submit'][4] = 'Four';
$form['#submit'][] = 'Four'; //this will be considered as $form['#submit'][5] = 'Four'; since its adds 4(last index)+1
Kruse answered 10/8, 2018 at 9:37 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.