CreaCaptcha

List_Command
in package

Manages one list-type setting — IP block/allow list, UA block list or the interceptor path list. The same class backs the blocklist, allowlist, ua-blocklist and paths command namespaces.

Table of Contents

Properties

$key  : string
The list setting key this instance manages.
$validation  : string
Validation type: 'ip' (IP/CIDR), 'action' (action-slug charset), 'cookie' (name=value), or 'text' (plain).

Methods

__construct()  : mixed
add()  : void
Adds one or more entries to the list.
clear()  : void
Empties the list.
list_entries()  : void
Prints the current list entries.
normalise()  : string|null
Validates and normalises one entry; returns null when invalid.
reject_reason()  : string
A human-readable reason why normalise() refused this value.
remove()  : void
Removes one or more entries from the list.
current()  : array<int, string>
The current list value.
prefix_zero_reject_reason()  : string
Listenabhängige Begründung für die Ablehnung einer Präfixlänge-0-CIDR (`0.0.0.0/0`, `::/0`) — B-M22.
report_collateral_drops()  : void
Warns about entries that were already stored before this command ran and are gone afterwards without having been removed on purpose.
save()  : array<int, string>
Writes the list back through the settings sanitiser and returns the list as it is stored afterwards.

Properties

$validation

Validation type: 'ip' (IP/CIDR), 'action' (action-slug charset), 'cookie' (name=value), or 'text' (plain).

private string $validation

Methods

__construct()

public __construct(string $key[, string $validation = 'text' ]) : mixed
Parameters
$key : string

The list setting key.

$validation : string = 'text'

'ip' (IP/CIDR), 'action' (action slug), 'cookie' (name=value), or 'text' (plain).

add()

Adds one or more entries to the list.

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

Nach dem Schreiben wird die Liste erneut gelesen und mit der Absicht verglichen. Exit-Code 1, wenn mindestens ein Eingabewert abgelehnt wurde (ungültig oder Liste voll) oder wenn ein Eintrag beim Speichern verworfen wurde; Exit-Code 0 nur, wenn jeder angenommene Eintrag danach wirklich in der Liste steht.

OPTIONS

... : One or more entries to add.

EXAMPLES

wp creacaptcha blocklist add 203.0.113.4 203.0.113.0/24
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

clear()

Empties the list.

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

OPTIONS

[--yes] : Skip the confirmation prompt.

EXAMPLES

wp creacaptcha blocklist clear --yes
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

list_entries()

Prints the current list entries.

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

OPTIONS

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

EXAMPLES

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

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

Tags
subcommand

list

normalise()

Validates and normalises one entry; returns null when invalid.

public normalise(string $raw) : string|null

Öffentlich, weil dies die Validierungs-Nahtstelle der CLI ist und der Ebene-2-Test genau sie prüfen muss (CLI-1). Kein Aufrufer außerhalb dieser Klasse und der Tests benutzt sie.

Parameters
$raw : string

Raw entry value.

Return values
string|null

reject_reason()

A human-readable reason why normalise() refused this value.

public reject_reason(string $raw) : string

Die Begründungen benennen jeweils die Regel, an der die Prüfung scheitert — „ist kein gültiger Eintrag" sagte dem Aufrufer nichts. Öffentlich aus demselben Grund wie normalise().

Parameters
$raw : string

Raw entry value.

Return values
string

remove()

Removes one or more entries from the list.

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

Exit-Code 1, wenn ein zu entfernender Eintrag nach dem Schreiben noch in der Liste steht. Ein Eintrag, der gar nicht in der Liste war, ist kein Fehler (unverändertes Verhalten).

OPTIONS

... : One or more entries to remove.

EXAMPLES

wp creacaptcha blocklist remove 203.0.113.4
Parameters
$args : array<int, string>

Positional arguments.

$assoc_args : array<string, string>

Associative arguments.

current()

The current list value.

private current([bool $force_refresh = false ]) : array<int, string>
Parameters
$force_refresh : bool = false

Read the option again instead of using the request-lokalen Settings-Cache.

Return values
array<int, string>

prefix_zero_reject_reason()

Listenabhängige Begründung für die Ablehnung einer Präfixlänge-0-CIDR (`0.0.0.0/0`, `::/0`) — B-M22.

private prefix_zero_reject_reason() : string

creationell_captcha_is_valid_ip_or_cidr() (die Wurzelfunktion, die normalise() für den Typ 'ip' aufruft) lehnt Präfixlänge 0 für jede 'ip'-Liste einheitlich ab; nur der ERKLÄRENDE TEXT muss zur jeweiligen Liste passen, sonst behauptet die Meldung eine Wirkung, die für diese Liste gar nicht zutrifft.

Return values
string

report_collateral_drops()

Warns about entries that were already stored before this command ran and are gone afterwards without having been removed on purpose.

private report_collateral_drops(array<int, string> $before, array<int, string> $stored[, array<int, string> $intended = [] ]) : void

Das passiert, wenn ein Altbestand die heutige Validierung nicht mehr besteht (etwa ein vor Modul 27 gespeichertes 0.0.0.0/0): der Sanitizer verwirft ihn beim nächsten Schreibvorgang. Der Schreibvorgang selbst ist erfolgreich — deshalb Warnung, kein Fehler.

Parameters
$before : array<int, string>

Stand vor dem Schreiben.

$stored : array<int, string>

Stand nach dem Schreiben.

$intended : array<int, string> = []

Absichtlich entfernte Einträge.

save()

Writes the list back through the settings sanitiser and returns the list as it is stored afterwards.

private save(array<int, string> $list) : array<int, string>

Der Rückgabewert ist der frisch gelesene Stand, nicht die Eingabe: nur so kann der Aufrufer melden, was wirklich passiert ist (CLI-2). Der Kontext wird ausdrücklich mitgegeben, damit ein späterer Wechsel des Default-Werts von creationell_captcha_sanitize_settings() die CLI nicht still auf die Formular-Semantik (requires-Rückschreibung) umstellt.

Parameters
$list : array<int, string>

The new list.

Return values
array<int, string> —

Der nach dem Schreiben gespeicherte Stand.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results