Menu and Menuitems API Guide - Revision history

Robbiej: Added deprecation notice and link to Joomla Manual

2024-11-27T11:04:48Z

Added deprecation notice and link to Joomla Manual

← Older revision		Revision as of 11:04, 27 November 2024
Line 1:		Line 1:
			{{Warning\|This page has been superseded and is no longer maintained. Please go to the [https://manual.joomla.org/docs/general-concepts/menus-menuitems/ Joomla Manual ] instead}}

	{{version/tutor\|3.x}}		{{version/tutor\|3.x}}

Cmb: Several markup changes.

2022-09-17T21:41:47Z

Several markup changes.

Show changes

Robbiej: ref to API guides inserted

2019-12-13T17:05:27Z

ref to API guides inserted

← Older revision		Revision as of 17:05, 13 December 2019
Line 2:		Line 2:

	== Introduction ==		== Introduction ==

			This is one of a series of [[API Guides]], which aim to help you understand how to use the Joomla APIs through providing detailed explanations and sample code which you can easily install and run.

	In Joomla a Menu is the set of navigation links you can have as a main menu (eg at the top of your site) or subsidiary menu (eg in the footer). Each of the individual navigation links is a Menuitem.		In Joomla a Menu is the set of navigation links you can have as a main menu (eg at the top of your site) or subsidiary menu (eg in the footer). Each of the individual navigation links is a Menuitem.

Robbiej: note re admin menu

2019-09-04T10:54:13Z

note re admin menu

← Older revision		Revision as of 10:54, 4 September 2019
Line 44:		Line 44:

	Unpublished menuitems are not returned. They're not included within the <tt>$sitemenu</tt> structure.		Unpublished menuitems are not returned. They're not included within the <tt>$sitemenu</tt> structure.

			Note that there isn't an equivalent method to get the menuitems on the administrator back-end, as the equivalent structure to <tt>$sitemenu</tt> above isn't populated with the admin menu structure. If you wanted to access the menu details you would have to read and interpret the appropriate records from the database.

	== Properties and Parameters ==		== Properties and Parameters ==

Robbiej: fix typo

2019-09-03T20:47:17Z

fix typo

← Older revision		Revision as of 20:47, 3 September 2019
Line 155:		Line 155:
	</source>		</source>

	or by simplying assigning different values to the Menuitem public properties. However these changes are not saved to the database and will last only for the ~~during~~ of handling the current HTTP request.		or by simplying assigning different values to the Menuitem public properties. However these changes are not saved to the database and will last only for the duration of handling the current HTTP request.

	== Sample Module Code ==		== Sample Module Code ==

Robbiej: remaining sections added

2019-09-01T21:17:03Z

remaining sections added

Show changes

Robbiej: Properties and Parameters section added

2019-09-01T20:50:30Z

Properties and Parameters section added

@@ Line 1: / Line 1: @@
 == Introduction ==
@@ Line 9: / Line 11: @@
 == Basic Operations ==
-There isn't a Joomla API to enable you to get the set of Menus on the system, so if you really do need these then your only recourse is to read the data from the menu_types table directly using a SQL query. But you can find from the Menuitem structure described below the Menu which that Menuitem belongs to, and find all the Menuitems for a particular Menu.
+There isn't a Joomla API to enable you to get the set of Menus on the system, so if you really do need these then your only recourse is to read the data from the <tt>menu_types</tt> table directly using a SQL query. But you can find from the Menuitem structure described below the Menu to which that Menuitem belongs, and find all the Menuitems for a particular Menu.
 When the Joomla application starts up in response to an HTTP request arriving at a Joomla site, it builds up a big structure containing lots of things which it realises will likely be needed during the process of working out what will be displayed on the web page. Within this structure it includes all the menuitems which may be needed. To get at this structure do:
@@ Line 44: / Line 46: @@
 == Properties and Parameters ==
 [[Category:Development]]

Robbiej: Page created with into section

2019-09-01T19:57:25Z

Page created with into section

New page

== Introduction ==

In Joomla a Menu is the set of navigation links you can have as a main menu (eg at the top of your site) or subsidiary menu (eg in the footer). Each of the individual navigation links is a Menuitem.

Within an overall Menu structure you can have a "submenu". This isn't implemented as a Joomla Menu construct, but rather as a set of Menuitems below a parent Menuitem. The Joomla Menuitems are thus implemented in an ordered tree structure, specifically using the [https://en.wikipedia.org/wiki/Nested_set_model Nested Set model].

This guide explains the Joomla API around the Menu/Menuitem area, and includes sample module code which you can install on your site as a demonstration of the capabilities.

== Basic Operations ==

There isn't a Joomla API to enable you to get the set of Menus on the system, so if you really do need these then your only recourse is to read the data from the menu_types table directly using a SQL query. But you can find from the Menuitem structure described below the Menu which that Menuitem belongs to, and find all the Menuitems for a particular Menu.

When the Joomla application starts up in response to an HTTP request arriving at a Joomla site, it builds up a big structure containing lots of things which it realises will likely be needed during the process of working out what will be displayed on the web page. Within this structure it includes all the menuitems which may be needed. To get at this structure do:

<source lang="php">
use Joomla\CMS\Factory;
$app = Factory::getApplication();
$sitemenu = $app->getMenu();
</source>

The <tt>$sitemenu</tt> structure will have entries for all the menuitems (plus access to a lot of other information besides, but which doesn't concern us).

To get at the individual menuitems we apply a filter to <tt>$sitemenu</tt> using <tt>getItems()</tt> to select the particular menuitems we're interested in. To obtain an array of all the menuitems use a blank filter:

<source lang="php">
$menuitems = $sitemenu->getItems(array(), array());
</source>

To obtain an array of all the menuitems which are in the "mainmenu" menu use:

<source lang="php">
$mainmenuItems = $sitemenu->getItems('menutype', 'mainmenu');
</source>

The above gives all the menuitems within the "mainmenu" menu, including those in submenus. To access just the menuitems which are in the topmost or first submenu level of the "mainmenu" menu use:

<source lang="php">
$mainmenuItems = $sitemenu->getItems(array('menutype','level'), array('mainmenu',array("1","2")));
</source>

To filter the specific menuitems you want, you pass an array of properties (from the list in the next section) and an array of corresponding values which those properties should have.

Unpublished menuitems are not returned. They're not included within the <tt>$sitemenu</tt> structure.

== Properties and Parameters ==

[[Category:Development]]
[[Category:Tutorials]]
[[Category:Module Development]]
[[Category:Plugin Development]]
[[Category:Component Development]]