Documentation

ValidPostTypeSlugSniff extends AbstractFunctionParameterSniff
in package

WPCS

WordPressCodingStandards

FinalYes

Validates post type names.

Checks the post type slug for invalid characters, long function names and reserved names.

Constants

POST_TYPE_MAX_LENGTH = 20: Max length of a post type name is limited by the SQL field.
VALID_POST_TYPE_CHARACTERS = '/^[a-z0-9_-]+$/': Regex to validate the characters that can be used as the post type slug.

Properties

$exclude : array<string|int, mixed>: Exclude groups.
$unittest_groups : array<string|int, mixed>: Groups of function data to check against.
$excluded_groups : array<string|int, mixed>: Cache for the excluded groups information.
$group_name : string: The group name for this group of functions.
$groups : array<string|int, mixed>: Cache for the group information.
$phpcsFile : File: The current file being sniffed.
$regex_pattern : string: Regex pattern with placeholder for the function names.
$reserved_names : array<string, true>: Array of reserved post type names which can not be used by themes and plugins.
$target_functions : array<string, true>: Array of functions that must be checked.
$tokens : array<string|int, mixed>: The list of tokens in the current file being sniffed.
$valid_tokens : array<int|string, int|string>: All valid tokens for in the first parameter of register_post_type().

Methods

check_for_matches() : int|void: Verify if the current token is one of the targetted functions.
getGroups() : array<string|int, mixed>: Groups of functions to restrict.
is_targetted_token() : bool: Verify is the current token is a function call.
process() : int|void: Set sniff properties and hand off to child class for processing of the token.
process_matched_token() : int|void: Process a matched token.
process_no_parameters() : int|void: Process the function if no parameters were found.
process_parameters() : void: Process the parameter of a matched function.
process_token() : int|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.
prepare_name_for_regex() : string: Prepare the function name for use in a regular expression.
setup_groups() : bool: Set up the regular expressions for each group.

POST_TYPE_MAX_LENGTH

Max length of a post type name is limited by the SQL field.


    public
        int
    POST_TYPE_MAX_LENGTH
    = 20

VALID_POST_TYPE_CHARACTERS

Regex to validate the characters that can be used as the post type slug.


    public
        string
    VALID_POST_TYPE_CHARACTERS
    = '/^[a-z0-9_-]+$/'

$exclude

Exclude groups.


        public
            array<string|int, mixed>
    $exclude
     = array()

Example: 'switch_to_blog,user_meta'

$unittest_groups

Groups of function data to check against.


        public
        static    array<string|int, mixed>
    $unittest_groups
     = array()

Don't use this in extended classes, override getGroups() instead. This is only used for Unit tests.

$excluded_groups

Cache for the excluded groups information.


        protected
            array<string|int, mixed>
    $excluded_groups
     = array()

$group_name

The group name for this group of functions.


        protected
            string
    $group_name
     = 'restricted_parameters'

Intended to be overruled in the child class.

$groups

Cache for the group information.


        protected
            array<string|int, mixed>
    $groups
     = array()

$phpcsFile

The current file being sniffed.


        protected
            File
    $phpcsFile

$regex_pattern

Regex pattern with placeholder for the function names.


        protected
            string
    $regex_pattern
     = '`^(?:%s)$`i'

$reserved_names

Array of reserved post type names which can not be used by themes and plugins.


        protected
            array<string, true>
    $reserved_names
     = array(
    'action' => true,
    // Not a WP post type, but prevents other problems.
    'attachment' => true,
    'author' => true,
    // Not a WP post type, but prevents other problems.
    'custom_css' => true,
    'customize_changeset' => true,
    'nav_menu_item' => true,
    'oembed_cache' => true,
    'order' => true,
    // Not a WP post type, but prevents other problems.
    'page' => true,
    'post' => true,
    'revision' => true,
    'theme' => true,
    // Not a WP post type, but prevents other problems.
    'user_request' => true,
    'wp_block' => true,
    'wp_font_face' => true,
    'wp_font_family' => true,
    'wp_global_styles' => true,
    'wp_navigation' => true,
    'wp_template' => true,
    'wp_template_part' => true,
)

Source:

Key is reserved post type name, value irrelevant.

$target_functions

Array of functions that must be checked.


        protected
            array<string, true>
    $target_functions
     = array('register_post_type' => true)

Key is function name, value irrelevant.

$tokens

The list of tokens in the current file being sniffed.


        protected
            array<string|int, mixed>
    $tokens

$valid_tokens

All valid tokens for in the first parameter of register_post_type().


        private
            array<int|string, int|string>
    $valid_tokens
     = array()

Set in register().

check_for_matches()

Verify if the current token is one of the targetted functions.


    public
                    check_for_matches(int $stackPtr) : int|void

Parameters

$stackPtr : int: The position of the current token in the stack.

Return values

int|void —

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

getGroups()

Groups of functions to restrict.


    public
                    getGroups() : array<string|int, mixed>

Return values

array<string|int, mixed>

is_targetted_token()

Verify is the current token is a function call.


    public
                    is_targetted_token(int $stackPtr) : bool

Parameters

$stackPtr : int: The position of the current token in the stack.

Return values

bool

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.

Return values

int|void —

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

process_matched_token()

Process a matched token.


    public
                    process_matched_token(int $stackPtr, string $group_name, string $matched_content) : int|void

Parameters

$stackPtr : int: The position of the current token in the stack.
$group_name : string: The name of the group which was matched.
$matched_content : string: The token content (function name) which was matched in lowercase.

Return values

int|void —

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

process_no_parameters()

Process the function if no parameters were found.


    public
                    process_no_parameters(int $stackPtr, string $group_name, string $matched_content) : int|void

Defaults to doing nothing. Can be overloaded in child classes to handle functions were parameters are expected, but none found.

Parameters

$stackPtr : int: The position of the current token in the stack.
$group_name : string: The name of the group which was matched.
$matched_content : string: The token content (function name) which was matched in lowercase.

Return values

int|void —

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

process_parameters()

Process the parameter of a matched function.


    public
                    process_parameters(int $stackPtr, string $group_name, string $matched_content, array<string|int, mixed> $parameters) : void

Errors on invalid post type names when reserved keywords are used, the post type is too long, or contains invalid characters.

Parameters

$stackPtr : int: The position of the current token in the stack.
$group_name : string: The name of the group which was matched.
$matched_content : string: The token content (function name) which was matched in lowercase.
$parameters : array<string|int, mixed>: Array with information about the parameters.

process_token()

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


    public
                    process_token(int $stackPtr) : int|void

Parameters

$stackPtr : int: The position of the current token in the stack.

Return values

int|void —

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

register()

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


    public
                    register() : array<string|int, mixed>

Return values

array<string|int, mixed>

prepare_name_for_regex()

Prepare the function name for use in a regular expression.


    protected
                    prepare_name_for_regex(string $function_name) : string

The getGroups() method allows for providing function names with a wildcard * to target a group of functions. This prepare routine takes that into account while still safely escaping the function name for use in a regular expression.

Parameters

$function_name : string: Function name.

Return values

string —

Regex escaped function name.

setup_groups()

Set up the regular expressions for each group.


    protected
                    setup_groups(string $key) : bool

Parameters

$key : string: The group array index key where the input for the regular expression can be found.

Return values

bool —

True if the groups were setup. False if not.

ValidPostTypeSlugSniff extends AbstractFunctionParameterSniff in package WPCS WordPressCodingStandards

Tags

Table of Contents

Constants

Properties

Methods

Constants

POST_TYPE_MAX_LENGTH

Tags

VALID_POST_TYPE_CHARACTERS

Tags

Properties

$exclude

Tags

$unittest_groups

Tags

$excluded_groups

Tags

$group_name

$groups

Tags

$phpcsFile

Tags

$regex_pattern

Tags

$reserved_names

Tags

$target_functions

Tags

$tokens

Tags

$valid_tokens

Tags

Methods

check_for_matches()

Parameters

Tags

Return values

getGroups()

Return values

is_targetted_token()

Parameters

Tags

Return values

process()

Parameters

Tags

Return values

process_matched_token()

Parameters

Return values

process_no_parameters()

Parameters

Return values

process_parameters()

Parameters

Tags

process_token()

Parameters

Return values

register()

Tags

Return values

prepare_name_for_regex()

Parameters

Tags

Return values

setup_groups()

Parameters

Tags

Return values

ValidPostTypeSlugSniff extends AbstractFunctionParameterSniff
in package

WPCS

WordPressCodingStandards