CreaCaptcha

Settings_Command
in package

Reads, writes, exports, imports and resets CreaCaptcha settings.

Table of Contents

Methods

export()  : void
Exports all settings as JSON.
get()  : void
Prints one setting value.
import()  : void
Imports settings from a JSON file.
list_settings()  : void
Lists all settings as key/value pairs.
load_defaults()  : void
Resets configuration values to default but keeps the lists.
reset()  : void
Resets every setting to its default — including emptying all lists.
set()  : void
Sets one setting value.
parse_bool()  : bool
Parses a boolean-ish CLI string.
stringify()  : string
Converts a setting value to a printable string.

Methods

export()

Exports all settings as JSON.

public export(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

[--file=] : Write to this file instead of STDOUT.

EXAMPLES

wp creacaptcha settings export --file=backup.json
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

get()

Prints one setting value.

public get(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

: The setting key.

EXAMPLES

wp creacaptcha settings get difficulty
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

import()

Imports settings from a JSON file.

public import(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

: Path to a settings-export JSON file.

[--yes] : Skip the confirmation prompt.

EXAMPLES

wp creacaptcha settings import backup.json
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

list_settings()

Lists all settings as key/value pairs.

public list_settings(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

[--format=] : Output format (table, json, yaml, csv).

EXAMPLES

wp creacaptcha settings list
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

Tags
subcommand

list

load_defaults()

Resets configuration values to default but keeps the lists.

public load_defaults(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

[--yes] : Skip the confirmation prompt.

EXAMPLES

wp creacaptcha settings load-defaults --yes
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

Tags
subcommand

load-defaults

reset()

Resets every setting to its default — including emptying all lists.

public reset(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

[--yes] : Skip the confirmation prompt.

EXAMPLES

wp creacaptcha settings reset --yes
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

set()

Sets one setting value.

public set(array<int, string> $args, array<string, string> $assoc_args) : void

OPTIONS

: The setting key. : The new value. Checkboxes accept true/false/1/0/yes/no/on/off.

EXAMPLES

wp creacaptcha settings set difficulty high
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

parse_bool()

Parses a boolean-ish CLI string.

private parse_bool(string $value) : bool
Parameters
$value : string

Raw value.

Return values
bool

stringify()

Converts a setting value to a printable string.

private stringify(mixed $value) : string
Parameters
$value : mixed

Raw setting value.

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results