cocur/slugify

Converts a string into a slug.

Developed by Florian Eckerstorfer in Vienna, Europe with the help of many great contributors.

Features

Removes all special characters from a string.
Provides custom replacements for German, French, Spanish, Russian, Ukrainian, Polish, Czech, Latvian, Greek, Esperanto¹, Arabian, Vietnamese, Burmese, Danish, Turkish, Finnish, Swedish, and Georgian special characters. Instead of removing these characters, Slugify approximates them (e.g., ae replaces ä).
No external dependencies.
PSR-4 compatible.
Compatible with PHP >= 5.5.9, PHP 7 and HHVM.
Integrations for Symfony2, Silex, Laravel, Twig, Zend Framework 2, Nette Framework, Latte and Plum.

¹ Some Esperanto transliterations conflict with others. You need to enable the Esperanto ruleset to use these transliterations.

Installation

You can install Slugify through Composer:

$ composer require cocur/slugify

Usage

The documentation you can find here has already been updated for the upcoming 2.0 release. If you are using the v1.4, the latest stable version, please use the corresponding documentation. You can find it here.

Generate a slug:

use Cocur\Slugify\Slugify;

$slugify = new Slugify();
echo $slugify->slugify('Hello World!'); // hello-world

You can also change the separator used by Slugify:

echo $slugify->slugify('Hello World!', '_'); // hello_world

The library also contains Cocur\Slugify\SlugifyInterface. Use this interface whenever you need to type hint an instance of Slugify.

To add additional transliteration rules you can use the addRule() method.

$slugify->addRule('i', 'ey');
echo $slugify->slugify('Hi'); // hey

Rulesets

Many of the transliterations rules used in Slugify are specific to a language. These rules are therefore categorized using rulesets. Rules for the most popular are activated by default in a specific order. You can change which rulesets are activated and the order in which they are activated. The order is important when there are conflicting rules in different languages. For example, in German ä is transliterated with ae, in Turkish the correct transliteration is a. By default the German transliteration is used since German is used more often on the internet. If you want to use prefer the Turkish transliteration you have to possibilities. You can activate it after creating the constructor:

$slugify = new Slugify();
$slugify->slugify('ä'); // -> "ae"
$slugify->activateRuleset('turkish');
$slugify->slugify('ä'); // -> "a"

An alternative way would be to pass the rulesets and their order to the constructor.

$slugify = new Slugify(['rulesets' => ['default', 'turkish']]);
$slugify->slugify('ä'); // -> "a"

You can find a list of the available rulesets in Resources/rules.

More options

The constructor takes an options array, you have already seen the rulesets options above. You can also change the regular expression that is used to replace characters with the separator.

$slugify = new Slugify(['regexp' => '/([^A-Za-z0-9]|-)+/']);

(The regular expression used in the example above is the default one.)

By default Slugify will convert the slug to lowercase. If you want to preserve the case of the string you can set the lowercase option to false.

$slugify = new Slugify(['lowercase' => false]);
$slugify->slugify('Hello World'); // -> "Hello-World"

By default Slugify will use dashes as separators. If you want to use a different default separator, you can set the separator option.

$slugify = new Slugify(['separator' => '_']);
$slugify->slugify('Hello World'); // -> "hello_world"

Contributing

Feel free to ask for new rules for languages that is not already here.

All you need to do is:

Provide transliteration rules for your language, in any form, e.g. 'ї' => 'ji'
Provide some examples of texts transliterated with this rules e.g. 'Україна' => 'Ukrajina'

Further information

API docs

Integrations

Symfony2

Slugify contains a Symfony2 bundle and service definition that allow you to use it as a service in your Symfony2 application. The code resides in the Cocur\Slugify\Bridge\Symfony namespace and you only need to add the bundle class to your AppKernel.php:

# app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Cocur\Slugify\Bridge\Symfony\CocurSlugifyBundle(),
        );
        // ...
    }

    // ...
}

You can now use the cocur_slugify service everywhere in your application, for example, in your controller:

$slug = $this->get('cocur_slugify')->slugify('Hello World!');

The bundle also provides an alias slugify for the cocur_slugify service:

$slug = $this->get('slugify')->slugify('Hello World!');

You can set the following configuration settings in app/config.yml to adjust the slugify service:

cocur_slugify:
    lowercase: <boolean>
    separator: <string>
    regexp: <string>
    rulesets: { }

Twig

If you use the Symfony2 framework with Twig you can use the Twig filter slugify in your templates after you have setup Symfony2 integrations (see above).

{{ 'Hällo Wörld'|slugify }}

If you use Twig outside of the Symfony2 framework you first need to add the extension to your environment:

use Cocur\Slugify\Bridge\Twig\SlugifyExtension;
use Cocur\Slugify\Slugify;

$twig = new Twig_Environment($loader);
$twig->addExtension(new SlugifyExtension(Slugify::create()));

To use the Twig filter with TwigBridge for Laravel, you'll need to add the Slugify extension using a closure:

// laravel/app/config/packages/rcrowe/twigbridge/config.php

'extensions' => array(
    //...
    function () {
        return new \Cocur\Slugify\Bridge\Twig\SlugifyExtension(\Cocur\Slugify\Slugify::create());
    },
),

You can find more information about registering extensions in the Twig documentation.

Silex

Slugify also provides a service provider to integrate into Silex.

$app->register(new Cocur\Slugify\Bridge\Silex\SlugifyServiceProvider());

You can use the slugify method in your controllers:

$app->get('/', function () {
    return $app['slugify']->slugify('welcome to the homepage');
});

And if you use Silex in combination with Twig you can also use it in your templates:

{{ app.slugify.slugify('welcome to the homepage') }}

Of course you can also add the Twig extension to your environment and use the slugify filter:

$app['twig']->addExtension(new SlugifyExtension(Slugify::create()));

Mustache.php

We don't need an additional integration to use Slugify in Mustache.php. If you want to use Slugify in Mustache, just add a helper:

use Cocur\Slugify\Slugify;

$mustache = new Mustache_Engine(array(
    // ...
    'helpers' => array('slugify' => function($string, $separator = null) {
        return Slugify::create()->slugify($string, $separator);
    }),
));

Laravel

Slugify also provides a service provider to integrate into Laravel (versions 4.1 and later).

In your Laravel project's app/config/app.php file, add the service provider into the "providers" array:

'providers' => array(
    "Cocur\Slugify\Bridge\Laravel\SlugifyServiceProvider",
)

And add the facade into the "aliases" array:

'aliases' => array(
    "Slugify" => "Cocur\Slugify\Bridge\Laravel\SlugifyFacade",
)

You can then use the Slugify::slugify() method in your controllers:

$url = Slugify::slugify('welcome to the homepage');

Zend Framework 2

Slugify can be easely used in Zend Framework 2 applications. Included bridge provides a service and a view helper already registered for you.

Just enable the module in your configuration like this.

return array(
    //...

    'modules' => array(
        'Application',
        'ZfcBase',
        'Cocur\Slugify\Bridge\ZF2' // <- Add this line
        //...
    )

    //...
);

After that you can retrieve the Cocur\Slugify\Slugify service (or the slugify alias) and generate a slug.

/** @var \Zend\ServiceManager\ServiceManager $sm */
$slugify = $sm->get('Cocur\Slugify\Slugify');
$slug = $slugify->slugify('Hällo Wörld');
$anotherSlug = $slugify->slugify('Hällo Wörld', '_');

In your view templates use the slugify helper to generate slugs.

<?php echo $this->slugify('Hällo Wörld') ?>
<?php echo $this->slugify('Hällo Wörld', '_') ?>

The service (which is also used in the view helper) can be customized by defining this configuration key.

return array(
    'cocur_slugify' => array(
        'reg_exp' => '/([^a-zA-Z0-9]|-)+/'
    )
);

Nette Framework

Slugify contains a Nette extension that allows you to use it as a service in your Nette application. You only need to register it in your config.neon:

# app/config/config.neon

extensions:
	slugify: Cocur\Slugify\Bridge\Nette\SlugifyExtension

You can now use the Cocur\Slugify\SlugifyInterface service everywhere in your application, for example in your presenter:

class MyPresenter extends \Nette\Application\UI\Presenter
{
	/** @var \Cocur\Slugify\SlugifyInterface @inject */
	public $slugify;

	public function renderDefault()
	{
		$this->template->hello = $this->slugify->slugify('Hällo Wörld');
	}
}

Latte

If you use the Nette Framework with it's native Latte templating engine, you can use the Latte filter slugify in your templates after you have setup Nette extension (see above).

{$hello|slugify}

If you use Latte outside of the Nette Framework you first need to add the filter to your engine:

use Cocur\Slugify\Bridge\Latte\SlugifyHelper;
use Cocur\Slugify\Slugify;
use Latte;

$latte = new Latte\Engine();
$latte->addFilter('slugify', array(new SlugifyHelper(Slugify::create()), 'slugify'));

Slim 3

Slugify does not need a specific bridge to work with Slim 3, just add the following configuration:

$container['view'] = function ($c) {
    $settings = $c->get('settings');
    $view = new \Slim\Views\Twig($settings['view']['template_path'], $settings['view']['twig']);
    $view->addExtension(new Slim\Views\TwigExtension($c->get('router'), $c->get('request')->getUri()));
    $view->addExtension(new Cocur\Slugify\Bridge\Twig\SlugifyExtension(Cocur\Slugify\Slugify::create()));
    return $view;
};

In a template you can use it like this:

<a href="/blog/{{ post.title|slugify }}">{{ post.title|raw }}</a></h5>

League

Slugify provides a service provider for use with league/container:

use Cocur\Slugify;
use League\Container;

/* @var Container\ContainerInterface $container */
$container->addServiceProvider(new Slugify\Bridge\League\SlugifyServiceProvider());

/* @var Slugify\Slugify $slugify */
$slugify = $container->get(Slugify\SlugifyInterface::class);

You can configure it by sharing the required options:

use Cocur\Slugify;
use League\Container;

/* @var Container\ContainerInterface $container */
$container->share('config.slugify.options', [
    'lowercase' => false,
    'rulesets' => [
        'default',
        'german',
    ],
]);

$container->addServiceProvider(new Slugify\Bridge\League\SlugifyServiceProvider());

/* @var Slugify\Slugify $slugify */
$slugify = $container->get(Slugify\SlugifyInterface::class);

You can configure which rule provider to use by sharing it:

use Cocur\Slugify;
use League\Container;

/* @var Container\ContainerInterface $container */
$container->share(Slugify\RuleProvider\RuleProviderInterface::class, function () {
    return new Slugify\RuleProvider\FileRuleProvider(__DIR__ . '/../../rules');
]);

$container->addServiceProvider(new Slugify\Bridge\League\SlugifyServiceProvider());

/* @var Slugify\Slugify $slugify */
$slugify = $container->get(Slugify\SlugifyInterface::class);

Change Log

Version 2.2 (10 July 2016)

#102 Add transliterations for Azerbaijani (by seferov)
#109 Made integer values into strings (by JonathanMH)
#114 Provide SlugifyServiceProvider for league/container (by localheinz)
#120 Add compatibility with Silex 2 (by shamotj)

Version 2.1.1 (8 April 2016)

Do not activate Swedish rules by default (fixes broken v2.1 release)

Version 2.1.0 (8 April 2016)

#104 Add Symfony configuration (by estahn)
#107 Fix Swedish rules

Version 2.0.0 (24 February 2016)

#78 Use multibyte-safe case convention (by Koc)
#81 Move rules into JSON files (by florianeckerstorfer)
#84 Add tests for very long strings containing umlauts (by florianeckerstorfer)
#88 Add rules for Hindi (by florianeckerstorfer)
#89 Add rules for Norwegian (by tsmes)
#90 Replace bindShared with singleton in Laravel bridge (by sunspikes)
#97 Set minimum PHP version to 5.5.9 (by florianeckerstorfer)
#98 Add rules for Bulgarian (by RoumenDamianoff)

Version 1.4.1 (11 February 2016)

#90 Replace bindShared with singleton in Laravel bridge (by sunspikes)

Version 1.4 (29 September 2015)

#75 Remove a duplicate array entry (by irfanevrens)
#76 Add support for Georgian (by TheGIBSON)
#77 Fix Danish transliterations (by kafoso)

Version 1.3 (2 September 2015)

#70 Add missing superscript and subscript digits (by BlueM)
#71 Improve Greek language support (by kostaspt)
#72 Improve Silex integration (by CarsonF)
#73 Improve Russian language support (by akost)

Version 1.2 (2 July 2015)

Add integration for Plum (by florianeckerstorfer)
#64 Fix Nette integration (by lookyman)
Add option to not convert slug to lowercase (by florianeckerstorfer and GDmac)

Version 1.1 (18 March 2015)

#54 Add support for Burmese characters (by lovetostrike)
#58 Add Nette and Latte integration (by lookyman)
#50 Fix transliteration for Vietnamese character Đ (by mac2000)

Version 1.0 (26 November 2014)

No new features or bugfixes, but it's about time to pump Slugify to v1.0.

Version 0.11 (23 November 2014)

#49 Add Zend Framework 2 integration (by acelaya)

Version 0.10.3 (8 November 2014)

#48 Add support for Vietnamese (by mac2000)

Version 0.10.2 (18 October 2014)

#44 Change visibility of properties to protected (by acelaya)
#45 Configure regular expression used to replace characters (by acelaya)
Fix type hinting (by florianeckerstorfer)
Remove duplicate rule (by florianeckerstorfer)

Version 0.10.1 (1 September 2014)

#39 Add support for rulesets (by florianeckerstorfer)

Version 0.10.0 (26 August 2014)

#32 Added Laraval bridge (by cviebrock)
#35 Fixed transliteration for Ď (by michalskop)

Version 0.9 (29 May 2014)

#28 Add Symfony2 service alias and make Twig extension private (by Kevin Bond)

Version 0.8 (18 April 2014)

#27 Add support for Arabic characters (by Davide Bellini)
Added some missing characters
Improved organisation of characters in Slugify class

Version 0.7 (4 April 2014)

This version introduces optional integrations into Symfony2, Silex and Twig. You can still use the library in any other framework. I decided to include these bridges because there exist integrations from other developers, but they use outdated versions of cocur/slugify. Including these small bridge classes in the library makes maintaining them a lot easier for me.

#23 Added Symfony2 service
#24 Added Twig extension
#25 Added Silex service provider

Version 0.6 (2 April 2014)

#22 Added support for Esperanto characters (by Michel Petit)

Version 0.5 (28 March 2014)

#21 Added support for Greek characters (by Michel Petit)
#20 Fixed rule for cyrillic letter D (by Marchenko Alexandr)
Add missing $separator parameter to SlugifyInterface

Version 0.4.1 (9 March 2014)

#19 Adds soft sign rule (by Marchenko Alexandr)

Version 0.4 (17 January 2014)

Nearly completely rewritten code, removes iconv support because the underlying library is broken. The code is now better and faster. Many thanks to Marchenko Alexandr.

Version 0.3 (12 January 2014)

#11 PSR-4 compatible (by mac2000)
#13 Added editorconfig (by mac2000)
#14 Return empty slug when input is empty and removed unused parameter (by mac2000)

Authors

Florian Eckerstorfer (Twitter)
Ivo Bathke
Marchenko Alexandr
And many great contributors

Slugify is a project of Cocur. You can contact us on Twitter: @cocurco

Support

If you need support you can ask on Twitter (well, only if your question is short) or you can join our chat on Gitter.

In case you want to support the development of Slugify you can help us with providing additional transliterations or inform us if a transliteration is wrong. We would highly appreciate it if you can send us directly a Pull Request on Github. If you have never contributed to a project on Github we are happy to help you. Just ask on Twitter or directly join our Gitter.

You always can help me (Florian, the original developer and maintainer) out by sending me an Euro or two.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Files

README.md

Latest commit

History