class Weight

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
  2. 10 core/lib/Drupal/Core/Render/Element/Weight.php \Drupal\Core\Render\Element\Weight
  3. 11.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

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
Gets the actual form array to be built.
BlockForm::validateForm in core/modules/block/src/BlockForm.php
Form validation handler.

... See full list

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
Builds the common elements of the book form for the node and outline forms.
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.

... See full list

File

core/lib/Drupal/Core/Render/Element/Weight.php, line 29

Namespace

Drupal\Core\Render\Element
View 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;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element&#039;s #value property. Overrides FormElementInterface::valueCallback 16
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
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes
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.