automattic/jetpack-constants

A wrapper for defining constants in a more testable way.

v3.0.0 2024-11-14 20:12 UTC

Requires

• php: >=7.2

Requires (Dev)

• automattic/jetpack-changelogger: ^5.0.0
• brain/monkey: 2.6.1
• yoast/phpunit-polyfills: ^1.1.1

Suggests

• automattic/jetpack-autoloader: Allow for better interoperability with other plugins that use this package.

GPL-2.0-or-later

README

A simple constant manager for Jetpack.

Testing constants is hard. Once you define a constant in PHP, it's defined. Constants Manager is an abstraction layer so that unit tests can set constants for tests.

Usage

Retrieve the value of a constant CONSTANT_NAME (returns null if it's not defined):

use Automattic\Jetpack\Constants;

$constant_value = Constants::get_constant( 'CONSTANT_NAME' );

Set the value of a constant CONSTANT_NAME to a particular value:

use Automattic\Jetpack\Constants;

$value = 'some value';
Constants::set_constant( 'CONSTANT_NAME', $value );

Check whether a constant CONSTANT_NAME is defined:

use Automattic\Jetpack\Constants;

$defined = Constants::is_defined( 'CONSTANT_NAME' );

Check whether a constant CONSTANT_NAME is truthy:

use Automattic\Jetpack\Constants;

$is_truthy = Constants::is_true( 'CONSTANT_NAME' );

Delete the CONSTANT_NAME constant:

use Automattic\Jetpack\Constants;

Constants::clear_single_constant( 'CONSTANT_NAME' );

Delete all known constants:

use Automattic\Jetpack\Constants;

Constants::clear_constants();

Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

License

jetpack-constants is licensed under GNU General Public License v2 (or later)