How is the «group» attribute used for a block?

dmitry_fedyuk · April 8, 2016, 3:42pm

Specification

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/Layout/etc/elements.xsd#L230-L230


<xs:attribute type="xs:string" name="group" use="optional" />

A usage example

github.com

magento/magento2/blob/ec436ce/app/code/Magento/Review/view/frontend/layout/catalog_product_view.xml#L21-L25


<block class="Magento\Review\Block\Product\Review" name="reviews.tab" as="reviews" template="Magento_Review::review.phtml" group="detailed_info">
    <block class="Magento\Review\Block\Form" name="product.review.form" as="review_form">
        <container name="product.review.form.fields.before" as="form_fields_before" label="Review Form Fields Before"/>
    </block>
</block>

Implementation

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/View/Layout/Generator/Block.php#L205-L207


if (!empty($attributes['group'])) {
    $structure->addToParentGroup($elementName, $attributes['group']);
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Data/Structure.php#L490-L497


/**
 * Add element to parent group
 *
 * @param string $childId
 * @param string $groupName
 * @return bool
 */
public function addToParentGroup($childId, $groupName)

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Data/Structure.php#L498-L506


{
    $parentId = $this->getParentId($childId);
    if ($parentId) {
        $this->_assertElementExists($parentId);
        $this->_elements[$parentId][self::GROUPS][$groupName][$childId] = $childId;
        return true;
    }
    return false;
}

dmitry_fedyuk · April 8, 2016, 3:42pm