Joomla 4.x Tutorial - Extension Development - A Menu Item

Modify this post

In this article you will learn how to create a menu item for the frontend view of your component. So it is not necessary that you know the exact URL. Later a modification to search engine friendly (SEF) URLsdocs.joomla.org/enabling_search_engine_friendly_(sef)_urls/ is possible. As a note, please do not enable this feature yet. This sample extension does not support SEF yet. We will add the Joomla conform routing later.

For impatient people: View the changed program code in the Diff Viewgithub.com/astridx/boilerplate/compare/t2...t3 and copy these changes into your development version.

Step by step

New files

The menu item in the frontend works differently than the one in the administration area. We create a separate XML file. Later we will use parameters. But for now we keep it straightforward. We add some language strings for text. Later on, we will see how to translate them.

components/com_foos/ tmpl/foo/default.xml

Create the file default.xml under components/com_foos/tmpl/foo and add the following code:

components/com_foos/ tmpl/foo/default.xml

<!-- https://raw.githubusercontent.com/astridx/boilerplate/t3/src/components/com_foos/tmpl/foo/default.xml -->

<?xml version="1.0" encoding="utf-8"?>
<metadata>
	<layout title="COM_FOOS_FOO_VIEW_DEFAULT_TITLE">
		<message>
			<![CDATA[COM_FOOS_FOO_VIEW_DEFAULT_DESC]]>
		</message>
	</layout>
</metadata>

I already mentioned it in the chapter on the update server: The term CDATAen.wikipedia.org/wiki/cdata is used in the XML markup language for various purposes. It indicates that a given part of the document is general characters rather than program code with a more specific, limited structure. The CDATA section may contain markup characters (<, > and &). These are not interpreted further by the parser. The use of entities such as &lt; and &amp; is not necessary.

The title attribute in the layout tag here is used when we create a new menu item for this component in the administration area. The text in the message tag is displayed as a description. The language string does not stay as it is. It will be translated into different languages. We will work on this later. Here we prepare everything.

Test your Joomla component

  1. install your component in Joomla version 4 to test it: Copy the files in the components folder to the components folder of your Joomla 4 installation. A new installation is not necessary. Continue using the ones from the previous part.
  2. open the menu manager to create a menu item. To do this, click on Menu in the left sidebar and then on All Menu Items.

Joomla - Create a menu item in the backend

Then click on the New button and fill in all the necessary fields.

Joomla - Select the type of menu item in the backend

  1. find the appropriate Menu Item Type with the Select button.

Joomla - Save a menu item in the backend

  1. save the menu item.
  2. switch to the frontend and make sure that the menu item is created correctly and works.

Joomla - The view of the menu item in the frontend

Modify this post

Comments