nopCommerce Documentation

How to add a menu item into the administration area from a plugin (for version 4.80 and above)

To add menu items you should use AdminMenuCreatedEvent event. You can use the following code example which you should add to your plugins *.cs file.

Then, You can also put any security (ACL) logic to this method. For example, validate whether the current customer has "Manage plugins" permission.

public class EventConsumer: IConsumer<AdminMenuCreatedEvent>
{
    private readonly IPermissionService _permissionService;

    public EventConsumer(IPermissionService permissionService)
    {
        _permissionService = permissionService;
    }

    public Task HandleEventAsync(AdminMenuCreatedEvent eventMessage)
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermission.Configuration.MANAGE_PLUGINS))
            return;

        eventMessage.RootMenuItem.InsertBefore("Local plugins",
            new AdminMenuItem
            {
                SystemName = "YourCustomSystemName",
                Title = "Plugin Title",
                Url = eventMessage.GetMenuItemUrl("CONTROLLER_NAME", "ACTION_NAME"),
                IconClass = "far fa-dot-circle",
                Visible = true,
            });

        return Task.CompletedTask;
    }
}

Note

In nopCommerce version 4.70 and below, the administration menu is built from the sitemap.config file which is located in ~/Areas/Admin folder.

To do the same, you can use the following sample code which you need to add in your plugins' *.cs file. First, implement the IAdminMenuPlugin interface in your plugin main class.

public class CustomPlugin : BasePlugin, IAdminMenuPlugin
{

   public Task ManageSiteMapAsync(SiteMapNode rootNode)
   {
       var menuItem = new SiteMapNode()
       {
           SystemName = "YourCustomSystemName",
           Title = "Plugin Title",
           ControllerName = "ControllerName",
           ActionName = "List",
           IconClass = "far fa-dot-circle",
           Visible = true,
           RouteValues = new RouteValueDictionary() { { "area", AreaNames.Admin } },
       };
       var pluginNode = rootNode.ChildNodes.FirstOrDefault(x => x.SystemName == "Third party plugins");
       if(pluginNode != null)
           pluginNode.ChildNodes.Add(menuItem);
       else
           rootNode.ChildNodes.Add(menuItem);

       return Task.CompletedTask;
   }
}