This recipe is compatible with eZ Publish 5.2 / 2013.09

 

Description

Knowledge of the root location is important since it can be a starting point for API queries, or even links to home page, but as eZ Publish can be used for multisite development, and as such root location can vary.

By default, root location ID is 2, but as it can be easily be changed by configuration, the best practice is to retrieve it dynamically.

Retrieving root location ID

Root location ID can be retrieved easily from ConfigResolver. Parameter name is content.tree_root.location_id.

<?php
namespace Acme\TestBundle\Controller;

use eZ\Bundle\EzPublishCoreBundle\Controller;


class DefaultController extends Controller
{
    public function fooAction()
    {
        // ...
 
        $rootLocationId = $this->getConfigResolver()->getParameter( 'content.tree_root.location_id' );
 
        // ...
    }
}

Retrieving the root location

From a template

Root location is exposed in the global Twig helper.

<a href="{{ path( ezpublish.rootLocation ) }}" title="Link to homepage">Home page</a>

From a controller

<?php
namespace Acme\TestBundle\Controller;

use eZ\Bundle\EzPublishCoreBundle\Controller;

class DefaultController extends Controller
{
    public function fooAction()
    {
        // ...

        $rootLocation = $this->getRootLocation();

        // ...
    }
}
<?php
namespace Acme\TestBundle\Controller;

use eZ\Bundle\EzPublishCoreBundle\Controller;

class DefaultController extends Controller
{
    public function fooAction()
    {
        // ...

        $rootLocationId = $this->getConfigResolver()->getParameter( 'content.tree_root.location_id' );
        $rootLocation = $this->getRepository()->getLocationService()->loadLocation( $rootLocationId );

        // ...
    }
}