vdlp/oc-htmlpurifier-plugin

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Adds a standards compliant HTML filter to October CMS.

Installs: 11

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 7

Forks: 1

Open Issues: 0

Type:october-plugin

2.0.1 2021-05-28 14:31 UTC

This package is auto-updated.

Last update: 2021-10-28 15:17:04 UTC


README

An October CMS plugin which adds a standards compliant HTML filter to October CMS.

HTML Purifier is an HTML filtering solution that uses a unique combination of robust whitelists and agressive parsing to ensure that not only are XSS attacks thwarted, but the resulting HTML is standards compliant.

Installation

CLI:

php artisan plugin:install Vdlp.HtmlPurifier

October CMS:

Go to Settings > Updates & Plugins > Install plugins and search for 'HtmlPurifier'.

Configuration

To configure the filter execute this command:

php artisan vendor:publish --provider="Vdlp\HtmlPurifier\HtmlPurifierServiceProvider" --tag="config"

A configuration file named config/htmlpurifier.php is now created.

In depth information about configuration parameters can be found here: http://htmlpurifier.org/live/configdoc/plain.html

Usage

Use the `|purify' in your Twig templates to apply the HTML Purifier filter.

{{ contentFromCms|purify }}

{{ contentFromExternalSource|purify }}

or

{{ '<a href="" target="_blank">Some random HTML string</a>'|purify }}

For more information about templating in October CMS: http://octobercms.com/docs/markup/templating