Command
in package
Inspects and controls CreaCaptcha from the command line.
Table of Contents
Methods
- disable() : void
- Disables a CreaCaptcha module.
- enable() : void
- Enables a CreaCaptcha module.
- info() : void
- Shows environment and diagnostic information.
- repair() : void
- Repairs a CreaCaptcha installation: secrets, event-log table, missing default keys, version option.
- stats() : void
- Shows the analytics counters per event type.
- status() : void
- Shows the operational status: kill-switch, enabled modules, list sizes.
- feature_map() : array<string, string>
- Maps CLI feature names to their boolean setting key.
- set_feature() : void
- Toggles a feature's boolean setting.
Methods
disable()
Disables a CreaCaptcha module.
public
disable(array<int, string> $args, array<string, string> $assoc_args) : void
OPTIONS
EXAMPLES
wp creacaptcha disable underattack
Parameters
- $args : array<int, string>
-
Positional arguments.
- $assoc_args : array<string, string>
-
Associative arguments.
enable()
Enables a CreaCaptcha module.
public
enable(array<int, string> $args, array<string, string> $assoc_args) : void
OPTIONS
EXAMPLES
wp creacaptcha enable firewall
Parameters
- $args : array<int, string>
-
Positional arguments.
- $assoc_args : array<string, string>
-
Associative arguments.
info()
Shows environment and diagnostic information.
public
info(array<int, string> $args, array<string, string> $assoc_args) : void
OPTIONS
[--format=
EXAMPLES
wp creacaptcha info
Parameters
- $args : array<int, string>
-
Positional arguments.
- $assoc_args : array<string, string>
-
Associative arguments.
repair()
Repairs a CreaCaptcha installation: secrets, event-log table, missing default keys, version option.
public
repair(array<int, string> $args, array<string, string> $assoc_args) : void
OPTIONS
[--yes] : Skip the confirmation prompt.
EXAMPLES
wp creacaptcha repair
Parameters
- $args : array<int, string>
-
Positional arguments.
- $assoc_args : array<string, string>
-
Associative arguments.
stats()
Shows the analytics counters per event type.
public
stats(array<int, string> $args, array<string, string> $assoc_args) : void
OPTIONS
[--window=
[--format=
EXAMPLES
wp creacaptcha stats --window=7d
Parameters
- $args : array<int, string>
-
Positional arguments.
- $assoc_args : array<string, string>
-
Associative arguments.
status()
Shows the operational status: kill-switch, enabled modules, list sizes.
public
status(array<int, string> $args, array<string, string> $assoc_args) : void
OPTIONS
[--format=
EXAMPLES
wp creacaptcha status
Parameters
- $args : array<int, string>
-
Positional arguments.
- $assoc_args : array<string, string>
-
Associative arguments.
feature_map()
Maps CLI feature names to their boolean setting key.
private
feature_map() : array<string, string>
Return values
array<string, string>set_feature()
Toggles a feature's boolean setting.
private
set_feature(string $feature, bool $on) : void
Parameters
- $feature : string
-
CLI feature name.
- $on : bool
-
Target state.