class Actions
Same name in other branches
- 9 core/lib/Drupal/Core/Render/Element/Actions.php \Drupal\Core\Render\Element\Actions
- 8.9.x core/lib/Drupal/Core/Render/Element/Actions.php \Drupal\Core\Render\Element\Actions
- 11.x core/lib/Drupal/Core/Render/Element/Actions.php \Drupal\Core\Render\Element\Actions
Provides a wrapper element to group one or more buttons in a form.
Use of a single Actions element with an array key of 'actions' to group the primary submit buttons on a form helps to ensure proper styling in themes, and enables other modules to properly alter a form's actions.
Usage example:
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Save'),
];
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Actions
36 string references to 'Actions'
- action.links.menu.yml in core/
modules/ action/ action.links.menu.yml - core/modules/action/action.links.menu.yml
- action.routing.yml in core/
modules/ action/ action.routing.yml - core/modules/action/action.routing.yml
- claro_form_alter in core/
themes/ claro/ claro.theme - Implements hook_form_alter().
- claro_preprocess_views_exposed_form in core/
themes/ claro/ claro.theme - Implements hook_preprocess_HOOK() for views_exposed_form.
- CommentBulkFormTest::testConstructor in core/
modules/ comment/ tests/ src/ Unit/ Plugin/ views/ field/ CommentBulkFormTest.php - Tests the constructor assignment of actions.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Actions.php, line 26
Namespace
Drupal\Core\Render\ElementView source
class Actions extends Container {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#process' => [
// @todo Move this to #pre_render.
[
$class,
'preRenderActionsDropbutton',
],
[
$class,
'processActions',
],
[
$class,
'processContainer',
],
],
'#weight' => 100,
'#theme_wrappers' => [
'container',
],
];
}
/**
* Processes a form actions container element.
*
* @param array $element
* An associative array containing the properties and children of the
* form actions container.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*
* @return array
* The processed element.
*/
public static function processActions(&$element, FormStateInterface $form_state, &$complete_form) {
$element['#attributes']['class'][] = 'form-actions';
return $element;
}
/**
* #pre_render callback for #type 'actions'.
*
* This callback iterates over all child elements of the #type 'actions'
* container to look for elements with a #dropbutton property, so as to group
* those elements into dropbuttons. As such, it works similar to #group, but is
* specialized for dropbuttons.
*
* The value of #dropbutton denotes the dropbutton to group the child element
* into. For example, two different values of 'foo' and 'bar' on child elements
* would generate two separate dropbuttons, which each contain the corresponding
* buttons.
*
* @param array $element
* The #type 'actions' element to process.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*
* @return array
* The processed #type 'actions' element, including individual buttons grouped
* into new #type 'dropbutton' elements.
*/
public static function preRenderActionsDropbutton(&$element, FormStateInterface $form_state, &$complete_form) {
$dropbuttons = [];
foreach (Element::children($element, TRUE) as $key) {
if (isset($element[$key]['#dropbutton'])) {
$dropbutton = $element[$key]['#dropbutton'];
// If there is no dropbutton for this button group yet, create one.
if (!isset($dropbuttons[$dropbutton])) {
$dropbuttons[$dropbutton] = [
'#type' => 'dropbutton',
];
}
// Add this button to the corresponding dropbutton.
// @todo Change #type 'dropbutton' to be based on item-list.html.twig
// instead of links.html.twig to avoid this preemptive rendering.
$button = \Drupal::service('renderer')->renderInIsolation($element[$key]);
$dropbuttons[$dropbutton]['#links'][$key] = [
'title' => $button,
];
// Merge metadata like drupalSettings.
BubbleableMetadata::createFromRenderArray($dropbuttons[$dropbutton])->merge(BubbleableMetadata::createFromRenderArray($element[$key]))
->applyTo($dropbuttons[$dropbutton]);
}
}
// @todo For now, all dropbuttons appear first. Consider to invent a more
// fancy sorting/injection algorithm here.
return $dropbuttons + $element;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Actions::getInfo | public | function | Returns the element properties for this element. | Overrides Container::getInfo | |
Actions::preRenderActionsDropbutton | public static | function | #pre_render callback for #type 'actions'. | ||
Actions::processActions | public static | function | Processes a form actions container element. | ||
Container::preRenderContainer | public static | function | Prevents optional containers from rendering if they have no children. | ||
Container::processContainer | public static | function | Processes a container element. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.