The Pepperminty Wiki core
| ids | Provides an interface to interact with page ids. |
| page_renderer | Renders the HTML page that is sent to the client. |
url_origin(array $s = false, boolean $use_forwarded_host = false) : string
Get the actual absolute origin of the request sent by the user.
| array | $s | The $_SERVER variable contents. Defaults to $_SERVER. |
| boolean | $use_forwarded_host | Whether to utilise the X-Forwarded-Host header when calculating the actual origin. |
The actual origin of the user's request.
full_url(array $s = false, boolean $use_forwarded_host = false) : string
Get the full url, as requested by the client.
| array | $s | The $_SERVER variable. Defaults to $_SERVER. |
| boolean | $use_forwarded_host | Whether to take the X-Forwarded-Host header into account. |
The full url, as requested by the client.
glob_recursive(string $pattern, integer $flags) : array
A recursive glob() function.
| string | $pattern | The glob pattern to use to find filenames. |
| integer | $flags | The glob flags to use when finding filenames. |
An array of the filepaths that match the given glob.
get_subpages(object $pageindex, string $pagename) : object
Gets a list of all the sub pages of the current page.
| object | $pageindex | The pageindex to use to search. |
| string | $pagename | The name of the page to list the sub pages of. |
An object containing all the subpages and their respective distances from the given page name in the pageindex tree.
makepathsafe(string $string) : string
Makes a path (or page name) safe.
A safe path / page name may not contain: Forward-slashes at the beginning Multiple dots in a row Odd characters (e.g. ?%*:|"<>() etc.) A safe path may, however, contain unicode characters such as éôà etc.
| string | $string | The string to make safe. |
A safe version of the given string.
starts_with(string $haystack, string $needle) : boolean
Checks to see if $haystack starts with $needle.
| string | $haystack | The string to search. |
| string | $needle | The string to search for at the beginning of $haystack. |
Whether $needle can be found at the beginning of $haystack.
mb_stripos_all(string $haystack, string $needle) : array|false
Case-insensitively finds all occurrences of $needle in $haystack. Handles UTF-8 characters correctly.
| string | $haystack | The string to search. |
| string | $needle | The string to find. |
An array of match indices, or false if nothing was found.
str_replace_once(string $find, string $replace, string $subject) : string
Replaces the first occurrence of $find with $replace.
| string | $find | The string to search for. |
| string | $replace | The string to replace the search string with. |
| string | $subject | The string ot perform the search and replace on. |
The source string after the find and replace has been performed.
stack_trace(boolean $log_trace = true, boolean $full = false) : string
Generates a stack trace.
| boolean | $log_trace | Whether to send the stack trace to the error log. |
| boolean | $full | Whether to output a full description of all the variables involved. |
A string prepresentation of a stack trace.
get_user_pagename(string $username) : string
Figures out the path to the user page for a given username.
Does not check to make sure the user acutally exists.
| string | $username | The username to get the path to their user page for. |
The path to the given user's page.
email_user(string $username, string $subject, string $body) : boolean
Sends a plain text email to a user, replacing {username} with the specified username.
| string | $username | The username to send the email to. |
| string | $subject | The subject of the email. |
| string | $body | The body of the email. |
Whether the email was sent successfully or not. Currently, this may fail if the user doesn't have a registered email address.
email_users(array<mixed,string> $usernames, string $subject, string $body) : integer
Sends a plain text email to a list of users, replacing {username} with each user's name.
| array<mixed,string> | $usernames | A list of usernames to email. |
| string | $subject | The subject of the email. |
| string | $body | The body of the email. |
The number of emails sent successfully.
register_remote_file(array $remote_file_def)
Registers a request for a remote file to be downloaded before execution. Will block until all files are downloaded.
Example definition: [ "local_filename" => "file.ext", "remote_url": "https://example.com" ]
| array | $remote_file_def | The remote file definition to register. |
Exception Throws an exception if a definition for the requested local file already exists.
has_action(string $action_name) : boolean
Figures out whether a given action is currently registered.
Only guaranteed to be accurate in inside an existing action function
| string | $action_name | The name of the action to search for |
Whether an action with the specified name exists.
parse_page_source(string $source) : string
Parses the specified page source using the parser specified in the settings into HTML.
The specified parser may (though it's unilkely) render it to other things.
| string | $source | The source to render. |
The source rendered to HTML.