UberMenu Conditionals

Introduction to UberMenu Conditionals

Welcome to UberMenu Conditionals! Thank you for purchasing this plugin, I appreciate it!

This guide should answer all your questions about how to use this plugin. You can browse the document using the navigation sidebar on the left, or search the entire document by using CTRL+F in your browser.

The latest version of this support guide can always be found here: UberMenu Conditionals Support Guide.

Getting Support

Please be polite when requesting support, and I'll be sure to respond as soon as possible. I'll do my best to answer your questions, but unfortunately I generally can't offer customizations beyond a few lines of code - there just aren't enought hours in the day! Of course, I will always provide fixes for any bugs that crop up as soon as can be :)

Requirements

1. WordPress 3.4+
2. UberMenu 2.1+

Installation

Install the Plugin

WordPress Plugin Uploader

You can install UberMenu Conditionals via the WordPress plugin uploader without unzipping the file.

1. Log into your WordPress admin panel
2. Navigate to Plugins > Add New
3. Click Upload
4. Click Choose File and select the UberMenu Conditionals download zip.
5. Click Install Now.

FTP

You can also install UberMenu Conditionals via FTP

1. Extract the .zip file you downloaded from CodeCanyon.
2. Find the ubermenu-conditionals folder (this directory is created when you unzip the file).
3. Upload the ubermenu-conditionals folder to your wp-content/plugins directory.
4. Navigate to your Control Panel: Plugins
5. Under UberMenu Conditionals, click Activate

What did this do?

Installing the plugin doesn't automatically change any navigation menus - so it immediately affect anything on your site, either. Once you install the plugin, you'll get:

• New conditional options for Menu Items in the Appearance > Menus Control Panel

Usage

Activating UberMenu Conditionals will add two new options to each of your menu items in Appearance > Menus, Conditional Display: Show item and Conditional Parameters.

Conditional Display: Show item

Setting the option here will enforce that the menu item is displayed ONLY when the chosen condition is met. For example, if "On front page" is selected, the item will be displayed on the front page, and not on any others.

Conditional Parameters

Some of the conditional functions used can take a parameter. UberMenu Conditionals uses the Conditional Parameters setting to pass additional information to the functions.

Single String or Integer Parameters

For example, to display an item only on a particular page, set the Conditional Display to On a page and set the Conditional Parameter to the ID of that page.

In the example above, the menu item will only be displayed on the page with the ID 255

Multiple String or Integer Parameters

Some of the conditional functions allow you to pass an array of strings or integers as a parameter. To do so, use a comma-delimited list in the parameters setting. UberMenu Conditionals will automatically convert any value with a comma into an array to pass to the conditional function.

For example, to display an item only on a specific group of pages, set the Conditional Parameters to a comma-delimited string of the page IDs: 255, 119

In the example above, the menu item will be displayed only on two pages: page 255 and page 119.

Tip: The content Conditional Parameters input box will always be passed as the first parameter of the conditional function. If the value contains commas, it will be passed as an array. To pass a second parameter to the few conditional functions that support it, you'd need to write a custom conditional filter.

Custom Conditional Filters

If you need a conditional statement more advanced than the provided parameters, UberMenu Conditionals allows you to write a custom conditional filter.

The best place to put custom conditional filters would be in your child theme's functions.php, or in a separate plugin. This is totally up to you and depends on how you manage your site.

Here's an example of a custom conditional filter that makes sure a particular menu item will not display on the front page for logged in users.

function my_custom_conditional_filter( $display_on , $walker , $element , $max_depth, $depth, $args ){

	//The ID of the menu item currently being filtered
	$id = $element->ID;

	//Check for that specific menu item
	if( $id == 268 ){

		//If we're currently logged in AND on the front page
		if( is_user_logged_in() && is_front_page() ){

			//Disable the menu item
			$display_on = false;

		}

	}

	//Return the filtered display boolean
	return $display_on;
}
add_filter( 'uberMenu_display_item', 'my_custom_conditional_filter', 20, 6 );

1. 268 is the ID of the menu item we are filtering - it will be specific to your menu item. It can be determined by looking at the ID of the menu item within your menu.
2. It is very important to return $display_on; when your conditions are not met
3. To display the menu item, return true; To hide the menu item, return false; to not change the current value of the menu item's display visibility, return the incoming $display_on value.
4. The second parameter of the add_filter() function call and your function name (my_custom_conditional_filter) must match.
5. You should keep the function definition as in the example; the only things that should change are the function name if you wish, and the contents of the function.

Frequently Asked Questions

Will be updated as questions are asked.