1b2f5ab4ad
The root namespace of Core is Automattic\WooCommerce, but both the blocks and wc-admin plugins exist in this namespace. In an effort to prevent possible conflicts, we should not allow for overlap in our repository. The rationale behind doing this as opposed to renaming our root namespace feels reasonable. In the case of Blocks, all of the tooling is already set up in their repository, so all blocks should go there anyway. In the case of WC-Admin, we shouldn't be refactoring admin classes, as that would duplicate work done to revamp them entirely. |
||
|---|---|---|
| .. | ||
| Admin | ||
| Blocks | ||
| Autoloader.php | ||
| Packages.php | ||
| README.md | ||
README.md
WooCommerce src files
This directory is home to new WooCommerce class files under the \Automattic\WooCommerce\ namespace using PSR-4 file naming. This is to take full advantage of autoloading.
Currently, these classes have a PHP 7.0 requirement. No required core classes will be added here until this PHP version is enforced. If running an older version of PHP, these class files will not be used.
Installing Composer
Composer is used to generate autoload class-maps for the files here. The stable release of WooCommerce comes with the autoloader, however, if you're running a development version you'll need to use Composer.
If you don't have Composer installed, go and check how to install Composer and then continue here.
Installing packages
To install the packages WooCommerce requires, from the main directory run:
composer install
To update packages run:
composer update
If you add a class to WooCommerce and want to ensure it's included in the autoloader class-maps, run:
composer dump-autoload
Using classes
To use something a namespaced class you have to declare it at the top of the file before any other instruction, and then use it in the code. For example:
use Automattic\WooCommerce\TestClass;
// other code...
$test_class = new TestClass();
If you need to rule out conflicts, you can alias it:
use Automattic\WooCommerce\TestClass as Test_Class_Alias;
// other code...
$test_class = new Test_Class_Alias();