Important

You are browsing documentation for version 5.0 of OroCommerce, supported until January 2025. Read the documentation for version 6.0 (the latest LTS version) to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

How to Display a WYSIWYG Field 

Hint

The feature is available starting from OroCommerce v5.0.6. To check which application version you are running, see the system information.

A WYSIWYG field can contain complex HTML, CSS structures, and dynamic content that should be successfully rendered and displayed in the storefront. For that reason, be aware that:

  1. The WYSIWYG content cannot be rendered and displayed identically both in the storefront and in the back-office. In the back-office, it can be rendered only in a simplified preview mode.

  2. The WYSIWYG fields are rendered using different approaches in the storefront and in the back-office. These approaches are described below.

Display a WYSIWYG Field in the Back-Office 

Depending on the way a WYSIWYG field is added to an entity, there are two possible cases:

1. When a WYSIWYG field is an extended field added through the entity management UI or programmatically (e.g., to some of the default Oro entities), then the system considers the Show on View entity field config options to display the WYSIWYG field on an entity view page in the back-office.

Note

Keep in mind that the WYSIWYG content is rendered in a simplified preview mode in the back-office.

Note

On the view pages of the default Oro entity, extended fields are rendered by the renderDynamicFields TWIG macro defined in @OroEntityConfig/macros.html.twig

2. When a WYSIWYG field is added programmatically and explicitly, then you should manually configure its representation on the entity view page, using TWIG macro renderCollapsibleWysiwygContentPreview:

src/Acme/WysiwygBundle/Resources/views/BlogPostCrud/view.html.twig 
{# ... #}

{%- import '@OroUI/macros.html.twig' as UI -%}
# Renders extraContent WYSIWYG field content and stores to extraContent variable.
{%- set extraContent -%}
    {{ UI.renderCollapsibleWysiwygContentPreview(entity.extraContent, entity, 'extraContent') }}
{%- endset -%}

# Adds rendered WYSIWYG content to the dataBlocks to display it in a separate section.
{% set dataBlocks = dataBlocks|merge([
    {
        'title': 'acme.wysiwyg.blogpost.sections.extra_content'|trans,
        'subblocks': [
            {'data' : [extraContent]}
        ]
    }
]) %}

{# ... #}

Display a WYSIWYG Field in the Storefront 

Depending on the way a WYSIWYG field is added to an entity, there are 3 possible cases:

1. When a WYSIWYG field is an extended field added through the entity management UI or programmatically (e.g., to some of the default Oro entities), then the system is not responsible for displaying it in the storefront.

Note

The Show on View option from the Frontend options entity field config affects only the fields created as a product attribute.

There are 2 approaches to render and display content from the WYSIWYG field in the storefront. Select the most suitable for you depending on your needs:

  1. Using the layout block type wysiwyg_content:

layout:
    actions:
        # ...

        - '@addTree':
            items:
                blog_post_content:
                    blockType: wysiwyg_content
                    options:
                        content: '=data["blog_post"].getContent()'
                        contentStyle: '=data["blog_post"].getContentStyle()'
            tree:
                page_content:
                    blog_post_content: ~

        # ...

  1. Using TWIG macro renderWysiwygContent defined in @OroCMS/macros.html.twig:

{% set attr = layout_attr_defaults(attr, {
    '~class': ' cms-typography'
}) %}

<div {{ block('block_attributes') }}>
    {%- import '@OroCMS/macros.html.twig' as CMS -%}
    {{ CMS.renderWysiwygContent(value, styles|default('')) }}
</div>

Note

CSS class cms-typography should be used in the HTML element that contains rendered WYSIWYG content to ensure proper styling.

2. When a WYSIWYG field is added to the Product entity as a product attribute using the product attributes UI, or programmatically, then the system considers the Show on View option from the Frontend options entity field config to display the WYSIWYG field in the storefront.

Note

To have more fine control, you can still display the WYSIWYG product attribute manually. For that, set the Show on View option from the Frontend options entity field config to No and use one of the two abovementioned approaches (wysiwyg_content layout block type or renderWysiwygContent TWIG macro).

Note

Consider setting ACL Protected entity field config option to No or adding the commerce option to the File Applications entity field config. Otherwise, the WYSIWYG field will not be displayed in the storefront due to lack of permissions, even if the Show on View option is enabled.

3. When a WYSIWYG field is added programmatically and explicitly, then the system is not responsible for displaying it in the storefront. You should display it manually using one of the two abovementioned approaches (wysiwyg_content layout block type or renderWysiwygContent TWIG macro).