Pollen Solution Wordpress project skeleton.
Open Issues: 0
- php: ^7.4 || ^8.0
- ext-json: *
- composer/installers: ^1.12
- johnpbloch/wordpress-core: ^6.1
- johnpbloch/wordpress-core-installer: ^2.0
- pollen-solutions/asset: ^1.0
- pollen-solutions/console: ^1.0
- pollen-solutions/debug: ^1.0
- pollen-solutions/log: ^1.0
- pollen-solutions/view-extends: ^1.0
- pollen-solutions/wp-kernel: ^1.0
- wpackagist-theme/twentytwentythree: ^1.0
- phpunit/phpunit: ^9.5
- roave/security-advisories: dev-latest
This package is auto-updated.
Last update: 2023-05-31 15:08:24 UTC
WordPress Skeleton Component provides structures of WordPress project based on Pollen Solutions suite.
Table of contents
- Directory structure
The Pollen solutions Skeleton component embeds :
- Composer, as package manager for PHP libraries.
- ViteJS as assets bundler and responsible for compiling, transpilating, versioning, optimizing ...
- Pollen solutions components suite that includes :
- A dependency injection container
- A routing system
- A templating library
- An asset manager and injector
- An expandable command line interface
- An event manager
- A preconfigured Docker environment integrating :
- A light-weight command-line interface for interact with Docker easily
- A PHP server that run through Apache
- A MySQL server
- An email previewer service (MailHog)
- A sharing local application service
- ... And a lot of other kinds of magic !
To try it is already to contribute, you are welcome !
- PHP must be installed on your machine see details.
- Composer must be installed on your machine see details.
composer create-project pollen-solutions/wp-skeleton your-app-name
Serve the app
Serve your application using
the built-in web server in PHP (or your server of
choice) from the
php -S 127.0.0.1:8000 -t public
Visit the application in the browser:
- Docker must be installed on your machine see details
composer create-project pollen-solutions/wp-skeleton your-app-name --no-install --no-scripts
Launch application builder
cd ./your-app-name bin/app.build
Visit the application in the browser:
Retrieve More details about docker usage in a Pollen application from the built-in documentation.
During the installation process, the file
.env.example is copied to
This file contains all required default configuration.
# ENVIRONMENT APP_ENV=dev APP_DEBUG=true APP_URL=http://127.0.0.1:8000 APP_TIMEZONE=Europe/Paris # DATABASE DATABASE_URL=sqlite:///%%app.base_dir%%/var/database.sqlite
Customize a local environment configuration
To customize your application configuration, you can directly edit the
.env file, but the best practice is to
create a new
.env.local file that will contain all the configuration attributes specific to your installation.
.env.local file you can if necessary override an environment value declared in the
.env file or
define new ones :
# DATABASE DATABASE_URL=mysql://root:root@mysql:3306/pollen #REDIS REDIS_CLIENT=phpredis REDIS_HOST=127.0.0.1
Environment variables types
STRING_VAR=string QUOTES_VAR="quoted variable" EMPTY_STRING= BOOL_VAR=true NULL_VAR=null
Environment variable mapping
You can use another existing global or previously defined environment variable like this :
Note that, for security reasons, global environnement variables couldn't be overridden.
Use application variable
In some special cases, you may need to access application variable to complete the configuration of your environment variables and the merge vars could help you.
The paths of the application are natively available :
%%app.base_dir%%: Absolute path to the root directory of the app.
%%app.public_dir%%: Absolute path to the public directory of the app.
Example of usage :
Pollen solutions suite uses the vlucas/phpdotenv library to work. More information on its github repository.
The WordPress Skeleton component is a micro-framework to work with the Wordpress CMS. Like other solutions of this type, it is opinionated and its directory structure is intended to provide a starting point for creating a complete web application.
The Root directory structure
|–– bin |–– bootstrap |–– config |–– docker |–– docs |–– (node_modules) |–– public |–– (assets) |–– languages |–– mu-plugins |–– plugins |–– themes |–– uploads |–– (wordpress) |–– resources |–– assets |–– views |–– src |–– tests |–– var |–– (vendor)
The Root directory
src directory contains the core PHP code of your application.
resources directory contains the templating code. This included views and css, js, fonts, images and all other
public directory contains the index.php file, which is the entry point for all requests entering your
application and configures autoload.
This directory also houses the build assets such css, js, fonts, images and all other assets files.
config directory, as the name implies, contains all of your application's PHP configuration files.
docs directory contains the complete documentation of the micro framework and its components.
Work in progress ;)