jorisnoo/craft-twig-helpers

Shared Twig helpers for Craft CMS with config-based extensibility.

Maintainers

Package info

github.com/jorisnoo/craft-twig-helpers

Type:craft-module

pkg:composer/jorisnoo/craft-twig-helpers

Statistics

Installs: 108

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

dev-main 2026-04-04 13:32 UTC

Requires

Requires (Dev)

MIT 1f8f865e70e0acb9a80345f557f921b85c1582b1

  • Joris Noordermeer <contact.woop@noordermeer.ch>

This package is auto-updated.

Last update: 2026-04-04 13:32:15 UTC

README

A Craft CMS module that provides shared Twig helpers with config-based extensibility. Ships with a set of built-in functions and filters, and allows you to register your own via a config file.

Features

  • Built-in Twig functions: placeholderImage
  • Built-in Twig filters: hasTransparency, trimEmptyParagraphs
  • Built-in Twig tag: {% minify %} for HTML minification
  • Register custom filters, functions, globals, and tests via config
  • Supports Craft 4 and Craft 5

Requirements

  • Craft CMS ^4.0.0 or ^5.0.0
  • PHP ^8.2

Installation

composer require jorisnoo/craft-twig-helpers

Register the module in your config/app.php:

return [
    'modules' => [
        'twig-helpers' => \Noo\CraftTwigHelpers\TwigHelpers::class,
    ],
    'bootstrap' => ['twig-helpers'],
];

Configuration

Create a config/twig-helpers.php file in your Craft project to register custom helpers:

use Noo\CraftTwigHelpers\config\TwigHelpersConfig;

return TwigHelpersConfig::create()
    ->filters([
        'myFilter' => fn (string $value) => strtoupper($value),
    ])
    ->functions([
        'myFunction' => fn () => 'Hello, world!',
    ])
    ->globals([
        'siteName' => 'My Site',
    ])
    ->tests([
        'even' => fn (int $value) => $value % 2 === 0,
    ]);

Built-in Helpers

Functions

placeholderImage(config)

Generates a data URI for a placeholder SVG image.

<img src="{{ placeholderImage({ width: 800, height: 600 }) }}">
<img src="{{ placeholderImage({ width: 800, height: 600, color: '#eee' }) }}">

Filters

hasTransparency

Checks whether an Asset image has transparency.

{% if asset|hasTransparency %}
    {# handle transparent image #}
{% endif %}

trimEmptyParagraphs

Strips empty <p> tags from the beginning and end of HTML content. Useful for cleaning up CKEditor output that adds filler paragraphs.

Handles <p></p>, <p><br></p>, <p>&nbsp;</p>, non-breaking space characters, and <br> tags with attributes (e.g. data-cke-filler).

{{ entry.text|trimEmptyParagraphs }}

Tags

{% minify %}

Minifies the wrapped HTML by stripping comments, collapsing whitespace, and removing unnecessary spaces around block-level elements. Content inside <pre>, <textarea>, <script>, and <style> tags is preserved.

Minification is automatically disabled when devMode is true.

{% minify %}
<!doctype html>
<html>
    <head>...</head>
    <body>
        ...
    </body>
</html>
{% endminify %}

License

MIT