How does Magento 2 decide whether to display the product's Stock Status?

dmitry_fedyuk · November 13, 2015, 4:52am

The stock status visibility is controlled by the «Catalog» → «Inventory» → «Stock Options» → «Display products availability in stock on Storefront» backend config option:

The config field declaration:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/CatalogInventory/etc/adminhtml/system.xml#L34-L37


<field id="display_product_stock_status" translate="label" type="select" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
    <label>Display products availability in stock on Storefront.</label>
    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
</field>

The PHP constant:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/CatalogInventory/Model/Configuration.php#L97


const XML_PATH_SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock';


/**
 * Auto return config path
 */
const XML_PATH_ITEM_AUTO_RETURN = 'cataloginventory/item_options/auto_return';


/**
 * Path to configuration option 'Display product stock status'
 */
const XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS = 'cataloginventory/options/display_product_stock_status';


/**
 * @var ConfigInterface
 */
protected $config;


/**
 * Core store config
 *
 * @var ScopeConfigInterface

The \Magento\CatalogInventory\Model\Configuration::isDisplayProductStockStatus() method

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/CatalogInventory/Model/Configuration.php#L365-L372


public function isDisplayProductStockStatus($store = null)
{
    return $this->scopeConfig->isSetFlag(
        self::XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS,
        \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
        $store
    );
}

The \Magento\CatalogInventory\Observer\DisplayProductStatusInfoObserver:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/CatalogInventory/Observer/DisplayProductStatusInfoObserver.php#L37-L41


public function execute(EventObserver $observer)
{
    $info = $observer->getEvent()->getStatus();
    $info->setDisplayStatus($this->stockConfiguration->isDisplayProductStockStatus());
}

The observer’s declaration:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/CatalogInventory/etc/events.xml#L9-L11


<event name="catalog_block_product_status_display">
    <observer name="inventory" instance="Magento\CatalogInventory\Observer\DisplayProductStatusInfoObserver"/>
</event>

The catalog_block_product_status_display event is triggered by the \Magento\Catalog\Block\Product\AbstractProduct::displayProductStockStatus() method

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/Catalog/Block/Product/AbstractProduct.php#L374-L379


public function displayProductStockStatus()
{
    $statusInfo = new \Magento\Framework\DataObject(['display_status' => true]);
    $this->_eventManager->dispatch('catalog_block_product_status_display', ['status' => $statusInfo]);
    return (bool) $statusInfo->getDisplayStatus();
}

The \Magento\Catalog\Block\Product\AbstractProduct::displayProductStockStatus() method is used by product templates.
The default template:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/Catalog/view/frontend/templates/product/view/type/default.phtml#L13-L23


<?php if ($block->displayProductStockStatus()): ?>
<?php if ($_product->isAvailable()): ?>
    <div class="stock available" title="<?php /* @escapeNotVerified */ echo __('Availability') ?>">
        <span><?php /* @escapeNotVerified */ echo __('In stock') ?></span>
    </div>
<?php else: ?>
    <div class="stock unavailable" title="<?php /* @escapeNotVerified */ echo __('Availability') ?>">
        <span><?php /* @escapeNotVerified */ echo __('Out of stock') ?></span>
    </div>
<?php endif; ?>
<?php endif; ?>

The template for the Grouped products:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/GroupedProduct/view/frontend/templates/product/view/type/default.phtml#L15-L25


<?php if ($block->displayProductStockStatus()): ?>
<?php if ($_product->isAvailable() && $_hasAssociatedProducts): ?>
    <div class="stock available" title="<?php /* @escapeNotVerified */ echo __('Availability') ?>">
        <span><?php /* @escapeNotVerified */ echo __('In stock') ?></span>
    </div>
<?php else: ?>
    <div class="stock unavailable" title="<?php /* @escapeNotVerified */ echo __('Availability') ?>">
        <span><?php /* @escapeNotVerified */ echo __('Out of stock') ?></span>
    </div>
<?php endif; ?>
<?php endif; ?>

The template for the Bundle products:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/Bundle/view/frontend/templates/catalog/product/view/type/bundle.phtml#L12-L22


<?php if ($block->displayProductStockStatus()): ?>
<?php if ($_product->isAvailable()): ?>
    <p class="stock available" title="<?php /* @escapeNotVerified */ echo __('Availability:') ?>">
        <span><?php /* @escapeNotVerified */ echo __('In stock') ?></span>
    </p>
<?php else: ?>
    <p class="stock unavailable" title="<?php /* @escapeNotVerified */ echo __('Availability:') ?>">
        <span><?php /* @escapeNotVerified */ echo __('Out of stock') ?></span>
    </p>
<?php endif; ?>
<?php endif; ?>

See also: Has it any sense to display the stock status for the virtual products?