{"id":348223,"date":"2022-08-18T13:56:09","date_gmt":"2022-08-18T13:56:09","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=348223"},"modified":"2022-12-20T07:02:51","modified_gmt":"2022-12-20T07:02:51","slug":"directory-structure-of-creating-add-on-in-cs-cart-part-1","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/","title":{"rendered":"Directory Structure of creating Add-on in CS-Cart (Part 1)"},"content":{"rendered":"\n

<\/p>\n\n\n\n

In this blog, we will learn about the cs-cart add-on.<\/p>\n\n\n\n

Here is the link to the Cs-cart Guide<\/a>.<\/p>\n\n\n\n

wherefore, If you want to create your CS-Cart add-ons<\/a>, at that time make sure to use this blog. It will be helpful for you.<\/p>\n\n\n\n

Cs-Cart Folder Structure \u2013<\/strong><\/h2>\n\n\n\n

Here, we are going to describe the CS-Cart Add-on folder structure and how to reside the code under this folder structure. <\/p>\n\n\n\n

Inside the Cs-Cart setup there 4 main folders for addon creation. These are app, design, var, and JS.<\/p>\n\n\n\n

In app folder<\/strong><\/span>:- <\/h4>\n\n\n\n

we put the addon controllers, additional function file, and addon.xml file.<\/p>\n\n\n\n

In design folder<\/span><\/strong>:-<\/h4>\n\n\n\n

we put the files for the backend view. It contains a frontend file for the view, while creating the addon structure we put frontend view files in the var folder as the theme repository.<\/p>\n\n\n\n

In var folder<\/span><\/strong>:-<\/p>\n\n\n\n

we put the ‘.po’ file for language and addon view files for the frontend in the theme repository.<\/p>\n\n\n\n

In JS folder<\/span><\/strong>:- <\/p>\n\n\n\n

we put JS files related to the addon if the addon needs that.<\/p>\n\n\n\n

There is 3 type of folder structure:-<\/strong>
1. App folder structure
2. Design Folder structure
3. Var folder structure<\/p>\n\n\n\n

If you need to add JS, there is a folder in the root directory with the js name. you can add your addon folder here. Create the js files in it.<\/p>\n\n\n\n

Example<\/p>\n\n\n\n

\"vishal_1\"
JS Folder<\/figcaption><\/figure>\n\n\n\n

App folder structure<\/strong><\/p>\n\n\n\n

app<\/p>\n\n\n\n

– addons<\/p>\n\n\n\n

– addonId(means folder name and folder name should be the same as addon ID)<\/p>\n\n\n\n

-controllers<\/p>\n\n\n\n

-init.php<\/p>\n\n\n\n

-func.php<\/p>\n\n\n\n

-schemas<\/p>\n\n\n\n

-addon.xml<\/p>\n\n\n\n

Let’s take the example of the Buy together addon.<\/strong><\/p>\n\n\n\n

\"vishal_2-1\"
Addon main folder structure<\/figcaption><\/figure>\n\n\n\n

You have to create a folder with the name addon_id inside ‘app\/addons’. The addon_id of the addon should be unique. In the case of Buy Together, addon_id is buy_together.<\/p>\n\n\n\n

\n
\n
\"vishal_4\"
Addon inside the folder structure<\/figcaption><\/figure>\n\n\n\n

Inside the addon folder, there is a controller folder in which we put controllers separated by the backend, frontend, and common folder.<\/p>\n\n\n\n

We put the controller to use in the backend in the backend folder, a frontend controller in the frontend folder, and a controller that is used at both ends in the common folder.<\/p>\n\n\n\n

Schemas:-<\/span><\/strong><\/h4>\n\n\n\n

Schemas folder is used for menu, block manager, permission, product variations, and more.<\/p>\n\n\n\n

And three main files are addon.xml which is used for addon details and structure, func.php file for additional functions for the addon, and init.php file for initializing some needed functionality for an addon like hook registry for the addon. <\/p>\n<\/div>\n<\/div>\n\n\n\n

\n
How to use Rest API in Cs-Cart<\/a><\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

In this blog, we will learn about the cs-cart add-on. Here is the link to the Cs-cart Guide. wherefore, If you want to create your CS-Cart add-ons, at that time make sure to use this blog. It will be helpful for you. Cs-Cart Folder Structure \u2013 Here, we are going to describe the CS-Cart Add-on […]<\/a><\/p>\n","protected":false},"author":458,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-348223","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"\nHow to build the add-on directory structure in Cs-cart - Webkul Blog<\/title>\n<meta name=\"description\" content=\"In this blog, you are going to learn \u201cHow to build the add-on directory structure in Cs-Cart.\u201d I hope you know about the add-on in Cs-Cart.\" \/>\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\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to build the add-on directory structure in Cs-cart - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"In this blog, you are going to learn \u201cHow to build the add-on directory structure in Cs-Cart.\u201d I hope you know about the add-on in Cs-Cart.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\" \/>\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=\"2022-08-18T13:56:09+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2022-12-20T07:02:51+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png\" \/>\n<meta name=\"author\" content=\"Vishal Verma\" \/>\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=\"Vishal Verma\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\"},\"author\":{\"name\":\"Vishal Verma\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/45eb31829cd032c0b0bc4687f5a66013\"},\"headline\":\"Directory Structure of creating Add-on in CS-Cart (Part 1)\",\"datePublished\":\"2022-08-18T13:56:09+00:00\",\"dateModified\":\"2022-12-20T07:02:51+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\"},\"wordCount\":435,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png\",\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\",\"url\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\",\"name\":\"How to build the add-on directory structure in Cs-cart - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png\",\"datePublished\":\"2022-08-18T13:56:09+00:00\",\"dateModified\":\"2022-12-20T07:02:51+00:00\",\"description\":\"In this blog, you are going to learn \u201cHow to build the add-on directory structure in Cs-Cart.\u201d I hope you know about the add-on in Cs-Cart.\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png\",\"width\":552,\"height\":116,\"caption\":\"vishal_1\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Directory Structure of creating Add-on in CS-Cart (Part 1)\"}]},{\"@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\/45eb31829cd032c0b0bc4687f5a66013\",\"name\":\"Vishal Verma\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/4043345377b7d2bfcc7e20a2d3d92c06113513f627020d280dca02b94e7d7f6f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/4043345377b7d2bfcc7e20a2d3d92c06113513f627020d280dca02b94e7d7f6f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Vishal Verma\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/vishal-verma676\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to build the add-on directory structure in Cs-cart - Webkul Blog","description":"In this blog, you are going to learn \u201cHow to build the add-on directory structure in Cs-Cart.\u201d I hope you know about the add-on in Cs-Cart.","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\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/","og_locale":"en_US","og_type":"article","og_title":"How to build the add-on directory structure in Cs-cart - Webkul Blog","og_description":"In this blog, you are going to learn \u201cHow to build the add-on directory structure in Cs-Cart.\u201d I hope you know about the add-on in Cs-Cart.","og_url":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2022-08-18T13:56:09+00:00","article_modified_time":"2022-12-20T07:02:51+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png","type":"","width":"","height":""}],"author":"Vishal Verma","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Vishal Verma","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/"},"author":{"name":"Vishal Verma","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/45eb31829cd032c0b0bc4687f5a66013"},"headline":"Directory Structure of creating Add-on in CS-Cart (Part 1)","datePublished":"2022-08-18T13:56:09+00:00","dateModified":"2022-12-20T07:02:51+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/"},"wordCount":435,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png","inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/","url":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/","name":"How to build the add-on directory structure in Cs-cart - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png","datePublished":"2022-08-18T13:56:09+00:00","dateModified":"2022-12-20T07:02:51+00:00","description":"In this blog, you are going to learn \u201cHow to build the add-on directory structure in Cs-Cart.\u201d I hope you know about the add-on in Cs-Cart.","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/08\/vishal_1.png","width":552,"height":116,"caption":"vishal_1"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/directory-structure-of-creating-add-on-in-cs-cart-part-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Directory Structure of creating Add-on in CS-Cart (Part 1)"}]},{"@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\/45eb31829cd032c0b0bc4687f5a66013","name":"Vishal Verma","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/4043345377b7d2bfcc7e20a2d3d92c06113513f627020d280dca02b94e7d7f6f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/4043345377b7d2bfcc7e20a2d3d92c06113513f627020d280dca02b94e7d7f6f?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Vishal Verma"},"url":"https:\/\/webkul.com\/blog\/author\/vishal-verma676\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/348223","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\/458"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=348223"}],"version-history":[{"count":7,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/348223\/revisions"}],"predecessor-version":[{"id":376674,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/348223\/revisions\/376674"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=348223"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=348223"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=348223"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}