Creating Custom URLs with Parameters in Magento 2

In Magento 2, generating custom URLs with parameters is a common requirement for various purposes like linking to specific pages, filtering products, or passing data between different parts of the application. In this post, we’ll explore how to create custom URLs with parameters in Magento 2 using the UrlInterface class.

Using UrlInterface for URL Generation

Magento 2 provides the UrlInterface class, which allows developers to generate URLs dynamically within their modules or extensions. This class provides methods for building URLs with various parameters, including route paths, route parameters, and query parameters.

Creating a Custom URL Builder Class

To create a custom URL builder class, we’ll inject the UrlInterface into our class constructor and define a method for building URLs with parameters.

use Magento\Framework\UrlInterface;

class CustomUrlBuilder
{
    protected $urlBuilder;

    public function __construct(
        UrlInterface $urlBuilder
    ) {
        $this->urlBuilder = $urlBuilder;
    }

    public function buildUrlWithParams($routePath, $routeParams = [])
    {
        return $this->urlBuilder->getUrl($routePath, $routeParams);
    }
}

Generating URLs with Parameters

Now that we have our custom URL builder class set up, we can use it to generate URLs with parameters. Here’s an example of how to do this:

$routePath = 'catalog/product/view'; // Route path of the page
$routeParams = ['id' => 123, '_query' => ['param1' => 'value1', 'param2' => 'value2']];

$url = $customUrlBuilder->buildUrlWithParams($routePath, $routeParams);

In this example, we specify the route path of the page we want to link to (catalog/product/view) and provide any route parameters (e.g., product ID) as an associative array. Additionally, we can include query parameters by passing them in the _query parameter of the route parameters array.

Conclusion

Creating custom URLs with parameters in Magento 2 is straightforward and provides developers with the flexibility to generate dynamic links within their applications. By leveraging the UrlInterface class and custom URL builder classes, developers can easily generate URLs with route paths, route parameters, and query parameters, enabling enhanced functionality and user experience in Magento 2 stores.