PHPackages                             suilven/sluggable - 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. [Utility & Helpers](/categories/utility)
4. /
5. suilven/sluggable

ActiveSilverstripe-vendormodule[Utility & Helpers](/categories/utility)

suilven/sluggable
=================

Add a slug field to any DataObject

1.0.7(5y ago)06432[1 issues](https://github.com/gordonbanderson/silverstripe-sluggable/issues)MITPHPPHP ~7.1CI failing

Since Nov 4Pushed 5y ago1 watchersCompare

[ Source](https://github.com/gordonbanderson/silverstripe-sluggable)[ Packagist](https://packagist.org/packages/suilven/sluggable)[ Docs](https://github.com/gordonbanderson/sluggable)[ RSS](/packages/suilven-sluggable/feed)WikiDiscussions master Synced 4d ago

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

Sluggable
=========

[](#sluggable)

[![Build Status](https://camo.githubusercontent.com/6066a610d766f5e7f859d22ab71d568c7a73856fd8279a48d0a4beefab7165a6/68747470733a2f2f7472617669732d63692e6f72672f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/gordonbanderson/silverstripe-sluggable)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/998d483a83f5e229bc864f3534e343a02eac3268629094aa87339d5dcce6b016/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/gordonbanderson/silverstripe-sluggable/?branch=master)[![Build Status](https://camo.githubusercontent.com/8f9bc5b336f38c7f123dac752b4cef7976203b1339e6dcfa5f98ffa72365a8c6/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/gordonbanderson/silverstripe-sluggable/build-status/master)[![CircleCI](https://camo.githubusercontent.com/6244c3ac0fc78f283771023fb04b11c2bfd3ea4070a68bfd2c967cb0c3a10f1e/68747470733a2f2f636972636c6563692e636f6d2f67682f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652e7376673f7374796c653d737667)](https://circleci.com/gh/gordonbanderson/silverstripe-sluggable)

[![codecov.io](https://camo.githubusercontent.com/ded54a773ac5c1bca06d3eba6a162ca31a740bba2f31d7e4dfdf0938f512e94d/68747470733a2f2f636f6465636f762e696f2f6769746875622f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652f636f7665726167652e7376673f6272616e63683d6d6173746572)](https://codecov.io/github/gordonbanderson/silverstripe-sluggable?branch=master)

[![Latest Stable Version](https://camo.githubusercontent.com/2a182d939c84be58ceae5a3e20cad3af9c63965af662970d5a180d3fa36ef289/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f76657273696f6e)](https://packagist.org/packages/suilven/sluggable)[![Latest Unstable Version](https://camo.githubusercontent.com/0af5c24185231e3b1f3eaadad41d95e1addc90afd4be8d7df2bdabc3b44dedc6/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f762f756e737461626c65)](//packagist.org/packages/suilven/sluggable)[![Total Downloads](https://camo.githubusercontent.com/3df0c165cfe509b622d48ce884a1e104535df2d80326c242e5117755823c8041/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f646f776e6c6f616473)](https://packagist.org/packages/suilven/sluggable)[![License](https://camo.githubusercontent.com/670bb046425c47ee57bc549f601cbaf9645fbf39c84a7a675a54b5a34261cf20/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f6c6963656e7365)](https://packagist.org/packages/suilven/sluggable)[![Monthly Downloads](https://camo.githubusercontent.com/2e89e6440670a21028b4c4ab74684f9b74761494fe54c040608d2b7e92aa9d24/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f642f6d6f6e74686c79)](https://packagist.org/packages/suilven/sluggable)[![Daily Downloads](https://camo.githubusercontent.com/d278252d2e89bea7390c3001257a15dc424d2ffb49f09d89ae51911768471c26/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f642f6461696c79)](https://packagist.org/packages/suilven/sluggable)[![composer.lock](https://camo.githubusercontent.com/8718bf1e212fd06caf334fdbbfe3c0f2a83764e08d2e16a5bb3fdf717d9f5ffe/68747470733a2f2f706f7365722e707567782e6f72672f7375696c76656e2f736c75676761626c652f636f6d706f7365726c6f636b)](https://packagist.org/packages/suilven/sluggable)

[![GitHub Code Size](https://camo.githubusercontent.com/c091c8418307a7f8dd60d3c30c57561a9dd87acb0cb86fb074ee1f2dcca0dd82/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c65)](https://github.com/gordonbanderson/silverstripe-sluggable)[![GitHub Repo Size](https://camo.githubusercontent.com/c26f1ab836870eea2bbadc16d1d90a1c107246a3fec43c71855b23a0bee73efc/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c65)](https://github.com/gordonbanderson/silverstripe-sluggable)[![GitHub Last Commit](https://camo.githubusercontent.com/666a24a728766569f4b6808c2be2b657dc3fc13b036c1f679089a64ec46a703e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c65)](https://github.com/gordonbanderson/silverstripe-sluggable)[![GitHub Activity](https://camo.githubusercontent.com/4af68599593bb6e954a3fa7da219da77e44d49f1f2f87b6edac7feca75b3b25f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6d6d69742d61637469766974792f6d2f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c65)](https://github.com/gordonbanderson/silverstripe-sluggable)[![GitHub Issues](https://camo.githubusercontent.com/582fa9b943f682135bd0e6964b582bfc532fe1a93790554642ee51dd9ae61f53/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c65)](https://github.com/gordonbanderson/silverstripe-sluggable/issues)

[![codecov.io](https://camo.githubusercontent.com/84ee4d3bcad1e69a58865e63653544293b681dea58d85139c36f6d30e86304a0/68747470733a2f2f636f6465636f762e696f2f6769746875622f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652f6272616e63682e7376673f6272616e63683d6d6173746572)](https://camo.githubusercontent.com/84ee4d3bcad1e69a58865e63653544293b681dea58d85139c36f6d30e86304a0/68747470733a2f2f636f6465636f762e696f2f6769746875622f676f72646f6e62616e646572736f6e2f73696c7665727374726970652d736c75676761626c652f6272616e63682e7376673f6272616e63683d6d6173746572)

This SilverStripe module allows the developer to add a field that will be converted to a slug (kebab case) when saved

Configuration
=============

[](#configuration)

For any given class that needs slugs, the extension `Suilven\Sluggable\Extension\Sluggable` needs added and also the name of the field name to slug, under the key `slug`. The slug is stored in a field called `Slug` on the data object after a write is executed.

```
---
Name: cricket-slugs
---

Suilven\CricketSite\Model\Club:
  extensions:
    - Suilven\Sluggable\Extension\Sluggable
  slug: Name

Suilven\CricketSite\Model\Player:
  extensions:
    - Suilven\Sluggable\Extension\Sluggable
  slug: DisplayName
```

Enable Configuration
====================

[](#enable-configuration)

```
vendor/bin/sake dev/build flush=all
```

Then reload the browser, `/admin?flush=all`

Now when the above models are saved, they will be saved with a slug associated with them.

Install
-------

[](#install)

Via Composer

```
$ composer require suilven/sluggable
```

Usage
-----

[](#usage)

Assuming the configuration above:

```
$club = new Suilven\CricketSite\Model\Club();
$club->Name = 'GitHub Cricket Club';
$club->write();
echo $club->Slug
```

The value output will be `github-cricket-club`

Change log
----------

[](#change-log)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Testing
-------

[](#testing)

```
$ composer test
```

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE\_OF\_CONDUCT](CODE_OF_CONDUCT.md) for details.

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- \[Gordon Anderson\]\[link-author\]

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~47 days

Recently: every ~73 days

Total

8

Last Release

2054d ago

PHP version history (2 changes)1.0.0PHP ~5.6|~7

1.0.7PHP ~7.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/770fae946ca5ca8f0f1f0179462c84d3ca60e9bd32cac3f522fdb64c2e384789?d=identicon)[suilven](/maintainers/suilven)

---

Top Contributors

[![gordonbanderson](https://avatars.githubusercontent.com/u/7060?v=4)](https://github.com/gordonbanderson "gordonbanderson (53 commits)")

---

Tags

slug

###  Code Quality

TestsPHPUnit

Type Coverage Yes

### Embed Badge

![Health badge](/badges/suilven-sluggable/health.svg)

```
[![Health](https://phpackages.com/badges/suilven-sluggable/health.svg)](https://phpackages.com/packages/suilven-sluggable)
```

###  Alternatives

[jbroadway/urlify

A fast PHP slug generator and transliteration library that converts non-ascii characters for use in URLs.

6737.4M62](/packages/jbroadway-urlify)[ausi/slug-generator

Slug Generator

8002.2M22](/packages/ausi-slug-generator)[voku/urlify

PHP port of URLify.js from the Django project. Transliterates non-ascii characters for use in URLs.

254.1M7](/packages/voku-urlify)[keyvanakbary/slugifier

A full-featured, simple, clean and pure functional implementation for creating slugs

68187.9k4](/packages/keyvanakbary-slugifier)[wazum/sluggi

TYPO3 extension for URL slug management with inline editing, auto-sync, locking, access control, and redirects

39488.5k](/packages/wazum-sluggi)[internetgalerie/ig-slug

Rebuild URL slugs

12861.7k2](/packages/internetgalerie-ig-slug)

PHPackages © 2026

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