magento2小部件widget的应用与自定义小部件

本文来源于:
Magento2.x企业级开发实战

小部件是用于向 Magento 2 的 CMS 页面和块添加静态或动态内容的元素。因此,小部件是将内容插入或编辑到 CMS 页面块或页面以在您的商店中添加更多功能的更好工具。 小部件类似于创建功能并在任何页面或块上使用它,以便它们成为 Magento 2 的可重用组件。

在本文中,我们将创建一个自定义小部件,这将帮助您了解如何创建自定义小部件然后使用它,因此本文是对自定义小部件的介绍,我们一定会制作第 2 部分,其中 我们将为我们的自定义小部件添加更多功能。

所以,让我们从创建一个新模块开始,我们将学习在 Magento 2 中创建自定义小部件的分步过程。

步骤 1. 注册一个新模块; 在 app/code/Bizspice/CustomWidget/ 中创建 registration.php

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

            'Bizspice_CustomWidget',

            __DIR__

);

步骤 2. 现在在 app/code/Bizspice/CustomWidget/etc 中创建 module.xml

<?xml version="1.0" ?>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">

    <module name="Bizspice_CustomWidget" setup_version="1.0.0"/>

</config>

现在,模块的基本文件已创建,因此我们现在将专注于创建小部件。

步骤 3. 通过在 app/code/Bizspice/CustomWidget/etc 中创建 widget.xml 来声明小部件

<?xml version="1.0" ?>

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">

<widget class="Bizspice\CustomWidget\Block\Widget\Samplewidget" id="customwidget_samplewidget">

    <label>Bizspice Sample Widget</label>

    <description></description>

             <parameters>

                         <parameter name="widgettitle" sort_order="10" visible="true" xsi:type="text">

                                     <label>Title</label>

                         </parameter>

                         <parameter name="widgetcontent" sort_order="20" visible="true" xsi:type="text">

                                     <label>Content</label>

                         </parameter>

             </parameters>

    </widget>

</widgets>

在这里,我们在 admin 中创建了 2 个文本框,分别命名为 widgettitle(带有标签 Title)和 widgetcontent(带有标签 Content)作为参数显示在调用小部件的任何地方(查看参数内的代码)。 现在我们的管理工作已经完成,您可以检查“内容”>“小工具”中列出的小工具,然后单击“添加小工具”,在“类型下拉菜单”中,您将找到 Bizspice 示例小工具,这是我们的自定义小工具。

我们列出的这两个字段将如下所示

此外,我们的 标签包含块类“Bizspice\CustomWidget\Block\Widget\Samplewidget”,它让小部件知道必须使用哪个模板文件。

第 4 步。在我们的 widget.xml 中,我们声明了块类,所以现在我们将创建块

在 app/code/Bizspice/CustomWidget/Block/Widget 中创建 Samplewidget.php

<?php

namespace Bizspice\CustomWidget\Block\Widget;

use Magento\Framework\View\Element\Template;

use Magento\Widget\Block\BlockInterface;

class Samplewidget extends Template implements BlockInterface

{

protected $_template = "widget/samplewidget.phtml"

}

在上面的代码中,我们在 samplewidget.phtml 中指定了一个名为 $_template 变量的自定义模板文件。 在 phtml 文件中,我们将定义应该在前端显示我们使用这个小部件的地方。

步骤 5. 在 app/code/Bizspice/CustomWidget/view/frontend/templates/widget 中创建 samplewidget.phtml

由于我们在小部件中创建了两个名为 widgettitle 和 widgetcontent 的字段,因此我们将它们称为前端。

<?php if($block->getData('widgettitle')): ?>

    <h2 class='title'><?php echo $block->getData('widgettitle'); ?></h2>

<?php endif; ?>

<?php if($block->getData('widgetcontent')): ?>

    <h2 class='content'><?php echo $block->getData('widgetcontent'); ?></h2>

<?php endif; ?>

完成,我们已经创建了我们的第一个自定义小部件,我们可以使用它了。

如何使用:我们可以通过两种方式使用widget

直接从 CMS 块或页面。
为此,请转到特定的块或页面。 在内容上单击插入小部件

然后从列表中选择您的小部件并将内容放在我们为小部件创建的组件(在本例中为文本框)上

通过从“内容”>“小工具”创建小工具,然后单击“添加小工具”并填充所有字段并选择我们必须使用小工具的站点部分。

本文来源于:magento中文网-magento2如何创建一个小部件-widget

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

推荐阅读更多精彩内容