Skip to content

A Twig filter that strips html and generates paragraphs from newlines. Implemented as a Craft CMS plugin.

License

Notifications You must be signed in to change notification settings

emandiev/autop-twig-filter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

autop Twig Filter plugin for Craft CMS 3

A Twig filter that strips html and generates paragraphs from newlines.

Useful when you want to use the Plain Text field to generate <p> and <br> tags.

Example Usage

Requirements

This plugin requires Craft CMS 3.0.0 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

cd /path/to/project

  1. Then tell Composer to load the plugin:

composer require emandiev/autop-twig-filter

  1. In the Control Panel, go to Settings → Plugins and click the “Install” button for autop Twig Filter.

Using autop Twig Filter

You can use the autop filter without parameters like this:

{{ entry.plainText|autop }}

The filter will create <p> tags from consecutive newlines and (by default) <br> tags from single newlines.

The optional parameter $br allows you to disable the <br> tag creation.

{{ entry.plainText|autop(false) }}

The plugin will also register a Twig function that you can use if needed.

{% set formattedText = autop(entry.plainText) %}

Configuring autop Twig Filter

You can create a file named autop-twig-filter.php in Craft's config folder to change the default parameter values.

For example, you can disable the default <br> tag creation globally like this:

<?php
return [
    'br' => false,
];

{{ entry.plainText|autop }} // will not generate <br> tags

Credits

Brought to you by Danail Emandiev

About

A Twig filter that strips html and generates paragraphs from newlines. Implemented as a Craft CMS plugin.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages