WooCommerce Code Reference

Utils
in package

Table of Contents

assertValidName()  : void
Upholds the spec rules about naming.
assign()  : object
charCodeAt()  : int
Returns UTF-8 char code at given $positing of the $string.
chr()  : string
UTF-8 compatible chr().
extractKey()  : mixed
Try to extract the value for a key from an object like value.
isValidNameError()  : Error|null
Returns an Error if a name is invalid.
ord()  : int
UTF-8 compatible ord().
orList()  : string
printCharCode()  : string
printSafe()  : string
Print a value that came from PHP for debugging purposes.
printSafeJson()  : string
Print a value that came from JSON for debugging purposes.
quotedOrList()  : string
splitLines()  : array<int, string>
Split a string that has either Unix, Windows or Mac style newlines into lines.
suggestionList()  : array<int, string>
Given an invalid input string and a list of valid options, returns a filtered list of valid options sorted based on their similarity with the input.
undefined()  : stdClass
jsonEncodeOrSerialize()  : string
printSafeInternal()  : string

Methods

assertValidName()

Upholds the spec rules about naming.

public static assertValidName(string $name) : void
Parameters
$name : string
Tags
throws
Error
Return values
void —

assign()

public static assign(object $obj, array<string, mixed> $vars) : object
Parameters
$obj : object
$vars : array<string, mixed>
Return values
object —

charCodeAt()

Returns UTF-8 char code at given $positing of the $string.

public static charCodeAt(string $string, int $position) : int
Parameters
$string : string
$position : int
Return values
int —

chr()

UTF-8 compatible chr().

public static chr(int $ord[, string $encoding = 'UTF-8' ]) : string
Parameters
$ord : int
$encoding : string = 'UTF-8'
Return values
string —

extractKey()

Try to extract the value for a key from an object like value.

public static extractKey(mixed $objectLikeValue, string $key) : mixed
Parameters
$objectLikeValue : mixed
$key : string
Return values
mixed —

ord()

UTF-8 compatible ord().

public static ord(string $char[, string $encoding = 'UTF-8' ]) : int
Parameters
$char : string
$encoding : string = 'UTF-8'
Return values
int —

orList()

public static orList(array<string|int, string> $items) : string
Parameters
$items : array<string|int, string>
Return values
string —

printCharCode()

public static printCharCode(int|null $code) : string
Parameters
$code : int|null
Tags
throws
JsonException
Return values
string —

printSafe()

Print a value that came from PHP for debugging purposes.

public static printSafe(mixed $value) : string
Parameters
$value : mixed
Return values
string —

printSafeJson()

Print a value that came from JSON for debugging purposes.

public static printSafeJson(mixed $value) : string
Parameters
$value : mixed
Return values
string —

quotedOrList()

public static quotedOrList(array<string|int, string> $items) : string
Parameters
$items : array<string|int, string>
Return values
string —

splitLines()

Split a string that has either Unix, Windows or Mac style newlines into lines.

public static splitLines(string $value) : array<int, string>
Parameters
$value : string
Return values
array<int, string> —

suggestionList()

Given an invalid input string and a list of valid options, returns a filtered list of valid options sorted based on their similarity with the input.

public static suggestionList(string $input, array<string|int, string> $options) : array<int, string>
Parameters
$input : string
$options : array<string|int, string>
Return values
array<int, string> —

jsonEncodeOrSerialize()

protected static jsonEncodeOrSerialize(stdClass|array<string|int, mixed> $value) : string
Parameters
$value : stdClass|array<string|int, mixed>
Return values
string —