Notice: You are browsing the documentation for PrestaShop 9, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 8. Read the current version of this page

Shop context

In many cases, your code will need to know if the multistore mode is enabled, if there are more than one shop activated, and if yes, what is the current shop context. This is where the shop context and multistore feature adapters will come in handy.

The multistore feature adapter

Service identifier: prestashop.adapter.feature.multistore (it takes the legacy configuration adapter as a parameter)
Class: PrestaShop\PrestaShop\Adapter\Feature\MultistoreFeature

The multistore feature adapter can be used to:

  • detect if multistore was enabled in the configuration,

  • detect if multistore is active (if it is enabled, and if there are more than one active shop),

  • enable/disable the multistore feature.

Example:

<?php

// Get the multistore feature adapter from the service container
$multistoreFeature = $this->get('prestashop.adapter.feature.multistore');

// Is the multistore feature enabled?
$isMultistoreEnabled = $multistoreFeature->isActive();

// This will check that multistore is enabled AND that there are at least two active shops
$isMultistoreUsed = $multistoreFeature->isUsed();

// Disable / enable multistore feature
$multistoreFeature->disable();
$multistoreFeature->enable();

The shop context adapter

Service identifier: prestashop.adapter.shop.context
Class: PrestaShop\PrestaShop\Adapter\Shop\Context

When the multistore feature is enabled, at the top of all Back Office pages, a dropdown is displayed. It allows selecting the shop context we want (all shops, a group shop, a single shop). The shop context adapter will tell you in what context your code is operating.

Here are some examples of commonly used functions in the shop context adapter:

<?php

// Get the shop context adapter from the service container
$shopContext = $this->get('prestashop.adapter.shop.context');

// Get a list of all active shops
$shopList = $shopContext->getShops(false, true);

// Is the current context a group of shops?
$isShopGroupContext = $shopContext->isShopGroupContext();

// Is the current context a single shop?
$isSingleShopContext = $shopContext->isSingleShopContext();

// Is "all shops" context
$isAllShopContext = $shopContext->isAllContext();

// Get a list of IDs for all shops belonging to the current context (useful is the current context is a group) 
$shopList = $shopContext->getContextListShopID();

// Get the id of the shop in the current context (useful if the current context is a single shop)
$currentIdShop = $shopContext->getContextShopID();

The shop context adapter class has many functions with self-explanatory naming and helpful comments, feel free to explore it by yourself.