phile/twig-filters

An example plugin for Phile showing how to make Twig filters.

1.1.0 2018-03-29 15:34 UTC

This package is auto-updated.

Last update: 2024-10-29 04:30:53 UTC


README

Build Status

Adds helpfull Twig functions to Phile and easily allows you to create new ones. Project home.

Installation

composer require phile/twig-functions

Activation

$config['plugins']['phile\\twigFunctions'] = [
    'active' => true
];

Usage

This plugin includes some predefined Twig-filter and allows you to easily add your own.

Define a New Custom Filter

See the existing filters in config.php for how to add your own filter.

excerpt

Grabs the first paragraph of the content string.

{{ content|excerpt }}

limit_words

Similar to excert but limits on number of words. Use Twig's striptags to remove HTML-tags.

{{ page.content|striptags|limit_words }}

shuffle

Shuffles an array. For example show a shuffled lists of pages:

<ul class="posts">
  {% for page in pages|shuffle %}
    <li><a href="{{ page.url }}">{{ page.title }}</a></li>
  {% endfor %}
</ul>

slugify

This new Twig filter allows you to slugify a string. This is useful for making safe URLs, HTML-safe class/id names, or just cleaning up general strings.

<!-- becomes "this–is–an–strange–string" -->
{{ "This Is ____an STRÄNGE      string" | slugify }}