Reference

This page provides detailed reference documentation for the Auth0 WordPress Plugin's configuration options, APIs, hooks, and database structures. Use this as a quick lookup guide when working with the plugin.

For installation and setup, see Getting Started. For architectural details, see Architecture. For development workflows, see Development.

Plugin API Overview

The plugin exposes its functionality through a singleton pattern centered around the wpAuth0() helper function and the Plugin class. This provides access to the Auth0 SDK, configuration management, and internal components.

Core API Entry Points

Sources: wpAuth0.php72-89 src/Plugin.php21-330

Configuration System Architecture

The plugin's configuration is organized hierarchically into groups stored as WordPress options with the auth0_ prefix. Each group contains related settings that are validated and sanitized through dedicated handlers.

Configuration Groups and Storage

Sources: src/Actions/Configuration.php21-438 src/Plugin.php113-159

Database Schema

The plugin creates two custom tables to manage user account linking and background synchronization. These extend WordPress's native user system without modifying core tables.

Custom Tables Structure

Sources: src/Database.php101-141 src/Actions/Authentication.php53-173

Core Plugin Methods

Method	Return Type	Purpose
wpAuth0()	Plugin	Returns singleton Plugin instance
Plugin::isEnabled()	bool	Checks if authentication is enabled
Plugin::isReady()	bool	Validates minimum configuration
Plugin::getSdk()	Auth0	Returns configured Auth0 SDK instance
Plugin::getOption()	mixed	Retrieves configuration values
Plugin::getOptionString()	?string	Type-safe string option getter
Plugin::getOptionBoolean()	?bool	Type-safe boolean option getter
Plugin::getOptionInteger()	?int	Type-safe integer option getter

Sources: wpAuth0.php79-89 src/Plugin.php113-219

Security Secrets Management

The plugin generates and manages several cryptographic secrets for different security functions. These are created during plugin activation and stored in WordPress options.

Secret	Option Key	Purpose
Cookie Secret	auth0_cookies[secret]	Encrypts session cookies
Backchannel Logout Secret	auth0_backchannel_logout[secret]	Validates logout tokens
Fallback Secret	auth0_authentication[fallback_secret]	Enables WordPress login bypass

Sources: wpAuth0.php40-67 src/Actions/Configuration.php722-758

Version and Compatibility

Current Version Information

Attribute	Value
Plugin Version	5.2.1
WordPress Minimum	6.0
WordPress Tested	6.5.3
PHP Minimum	8.1
Auth0 SDK Version	^8.14

Version Constants

Sources: wpAuth0.php7-26 CHANGELOG.md1-60 .version1

WordPress Hook Integration

The plugin integrates with WordPress through a comprehensive set of action and filter hooks. These are registered through the Actions and Filters classes using the Hooks utility.

Hook Registration Pattern

Key Hook Categories

Category	Class	Primary Hooks
Authentication	AuthenticationActions	init, login_form_login, wp_login
Configuration	ConfigurationActions	admin_init, admin_menu
Synchronization	SyncActions	AUTH0_CRON_SYNC, AUTH0_CRON_MAINTENANCE

Sources: src/Plugin.php26-31 src/Actions/Base.php16-122 src/Hooks.php7-63

Configuration Options Reference

The plugin organizes configuration into logical groups, each with specific validation and sanitization rules. All options are stored as WordPress options with the auth0_ prefix.

Client Configuration

Authentication Settings

Account Management

Sources: src/Actions/Configuration.php84-256

This reference provides the foundation for understanding the plugin's technical interfaces. For detailed implementation examples and advanced usage patterns, refer to the specific subsections of this reference documentation.