{"id":87511,"date":"2017-11-15T11:31:30","date_gmt":"2017-11-15T11:31:30","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=87511"},"modified":"2024-02-21T04:45:36","modified_gmt":"2024-02-21T04:45:36","slug":"create-custom-widget-type-magento2","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/","title":{"rendered":"Create Custom Widget type in Magento 2"},"content":{"rendered":"\n

Today i am explaining how to create custom widget type in Magento 2.<\/p>\n\n\n\n

To create widget firstly need to create widget.xml in app\/code\/Namespace\/Module\/etc\/ folder.<\/p>\n\n\n\n

<?xml version="1.0"?>\n<widgets xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\/..\/..\/Magento\/Widget\/etc\/widget.xsd">\n    <widget id="wk_customwidget" class="Webkul\\CustomWidget\\Block\\CustomWidget">\n        <label translate="true">Custom Widget<\/label>\n        <description>Widget for example<\/description>\n        <parameters>\n\t\t\t<parameter name="test_desc" xsi:type="text" required="true" visible="true" sort_order="0" >\n\t\t\t\t<label translate="true">Description<\/label>\n                <description>Text type option<\/description>\n\t\t\t<\/parameter>\n            <parameter name="test_select" xsi:type="select" required="true" source_model="Webkul\\CustomWidget\\Model\\Config\\Source\\Select" visible="true" sort_order="8" >\n\t\t\t\t<label translate="true">Select option<\/label>\n                <description>Select type option<\/description>\n\t\t\t<\/parameter>\n        <\/parameters>\n    <\/widget>\n<\/widgets><\/pre>\n\n\n\n
Here, Widget id:<\/strong> wk_customwidget, you can defined as per your choice.<\/p>\n\n\n\n
Class attribute:<\/strong> in this you need to add a block class which uses in your widget.<\/p>\n\n\n\n
label and description<\/strong> tags for the widget explanation.<\/p>\n\n\n\n
In the parameter tag we added 2 type of fields:<\/p>\n\n\n\n
1: text type<\/strong>, you can add text values.<\/p>\n\n\n\n
2: select type<\/strong>: to select option values, for this you need to define values in model.<\/p>\n\n\n\n
Model file for the select options at path: Webkul\\CustomWidget\\Model\\Config\\Source\\Select.php<\/p>\n\n\n\n
will have code like:<\/p>\n\n\n\n
<?php\n\nnamespace Webkul\\CustomWidget\\Model\\Config\\Source;\n\nclass Select implements \\Magento\\Framework\\Option\\ArrayInterface\n{\n    public function toOptionArray()\n    {\n        return [\n            ['value' => 'yes', 'label' => __('Yes')],\n            ['value' => 'no', 'label' => __('No')]\n        ];\n    }\n}<\/pre>\n\n\n\n
By this code, there are two option will appear with Yes and No values.<\/p>\n\n\n\n
Now Create block which is defined in widget.xml<\/p>\n\n\n\n
Block file at path\u00a0Webkul\\CustomWidget\\Block\\CustomWidget.php<\/p>\n\n\n\n
<?php\n\nnamespace Webkul\\CustomWidget\\Block;\n\nuse Magento\\Framework\\View\\Element\\Template;\nuse Magento\\Framework\\App\\Config\\ScopeConfigInterface;\n\nclass CustomWidget extends \\Magento\\Framework\\View\\Element\\Template implements \\Magento\\Widget\\Block\\BlockInterface\n{\n\n    \/**\n     * construct description\n     * @param MagentoFrameworkViewElementTemplateContext $context\n     * $data[]\n     *\/\n    public function __construct(\n        \\Magento\\Framework\\View\\Element\\Template\\Context $context,\n        array $data = []\n    ) {\n        parent::__construct($context, $data);\n    }\n\n    \/**\n     * construct function\n     *\/\n    protected function _construct()\n    {\n        parent::_construct();\n        $this->setTemplate('custom_widget.phtml');\n    }\n\n    public function getDescription()\n    {\n        $desc = $this->getData('test_desc');\n        \/\/it will return your description which is added in your widget\n    }\n\n    public function getSelectValue()\n    {\n        return $this->getData('test_select');\n        \/\/will return select option value\n    }\n}<\/pre>\n\n\n\n
Here, you can set your custom template in $this->setTemplate() function.<\/p>\n\n\n\n
In block i created two functions to get values which i added at time of adding widget.<\/p>\n\n\n\n
After these files, you will get a new widget type with custom fields.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You can add this widget on any page, and use widget’s data through your block.<\/p>\n\n\n\n
I hope this blog will help you with Create Custom Widget type in Magento 2. You may also check our wide range of best Magento 2 Extensions<\/a>.<\/p>\n\n\n\n
Please reach out to our team via a support ticket<\/a> if you have any queries.<\/p>\n\n\n\n
Try this and if you have any queries then just comment below \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"
Today i am explaining how to create custom widget type in Magento 2. To create widget firstly need to create widget.xml in app\/code\/Namespace\/Module\/etc\/ folder. Here, Widget id: wk_customwidget, you can defined as per your choice. Class attribute: in this you need to add a block class which uses in your widget. label and description tags for […]<\/a><\/p>\n","protected":false},"author":68,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[302],"tags":[2070,4829],"class_list":["post-87511","post","type-post","status-publish","format-standard","hentry","category-magento2","tag-magento2","tag-widget"],"yoast_head":"\nCreate Custom Widget type in Magento 2<\/title>\n<meta name=\"description\" content=\"In this blog we will discuss create custom widget type in Magento 2\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Create Custom Widget type in Magento 2\" \/>\n<meta property=\"og:description\" content=\"In this blog we will discuss create custom widget type in Magento 2\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2017-11-15T11:31:30+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-02-21T04:45:36+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png\" \/>\n<meta name=\"author\" content=\"Bulbul\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Bulbul\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\"},\"author\":{\"name\":\"Bulbul\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/c9c6288b3950490ffdb37cb2a526996e\"},\"headline\":\"Create Custom Widget type in Magento 2\",\"datePublished\":\"2017-11-15T11:31:30+00:00\",\"dateModified\":\"2024-02-21T04:45:36+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\"},\"wordCount\":265,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png\",\"keywords\":[\"Magento2\",\"widget\"],\"articleSection\":[\"Magento2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\",\"url\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\",\"name\":\"Create Custom Widget type in Magento 2\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png\",\"datePublished\":\"2017-11-15T11:31:30+00:00\",\"dateModified\":\"2024-02-21T04:45:36+00:00\",\"description\":\"In this blog we will discuss create custom widget type in Magento 2\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png\",\"width\":1024,\"height\":581},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Custom Widget type in Magento 2\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/c9c6288b3950490ffdb37cb2a526996e\",\"name\":\"Bulbul\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/37ea7175f5ae6557d01bb38e147f6a02a540714ecdb71770d8ec554d4d34c23f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/37ea7175f5ae6557d01bb38e147f6a02a540714ecdb71770d8ec554d4d34c23f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"caption\":\"Bulbul\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/bulbul896\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Create Custom Widget type in Magento 2","description":"In this blog we will discuss create custom widget type in Magento 2","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/","og_locale":"en_US","og_type":"article","og_title":"Create Custom Widget type in Magento 2","og_description":"In this blog we will discuss create custom widget type in Magento 2","og_url":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2017-11-15T11:31:30+00:00","article_modified_time":"2024-02-21T04:45:36+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png","type":"","width":"","height":""}],"author":"Bulbul","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Bulbul","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/"},"author":{"name":"Bulbul","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/c9c6288b3950490ffdb37cb2a526996e"},"headline":"Create Custom Widget type in Magento 2","datePublished":"2017-11-15T11:31:30+00:00","dateModified":"2024-02-21T04:45:36+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/"},"wordCount":265,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png","keywords":["Magento2","widget"],"articleSection":["Magento2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/","url":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/","name":"Create Custom Widget type in Magento 2","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png","datePublished":"2017-11-15T11:31:30+00:00","dateModified":"2024-02-21T04:45:36+00:00","description":"In this blog we will discuss create custom widget type in Magento 2","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/06\/widget.png","width":1024,"height":581},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/create-custom-widget-type-magento2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Create Custom Widget type in Magento 2"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/c9c6288b3950490ffdb37cb2a526996e","name":"Bulbul","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/37ea7175f5ae6557d01bb38e147f6a02a540714ecdb71770d8ec554d4d34c23f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/37ea7175f5ae6557d01bb38e147f6a02a540714ecdb71770d8ec554d4d34c23f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","caption":"Bulbul"},"url":"https:\/\/webkul.com\/blog\/author\/bulbul896\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/87511","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/68"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=87511"}],"version-history":[{"count":16,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/87511\/revisions"}],"predecessor-version":[{"id":423218,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/87511\/revisions\/423218"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=87511"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=87511"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=87511"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}