Use HTML Comments Based on Admin Config

Author: pykettk

Plugin/AddCmsBlockIdentifierToMarkup.php

@@ -54,7 +54,7 @@ public function beforeSave(
                         0
                     )
                 );
-            } else {
+            } else if ($this->moduleConfig->useHtmlComments()) {
                 $block->setContent('<!-- CMS identifier = ' . $identifier . ' -->' . "\n" . $content);
             }
         }

Scope/Config.php

@@ -14,6 +14,7 @@ class Config
 {
     const XML_PATH_CMS_IDENTIFIER_MARKUP_ENABLED = 'cms/pagebuilder/block_identifier_markup_enabled';
     const XML_PATH_CMS_IDENTIFIER_DATA_ATTR_NAME = 'cms/pagebuilder/block_identifier_attribute_name';
+    const XML_PATH_CMS_IDENTIFIER_HTML_COMMENT = 'cms/pagebuilder/block_identifier_comment';
 
     /** @var ScopeConfigInterface */
     private ScopeConfigInterface $scopeConfig;
@@ -52,4 +53,17 @@ public function getBlockIdentifierDataAttributeName($scopeCode = null): string
             $scopeCode
         );
     }
+
+    /**
+     * @param int|string|null $scopeCode
+     * @return bool
+     */
+    public function useHtmlComments($scopeCode = null): bool
+    {
+        return $this->scopeConfig->isSetFlag(
+            self::XML_PATH_CMS_IDENTIFIER_HTML_COMMENT,
+            ScopeInterface::SCOPE_STORE,
+            $scopeCode
+        );
+    }
 }

etc/adminhtml/system.xml

@@ -41,6 +41,23 @@
                         <field id="cms/pagebuilder/block_identifier_markup_enabled">1</field>
                     </depends>
                 </field>
+                <field id="block_identifier_comment"
+                       translate="label comment"
+                       type="select"
+                       sortOrder="3020"
+                       showInDefault="1"
+                       showInWebsite="1"
+                       showInStore="1"
+                       canRestore="1">
+                    <label>Use HTML Comments for non-HTML Content</label>
+                    <comment>
+                        A HTML comment will be used when the block content does not contain a wrapping HTML tag to edit.
+                    </comment>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <depends>
+                        <field id="cms/pagebuilder/block_identifier_markup_enabled">1</field>
+                    </depends>
+                </field>
             </group>
         </section>
     </system>

etc/config.xml

@@ -12,6 +12,7 @@
             <pagebuilder>
                 <block_identifier_markup_enabled>1</block_identifier_markup_enabled>
                 <block_identifier_attribute_name>block-identifier</block_identifier_attribute_name>
+                <block_identifier_comment>1</block_identifier_comment>
             </pagebuilder>
         </cms>
     </default>