How to get a product by its SKU programmatically?

dmitrii_fediuk · February 26, 2016, 3:26pm

Interface

Use the get() method of the [Magento\Catalog\Api\ProductRepositoryInterface] (https://github.com/magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Api/ProductRepositoryInterface.php) interface:

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Api/ProductRepositoryInterface.php#L27-L37


/**
 * Get info about product by product SKU
 *
 * @param string $sku
 * @param bool $editMode
 * @param int|null $storeId
 * @param bool $forceReload
 * @return \Magento\Catalog\Api\Data\ProductInterface
 * @throws \Magento\Framework\Exception\NoSuchEntityException
 */
public function get($sku, $editMode = false, $storeId = null, $forceReload = false);

It throws a \Magento\Framework\Exception\NoSuchEntityException exception if a product with the given SKU is not found.

Implementation

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/etc/di.xml#L10-L10


<preference for="Magento\Catalog\Api\ProductRepositoryInterface" type="Magento\Catalog\Model\ProductRepository" />

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Model/ProductRepository.php#L23-L23


class ProductRepository implements \Magento\Catalog\Api\ProductRepositoryInterface

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Model/ProductRepository.php#L179-L199


public function get($sku, $editMode = false, $storeId = null, $forceReload = false)
{
    $cacheKey = $this->getCacheKey([$editMode, $storeId]);
    if (!isset($this->instances[$sku][$cacheKey]) || $forceReload) {
        $product = $this->productFactory->create();


        $productId = $this->resourceModel->getIdBySku($sku);
        if (!$productId) {
            throw new NoSuchEntityException(__('Requested product doesn\'t exist'));
        }
        if ($editMode) {
            $product->setData('_edit_mode', true);
        }
        if ($storeId !== null) {
            $product->setData('store_id', $storeId);
        }
        $product->load($productId);
        $this->instances[$sku][$cacheKey] = $product;
        $this->instancesById[$product->getId()][$cacheKey] = $product;
    }
    return $this->instances[$sku][$cacheKey];

Usage

Example 1

Example 2

Example 3

Example 4

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Bundle/Model/OptionManagement.php#L40-L40


$product = $this->productRepository->get($option->getSku());

Example 5

Example 6

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Bundle/Ui/DataProvider/Product/Form/Modifier/Composite.php#L105-L105


$linkedProduct = $this->productRepository->get($productLink->getSku());

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Model/Product/TierPriceManagement.php#L93-L93


$product = $this->productRepository->get($sku, ['edit_mode' => true]);

Example 10

https://github.com/magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Model/Product/Gallery/GalleryManagement.php#L56-L56

dmitrii_fediuk · February 26, 2016, 3:34pm

Interface

Implementation

Usage

Example 1

Example 2

Example 3

Example 4

Example 5

Example 6

Example 7

Example 8

Example 9

Example 10