{"id":2554,"date":"2018-04-18T19:37:59","date_gmt":"2018-04-19T02:37:59","guid":{"rendered":"https:\/\/www.elegantthemes.com\/documentation\/?p=2554"},"modified":"2018-04-19T18:18:58","modified_gmt":"2018-04-20T01:18:58","slug":"compatibility-levels","status":"publish","type":"post","link":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/","title":{"rendered":"Compatibility Levels"},"content":{"rendered":"<blockquote><p><strong>Note:<\/strong> This tutorial series is intended for advanced users. At least a basic understanding of coding in PHP and JavaScript is required.<\/p><\/blockquote>\n<p>How a custom module looks and behaves inside the builder depends on its level of compatibility with the builder.\u00a0There are three levels of compatibility available to custom modules:\u00a0<code>off<\/code>\u00a0(this is the default), <code>partial<\/code>, and <code>on<\/code>. Custom modules can declare their level of compatibility using the <code>vb_support<\/code>\u00a0property in their PHP class definition.<\/p>\n<h2>No Compatibility<\/h2>\n<p>This is the default setting for all custom modules. Live previews are not shown for modules with no support for the latest version of the Divi Builder. Instead, a generic block will be shown. The module&#8217;s settings can still be edited and it can still be moved around on the page.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-2555\" src=\"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png\" alt=\"\" width=\"766\" height=\"264\" srcset=\"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png 766w, https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module-300x103.png 300w\" sizes=\"auto, (max-width: 766px) 100vw, 766px\" \/><\/p>\n<h2>Partial Compatibility<\/h2>\n<p>The builder will attempt to render a live preview via AJAX for custom modules that declare partial support. AJAX rendering is not ideal as it&#8217;s much slower than normal rendering and it won&#8217;t be suitable in all cases. For that reason, its important that developers test their modules and only declare partial support for modules that can actually be successfully rendered via AJAX.<\/p>\n<h3>Declaring Partial Compatibility Example<\/h3>\n<div><script src=\"https:\/\/gist.github.com\/lots0logs\/3db0568a1c7f6de794fb89d82bd4c9ee.js?ts=4\"><span data-mce-type=\"bookmark\" style=\"display: inline-block; width: 0px; overflow: hidden; line-height: 0;\" class=\"mce_SELRES_start\">\ufeff<\/span><\/script><\/div>\n<div><\/div>\n<h2>Full Compatibility<\/h2>\n<p>Modules that are fully compatible with the Divi Builder behave just like official modules. They use the builder&#8217;s\u00a0<a href=\"https:\/\/www.elegantthemes.com\/documentation\/developers\/code-reference\/divi-builder-javascript-api\/\">JavaScript API<\/a> to handle their own rendering inside the builder. You can learn more about that <a href=\"https:\/\/www.elegantthemes.com\/documentation\/developers\/how-to-create-a-divi-builder-module#react-component\">here<\/a>.<\/p>\n<h3>Declaring Full Compatibility Example<\/h3>\n<div><script src=\"https:\/\/gist.github.com\/lots0logs\/8c3f3188378d8ab65b92e28ce3bd09c4.js?ts=4\"><\/script><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Making existing custom modules compatible with the latest version of the Divi Builder.<\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[22,23],"tags":[],"class_list":["post-2554","post","type-post","status-publish","format-standard","hentry","category-developers","category-divi-module"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.3 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Elegant Themes Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Compatibility Levels - Elegant Themes Documentation\" \/>\n<meta property=\"og:description\" content=\"Making existing custom modules compatible with the latest version of the Divi Builder.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/\" \/>\n<meta property=\"og:site_name\" content=\"Elegant Themes Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2018-04-19T02:37:59+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2018-04-20T01:18:58+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png\" \/>\n<meta name=\"author\" content=\"Dustin Falgout\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Dustin Falgout\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/\"},\"author\":{\"name\":\"Dustin Falgout\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/#\\\/schema\\\/person\\\/0e2387f96b40940c4d33e54bac52e79b\"},\"headline\":\"Compatibility Levels\",\"datePublished\":\"2018-04-19T02:37:59+00:00\",\"dateModified\":\"2018-04-20T01:18:58+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/\"},\"wordCount\":241,\"image\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/wp-content\\\/uploads\\\/2018\\\/04\\\/no-support-module.png\",\"articleSection\":[\"Developer Documentation\",\"Divi Module: In-Depth\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/\",\"url\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/\",\"name\":\"Compatibility Levels - Elegant Themes Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/wp-content\\\/uploads\\\/2018\\\/04\\\/no-support-module.png\",\"datePublished\":\"2018-04-19T02:37:59+00:00\",\"dateModified\":\"2018-04-20T01:18:58+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/#\\\/schema\\\/person\\\/0e2387f96b40940c4d33e54bac52e79b\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#primaryimage\",\"url\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/wp-content\\\/uploads\\\/2018\\\/04\\\/no-support-module.png\",\"contentUrl\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/wp-content\\\/uploads\\\/2018\\\/04\\\/no-support-module.png\",\"width\":766,\"height\":264},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/developers\\\/divi-module\\\/compatibility-levels\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Compatibility Levels\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/#website\",\"url\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/\",\"name\":\"Elegant Themes Documentation\",\"description\":\"Just another WordPress site\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.elegantthemes.com\\\/documentation\\\/#\\\/schema\\\/person\\\/0e2387f96b40940c4d33e54bac52e79b\",\"name\":\"Dustin Falgout\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/4e8ced4a3ccff2b6839ae64b6e01266bb3da7dcbd5d0d391a1886029e7feac13?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/4e8ced4a3ccff2b6839ae64b6e01266bb3da7dcbd5d0d391a1886029e7feac13?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/4e8ced4a3ccff2b6839ae64b6e01266bb3da7dcbd5d0d391a1886029e7feac13?s=96&d=mm&r=g\",\"caption\":\"Dustin Falgout\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Elegant Themes Documentation","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:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/","og_locale":"en_US","og_type":"article","og_title":"Compatibility Levels - Elegant Themes Documentation","og_description":"Making existing custom modules compatible with the latest version of the Divi Builder.","og_url":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/","og_site_name":"Elegant Themes Documentation","article_published_time":"2018-04-19T02:37:59+00:00","article_modified_time":"2018-04-20T01:18:58+00:00","og_image":[{"url":"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png","type":"","width":"","height":""}],"author":"Dustin Falgout","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Dustin Falgout","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#article","isPartOf":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/"},"author":{"name":"Dustin Falgout","@id":"https:\/\/www.elegantthemes.com\/documentation\/#\/schema\/person\/0e2387f96b40940c4d33e54bac52e79b"},"headline":"Compatibility Levels","datePublished":"2018-04-19T02:37:59+00:00","dateModified":"2018-04-20T01:18:58+00:00","mainEntityOfPage":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/"},"wordCount":241,"image":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#primaryimage"},"thumbnailUrl":"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png","articleSection":["Developer Documentation","Divi Module: In-Depth"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/","url":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/","name":"Compatibility Levels - Elegant Themes Documentation","isPartOf":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#primaryimage"},"image":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#primaryimage"},"thumbnailUrl":"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png","datePublished":"2018-04-19T02:37:59+00:00","dateModified":"2018-04-20T01:18:58+00:00","author":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/#\/schema\/person\/0e2387f96b40940c4d33e54bac52e79b"},"breadcrumb":{"@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#primaryimage","url":"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png","contentUrl":"https:\/\/www.elegantthemes.com\/documentation\/wp-content\/uploads\/2018\/04\/no-support-module.png","width":766,"height":264},{"@type":"BreadcrumbList","@id":"https:\/\/www.elegantthemes.com\/documentation\/developers\/divi-module\/compatibility-levels\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.elegantthemes.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Compatibility Levels"}]},{"@type":"WebSite","@id":"https:\/\/www.elegantthemes.com\/documentation\/#website","url":"https:\/\/www.elegantthemes.com\/documentation\/","name":"Elegant Themes Documentation","description":"Just another WordPress site","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.elegantthemes.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.elegantthemes.com\/documentation\/#\/schema\/person\/0e2387f96b40940c4d33e54bac52e79b","name":"Dustin Falgout","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/4e8ced4a3ccff2b6839ae64b6e01266bb3da7dcbd5d0d391a1886029e7feac13?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/4e8ced4a3ccff2b6839ae64b6e01266bb3da7dcbd5d0d391a1886029e7feac13?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/4e8ced4a3ccff2b6839ae64b6e01266bb3da7dcbd5d0d391a1886029e7feac13?s=96&d=mm&r=g","caption":"Dustin Falgout"}}]}},"_links":{"self":[{"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/posts\/2554","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/comments?post=2554"}],"version-history":[{"count":4,"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/posts\/2554\/revisions"}],"predecessor-version":[{"id":2579,"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/posts\/2554\/revisions\/2579"}],"wp:attachment":[{"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/media?parent=2554"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/categories?post=2554"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.elegantthemes.com\/documentation\/wp-json\/wp\/v2\/tags?post=2554"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}