bnomei/kirby3-htmlpurifier

Static class method, Uniform-Guard and Field-Method to filter your "dirty" HTML inputs to "clean" HTML.

1.0.3 2023-04-20 07:14 UTC

This package is auto-updated.

Last update: 2024-07-20 09:48:47 UTC


README

Release Downloads Build Status Coverage Status Maintainability Twitter

Static class method, Uniform-Guard and Field-Method to filter your "dirty" HTML inputs to "clean" HTML.

strip_tags and PHP Input Filter are not good enough for you? Installing a plugin that has a dependency with lots of code does not bother you? You are willing to take the performance hit if you use it? Read on then...

Commerical Usage


Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno
 

Installation

  • unzip master.zip as folder site/plugins/kirby3-htmlpurifier or
  • git submodule add https://github.com/bnomei/kirby3-htmlpurifier.git site/plugins/kirby3-htmlpurifier or
  • composer require bnomei/kirby3-htmlpurifier

Usage PHP

$cleanHtml = \Bnomei\HtmlPurifier::purify($dirtyHtml);

Usage Uniform-Guard

Because of the plugin loading order the htmlPurifyGuard will only be available with composer installations of this plugin.

$form = new \Uniform\Form;

if (kirby()->request()->is('POST')) {

    $form->honeypotGuard() // needs to be called explicitly now
        ->htmlPurifyGuard(); // purified all data

    if ($form->success()) {
        // ...
    }
}

Usage Field-Method

$dirtHtml = (string) $page->myfield();
$cleanHtml = (string) $page->myfield()->htmlPurify();
$cleanHtml = (string) $page->myfield()->kirbytext()->htmlPurify();

Usage with KQL for headless

If you want to make extra sure your html output to headless is valid html you can purify your fields. Be advised that this will come with a performance penalty since purification is no simple task.

⚠️ All proprietary elements (<template>, ...) and attributes (srcset, sizes, data-*, x-*:, @*:, ...) will be removed!

KQL Query

{
    "query": "page('photography')",
    "select": {
        "url": true,
        "title": true,
        "textWithPurifiedHtml": "page.text.kirbytext.htmlPurify"
    }
}

Example: Vue

<div v-html="textWithPurifiedHtml"></div>

Settings

Dependecies

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.