How to check if current url is homepage in Magento 2

How to check if the current URL is the homepage URL? You are also wondering that question and also finding the perfect way for your Magento 2 store. If you have ever been not sure if a page is a homepage or not, this post will guide you to clarify it by using the PHP code.

Let’s start!

3 Steps to check if current url is homepage in Magento 2

• Step 1: Declare in Mageplaza_HelloWorld
• Step 2: Declare function in template .phtml file
• Step 3: Get output in index.php file

Step 1: Declare in Mageplaza_HelloWorld

You will use a block class of the module Mageplaza_HelloWorld, then possibly inject the object of Logo class in the constructor of the module’s block class.

app/code/Mageplaza/HelloWorld/Block/HelloWorld.php

<?php
namespace Mageplaza\HelloWorld\Block;
class HelloWorld extends \Magento\Framework\View\Element\Template
{
	protected $_logo;	
	
	public function __construct(
		\Magento\Backend\Block\Template\Context $context,
		\Magento\Theme\Block\Html\Header\Logo $logo,
		array $data = []
	)
	{		
		$this->_logo = $logo;
		parent::__construct($context, $data);
	}
	
	/**
     * Check if current url is url for home page
     *
     * @return bool
     */
    public function isHomePage()
    {	
		return $this->_logo->isHomePage();
	}
}
?>

You can see more functions in vendor/magento/module-theme/Block/Html/Header/Logo.php.

Step 2: Declare function in template .phtml file

Run the below function in your template .phtml file

if ($block->isHomePage()) {
    // do something
}

Step 3: Get output in index.php file

To get the output of the bottom of the current page (homepage or another page), you can write the following script in the index.php file.

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$helloWorldBlock = $objectManager->get('Mageplaza\HelloWorld\Block\HelloWorld');
var_dump($helloWorldBlock->isHomePage());

Please follow three steps and you can check the current url. In case that you have any queries about the article or any questions in general, use the comment section below!

Related Post

• Add a custom checkout step in Magento 2
• Run cron job manually in Magento 2
• Magento 2 Tutorials
• Magento 2 Services

Wrap up

You have got a simple and effective solution to confirm if the current page is a homepage or not. Please follow three steps and you can check the current url. In case that you have any queries about the article or any questions in general, use the comment section below!