Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Display / Hide wp_nav_menu() items by role

branch: master
readme.md

=== Nav Menu Roles === Contributors: helgatheviking
Donate link: https://inspirepay.com/pay/helgatheviking
Tags: menu, menus, nav menu, nav menus
Requires at least: 3.8
Tested up to: 3.8.1
Stable tag: 1.5.0
License: GPLv3

Hide custom menu items based on user roles

== Description ==

This plugin lets you hide custom menu items based on user roles. So if you have a link in the menu that you only want to show to logged in users, certain types of users, or even only to logged out users, this plugin is for you.

Nav Menu Roles is very flexible. In addition to standard user roles, you can customize the functionality by adding your own check boxes with custom labels using the nav_menu_roles filter and then using the nav_menu_roles_item_visibility filter to check against whatever criteria you need. You can check against any user meta values (like capabilities) and any custom attributes added by other plugins. See the FAQ.

IMPORTANT NOTE

In WordPress menu items and pages are completely separate entities. Nav Menu Roles does not restrict access to content. Nav Menu Roles is only for showing/hiding nav menu items. If you wish to restrict content then you need to also be using a membership plugin.

= Usage =

  1. Go to Appearance > Menus
  2. Edit the menu items accordingly. First select whether you'd like to display the item to all logged in users, all logged out users or to customize by role.
  3. If you chose customize by role, then you you can check the boxes next to the roles you'd like to restrict visibility to.
  4. If you choose 'By Role' and don't check any boxes, the item will be visible to everyone like normal.

= Support =

Support is handled in the WordPress forums. Please note that support is limited and does not cover any custom implementation of the plugin. Before posting, please read the FAQ. Also, please verify the problem with other plugins disabled and while using a default theme.

Please report any bugs, errors, warnings, code problems to Github

== Installation ==

  1. Upload the plugin folder to the /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Go to Appearance > Menus
  4. Edit the menu items accordingly. First select whether you'd like to display the item to all logged in users, all logged out users or to customize by role.
  5. If you chose customize by role, then you you can check the boxes next to the roles you'd like to restrict visibility to.
  6. If you choose 'By Role' and don't check any boxes, the item will be visible to everyone like normal.

== Screenshots ==

  1. Show the new options for the menu items in the admin menu customizer

== Frequently Asked Questions ==

= I don't see the Nav Menu Roles options in the admin menu items? =

This is likely because you have another plugin (or theme) that is also trying to alter the same code that creates the Menu section in the admin. A non-exhaustive list of known conflicts:

Known Conflicts 1. UberMenu Mega Menus plugin 1. Menu Icons plugin 1. Add Descendants As Submenu Items 1. Menu Item Custom Fields 1. Navception 1. Avada theme

This is not a failure of Nav Menu Roles and there isn't anything I can do about it. WordPress does not have sufficient hooks in this area of the admin and until they do plugins are forced to replace everything via custom admin menu Walker, of which there can be only one. Until these hooks are added the menu modification plugins are unfortunately going to conflict with one another.

There's a trac ticket for this, but it has been around a while. When/if the appropriate hooks are added to WordPress core, I will update Nav Menu Roles.

As a workaround, you can switch to a default theme (or disable the conflicting plugin), edit the Nav Menu Roles, for each menu item, then revert to your original theme/ reenable the conflicting plugin. The front-end functionality of Nav Menu Roles will still work. This isn't really ideal, but there's nothing I can do about the WordPress admin's limitations.

= 1.1 I'm using XYZ Membership plugin and I don't see its "levels"? =

There are apparently a few membership plugins out there that don't use traditional WordPress roles/capabilities. My plugin will list any role registered in the traditional WordPress way. If your membership plugin is using some other system, then Nav Menu Roles won't work with it out of the box. Since 1.3.5 I've added a filter called nav_menu_roles_item_visibility just before my code decides whether to show/hide a menu item. There's also always been the nav_menu_roles filter which lets you modify the roles listed in the admin. Between these two, I believe you have enough to integrate Nav Menu Roles with any membership plugin.

Here's an example where I've added a new pseudo role, creatively called "new-role". The first function adds it to the menu item admin screen. The second function is pretty generic and won't actually do anything because you need to supply your own logic based on the plugin you are using. Nav Menu Roles will save the new "role" info and add it to the item in an array to the $item->roles variable.

= Adding a new "role" = ` /*

  • Add custom roles to Nav Menu Roles menu list ** * param:** $roles an array of all available roles, by default is global $wp_roles
    ** * return:** array
    */ function kia_new_roles( $roles ){ $roles['new-role-key'] = 'new-role'; return $roles; } add_filter( 'nav_menu_roles', 'kia_new_roles' ); `

Note, if you want to add a WordPress capability the above is literally all you need. Because Nav Menu Roles checks whether a role has permission to view the menu item using current_user_can($role) you do not need to right a custom callback for thenav_menu_roles_item_visibility` filter.

In case you do need to check your visibility status against something very custom, here is how you'd go about it:

` /*

  • Change visibilty of each menu item ** * param:** $visible boolean
    ** * param:** $item object, the complete menu object. Nav Menu Roles adds its info to $item->roles
  • $item->roles can be "in" (all logged in), "out" (all logged out) or an array of specific roles
  • return boolean / function kia_item_visibility( $visible, $item ){ if( isset( $item->roles ) && is_array( $item->roles ) && in_array( 'new-role-key', $item->roles ) ){ / if ( // your own custom check on the current user versus 'new-role' status ){ $visible = true; } else { $visible = false; } */ } return $visible; } add_filter( 'nav_menu_roles_item_visibility', 'kia_item_visibility', 10, 2 ); `

Note that you have to generate your own if/then logic. I can't provide free support for custom integration with another plugin. You may contact me to discuss hiring me, or I would suggest using a plugin that supports WordPress' roles, such as Justin Tadlock's Membership.

= What happened to my menu roles on import/export? =

The Nav Menu Roles plugin stores 1 piece of post meta to every menu item/post. This is exported just fine by the default Export tool.

However, the Import plugin only imports certain post meta for menu items. As of version 1.3, I've added a custom Importer to Nav Menu Roles as a work around.

= How Do I Use the Custom Importer? =

  1. Go to Tools>Export, choose to export All Content and download the Export file
  2. Go to Tools>Import on your new site and perform your normal WordPress import
  3. Return to Tools>Import and this time select the Nav Menu Roles importer.
  4. Use the same .xml file and perform a second import
  5. No duplicate posts will be created but all menu post meta (including your Nav Menu Roles info) will be imported

== Changelog ==

= 1.5.0 =

  • Switch to instance of plugin
  • Detect conflicts, add notice
  • remove some extraneous parameters
  • Add Spanish translation thanks to @deskarrada

= 1.4.1 =

  • update to WP 3.8 version of Walker_Nav_Menu_Edit (prolly not any different from 3.7.1)
  • minor CSS adjustment to admin menu items
  • checked against WP 3.8

= 1.4 =

  • Add to FAQ
  • add JS flair to admin menu items
  • update to WP 3.7.1 version of Walker_Nav_Menu_Edit

= 1.3.5 =

  • Add nav_menu_roles_item_visibility filter to work with plugins that don't use traditional roles

= 1.3.4 =

  • Update admin language thanks to @hassanhamm
  • Add Arabic translation thanks to @hassanhamm

= 1.3.3 =

  • Fix Nav_Menu_Roles_Import not found error

= 1.3.2 =

  • Stupid comment error causing save issues

= 1.3.1 =

  • SVN failure to include importer files!

= 1.3 =

  • Added custom importer

= 1.2 =

  • Major fix for theme's that use their own custom Walkers, thanks to Evan Stein @vanpop http://vanpop.com/
  • Instead of a custom nav Walker, menu items are controlled through the wp_get_nav_menu_items filter
  • Remove the custom nav Walker code

= 1.1.1 =

  • Fix link to plugin site
  • Fix labels in admin Walker

= 1.1 =

  • Clean up debug messages

= 1.0 =

  • Initial release
Something went wrong with that request. Please try again.