SmartCT Plugin Documentation

Overview

SmartCT is a WordPress plugin that integrates Cloudflare Turnstile CAPTCHA protection with WordPress forms. It provides lightweight and privacy-first protection for login, registration, password reset, comments, and WooCommerce forms.

Plugin Details:

Plugin Architecture

Main Files Structure

turnstilewp/
├── turnstilewp.php                 - Main plugin file
├── includes/                       - Core plugin classes
│   ├── class-init.php             - Plugin initialization
│   ├── class-loader.php           - Autoloader
│   ├── class-settings.php         - Settings management
│   ├── class-verify.php           - Token verification
│   ├── class-ajax-handlers.php    - AJAX functionality
│   ├── functions-common.php       - Common utility functions
│   └── settings/                  - Settings framework
├── integrations/                  - Form integrations
│   ├── class-turnstile.php       - Main Turnstile widget
│   ├── class-core-wp.php         - WordPress core forms
│   └── class-woocommerce.php     - WooCommerce integration
├── admin/                         - Admin interface
├── templates/                     - Template files
└── assets/                        - CSS/JS assets

Core Functions Documentation

1. Main Plugin File (turnstilewp.php)

Global Functions

turnstilewp_init()
Anonymous Activation Hook Function
Anonymous Deactivation Hook Function

Global Constants


2. Init Class (includes/class-init.php)

Class Properties

Methods

get_instance(): Init
init(): void
load_dependencies(): void
init_hooks(): void
enqueue_admin_assets(): void
enqueue_frontend_assets(): void
should_load_turnstile(): bool
activate(): void
deactivate(): void
verify_keys_ajax(): void
remove_keys_ajax(): void
get_client_ip(): string
init_integrations(): void

3. Loader Class (includes/class-loader.php)

Static Methods

register(): void
autoload(string $class): void
load_integrations(): void

4. Settings Class (includes/class-settings.php)

Class Properties

Methods

__construct()
get_settings(): array
get_option(string $key, $default = null)
add_default_options(): void
register_settings(): void
sanitize_settings(array $input): array
add_admin_menu(): void
render_dashboard_page(): void
render_integrations_page(): void
render_settings_main_page(): void
render_tools_page(): void
render_faqs_page(): void
register_centralized_fields(): void
organize_fields(array $fields): array
get_fields_structure(): array

5. Verify Class (includes/class-verify.php)

Class Properties

Methods

__construct()
verify_token(string $token, ?string $custom_secret_key = null): bool
get_client_ip(): string
log_error(string $message): void

6. Ajax Handlers Class (includes/class-ajax-handlers.php)

Methods

__construct()
export_settings(): void

7. Common Functions (includes/functions-common.php)

Utility Functions

is_login(): bool
is_registration_page(): bool
is_lost_password_page(): bool
is_comment_form_page(): bool

8. Turnstile Integration Class (integrations/class-turnstile.php)

Class Properties

Methods

__construct()
enqueue_script(): void
render(string $action): void
verify(?string $token = null): bool
render_dynamic(array $args = []): void

9. Core WordPress Integration (integrations/class-core-wp.php)

Class Properties

Methods

__construct()
init_hooks(): void
render_turnstile_field(): void
get_form_context(): string
verify_login($user, string $username, string $password)
verify_registration(\WP_Error $errors, string $sanitized_user_login, string $user_email): \WP_Error
verify_lost_password(\WP_Error $errors): \WP_Error
verify_comment(array $commentdata): array
verify_token(): bool
should_show_turnstile(): bool

10. WooCommerce Integration (integrations/class-woocommerce.php)

Class Properties

Methods

__construct()
register_settings_fields(): void
init_hooks(): void
add_checkout_hooks(string $location): void
render_turnstile(): void
verify_token(): bool
verify_turnstile($validation_error, $username, $password): \WP_Error
verify_turnstile_registration($errors, $username, $email): \WP_Error
verify_turnstile_reset_password($errors, $user_data): \WP_Error
verify_turnstile_checkout(): void
verify_turnstile_pay_order(): void

11. Field Renderer (includes/settings/field-renderer.php)

Functions

render_setting_field($field, $value)
render_setting_fields_grouped($fields, $values)

Settings Field Types

The plugin supports various field types for the settings system:

Field Types

  1. text - Standard text input
  2. password - Password input (masked)
  3. email - Email input with validation
  4. url - URL input with validation
  5. number - Numeric input
  6. checkbox - Boolean checkbox with toggle styling
  7. select - Dropdown selection
  8. textarea - Multi-line text input
  9. content - Static content display

Field Configuration

Each field can have the following properties:


Hooks and Filters

Actions

Filters


Security Features

Token Verification

Data Protection


Error Handling

Debug Mode

Fallback Behavior


Extensibility

Developer Hooks

The plugin provides numerous hooks for customization:

Integration Framework


Database Schema

Options Table

Transients


This documentation covers all major functions and classes in the SmartCT plugin. Each function is documented with its purpose, parameters, return values, and functionality to provide a complete reference for developers and users working with this plugin.