An extensible theme and plugin framework for WordPress.
PHP
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tests
.gitignore
.php_cs
.travis.yml
COPYING.md
README.md
composer.json
composer.lock
phpunit.xml

README.md

iguana

An extensible theme and plugin framework for WordPress.

Components

Iguana is split into several components. The idea is that iguana and iguana-theme are the two core libraries that will seldom change, while new features will be added to iguana-extras on a regular basis.

  • iguana is the library that allows themes and plugins to set up autoloading and dependency injection without nearly as much boilerplate code
  • iguana-theme builds on iguana and allows themes to register helper functions and use template layouts
  • iguana-extras builds on iguana and iguana-theme and provides a bunch of little components for plugins and themes

Theme templates that use Iguana

Installation

Add the library to your theme:

$ composer require dxw/iguana

Add these two lines to template/functions.php (modify appropriately if functions.php isn't in a subdirectory):

$registrar = require __DIR__.'/../app/load.php';
$registrar->register();

Add a new file called app/load.php:

<?php

require __DIR__.'/../vendor.phar';

return \Dxw\Iguana\Init::init(__DIR__, 'Dxw\\MyTheme');

(Replace Dxw\\MyTheme with the namespace of your own application.)

Add a new file called app/di.php:

It can start out blank:

<?php

But eventually it will contain the code necessary to construct the dependency graph of your code, i.e.:

$registrar->addInstance(new \Dxw\MyTheme\MyClass());
$registrar->addInstance(new \Dxw\MyTheme\MyOtherClass(
    $registrar->getInstance(Dxw\MyTheme\MyClass::class)
));

What Iguana provides

For your dependency-injected class structure

Your classes can automatically register themselves (or rather, indicate that they need to be registered):

<?php

namespace Dxw\MyTheme;

class MyClass implements \Dxw\Iguana\Registerable
{
    public function register()
    {
        add_filter(...);
    }
}

Any instance added to the registrar that implements \Dxw\Iguana\Registerable will have its register() method called.

This means you don't have to remember call the register() method somewhere after adding it to app/di.php.

And moving the calls to add_filter(), 'register_xyz()`, etc out from the constructor makes it much easier to test.

For your background processes and cron jobs

If you're running a background process or cron job outside of WordPress, you can $registrar = require 'path/to/load.php'; to load all the code in your theme/plugin. If you need to register it, you can do it piece-by-piece, or you can $registrar->register(); to register it all at once.

Licence

MIT