How to get a product by its ID programmatically?

dmitry_fedyuk · February 26, 2016, 3:25pm

Interface

Use the getById() 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#L39-L49


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

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

Implementation

How does \Magento\Catalog\Api\ProductRepository::getById() work?

Usage

Example 1

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Helper/Product.php#L416-L420


try {
    $product = $this->productRepository->getById($productId, false, $this->_storeManager->getStore()->getId());
} catch (NoSuchEntityException $e) {
    return false;
}

Example 2

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Bundle/Controller/Adminhtml/Product/Initialization/Helper/Plugin/Bundle.php#L158-L158


$linkProduct = $this->productRepository->getById($linkData['product_id']);

Example 3

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Block/Product/View.php#L163-L175


/**
 * Retrieve current product model
 *
 * @return \Magento\Catalog\Model\Product
 */
public function getProduct()
{
    if (!$this->_coreRegistry->registry('product') && $this->getProductId()) {
        $product = $this->productRepository->getById($this->getProductId());
        $this->_coreRegistry->register('product', $product);
    }
    return $this->_coreRegistry->registry('product');
}

Example 4

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Console/Command/ImagesResizeCommand.php#L89-L89


$product = $this->productRepository->getById($productId);

Example 5

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Controller/Adminhtml/Product/Save.php#L180-L180


$product = $this->productRepository->getById($productId);

Example 6

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Controller/Adminhtml/Product/Initialization/Helper.php#L225-L225


$linkProduct = $this->productRepository->getById($linkData['id']);

Example 7

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Catalog/Controller/Product/Compare/Add.php#L28-L32


try {
    $product = $this->productRepository->getById($productId, false, $storeId);
} catch (NoSuchEntityException $e) {
    $product = null;
}

dmitry_fedyuk · February 26, 2016, 3:33pm

Interface

Implementation

Usage

Example 1

Example 2

Example 3

Example 4

Example 5

Example 6

Example 7

Example 8

Example 9

Example 10

Example 11

Example 12