hypershop/module-shortcodes

Magento 2 module to add shortcodes to CMS pages & blocks

Maintainers

Details

github.com/hypershopbv/Hypershop_Shortcodes

Homepage

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 2

Forks: 0

Open Issues: 0

Type:magento2-module

100.4.5 2022-11-02 08:35 UTC

OSL-3.0 3d457019739eed48c209b2298fad8c12034cda09

This package is auto-updated.

Last update: 2025-05-04 14:18:45 UTC

README

Goal

  • This module is created to add shortcodes to CMS pages & blocks and convert those into HTML wraps.

Installation / Setup

  • Install the module using the command composer require hypershop/module-shortcodes
  • After installing, run a bin/magento setup:upgrade to add it to the Magento module list.

Usage / Settings

Initially the only shortcode to this module is:

[wrap]
Your content here
[/wrap]

This will be converted into:

<div class="wrap">
Your content here
</div>

It is also possible to add extra classes to the shortcode:

[wrap extra-class="extra-class-one extra-class-two extra-class-three"]
Your content here
[/wrap]

This will be converted into:

<div class="wrap extra-class-one extra-class-two extra-class-three">
Your content here
</div>

You can extend the shortcode list within your theme or through a custom module or theme by extending it like this in a layout XML file:

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="shortcodes">
            <arguments>
                <argument name="list" xsi:type="array">
                    <item name="second-shortcode" xsi:type="array">
                        <item name="shortcode" xsi:type="string">second-shortcode</item>
                        <item name="class" xsi:type="string">second-shortcode-class</item>
                    </item>
                    <item name="third-shortcode" xsi:type="array">
                        <item name="shortcode" xsi:type="string">third-shortcode</item>
                        <item name="class" xsi:type="string">third-shortcode-class</item>
                    </item>
                </argument>
            </arguments>
        </referenceBlock>
    </body>
</page>

Common issues

  • None known so far.