moonwalkingbits/wordpress-autoloader

A class loader for the WordPress coding standards.

0.1.1 2020-06-12 00:13 UTC

Requires

• php: >=7.4

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ~0.6
• phan/phan: ~3.0
• phpmd/phpmd: ~2.8
• phpunit/phpunit: ~9.2
• squizlabs/php_codesniffer: ~3.5
• wp-coding-standards/wpcs: ~2.3

GPL-3.0-or-later

• Martin Pettersson

README

A class loader for the WordPress coding standards.

When taking the object oriented approach to developing in PHP, autoloading can get rid of all the include/require statements in your code. Instead of manually including the file before you use the class, or having to check if the class is available you just use it. If it is not yet included it will be automatically included by the class loader.

The only class file you need to include is the autoloader. Or if you use this library as a composer package it is enough to include composer's autoload.php. After you've set it up it will take care of the rest of the includes.

<?php

require_once '/path/to/class-autoloader.php';

$autoloader = new Moonwalking_Bits\Autoloader();

// Add as many namespace mappings as needed.
$autoloader->add_namespace_mapping( 'Namespace', '/path/to/classes' );

// Register the autoloader with the spl provided autoload queue.
spl_autoload_register( array( $autoloader, 'load_class' ) );

After this setup any class in the Namespace namespace that resides in the registered namespace directory can be used directly without any include/require statements.

Nested namespaces

The autoloader will resolve any classes with nested namespace as long as the directory structure follows the namespace path:

<?php

$autoloader->add_namespace_mapping( 'Namespace', '/path/to/classes' );

<?php // /path/to/classes/nested/class-test-class.php

namespace Namespace\Nested;

class Test_Class {}

Given the above example the class Namespace\Nested\Test_Class will be loaded correctly.

Classes without namespace

To load classes that do not use any namespace just register the mapping with an empty namespace:

<?php

$autoloader->add_namespace_mapping( '', '/path/to/classes' );

License

Autoloader is released under the GPL license.