Unofficial SMF API Documentation

./Sources/QueryString.php

• cleanRequest
• isValidIPv6
• expandIPv6
• matchIPtoCIDR
• escapestring__recursive
• htmlspecialchars__recursive
• urldecode__recursive
• unescapestring__recursive
• stripslashes__recursive
• htmltrim__recursive
• ob_sessrewrite

cleanRequest

function cleanRequest(): void

Clean the request variables - add html entities to GET and slashes if magic_quotes_gpc is Off.

What it does:

• cleans the request variables (ENV, GET, POST, COOKIE, SERVER) and
• makes sure the query string was parsed correctly.
• handles the URLs passed by the queryless URLs option.
• makes sure, regardless of php.ini, everything has slashes.
• sets up $board, $topic, and $scripturl and $_REQUEST[‘start’].
• determines, or rather tries to determine, the client’s IP.

isValidIPv6

function isValidIPv6(string $ip): bool

Validates a IPv6 address. returns true if it is ipv6.

expandIPv6

function expandIPv6(string $addr, bool $strict_check = true): string|bool

Expands a IPv6 address to its full form.

matchIPtoCIDR

function matchIPtoCIDR(string $ip_address, string $cidr_address): bool

Detect if a IP is in a CIDR address

• returns true or false

escapestring__recursive

function escapestring__recursive(array|string $var): array|string

Adds slashes to the array/variable.

What it does:

• returns the var, as an array or string, with escapes as required.
• importantly escapes all keys and values!
• calls itself recursively if necessary.

htmlspecialchars__recursive

function htmlspecialchars__recursive(array|string $var, int $level = 0): array|string

Adds html entities to the array/variable. Uses two underscores to guard against overloading.

What it does:

• adds entities (", <, >) to the array or string var.
• importantly, does not effect keys, only values.
• calls itself recursively if necessary.

urldecode__recursive

function urldecode__recursive(array|string $var, int $level = 0): array|string

Removes url stuff from the array/variable. Uses two underscores to guard against overloading.

What it does:

• takes off url encoding (%20, etc.) from the array or string var.
• importantly, does it to keys too!
• calls itself recursively if there are any sub arrays.

unescapestring__recursive

function unescapestring__recursive(array|string $var): array|string

Unescapes any array or variable. Uses two underscores to guard against overloading.

What it does:

• unescapes, recursively, from the array or string var.
• effects both keys and values of arrays.
• calls itself recursively to handle arrays of arrays.

stripslashes__recursive

function stripslashes__recursive(array|string $var, int $level = 0): array|string

Remove slashes recursively. Uses two underscores to guard against overloading.

What it does:

• removes slashes, recursively, from the array or string var.
• effects both keys and values of arrays.
• calls itself recursively to handle arrays of arrays.

htmltrim__recursive

function htmltrim__recursive(array|string $var, int $level = 0): array|string

Trim a string including the HTML space, character 160. Uses two underscores to guard against overloading.

What it does:

• trims a string or an the var array using html characters as well.
• does not effect keys, only values.
• may call itself recursively if needed.

ob_sessrewrite

function ob_sessrewrite(string $buffer): string

Rewrite URLs to include the session ID.

What it does:

• rewrites the URLs outputted to have the session ID, if the user is not accepting cookies and is using a standard web browser.
• handles rewriting URLs for the queryless URLs option.
• can be turned off entirely by setting $scripturl to an empty string, ‘’. (it wouldn’t work well like that anyway.)
• because of bugs in certain builds of PHP, does not function in versions lower than 4.3.0 - please upgrade if this hurts you.

Suggest an edit to this page on GitHub