hook_form_alter add field after submit button to exposed view

Question

I'm trying to add a field that would be displayed after the submit button in the rendered HTML in my hook_form_alter.

e.g.

$form['include_card'] = [
  '#type' => 'checkbox',
  '#title' => t('Include gift card'),
  '#weight' => 25,
];

Weight doesn't seem to have any bearing on it. How would you set that up?

I can't remember exactly, but I believe there's a #sorted key somewhere in the $form array. You need to make sure it's set to false. If it's set to true, the form has already been sorted and it won't be re-sorted, i.e. you can add new fields or adjust existing weights and the weights will be ignored. If you set it to false, the form will be re-sorted. — sonfd, Commented Jul 23, 2020 at 18:24

Clive · Accepted Answer · 2020-07-23 18:59:12Z

The submit button will likely be inside an Actions element, which has a default weight of 100.

You could add your field to the actions element:

$form['actions']['include_card'] = ...

At which point the weight of include_card will be relative to the buttons/etc that are inside the actions element (and 25 will probably work).

Another option would be to position your element directly after the actions:

$form['include_card'] = [
  '#type' => 'checkbox',
  '#title' => t('Include gift card'),
  '#weight' => $form['actions']['#weight'] + 1,
];

1 Answer 1