deep-web-solutions/wp-framework-bootstrapper

A set of related functions that help bootstrap and version the other DWS WordPress Framework packages.

v1.3.0 2022-01-13 14:34 UTC

Requires

• php: >=7.4

Requires (Dev)

• codeception/module-asserts: ^1.3
• codeception/module-cli: ^1.1
• codeception/module-db: ^1.1
• codeception/module-filesystem: ^1.0
• codeception/module-phpbrowser: ^1.0
• codeception/module-webdriver: ^1.4
• codeception/stub: <4.0
• codeception/util-universalframework: ^1.0
• dealerdirect/phpcodesniffer-composer-installer: *
• deep-web-solutions/wordpress-configs: master@dev
• hoa/console: ^3.17
• johnpbloch/wordpress-core: 5.5.*
• lucatume/wp-browser: 3.*
• php-stubs/wordpress-stubs: 5.5.*
• phpcompatibility/php-compatibility: *
• phpcompatibility/phpcompatibility-wp: *
• phpmd/phpmd: 2.*
• squizlabs/php_codesniffer: 3.*
• vlucas/phpdotenv: ^5.4
• wp-coding-standards/wpcs: *

GPL-3.0-or-later

• Antonius Hegyes
• Contributors

• framework
• wordpress
• bootstrapper
• Deep Web Solutions

README

Description

A set of related functions that help bootstrap and version the other DWS WordPress Framework components.

The bootstrap.php file is designed to be one of the very first things that will autoload when calling require vendor/autoload.php because it is mentioned specifically as a file to autoload in composer.json.

Upon loading, the file will define the necessary functions and validate its own minimum requirements. The end-plugin can now make use of the same functions to check for minimum WP and PHP requirements, and also use the same functions for outputting an error message.

Documentation

Documentation for this module and the rest of the DWS WP Framework can be found here.

Installation

The package is designed to be installed via Composer. It may work as a stand-alone but that is not officially supported. The package's name is deep-web-solutions/wp-framework-bootstrapper.

If the package will be used outside a composer-based installation, e.g. inside a regular WP plugin, you should install using the --ignore-platform-reqs option. If you don't do that, the package will only be able to perform checks for the WordPress version because composer will throw an error in case of an incompatible PHP version.

Contributing

Contributions both in the form of bug-reports and pull requests are more than welcome!

Frequently Asked Questions

• What is the purpose of this package?

It is a good idea for every WordPress plugin to first check the PHP and WP versions present before running, and, if minimum requirements are not fulfilled, to stop execution and display an error message. This package provides an easy way of doing just that!

• Can this be used outside the DWS framework?

While this package was built to be used by the DWS WordPress Framework, it does come with a whitelabel functionality. If you define the constants checked for in includes/whitelabel.php before calling require vendor/autoload.php you can customize quite a lot of things.

• Will you support earlier versions of WordPress and PHP?

The bootstrapper module itself will run on any PHP version back to 5.3 -- however, it will do so only to let the user know that they should update to at least PHP 8.4. As of writing this (December 2024), more than half the WordPress installations use version 6.7 so we won't be supporting anything below that.

• Is this bug-free?

Hopefully yes, probably not. If you found any problems, please raise an issue on GitHub!

Changelog

2.0.0 (TBD)

• Entire rewrite to cut down on verbosity, constants, and improve performance.