6.Magento 2 添加后台管理菜单

Magento 2 模块开发基础部分 - 目录

本章节讨论如何在后台左侧导航菜单条添加自定义链接。

首先要理解后台菜单的结构及每个菜单项的交互方式。菜单是分为层级式的父子结构。在左侧导航菜单条直接显示的是第0层,当你点击第0层菜单项时会显示出对应更高层级的分组子菜单项。如下图是店铺Store菜单,Stores就是第0层直接显示在左侧导航条上,点击Stores之后子菜单就会展开显示:Settings、Attributes、Taxes等,以及它们的子子菜单项(Settings就有子项:All Stores、Configuration、Terms and Conditions、Order Status)。

6-store-menu-items.png

在前端时路由名称的格式为:{router_name}_{controller_name}_{actions_name},后台路由格式也一样,但需要指定一个不同的名称以便让系统知道调用的是后台的路由。

菜单到底如何添加?接下来继续使用之前的Hello World模块进行演示菜单项的添加。

添加菜单使用 menu.xml 配置文件步骤如下:

  • 1 创建 menu.xml 配置文件
  • 2 添加菜单项
  • 3 清除缓存

第一步 创建 menu.xml

文件: app/code/Aqrun/HelloWorld/etc/adminhtml/menu.xml

代码:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Backend:etc/menu.xsd">
    <menu>
    </menu>
</config>

第二步 配置菜单项

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Backend:etc/menu.xsd">
    <menu>
        <add id="Aqrun_HelloWorld::helloworld" title="你好世界"
             module="Aqrun_HelloWorld" sortOrder="51"
             resource="Aqrun_HelloWorld::helloworld"/>
        <add id="Aqrun_HelloWorld::post" title="文章管理"
             module="Aqrun_HelloWorld" sortOrder="10"
             action="aqrun_helloworld/post" resource="Aqrun_HelloWorld::post"
             parent="Aqrun_HelloWorld::helloworld"/>
        <add id="Aqrun_HelloWorld::hello_configuration" title="参数设置"
             module="Aqrun_HelloWorld" sortOrder="99"
             parent="Aqrun_HelloWorld::helloworld"
             action="adminhtml/system_config/edit/section/helloworld"
             resource="Aqrun_HelloWorld::helloworld_configuration"/>
    </menu>
</config>

配置文件中,我们添加了名为“你好世界”的第0级菜单,以及它的两个子菜单项“文章管理”和“参数设置”。
在 menu.xml 文件中会定义很多 'add' 节点来向后台添加菜单项,它的结构如下:

<add id="Aqrun_HelloWorld::post" title="Manage Posts" 
    module="Aqrun_HelloWorld" 
    sortOrder="10" action="aqrun_helloworld/post" 
    resource="Aqrun_HelloWorld::post"
    parent="Aqrun_HelloWrld::helloworld"/>

属性解释:

  • id 是对应节点的唯一标识,并且命名格式必须是 {公司_模块名}::{菜单名或描述}
  • title 属性指定显示在菜单导航条上的文字
  • module 属性指定菜单属于哪个模块
  • srotOrder 属性控制菜单项显示顺序,数字越小越靠前
  • parent 属性关联其它菜单ID,告诉系统当前菜单是哪个菜单的子项。本例中 parent="Aqrun_HelloWorld::helloworld", 由此我们知道 “管理文章”是 “你好世界”的子项,会显示在“你好世界”的菜单页里。
  • action 属性值是要链接到的页面URL。上面提到过路由格式是 {路由名}{控制器文件夹}{动作名},因此当前菜单就链接到 HelloWorld 模块的Post控制器,动作是 Index。
  • resource 属性指定权限控制,控制管理员是否有权限查看当前菜单。

你也可以添加一些其它子菜单,会和店铺菜单一样的格式显示。

最后要提的是菜单的图标,显示在0级菜单名称的上面。这些图标是 'Admin Icons' 字体生成的,更多关于图标的内容查看这个链接

第三步 清空缓存

要确保自定义菜单正常显示需要清除一下缓存运行 php bin/magento cache:clean

本例显示结果如图:

6-helloworld-menu-items.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354