README

For easy script and style enqueueing in WordPress. With Laravel Mix Manifest and WP-Scripts asset file support!

Introduction
Getting Started
- Installation
Usage
Credits
Testing
License

Introduction

This tool is made for making the enqueueing and registering of WordPress scripts a bit more expressive and to make using laravel Mix Manifest much easier to manage.

This tool lets you:

Define a root URL for your scripts and stylesheets so that you only have to use get_stylesheet_directory_uri once and instead use relative paths when enqueueing
Add your mix-manifest.json file so that all mix compiled assets gets hashed automatically
Use a fluid interface for enqueueing assets

Getting Started

Fist install the package!

Then from here on your entry point will be \Morningtrain\WP\Enqueue\Enqueue.

Installation

This tool is available as a package and can be installed through composer:

composer require morningtrain/wp-enqueue

Usage

Here is a quick example of how this package works!

use Morningtrain\WP\Enqueue\Enqueue;

// functions.php (or plugin.php)
Enqueue::setup(get_stylesheet_directory_uri() . "/public/build", get_stylesheet_directory() . "/public/build");

// Then wherever you wish to enqueue - preferably in the wp_enqueue_scripts action
Enqueue::script('main')
    ->src('js/main.js')
    ->deps('jquery')
    ->applyAssetFile() // This applies the main.asset.php file containing dependencies and version. Dependencies are pushed to existing dependencies
    ->enqueue();

// Or to simply register a stylesheet
Enqueue::style('main')
    ->src('css/main.css')
    ->register();

// In a block, on a route or in a condition somewhere you can now enqueue the already registered stylesheet
Enqueue::style('main')->enqueue();

Before you start

All relative paths should match paths in webpack.mix.js.

So if you have the following in your mix:

// webpack.mix.js

let mix = require('laravel-mix');

mix.js('resources/js/app.js', 'js').setPublicPath('public/build');

Then your public directory would be public/build and all assets would use a source relative to this path. So in the above example, you would enqueue app.js like this:

Enqueue::script('app', 'js/app.js')->enqueue();

Note: Enqueueing assets before the wp_enqueue_scripts hook will automatically delay the enqueueing until WordPress is ready. You should, of course, still enqueue properly in the right hook.

Defining the root Url

You may define the root URL of your build directory.

By doing this you can now enqueue assets using a relative path. This should match the one defined in webpack.mix.js if you are using Laravel Mix

// Setting the root URL
\Morningtrain\WP\Enqueue\Enqueue::setRootUrl(get_stylesheet_directory_uri() . '/public/build');

You may also get the url by calling Enqueue::getRootUrl()

// Getting the root URL
$rootUrl = \Morningtrain\WP\Enqueue\Enqueue::getRootUrl();

Adding a MixManifest file

If you are using Laravel Mix then you can add the generated mix-manifest.json file. By doing this all enqueued assets will automatically use the hashed sources.

This is an easy and convenient way to clear client cached assets without worry.

// Adding the manifest file
\Morningtrain\WP\Enqueue\Enqueue::addManifest(get_stylesheet_directory() . '/public/build/mix-manifest.json');

You may also retrieve the manifest content

// Adding the manifest content
\Morningtrain\WP\Enqueue\Enqueue::getManifest();

Loading scripts and styles

Loading a script or a style is almost the same! Construct either a Script or a Style from Enqueue

Then, using a fluid api, you can configure your asset and then either enqueue or register at the end.

Note: These methods act the same as, and wraps, WordPress methods wp_enqueue_script() and wp_enqueue_style() and their register equivalents.

// Beginning an Enqueue chain
// This is how you start enqueueing or registering a script
\Morningtrain\WP\Enqueue\Enqueue::script('my-script');
// ... and for a stylesheet
\Morningtrain\WP\Enqueue\Enqueue::style('my-style');

After this inspect the instance returned. All options are available as chainable methods!

Enqueueing

To enqueue simply end your chain by calling enqueue()

// Enqueue a script called 'my-script' which is located in the /js directory
\Morningtrain\WP\Enqueue\Enqueue::script('my-script')
    ->src('js/my-script.js')
    ->enqueue();

// Or you may supply the source as the second param as so
\Morningtrain\WP\Enqueue\Enqueue::script('my-script', 'js/my-script.js')
    ->enqueue();

Registering

To register instead of enqueueing use register()

// Register a script called 'my-script' which is located in the /js directory
\Morningtrain\WP\Enqueue\Enqueue::script('my-script')
    ->src('js/my-script.js')
    ->register();

Then later you can enqueue your asset this way:

// Enqueue a script called 'my-script' which has already been registered
\Morningtrain\WP\Enqueue\Enqueue::script('my-script')
    ->enqueue();

Options

There are the same options as the methods these classes wrap.

Note: deps() also accepts a string and if you call it multiple times in the same chain then every call pushes its value to the list.

Script

Here is an example using all available options:

See wp_enqueue_script on developer.wordpress.org

\Morningtrain\WP\Enqueue\Enqueue::script('my-script')
    ->src('js/my-script.js')
    ->deps('jquery')
    ->ver('1.0')
    ->inFooter(true)
    ->enqueue();

Style

Here is an example using all available options:

See wp_enqueue_style on developer.wordpress.org

\Morningtrain\WP\Enqueue\Enqueue::style('my-style')
    ->src('css/my-style.css')
    ->deps('print-styles')
    ->ver('1.0')
    ->media('print')
    ->enqueue();

Namespacing

You may register a namespace for a set of scripts or styles that live somewhere else in your codebase.

To do this simple add the namespace and then use this namespace in your handles. Namespacing is especially useful when writing a plugin.

Adding a namespace

\Morningtrain\WP\Enqueue\Enqueue::addNamespace('myPlugin',\plugin_dir_url(__FILE__). "public/build", __DIR__ . "/public/build/mix-manifest.json");

Using a namespace

\Morningtrain\WP\Enqueue\Enqueue::style('myPlugin::main')
    ->src('css/main.css')
    ->enqueue();

Credits

Testing

composer test

License

The MIT License (MIT). Please see License File for more information.

morningtrain / wp-enqueue

Maintainers

Details