How is a widget rendered on a CMS page?

dmitry_fedyuk (Dmitrii Fediuk) February 3, 2016, 1:34am 1

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Cms/Block/Page.php#L149-L158


/**
 * Prepare HTML content
 *
 * @return string
 */
protected function _toHtml()
{
    $html = $this->_filterProvider->getPageFilter()->filter($this->getPage()->getContent());
    return $html;
}

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Cms/Model/Template/FilterProvider.php#L80-L83


public function getPageFilter()
{
    return $this->_getFilterInstance($this->_pageFilter);
}

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Widget/etc/di.xml#L27-L32


<type name="Magento\Cms\Model\Template\FilterProvider">
    <arguments>
        <argument name="pageFilter" xsi:type="string">Magento\Widget\Model\Template\Filter</argument>
        <argument name="blockFilter" xsi:type="string">Magento\Widget\Model\Template\Filter</argument>
    </arguments>
</type>

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Cms/Model/Template/FilterProvider.php#L55-L58


protected function _getFilterInstance($instanceName)
{
    if (!isset($this->_instanceList[$instanceName])) {
        $instance = $this->_objectManager->get($instanceName);

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Email/Model/Template/Filter.php#L960-L977


public function filter($value)
{
    try {
        $value = parent::filter($value);
    } catch (\Exception $e) {
        // Since a single instance of this class can be used to filter content multiple times, reset callbacks to
        // prevent callbacks running for unrelated content (e.g., email subject and email body)
        $this->resetAfterFilterCallbacks();


        if ($this->_appState->getMode() == \Magento\Framework\App\State::MODE_DEVELOPER) {
            $value = sprintf(__('Error filtering template: %s'), $e->getMessage());
        } else {
            $value = __("We're sorry, an error has occurred while generating this email.");
        }
        $this->_logger->critical($e);
    }
    return $value;
}

github.com

magento/magento2/blob/b3f5588/lib/internal/Magento/Framework/Filter/Template.php#L102-L110


/**
 * Filter the string as template.
 *
 * @param string $value
 * @return string
 * @throws \Exception
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
public function filter($value)

github.com

magento/magento2/blob/b3f5588/lib/internal/Magento/Framework/Filter/Template.php#L141-L141


$replacedValue = call_user_func($callback, $construction);

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Widget/Model/Template/Filter.php#L120-L129


/**
 * Generate widget
 *
 * @param string[] $construction
 * @return string
 */
public function widgetDirective($construction)
{
    return $this->generateWidget($construction);
}

$construction looks like this:

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Widget/Model/Template/Filter.php#L78-L84


/**
 * General method for generate widget
 *
 * @param string[] $construction
 * @return string
 */
public function generateWidget($construction)

github.com

magento/magento2/blob/b3f5588/lib/internal/Magento/Framework/Filter/Template.php#L282-L299


/**
 * Return associative array of parameters.
 *
 * @param string $value raw parameters
 * @return array
 */
protected function getParameters($value)
{
    $tokenizer = new Template\Tokenizer\Parameter();
    $tokenizer->setString($value);
    $params = $tokenizer->tokenize();
    foreach ($params as $key => $value) {
        if (substr($value, 0, 1) === '$') {
            $params[$key] = $this->getVariable(substr($value, 1), null);
        }
    }
    return $params;
}

$value looks like this:

type="Magento\CatalogWidget\Block\Product\ProductsList" products_count="10" template="product/widget/content/grid.phtml" conditions_encoded="a:2:[i:1;a:4:[s:4:`type`;s:50:`Magento|CatalogWidget|Model|Rule|Condition|Combine`;s:10:`aggregator`;s:3:`all`;s:5:`value`;s:1:`1`;s:9:`new_child`;s:0:``;]s:4:`1--1`;a:4:[s:4:`type`;s:50:`Magento|CatalogWidget|Model|Rule|Condition|Product`;s:9:`attribute`;s:12:`category_ids`;s:8:`operator`;s:2:`==`;s:5:`value`;s:1:`3`;]]"

$params (the function’s result) looks like this:

$type may be Magento\CatalogWidget\Block\Product\ProductsList

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Widget/Model/Widget.php#L77-L84


/**
 * Return widget config based on its class type
 *
 * @param string $type Widget type
 * @return null|array
 * @api
 */
public function getWidgetByClassType($type)

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Widget/Model/Widget.php#L213-L220


/**
 * Return filtered list of widgets
 *
 * @param array $filters Key-value array of filters for widget node properties
 * @return array
 * @api
 */
public function getWidgets($filters = [])

$data looks like this:

An example of a widget definition:

github.com

magento/magento2/blob/b3f5588/app/code/Magento/CatalogWidget/etc/widget.xml#L10-L61


<widget id="products_list" class="Magento\CatalogWidget\Block\Product\ProductsList" is_email_compatible="true"
        placeholder_image="Magento_CatalogWidget::images/products_list.png" ttl="86400">
    <label translate="true">Catalog Products List</label>
    <description translate="true">List of Products</description>
    <parameters>
        <parameter name="title" xsi:type="text" required="false" visible="true">
            <label translate="true">Title</label>
        </parameter>
        <parameter name="show_pager" xsi:type="select" visible="true"
                   source_model="Magento\Config\Model\Config\Source\Yesno">
            <label translate="true">Display Page Control</label>
        </parameter>
        <parameter name="products_per_page" xsi:type="text" required="true" visible="true">
            <label translate="true">Number of Products per Page</label>
            <depends>
                <parameter name="show_pager" value="1" />
            </depends>
            <value>5</value>
        </parameter>
        <parameter name="products_count" xsi:type="text" required="true" visible="true">
            <label translate="true">Number of Products to Display</label>
            <value>10</value>
        </parameter>
        <parameter name="template" xsi:type="select" required="true" visible="true">
            <label translate="true">Template</label>
            <options>
                <option name="default" value="product/widget/content/grid.phtml" selected="true">
                    <label translate="true">Products Grid Template</label>
                </option>
            </options>
        </parameter>
        <parameter name="cache_lifetime" xsi:type="text" visible="true">
            <label translate="true">Cache Lifetime (Seconds)</label>
            <description translate="true">86400 by default, if not set. To refresh instantly, clear the Blocks HTML Output cache.</description>
        </parameter>
        <parameter name="condition" xsi:type="conditions" visible="true" required="true" sort_order="10"
                   class="Magento\CatalogWidget\Block\Product\Widget\Conditions">
            <label translate="true">Conditions</label>
        </parameter>
    </parameters>
    <containers>
        <container name="content">
            <template name="grid" value="default" />
        </container>
        <container name="content.top">
            <template name="grid" value="default" />
        </container>
        <container name="content.bottom">
            <template name="grid" value="default" />
        </container>
    </containers>
</widget>

$widget could be:

github.com

magento/magento2/blob/b3f5588/app/code/Magento/Widget/Model/Template/Filter.php#L112-L112


$widget = $this->_layout->createBlock($type, $name, ['data' => $params]);

See a continuation here: How is a product collection widget rendered on a CMS page

How is a product collection widget rendered on a CMS page?

How is a CMS page rendered?

How is a product collection widget rendered on a CMS page?

dmitry_fedyuk (Dmitrii Fediuk) May 5, 2017, 12:22am 2

See also:

How is a CMS page rendered?