class 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'] = [
  '#type' => 'weight',
  '#title' => $this->t('Weight'),
  '#default_value' => $edit['weight'],
  '#delta' => 10,
];
  
  Attributes
#[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\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Weight extends \Drupal\Core\Render\Element\FormElementBase
 
 
 - class \Drupal\Core\Render\Element\FormElementBase implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElementBase
 
 - class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \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  
165 string references to 'Weight'
- block.schema.yml in core/
modules/ block/ config/ schema/ block.schema.yml  - core/modules/block/config/schema/block.schema.yml
 - 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  - Gets the actual form array to be built.
 
23 #type uses of Weight
- BlockListBuilder::buildBlocksForm in core/
modules/ block/ src/ BlockListBuilder.php  - Builds the main "Blocks" portion of the form.
 - ConfigTestForm::form in core/
modules/ config/ tests/ config_test/ src/ ConfigTestForm.php  - Gets the actual form array to be built.
 - ContactFormEditForm::form in core/
modules/ contact/ src/ ContactFormEditForm.php  - Gets the actual form array to be built.
 - DraggableListBuilderTrait::buildRow in core/
lib/ Drupal/ Core/ Entity/ DraggableListBuilderTrait.php  - Builds a row for an entity in the entity listing.
 - FileWidget::formMultipleElements in core/
modules/ file/ src/ Plugin/ Field/ FieldWidget/ FileWidget.php  - Overrides \Drupal\Core\Field\WidgetBase::formMultipleElements().
 
File
- 
              core/
lib/ Drupal/ Core/ Render/ Element/ Weight.php, line 28  
Namespace
Drupal\Core\Render\ElementView source
class Weight extends FormElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#input' => TRUE,
      '#delta' => 10,
      '#default_value' => 0,
      '#process' => [
        [
          static::class,
          'processWeight',
        ],
        [
          static::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;
  }
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | ||
| FormElementBase::processPattern | public static | function | Render API callback: Handles the #pattern form element property. | 1 | ||
| FormElementBase::validatePattern | public static | function | Render API callback: Handles the #pattern form element property. | 1 | ||
| FormElementBase::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementInterface::valueCallback | 17 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 165 | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 80 | ||
| 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 | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | ||
| Weight::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | ||
| Weight::processWeight | public static | function | Expands a weight element into a select/number element. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.