AxeWP Common

Shared WordPress and WPGraphQL utilities for AxeWP plugins.

axepress/axewp-common is a PHP library providing reusable base classes, interfaces, and traits used the AxePress suite of WordPress plugins.

• PHP 8.2+

composer require axepress/axewp-common

Extend AbstractEncryptor with the name of the wp-config.php constant that holds the key:

final class Encryptor extends AbstractEncryptor {
	protected static function get_constant_key(): string {
		return 'MY_PLUGIN_ENCRYPTION_KEY';
	}
}

$stored = Encryptor::encrypt( $secret ); // 'enc:v1:...'
$secret = Encryptor::decrypt( $stored );

encrypt() and decrypt() return a WP_Error on failure. decrypt() returns not_encrypted if the value lacks the prefix, and decryption_failed if it's malformed, was tampered with, or was encrypted with a different key. is_encrypted() only checks the prefix.

Set the constant to a long random string, e.g. from openssl rand -base64 32. If it isn't set, LOGGED_IN_KEY is used instead, and values become unreadable if the salts are rotated. The wp-config-sample.php placeholder phrase counts as undefined. The library emits no notice for the fallback: call is_using_fallback_key() to surface it to site owners. If no key exists at all, encrypt() and decrypt() return a WP_Error (no_encryption_key).

After you add the constant, values encrypted with LOGGED_IN_KEY still decrypt, and stay tied to it until re-encrypted. Re-encrypt the values for which needs_reencryption() is true to move them to the new key.

Subclasses can override these static properties:

Changing any of these, the constant's name, or its value means existing values can no longer be decrypted.

Abstracts for registering WPGraphQL types with a consistent API:

Abstracts (src/GraphQL/Abstracts/)

Interfaces (src/GraphQL/Interfaces/)

GraphQLType, TypeWithFields, TypeWithInputFields, TypeWithInterfaces, TypeWithConnections

Traits (src/GraphQL/Traits/)

TypeNameTrait, TypeResolverTrait

See DEVELOPMENT.md for the full setup, standards, and testing guide, and CONTRIBUTING.md before opening a PR.

# Install the NPM dependencies (using NVM)
nvm use
npm ci

# Install the PHP dependencies (using Composer)
composer install

# Lints
## Prettier
npm run format

## PHPCS
npm run lint:php
npm run lint:php:fix

## PHPStan
npm run lint:php:stan

## TypeScript
npm run lint:js:types

# Start the wp-env test environment with Xdebug code coverage enabled
npm run wp-env:test start -- --xdebug=coverage

# Run the PHPUnit tests
npm run test:php

GPL-3.0-or-later