Simple Navigator Snippet for ModX Revolution

Simple Navigator Snippet for ModX Revolution

Posted:  January 10, 2014

Simple Navigator Snippet for ModX Revolution

I found myself needing a really simple way to pull in my sites menu, but also wanted the ability to have some placeholders for the links as well.  The following code should be created as a snippet, and called un-cached [[!YOUR_SNIPPET_NAME]]

What’s it do?

Well, simply put it generates a navigation block, and throws all your ModX site page links into a hierarchal un-ordered list of link items.  As well, as generates a bunch of dynamic placeholders in case you have a need for them.  Note:  the snippet needs to be called, prior to placing any placeholders in your content.

How Do I Use This?

Create your template or page and place the following snippet call (make sure to replace YOUR_SNIPPET_NAME, with whatever you named this…)

[[+link.Title-11]] .:. [[+link.MenuTitle-11]] .:. [[+link.URL-11]] // Pulls the link Title, Menu Title, and Link for Resource ID 11
<hr />
 [[!YOUR_SNIPPET_NAME? &Wrapper_Class=`MenuWrapper`
			 &Wrapper_Extra=` data-rel="Wrapper"`

What’s All This Mean?

The snippet generates a multi-level navigation structure.   It only pulls published documents, that are not hidden from the menu, and are not deleted.  The items are sorted by the parent first, then by the items menu index.  It is only capable of rendering a menu for modDocuments, and modWebLinks…   In the case of modWebLinks, it will inject the Link Attributes (useful for target=”_blank”)  It sets the link title to the resources Long Title, uses the Menu Title for display, Resource Alias for ID’s, and Resource URIs for the links  it also generates a series of placeholders:

  •  [[+link.Title-PAGEID]]
  •  [[+link.MenuTitle-PAGEID]]
  •  [[+link.URL-PAGEID]]

It is also capable of running included basic snippets if specified, and the snippet exists in the ‘Summary’ field of the resource.  This is useful if you need to pull in some other nav items from other sources… for instance, I pull in the top 5 latest articles from my blog  but need them to be displayed in my main menu  NOTE: At this time, it does not include Snippet parameters, nor does it matter if you put in the !


 &Wrapper_Class = css class for the <nav> wrapper
 &Wrapper_ID = ID of the <nav> wrapper
 &Wrapper_Extra = any valid <nav> attributes
 &Contains_Snippet = true/false
&Should_Cache = true/false
&Cache_Length = # of seconds

Where’s My Code?

Keep your pants on, here ya go… just copy/paste it into YOUR_SNIPPET_NAME’s code

 	// Set some variable we can use to set some classes, id's, extras
	$wc = (string)(strlen($Wrapper_Class) > 0) ? $Wrapper_Class : 'wrapper';
	$wi = (string)(strlen($Wrapper_ID) > 0) ? $Wrapper_ID : 'wrapper';
	$we = (string)(strlen($Wrapper_Extra) > 0) ? $Wrapper_Extra : null;
	$cs = (bool)(!empty($Contains_Snippet)) ? filter_var($Contains_Snippet, FILTER_VALIDATE_BOOLEAN) : false;	
	$sc = (bool)(!empty($Should_Cache)) ? filter_var($Should_Cache, FILTER_VALIDATE_BOOLEAN) : true;
	$cl = (int)((int)$Cache_Length > 0) ? (int)$Should_Cache : 7200;	// Check string for snippet
		function IsSnippet($str){
			$pattern = '/[[!?(.*)]]/';
			return preg_match($pattern, $str, $match);
	}	// recursive function to generate our un-ordered list of menu items
		function GenerateMenu($level, $parent = 0, $wc, $wi, $we, $cs, $sc, $cl){
			try {
				$lvl = ++$level;
				global $modx;
				// Check for #1, should this be cached, #2 does it already exist in the cache
				$cached = $modx->cacheManager->get('Navigator');
				if($sc && isset($cached)){
					// return our cached menu
					return $cached;
					// get the site start
					$siteStartId = $modx->getOption('site_start');
					// Set our initial rows array
					$rows = array();
					// Run our query to get our menu items
					$sql = 'Select `id`, `menutitle`, `uri`, `longtitle`, `parent`, `link_attributes`, `class_key`, `content`, `alias`, `introtext`
										From `' . $modx->getOption(xPDO::OPT_TABLE_PREFIX) . 'site_content` 
										Where `deleted` = 0 AND `hidemenu` = 0 AND `published` = 1 AND `parent` = :parent
										Order by `parent`, `menuindex`';
					$query = new xPDOCriteria($modx, $sql, array(':parent' => $parent));
					if ($query->stmt && $query->stmt->execute()) {
						$rows = $query->stmt->fetchAll(PDO::FETCH_ASSOC);
					// do some cleanup
					unset($query, $sql);
					// make sure we have some rows, and then build our html for the menu
						// grab a count of our results
						$rCt = count($rows);
						$cls = ($lvl > 1) ? 'sub-item-' . $lvl : 'main-item-' . $lvl;
						$ret .= '   <ul class="' . $cls . '" id="' . $cls . '-' . $parent . '">' . "rn";
						for($i = 0; $i < $rCt; ++$i){
							// if this resource is a WebLink, show the content in it, as the URL for the href tag, otherwise, use the resource's URI
							$url = ($rows[$i]['class_key'] == 'modWebLink') ? $rows[$i]['content'] : '/' . $rows[$i]['uri'];
							// Check for the site's start id, if true, show a "blank" link, otherwise show the $url
							$showUrl = ($siteStartId == $rows[$i]['id']) ? '/' : $url;
							$la = (strlen($rows[$i]['link_attributes']) > 0) ? ' ' . $rows[$i]['link_attributes'] : null;
							$ret .= '       <li class="' . $cls . '" id="' . $rows[$i]['alias'] . '">' . "rn";
							$ret .= '           <a href="' . $showUrl . '" title="' . $rows[$i]['longtitle'] . '"' . $la . '>' . $rows[$i]['menutitle'] . '</a>' . "rn";
							$ret .= GenerateMenu($lvl, $rows[$i]['id']);
							// Check for a snippet, and render it
							$it = $rows[$i]['introtext'];
							if($cs && IsSnippet($it)){
								// if we find a snippet in the Summary field, run it, and attach it to our output   
								preg_match('/[[!?(.*)]]/', $it, $sm);
								$ret .= $modx->runSnippet($sm[1]);
								// clean up
							$ret .= '       </li>' . "rn";
						$ret .= '   </ul>' . "rn";					}
					// clean up
					// Check to see if we should cache it, if so, set it to cache, and apply the length of time it should be cached for: defaults to 2 hours
						// Set the navigation to cache
						$modx->cacheManager->set('Navigator', $ret, $cl);
					// return the menu
					return $ret;
			} catch(Exception $e) {
				// If there was an error, make sure to write it out to the modX Error Log
				$modx->log(modX::LOG_LEVEL_ERROR, '[Navigator:GenerateMenu] Error: ' . $e->getMessage());
				return null;
	}	// Generate the placeholders to use
		function GeneratePlaceholders($sc, $cl){
			// need to global modx object
			global $modx;
			$rows = array();
			// get the ID of the start page
			$siteStartId = (int)$modx->getOption('site_start');
			// Run our query to get our menu items-- check for the cache first
			$cached = $modx->cacheManager->get('NavigatorPHs');
			if($sc && isset($cached)){
				$rows = $cached;
				$sql = 'Select `id`, `menutitle`, `uri`, `longtitle`, `class_key`, `content`
									From `' . $modx->getOption(xPDO::OPT_TABLE_PREFIX) . 'site_content` 
									Where `deleted` = 0 AND `hidemenu` = 0 AND `published` = 1
									Order by `parent`, `menuindex`';
				$query = new xPDOCriteria($modx, $sql, array());
				if ($query->stmt && $query->stmt->execute()) {
					$rows = $query->stmt->fetchAll(PDO::FETCH_ASSOC);
						$modx->cacheManager->set('NavigatorPHs', $rows, $cl);
				// do some cleanup
				unset($query, $sql);
				$rCt = count($rows);
				for($i = 0; $i < $rCt; ++$i){
					// if this resource is a WebLink, show the content in it, as the URL for the href tag, otherwise, use the resource's URI
					$url = ($rows[$i]['class_key'] == 'modWebLink') ? $rows[$i]['content'] : '/' . $rows[$i]['uri'];
					// Check for the site's start id, if true, show a "blank" link, otherwise show the $url
					$showUrl = ($siteStartId == $rows[$i]['id']) ? '/' : $url;
					$item = array('Title-' . $rows[$i]['id'] => $rows[$i]['longtitle'],
												'MenuTitle-' . $rows[$i]['id'] => $rows[$i]['menutitle'],
												'URL-' . $rows[$i]['id'] => $showUrl);
					$modx->toPlaceholders($item, 'link');
	}		// Fire up the placeholder generator
	GeneratePlaceholders($sc, $cl);
	// Fire up the menu
	$return = '<nav class="' . $wc . '" id="' . $wi . '"' . $we . '>' . "rn";
	$return .= GenerateMenu(0, 0, $wc, $wi, $we, $cs, $sc, $cl);
	$return .= '</nav>' . "rn";
	// Write it out to the page
	echo $return;
Kevin Pirnie

Kevin Pirnie

20+ Years of PC and server maintenance & over 15+ years of web development/design experience; you can rest assured that I take every measure possible to ensure your computers are running to their peak potentials. I treat them as if they were mine, and I am quite a stickler about keeping my machines up to date and optimized to run as well as they can.

Our Privacy Policy

Revised: June 8, 2021

Thank you for choosing to be part of my website at (“Company”, “I”, “me”, “mine”). I am committed to protecting your personal information and your right to privacy. If you have any questions or concerns about this privacy notice, or my practices with regards to your personal information, please contact me at .

When you visit my website (the “Website”), and more generally, use any of my services (the “Services”, which include the Website), I appreciate that you are trusting me with your personal information. I take your privacy very seriously. In this privacy notice, I seek to explain to you in the clearest way possible what information we collect, how I use it and what rights you have in relation to it. I hope you take some time to read through it carefully, as it is important. If there are any terms in this privacy notice that you do not agree with, please discontinue use of my Services immediately.

This privacy notice applies to all information collected through my Services (which, as described above, includes our Website), as well as, any related services, sales, marketing or events.

Please read this privacy notice carefully as it will help you understand what I do with the information that I collect.


Information automatically collected

In Short: Some information – such as your Internet Protocol (IP) address and/or browser and device characteristics – is collected automatically when you visit my Website.

I automatically collect certain information when you visit, use or navigate the Website. This information does not reveal your specific identity (like your name or contact information) but may include device and usage information, such as your IP address, browser and device characteristics, operating system, language preferences, referring URLs, device name, country, location, information about how and when you use our Website and other technical information. This information is primarily needed to maintain the security and operation of our Website, and for our internal analytics and reporting purposes.

Like many businesses, I also collect information through cookies and similar technologies.

The information I collect includes:
Log and Usage Data. Log and usage data is service-related, diagnostic, usage and performance information our servers automatically collect when you access or use our Website and which we record in log files. Depending on how you interact with us, this log data may include your IP address, device information, browser type and settings and information about your activity in the Website (such as the date/time stamps associated with your usage, pages and files viewed, searches and other actions you take such as which features you use), device event information (such as system activity, error reports (sometimes called ‘crash dumps’) and hardware settings).

Device Data. I collect device data such as information about your computer, phone, tablet or other device you use to access the Website. Depending on the device used, this device data may include information such as your IP address (or proxy server), device and application identification numbers, location, browser type, hardware model Internet service provider and/or mobile carrier, operating system and system configuration information.

Location Data. I collect location data such as information about your device’s location, which can be either precise or imprecise. How much information I collect depends on the type and settings of the device you use to access the Website. For example, I may use GPS and other technologies to collect geolocation data that tells me your current location (based on your IP address). You can opt out of allowing me to collect this information either by refusing access to the information or by disabling your Location setting on your device. Note however, if you choose to opt out, you may not be able to use certain aspects of the Services.


In Short: I process your information for purposes based on legitimate business interests, the fulfillment of my contract with you, compliance with my legal obligations, and/or your consent.

I use personal information collected via my Website for a variety of business purposes described below. I process your personal information for these purposes in reliance on my legitimate business interests, in order to enter into or perform a contract with you, with your consent, and/or for compliance with my legal obligations. I indicate the specific processing grounds I rely on next to each purpose listed below.

For other business purposes. I may use your information for other business purposes, such as data analysis, identifying usage trends, determining the effectiveness of our promotional campaigns and to evaluate and improve my Website, products, marketing and your experience. I may use and store this information in aggregated and anonymized form so that it is not associated with individual end users and does not include personal information. I will not use identifiable personal information without your consent.


In Short: I only share information with your consent, to comply with laws, to provide you with services, to protect your rights, or to fulfill business obligations.


In Short: I may use cookies and other tracking technologies to collect and store your information.

I may use cookies and similar tracking technologies (like web beacons and pixels) to access or store information. Specific information about how I use such technologies and how you can refuse certain cookies is set out in our Cookie Notice.


In Short: We may transfer, store, and process your information in countries other than your own.

My servers are located in the United States of America, unless otherwise requested by my clients. If you are accessing my Website from outside, please be aware that your information may be transferred to, stored, and processed by me in my facilities and by those third parties with whom I may share your personal information (see “WILL YOUR INFORMATION BE SHARED WITH ANYONE?” above), in and other countries.

If you are a resident in the European Economic Area, then these countries may not necessarily have data protection laws or other similar laws as comprehensive as those in your country. I will however take all necessary measures to protect your personal information in accordance with this privacy notice and applicable law.


In Short: I keep your information for as long as necessary to fulfill the purposes outlined in this privacy notice unless otherwise required by law.

I will only keep your personal information for as long as it is necessary for the purposes set out in this privacy notice, unless a longer retention period is required or permitted by law (such as tax, accounting or other legal requirements). No purpose in this notice will require me keeping your personal information for longer than 6 months.

When I have no ongoing legitimate business need to process your personal information, I will either delete or anonymize such information, or, if this is not possible (for example, because your personal information has been stored in backup archives), then I will securely store your personal information and isolate it from any further processing until deletion is possible.


In Short: I aim to protect your personal information through a system of organizational and technical security measures.

I have implemented appropriate technical and organizational security measures designed to protect the security of any personal information I process. However, despite our safeguards and efforts to secure your information, no electronic transmission over the Internet or information storage technology can be guaranteed to be 100% secure, so I cannot promise or guarantee that hackers, cybercriminals, or other unauthorized third parties will not be able to defeat my security, and improperly collect, access, steal, or modify your information. Although I will do my best to protect your personal information, transmission of personal information to and from my Website is at your own risk. You should only access the Website within a secure environment.


In Short: I do not knowingly collect data from or market to children under 18 years of age.

I do not knowingly solicit data from or market to children under 18 years of age. By using the Website, you represent that you are at least 18 or that you are the parent or guardian of such a minor and consent to such minor dependent’s use of the Website. If I learn that personal information from users less than 18 years of age has been collected, I will deactivate the account and take reasonable measures to promptly delete such data from my records. If you become aware of any data I may have collected from children under age 18, please contact me at .


In Short: You may review, change, or terminate your account at any time.

If you are a resident in the European Economic Area and you believe I am unlawfully processing your personal information, you also have the right to complain to your local data protection supervisory authority. You can find their contact details here:

If you are a resident in Switzerland, the contact details for the data protection authorities are available here:

Cookies and similar technologies: Most Web browsers are set to accept cookies by default. If you prefer, you can usually choose to set your browser to remove cookies and to reject cookies. If you choose to remove cookies or reject cookies, this could affect certain features or services of my Website.


Most web browsers and some mobile operating systems and mobile applications include a Do-Not-Track (“DNT”) feature or setting you can activate to signal your privacy preference not to have data about your online browsing activities monitored and collected. At this stage no uniform technology standard for recognizing and implementing DNT signals has been finalized. As such, I do not currently respond to DNT browser signals or any other mechanism that automatically communicates your choice not to be tracked online. If a standard for online tracking is adopted that I must follow in the future, I will inform you about that practice in a revised version of this privacy notice.


In Short: Yes, if you are a resident of California, you are granted specific rights regarding access to your personal information.

California Civil Code Section 1798.83, also known as the “Shine The Light” law, permits my users who are California residents to request and obtain from me, once a year and free of charge, information about categories of personal information (if any) I disclosed to third parties for direct marketing purposes and the names and addresses of all third parties with which I shared personal information in the immediately preceding calendar year. If you are a California resident and would like to make such a request, please submit your request in writing to me using the contact information provided below.

If you are under 18 years of age, reside in California, and have a registered account with the Website, you have the right to request removal of unwanted data that you publicly post on the Website. To request removal of such data, please contact us using the contact information provided below, and include the email address associated with your account and a statement that you reside in California. I will make sure the data is not publicly displayed on the Website, but please be aware that the data may not be completely or comprehensively removed from all my systems (e.g. backups, etc.).


In Short: Yes, I will update this notice as necessary to stay compliant with relevant laws.

I may update this privacy notice from time to time. The updated version will be indicated by an updated “Revised” date and the updated version will be effective as soon as it is accessible. If I make material changes to this privacy notice, I may notify you either by prominently posting a notice of such changes or by directly sending you a notification. We encourage you to review this privacy notice frequently to be informed of how I am protecting your information.


If you have questions or comments about this notice, you may email me at or by post to:

Kevin C. Pirnie

22 Orlando St.
Feeding Hills, MA 01030
United States of America


Based on the applicable laws of your country, you may have the right to request access to the personal information I collect from you, change that information, or delete it in some circumstances. To request to review, update, or delete your personal information, you may email me at or by post to:

Kevin C. Pirnie

22 Orlando St.
Feeding Hills, MA 01030
United States of America