How can extensions show / hide blocks conditionally in Magento 2

October 12, 2015 - Magento 2

In Magento 2 there are several ways of showing and hiding blocks conditionally. If its visibility depends on a configuration settings value, use the ifconfig expression in your layout file:

<referenceContainer name='form.buttons'>
    <block
        class='Dfe\Google\Block\Backend\Template'
        name='Dfe_Google_Backend_Buttons'
        template='buttons.phtml'
        after='adminhtml_auth_login_buttons'
        ifconfig='dfe_google/login/enable'
    />
</referenceContainer>

<block

class='Dfe\Google\Block\Backend\Template'

name='Dfe_Google_Backend_Buttons'

template='buttons.phtml'

after='adminhtml_auth_login_buttons'

ifconfig='dfe_google/login/enable'

</referenceContainer>

In case of a more complex visibility condition, show and hide a block by overriding the\Magento\Framework\View\Element\AbstractBlock::toHtml() method.

The block won’t be shown If you return the empty string from the method.

<?php
namespace Dfe\Facebook\Block;
class Login extends \Magento\Framework\View\Element\Html\Link {
    /**
    * @override
    * @see \Magento\Framework\View\Element\Html\Link::toHtml()
    * @return string
    */
    public function toHtml() {return !rm_customer_logged_in() ? parent::toHtml() : '';}
}

<?php

namespace Dfe\Facebook\Block;

class Login extends \Magento\Framework\View\Element\Html\Link {

/**

* @override

* @see \Magento\Framework\View\Element\Html\Link::toHtml()

* @return string

public function toHtml() {return !rm_customer_logged_in() ? parent::toHtml() : '';}

}

The above example illustrates how the block can be hidden or shown for anonymous or authenticated visitors. The rm_customer_logged_in function detects all necessary information.

Source

More tips from the cookbook

Post Tags:blocks magento 2 Magento 2 Developer’s Cookbook magento 2 extensions

← Previous Post Next Post →

Related posts