How is the `block` widget parameter type defined and used?

dmitrii_fediuk · June 1, 2024, 10:58am

1. The definition

magento/magento2/blob/2.4.7/app/code/Magento/Widget/etc/widget_file.xsd#L91-L102


      
          <xs:complexType name="block">
              <xs:annotation>
                  <xs:documentation>Parameter type which supplies a renderer.</xs:documentation>
              </xs:annotation>
              <xs:complexContent>
                  <xs:extension base="parameterType">
                      <xs:sequence>
                          <xs:element name="block" type="blockType" />
                      </xs:sequence>
                  </xs:extension>
              </xs:complexContent>
          </xs:complexType>

2. The usages

2.1. `Magento\Catalog\Block\Product\Widget\Link` («Catalog Product Link»)

github.com

magento/magento2/blob/2.4.7/app/code/Magento/Catalog/etc/widget.xml#L98-L107


      
          <parameter name="id_path" xsi:type="block" visible="true" required="true" sort_order="10">
              <label translate="true">Product</label>
              <block class="Magento\Catalog\Block\Adminhtml\Product\Widget\Chooser">
                  <data>
                      <item name="button" xsi:type="array">
                          <item name="open" xsi:type="string" translate="true">Select Product...</item>
                      </item>
                  </data>
              </block>
          </parameter>

2.2. `Magento\Catalog\Block\Category\Widget\Link` («Catalog Category Link»)

github.com

magento/magento2/blob/2.4.7/app/code/Magento/Catalog/etc/widget.xml#L137-L146


      
          <parameter name="id_path" xsi:type="block" visible="true" required="true" sort_order="10">
              <label translate="true">Category</label>
              <block class="Magento\Catalog\Block\Adminhtml\Category\Widget\Chooser">
                  <data>
                      <item name="button" xsi:type="array">
                          <item name="open" xsi:type="string" translate="true">Select Category...</item>
                      </item>
                  </data>
              </block>
          </parameter>

2.3. `Magento\Cms\Block\Widget\Page\Link` («CMS Page Link»)

github.com

magento/magento2/blob/2.4.7/app/code/Magento/Cms/etc/widget.xml#L15-L24


      
          <parameter name="page_id" xsi:type="block" visible="true" required="true" sort_order="10">
              <label translate="true">CMS Page</label>
              <block class="Magento\Cms\Block\Adminhtml\Page\Widget\Chooser">
                  <data>
                      <item name="button" xsi:type="array">
                          <item name="open" xsi:type="string" translate="true">Select Page...</item>
                      </item>
                  </data>
              </block>
          </parameter>

2.4. `Magento\Cms\Block\Widget\Block` («CMS Static Block»)

github.com

magento/magento2/blob/2.4.7/app/code/Magento/Cms/etc/widget.xml#L50-L59


      
          <parameter name="block_id" xsi:type="block" visible="true" required="true" sort_order="20">
              <label translate="true">Block</label>
              <block class="Magento\Cms\Block\Adminhtml\Block\Widget\Chooser">
                  <data>
                      <item name="button" xsi:type="array">
                          <item name="open" xsi:type="string" translate="true">Select Block...</item>
                      </item>
                  </data>
              </block>
          </parameter>

How is the `block` widget parameter type defined and used?

1. The definition

2. The usages

2.1. Magento\Catalog\Block\Product\Widget\Link («Catalog Product Link»)

2.2. Magento\Catalog\Block\Category\Widget\Link («Catalog Category Link»)

2.3. Magento\Cms\Block\Widget\Page\Link («CMS Page Link»)

2.4. Magento\Cms\Block\Widget\Block («CMS Static Block»)

2.1. `Magento\Catalog\Block\Product\Widget\Link` («Catalog Product Link»)

2.2. `Magento\Catalog\Block\Category\Widget\Link` («Catalog Category Link»)

2.3. `Magento\Cms\Block\Widget\Page\Link` («CMS Page Link»)

2.4. `Magento\Cms\Block\Widget\Block` («CMS Static Block»)