goblindegook/syllables

Syllables are helper classes and functions for WordPress development.

Installs: 19 988

Dependents: 0

Suggesters: 0

Stars: 5

Watchers: 2

Forks: 1

Open Issues: 1

Type:wordpress-plugin

0.3.2 2015-07-18 19:21 UTC

README

Syllables are helper classes and functions for WordPress development.

Latest Stable Version Latest Unstable Version Build Status Scrutinizer Code Quality Code Coverage

Installation

To install this library as a dependency in your WordPress project using Composer, run the following command to get the latest version:

$ composer require goblindegook/syllables

By default, Composer will install Syllables as a plugin in the wp-content/plugins/syllables directory. You may then sign into the Dashboard, navigate to "Plugins" and activate "Syllables".

Even though Syllables exists as a plugin, it doesn't do anything by itself, but it does make its classes and functions available so you don't have to include it as a dependency in every single one of your plugins or themes.

Install as a must-use WordPress plugin

To install Syllables as a must-use plugin (which cannot be turned off by users), make sure your site's composer.json file contains an extra.installer-paths section and that goblindegook/syllables is set to install in the correct directory:

"extra": {
    "installer-paths": {
        "wp-content/mu-plugins/syllables/": ["goblindegook/syllables"]
    }
}

Running Composer to install your dependencies will place Syllables into the wp-content/mu-plugins/syllables folder instead.

Now, because WordPress doesn't look for must-use plugins in subfolders, you will also need to copy the syllables-mu.php file provided into the parent directory.

$ cd /path/to/wp-content/mu-plugins/syllables
$ cp syllables-mu.php ..

Development builds

Syllables uses Gulp to automate builds through the following tasks:

  • gulp build: Installs Composer dependencies.
  • gulp test: Runs automated PHPUnit tests.
  • gulp watch: Observes source files for changes and runs unit tests automatically.
  • gulp apigen: Builds documentation using ApiGen.

Acknowledgements

License

Syllables is licensed under the GPL, version 2.0 or any later version. See LICENSE.