Documentation

ValidatedSanitizedInputSniff extends Sniff uses SanitizationHelperTrait

Flag any non-validated/sanitized input ( _GET / _POST / etc. ).

Tags
link
https://github.com/WordPress/WordPress-Coding-Standards/issues/69
since
0.3.0
0.4.0

This class now extends the WordPressCS native Sniff class.

0.5.0

Method getArrayIndexKey() has been moved to the WordPressCS native Sniff class.

0.13.0

Class name changed: this class is now namespaced.

1.0.0

This sniff has been moved from the VIP category to the Security category.

uses
SanitizationHelperTrait::$customSanitizingFunctions
SanitizationHelperTrait::$customUnslashingSanitizingFunctions

Table of Contents

Properties

$check_validation_in_scope_only  : bool
Check for validation functions for a variable within its own parenthesis only.
$phpcsFile  : File
The current file being sniffed.
$tokens  : array<string|int, mixed>
The list of tokens in the current file being sniffed.
$slashed_superglobals  : array<string, true>
Superglobals for which the values will be slashed by WP.

Methods

add_unslash_error()  : void
Add an error for missing use of unslashing.
process()  : int|void
Set sniff properties and hand off to child class for processing of the token.
process_token()  : void
Processes this test, when one of its tokens is encountered.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.

Properties

$check_validation_in_scope_only

Check for validation functions for a variable within its own parenthesis only.

public bool $check_validation_in_scope_only = false

$phpcsFile

The current file being sniffed.

protected File $phpcsFile
Tags
since
0.4.0

$tokens

The list of tokens in the current file being sniffed.

protected array<string|int, mixed> $tokens
Tags
since
0.4.0

Methods

add_unslash_error()

Add an error for missing use of unslashing.

public add_unslash_error(File $phpcsFile, int $stackPtr) : void
Parameters
$phpcsFile : File

The file being scanned.

$stackPtr : int

The index of the token in the stack which is missing unslashing.

Tags
since
0.5.0
3.0.0
  • Moved from the Sniff class to this class.
  • The $phpcsFile parameter was added.

process()

Set sniff properties and hand off to child class for processing of the token.

public process(File $phpcsFile, int $stackPtr) : int|void
Parameters
$phpcsFile : File

The file being scanned.

$stackPtr : int

The position of the current token in the stack passed in $tokens.

Tags
since
0.11.0
Return values
int|void

Integer stack pointer to skip forward or void to continue normal file processing.

process_token()

Processes this test, when one of its tokens is encountered.

public process_token(int $stackPtr) : void
Parameters
$stackPtr : int

The position of the current token in the stack.

register()

Returns an array of tokens this test wants to listen for.

public register() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results