How to add breadcrumbs

From Joomla! Documentation

Revision as of 10:35, 19 September 2010 by Batch1211 (Talk | contribs)

Replacement filing cabinet.png

Breadcrumbs are nice way to display the connection from the root. It gives you a hierarchical representation with click able links so that user can visit upper links easily. Breadcrumbs can be added in templates by using the object returned by $mainframe->getPathWay(). The member function addItem() allows to add a breadcrumb with the title of choice.

There are two parameters used for breadcrumbs creation process, and the first parameter is the title for the breadcrumb and the second parameter is the URL. If we do not need the breadcrumb to work like a link then we need to simply pass a blank string and then it will not work like a click able URL. This term is useful for hierarchical components where we have subcategories: we can generate a link to each and then end with the title of the current record or category.

The JPathway is currently used by the breadcrumbs module. If you are adding a new component and have already configured breadcrumbs, you may need to go into the breadcrumbs configuration and add the menu item for you component to the selection on the menu selelist.


A view's view.php could look something like this.

class exampleViewdefault extends JView {
        function display($tpl = null) {

                $mainframe = &JFactory::getApplication();
                $document  = &JFactory::getDocument();              
                $pathway   =& $mainframe->getPathway();

                $model =& $this->getModel();
                $data = $model->getData();

                $this->assignRef( 'events', $data);

                $document->setTitle( $this->events['name'] );             
                $pathway->addItem($this->events['name'], '');



See Also