PHPackages                             quinninteractive/silverstripe-webp-substitution - 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. [Image &amp; Media](/categories/media)
4. /
5. quinninteractive/silverstripe-webp-substitution

ActiveSilverstripe-vendormodule[Image &amp; Media](/categories/media)

quinninteractive/silverstripe-webp-substitution
===============================================

Automatically convert images to WebP format

3.0.0(3mo ago)02.9k↓33.3%BSD-3-ClausePHP

Since Jun 16Pushed 3mo ago2 watchersCompare

[ Source](https://github.com/Quinn-Interactive/silverstripe-webp-substitution)[ Packagist](https://packagist.org/packages/quinninteractive/silverstripe-webp-substitution)[ RSS](/packages/quinninteractive-silverstripe-webp-substitution/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelogDependencies (11)Versions (12)Used By (0)

Silverstripe WebP substitution
==============================

[](#silverstripe-webp-substitution)

This module provides a task, `tasks:webpconvert`, which is to be run periodically to provide WebP substitutes for all existing public images.

Requirements
------------

[](#requirements)

- silverstripe/framework ^4.4
- Conflicts with **silverstripe/s3** because this module works only with the default, filesystem-based asset manager.

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

[](#installation)

```
composer require quinninteractive/silverstripe-webp-substitution ^2.0.0
```

License
-------

[](#license)

See [License](LICENSE.md)

Configuration example
---------------------

[](#configuration-example)

If you should need to change the assets-relative directory or the file suffix to be used for WebP images, you can do that in the configuration.

There is a default limit of 32 megapixels, over which conversion is not attempted. This is to avoid overtaxing the server's virtual memory. This setting can be overridden as shown below. If you change the `webp_file_suffix`, you must also change the suffix in your nginx configuration (see example below).

```
QuinnInteractive\WebPSub\Task\ConvertImagesToWebpTask:
  webp_directory_path: '.misc/.WebP'
  webp_file_suffix: '.wp'
  size_limit_megapixels: 16
```

Command-line example
--------------------

[](#command-line-example)

```
sudo -Eu www ./vendor/bin/sake tasks:webpconvert
```

Crontab example
---------------

[](#crontab-example)

```
DOCROOT=/var/silverstripe/live/current/docroot
SAKE=./vendor/bin/sake
SUDO=/usr/local/bin/sudo

# WebP graphics conversion task every hour
50 * * * *    (cd $DOCROOT && $SUDO -Eu www $SAKE tasks:webpconvert) > /dev/null 2>&1
```

Nginx configuration example
---------------------------

[](#nginx-configuration-example)

To support this module, add these items to your existing Silverstripe configuration. If you have changed the YAML configuration, you will need to adjust these items accordingly.

### In the `http` section

[](#in-the-http-section)

```
# webp dir to try, if we accept webp (or none if not)
map $http_accept $webp_dir {
    default   "";
    "~*image/webp"  "/assets/.webp/";
}

map $arg_nowebp $accept_webp {
    default   $webp_dir;
    '1'    "/fail-on-purpose/";
}
```

### In the `server` section, before the main assets `location` directive

[](#in-the-server-section-before-the-main-assets-location-directive)

```
# first try to return allowed webp
location ~ ^/assets/.*\.(?i:gif|jpeg|jpg|png)$ {
    try_files $accept_webp$uri.webp $uri /index.php?$query_string;
}

# Never serve .protected, nor .webp not served above
location ~ ^/assets/\.(webp|protected)/ {
    return 403;
}
```

Apache configuration example
----------------------------

[](#apache-configuration-example)

TBD

Filesystem preparation
----------------------

[](#filesystem-preparation)

If it can, the task will create the directories that it needs. If not, you must create the `.webp` directory (or the directory named in the `webp_directory_path` configuration) under the `assets` directory and make it writable by the web server.

Version
-------

[](#version)

3.0.0

Release notes
-------------

[](#release-notes)

### 3.0.0

[](#300)

Silverstripe 6 support.

This module uses `nette/utils` where it previously used `nette/finder`, which has been abandoned and folded into `nette/utils`. For that reason, we have flagged this module as conflicting with `nette/finder` so that it won't load into a site still using `nette/finder`. This is so we don't introduce duplicate classes.

### 2.1.1

[](#211)

Silverstripe 5 support.

### 2.1.0

[](#210)

This version introduces a backward-compatible feature so that converted WebP files are not used in the CMS. To take advantage of this new feature, you need to change your nginx configuration (see example above). If you do not make the changes, your site will work just as it did in earlier versions, so this is a non-breaking change.

###  Health Score

45

—

FairBetter than 93% of packages

Maintenance82

Actively maintained with recent releases

Popularity21

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 91.7% 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 ~227 days

Recently: every ~303 days

Total

7

Last Release

66d ago

Major Versions

1.0.1 → 2.0.02022-11-17

2.1.1 → 3.0.02026-02-17

### Community

Maintainers

![](https://www.gravatar.com/avatar/b76b66ab5945b678e8fd9d75b48af1d002f4e0f3c95c6092f86ba61eee792bfe?d=identicon)[odnoc](/maintainers/odnoc)

---

Top Contributors

[![oddnoc](https://avatars.githubusercontent.com/u/568583?v=4)](https://github.com/oddnoc "oddnoc (11 commits)")[![phil-quinn](https://avatars.githubusercontent.com/u/1178418?v=4)](https://github.com/phil-quinn "phil-quinn (1 commits)")

---

Tags

imagesilverstripeimagescmsWebp

###  Code Quality

Static AnalysisPHPStan, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/quinninteractive-silverstripe-webp-substitution/health.svg)

```
[![Health](https://phpackages.com/badges/quinninteractive-silverstripe-webp-substitution/health.svg)](https://phpackages.com/packages/quinninteractive-silverstripe-webp-substitution)
```

PHPackages © 2026

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