class Weight
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
- 10 core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
- 8.9.x core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
Provides a form element for input of a weight.
Weights are integers used to indicate ordering, with larger numbers later in the order.
Properties:
- #delta: The range of possible weight values used. A delta of 10 would indicate possible weight values between -10 and 10.
Usage example:
$form['weight'] = array(
'#type' => 'weight',
'#title' => $this->t('Weight'),
'#default_value' => $edit['weight'],
'#delta' => 10,
);Plugin annotation
@FormElement("weight");Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElement implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\Weight extends \Drupal\Core\Render\Element\FormElement
- class \Drupal\Core\Render\Element\FormElement implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Weight
1 file declares its use of Weight
- WeightTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Render/ Element/ WeightTest.php
152 string references to 'Weight'
- block.schema.yml in core/
modules/ block/ config/ schema/ block.schema.yml - core/modules/block/config/schema/block.schema.yml
- BlockCreationTrait::placeBlock in core/
modules/ block/ tests/ src/ Traits/ BlockCreationTrait.php - Creates a block instance based on default settings.
- BlockDependenciesTest::createBlock in core/
modules/ views/ tests/ src/ Kernel/ Plugin/ BlockDependenciesTest.php - Creates a block instance based on default settings.
- BlockForm::form in core/
modules/ block/ src/ BlockForm.php - BlockForm::validateForm in core/
modules/ block/ src/ BlockForm.php
24 #type uses of Weight
- BlockListBuilder::buildBlocksForm in core/
modules/ block/ src/ BlockListBuilder.php - Builds the main "Blocks" portion of the form.
- BookAdminEditForm::bookAdminTableTree in core/
modules/ book/ src/ Form/ BookAdminEditForm.php - Helps build the main table in the book administration page form.
- BookManager::addFormElements in core/
modules/ book/ src/ BookManager.php - ConfigTestForm::form in core/
modules/ config/ tests/ config_test/ src/ ConfigTestForm.php - ContactFormEditForm::form in core/
modules/ contact/ src/ ContactFormEditForm.php
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Weight.php, line 29
Namespace
Drupal\Core\Render\ElementView source
class Weight extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#input' => TRUE,
'#delta' => 10,
'#default_value' => 0,
'#process' => [
[
$class,
'processWeight',
],
[
$class,
'processAjaxForm',
],
],
];
}
/**
* Expands a weight element into a select/number element.
*/
public static function processWeight(&$element, FormStateInterface $form_state, &$complete_form) {
// If the number of options is small enough, use a select field. Otherwise,
// use a number field.
$type = $element['#delta'] <= \Drupal::config('system.site')->get('weight_select_max') ? 'select' : 'number';
$element = array_merge($element, \Drupal::service('element_info')->getInfo($type));
$element['#is_weight'] = TRUE;
if ($type === 'select') {
$weights = [];
for ($n = -1 * $element['#delta']; $n <= $element['#delta']; $n++) {
$weights[$n] = $n;
}
$default_value = (int) $element['#default_value'];
if (!isset($weights[$default_value])) {
$weights[$default_value] = $default_value;
ksort($weights);
}
$element['#options'] = $weights;
}
else {
// Use a field big enough to fit most weights.
$element['#size'] = 10;
}
return $element;
}
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.