PHPackages                             jacksleight/statamic-distill - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. jacksleight/statamic-distill

ActiveLibrary

jacksleight/statamic-distill
============================

1.1.1(5mo ago)1425.5k↓28.1%1[1 issues](https://github.com/jacksleight/statamic-distill/issues)PHP

Since Mar 29Pushed 5mo ago1 watchersCompare

[ Source](https://github.com/jacksleight/statamic-distill)[ Packagist](https://packagist.org/packages/jacksleight/statamic-distill)[ GitHub Sponsors](https://github.com/jacksleight)[ RSS](/packages/jacksleight-statamic-distill/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (31)Used By (0)

Distill
=======

[](#distill)

This Statamic addon allows you to filter, fetch or index the individual values, sets and relations within your entries, from both root and deeply nested fields. It's useful for things like:

- Extracting the text from every Bard field within a replicator
- Finding every asset in the page, or just the first image
- Filtering, sorting and paginating a Grid field or raw array just like a collection
- Adding individual sections of a page to a search index
- Refactoring nested data and sets

Installation
------------

[](#installation)

You can search for this addon in the `Tools > Addons` section of the Statamic control panel and click **install**, or run the following command from your project root:

```
composer require jacksleight/statamic-distill
```

Examples
--------

[](#examples)

### Find every image in the page

[](#find-every-image-in-the-page)

```
{{ distill:page type="asset:*" is_image:is="true" unique="true" }}
    {{ url }}
{{ /distill:page }}
```

### Extract all Bard text from a page builder

[](#extract-all-bard-text-from-a-page-builder)

```
{{ { distill:bard from="builder" } | bard_text }}
```

### Filter, sort and paginate a Grid field

[](#filter-sort-and-paginate-a-grid-field)

```
{{ distill:parts_list depth="1" paginate="10" :category:is="get:category" :sort="get:sort" }}
    {{ items }}
        {{ name }} {{ price }}
    {{ /items }}
    {{ paginate }}
        ←
        →
    {{ /paginate }}
{{ /distill:parts_list }}
```

Usage
-----

[](#usage)

Distill recursively walks through the value you provide looking for items that match your criteria. It can find individual paragraphs and field values through to entire sets and references to other content.

For optimal performance you should use the `from`, `path`, `expand`, `limit` and `max_depth` parameters to restrict where it goes based on what you're looking for. These options don't just filter the final result, they tell Distill where to look and when to stop.

Distill can find references to other entries, terms, assets and users, but it will not walk into those objects. Additionally Distill will only walk raw values if you provide one, it will not walk into a field's raw value.

### Distill Tag

[](#distill-tag)

The `{{ distill:* }}` tag accepts the following parameters:

- **from (string)**
    The name of the source variable (*not the variable itself*), can be a single field or raw value or an entry, term, asset or user.
- **type (string|array)**
    The type to match, asterisks can be used as a wildcard and multiple types can be pipe delimited, options are:
    - `value:[fieldtype]` - A field value
    - `set:[handle]` - A Replicator or Bard set
    - `row:[distill-type]` - A Grid row (type can be defined in the field config)
    - `node:[type]` - A Bard node
    - `mark:[type]` - A Bard mark
    - `entry:[collection]` - An entry
    - `term:[taxonomy]` - A term
    - `asset:[container]` - An asset
    - `user` - A user
    - `raw:[php-type]` - A raw value (inc. stdClass)
    - `class:[php-class]` - Any other object (exc. stdClass)
- **path (string|array)**
    The path to match, asterisks can be used as a wildcard and multiple paths can be pipe delimited, paths themselves are dot delimited.
- **depth (integer)**
    Sets both `max_depth` and `min_depth`.
- **min\_depth (integer)**
    The minimim depth to find items from.
- **max\_depth (integer)**
    The maximum depth to find items from.
- **unique (boolean, false)**
    Filter out duplicate items. Filtering is only applied to these types:
    - `entry`
    - `term`
    - `asset`
    - `user`
- **expand (string|array, all)**
    Which types to expand and walk into, asterisks can be used as a wildcard and multiple types can be pipe delimited, options are:
    - `set:[handle]`
    - `row:[distill-type]`
    - `value:replicator`
    - `value:bard`
    - `value:grid`
    - `value:entries`
    - `value:terms`
    - `value:assets`
    - `value:users`
    - `raw:array`
    - `raw:object`
- **limit (integer)**
    The maximum number of items.
- **offset (integer)**
    The starting item offset.
- **paginate (integer)**
    Enables pagination and sets the number of items per page.
- **sort (string)**
    The sort order.
- **include\_source (boolean, false)**
    Whether to include the source value.
- **still (string)**
    Which still to apply, multiple stills can be pipe delimited.
- **\[conditions\] (mixed)**
    Any [where conditions](https://statamic.dev/conditions).

Each item returned includes an `info` object that contains the following values:

- **type** - Type of the item.
- **path** - Path to the item from the source.
- **name** - Field handle/value index.

- **source** - Original source value.
- **parent** - Parent item in the hierachy.

### Distill Text Tag & Modifier

[](#distill-text-tag--modifier)

The `{{ distill:text }}` tag returns all plain text from `text`, `textarea`, `bard` and `markdown` fields.

The `distill_text` modifier does the same thing, but must be passed the *name* of the field (as a string), not the field value itself.

### Distill Bard Tag & Modifier

[](#distill-bard-tag--modifier)

The `{{ distill:bard }}` tag returns all Bard data in a format that is compatible with the `bard_*` modifiers.

The `distill_bard` modifier does the same thing, but must be passed the *name* of the field (as a string), not the field value itself.

### Distill Count Tag

[](#distill-count-tag)

The `{{ distill:count }}` tag returns the number of results from a query.

### Stills

[](#stills)

Stills are exactly the same as [query scopes](https://statamic.dev/extending/query-scopes-and-filters), but for Distill queries. You can create them by adding a new class in `app/Stills/*.php`. They have an `apply` method that receives the query builder object and array of tag parameters.

### Usage in PHP

[](#usage-in-php)

#### Query Builder

[](#query-builder)

You can query a value manually in PHP using the `Distill::query()` method. The query builder class has camel cased method names that match the tag parameters above, plus all the usual `where` methods:

```
use JackSleight\StatamicDistill\Facades\Distill;

$youtubeVideoSets = Distill::query($value)
    ->type('set:video')
    ->where('url', 'like', '%youtube.com%')
    ->get();
```

#### Bard & Text Values

[](#bard--text-values)

You can extract Bard data and plain text manually in PHP using the `Distill::bard()` and `Distill::text()` methods. For example to create a plain text value of a page builder you could do one of these:

```
use JackSleight\StatamicDistill\Facades\Distill;
use Statamic\Facades\Collection;
use Statamic\Statamic;

$value = $entry->augmentedValue('content');
$data = Distill::bard($value);

$value = $entry->augmentedValue('builder');
$text = Distill::text($value);
```

### Search Integration

[](#search-integration)

Distill can add the results of a query to a search index, so they appear as their own individual search results. You can then use hash/fragment URLs to link to those items within the source page. Items from entries and terms are supported.

```
// config/statamic/search.php
'searchables' => [
    'distill:collection:pages:sections',
],
'fields' => ['heading'],
```

```
// app/Stills/Sections.php
namespace App\Stills;

use JackSleight\StatamicDistill\Stills\Still;

class Sections extends Still
{
    public function apply($query, $values)
    {
        $query->path('builder.*')->type('set:section');
    }
}
```

```
{{# resources/views/search.antlers.html #}}
{{ search:results }}
    {{ if result_type === 'distill:set:section' }}

            {{ title }}

    {{ else }}
        ...
    {{ /if }}
{{ /search:results }}
```

Here's a brief explanation of what that's doing:

1. `distill:collection:articles:sections` - Use the Sections still to extract items from entries within the articles collection
2. `$query->path('builder.*')` - Extract all the items that are direct children of the "builder" field (the sets)
3. `->type('set:section')` - Only extract the sets of type "section"
4. `'fields' => ['heading']` - Index the "heading" field from those sets

When a search is run the section headings will be searched, and any matching sets will be returned as results.

Sponsoring
----------

[](#sponsoring)

This addon is completely free to use. However fixing bugs, adding features and helping users takes time and effort. If you find this addon useful and would like to support its development any [contribution](https://github.com/sponsors/jacksleight) would be greatly appreciated. Thanks! 🙂

###  Health Score

46

—

FairBetter than 93% of packages

Maintenance69

Regular maintenance activity

Popularity36

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 98.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~37 days

Recently: every ~6 days

Total

27

Last Release

172d ago

Major Versions

0.8.5 → 1.0.02025-11-27

### Community

Maintainers

![](https://www.gravatar.com/avatar/5b1acb404d9801e5f633e31efa3403a4735e43ea93c798e3f895ba3264c92c6e?d=identicon)[jacksleight](/maintainers/jacksleight)

---

Top Contributors

[![jacksleight](https://avatars.githubusercontent.com/u/126740?v=4)](https://github.com/jacksleight "jacksleight (169 commits)")[![edalzell](https://avatars.githubusercontent.com/u/6069653?v=4)](https://github.com/edalzell "edalzell (2 commits)")

### Embed Badge

![Health badge](/badges/jacksleight-statamic-distill/health.svg)

```
[![Health](https://phpackages.com/badges/jacksleight-statamic-distill/health.svg)](https://phpackages.com/packages/jacksleight-statamic-distill)
```

###  Alternatives

[statamic/statamic

Statamic

824170.4k](/packages/statamic-statamic)[statamic-rad-pack/runway

Eloquently manage your database models in Statamic.

135192.6k5](/packages/statamic-rad-pack-runway)[statamic/ssg

Generate static sites with Statamic.

254302.4k](/packages/statamic-ssg)[statamic/eloquent-driver

Allows you to store Statamic data in a database.

125598.8k7](/packages/statamic-eloquent-driver)[statamic/seo-pro

65440.7k](/packages/statamic-seo-pro)[rias/statamic-redirect

28298.4k](/packages/rias-statamic-redirect)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)