CACHE_PATH
CACHE_PATH
_deprecated_argument(string $function_name, string $release, string $message = null)
Mark a function argument as deprecated and inform when it has been used.
This function is to be used whenever a deprecated function argument is used. Before this function is called, the argument must be checked for whether it was used by comparing it to its default value or evaluating whether it is empty.
There is a hook deprecated_argument_run that will be called that can be used
to get the backtrace up to what file and function used the deprecated
argument.
Default behavior is to trigger a user error if APP_ENV is set to DEV.
Example Usage:
if ( ! empty( $deprecated ) ) {
_deprecated_argument( __FUNCTION__, '0.9' );
}| string | $function_name | The function that was called. |
| string | $release | The release of TriTan CMS that deprecated the argument used. |
| string | $message | Optional. A message regarding the change. Default null. |
_deprecated_class(string $class_name, string $release, string $replacement = null)
Mark a class as deprecated and inform when it has been used.
There is a hook deprecated_class_run that will be called that can be used to get the backtrace up to what file, function/class called the deprecated class.
Default behavior is to trigger a user error if APP_ENV is set to DEV.
This function is to be used in every class that is deprecated.
| string | $class_name | The class that was called. |
| string | $release | The release of TriTan CMS that deprecated the class. |
| string | $replacement | Optional. The class that should have been called. Default null. |
_deprecated_class_method(string $method_name, string $release, string $replacement = null)
Mark a class's method as deprecated and inform when it has been used.
There is a hook deprecated_class_method_run that will be called that can be used to get the backtrace up to what file, function/class called the deprecated method.
Default behavior is to trigger a user error if APP_ENV is set to DEV.
This function is to be used in every class's method that is deprecated.
| string | $method_name | The class method that was called. |
| string | $release | The release of TriTan CMS that deprecated the class's method. |
| string | $replacement | Optional. The class method that should have been called. Default null. |
_deprecated_function(string $function_name, string $release, string $replacement = null)
Mark a function as deprecated and inform when it has been used.
There is a hook deprecated_function_run that will be called that can be used to get the backtrace up to what file and function called the deprecated function.
Default behavior is to trigger a user error if APP_ENV is set to DEV.
This function is to be used in every function that is deprecated.
| string | $function_name | The function that was called. |
| string | $release | The release of TriTan CMS that deprecated the function. |
| string | $replacement | Optional. The function that should have been called. Default null. |
_deprecated_hook(string $hook, string $release, string $replacement = null, string $message = null)
Marks a deprecated action or filter hook as deprecated and throws a notice.
Default behavior is to trigger a user error if APP_ENV is set to DEV.
| string | $hook | The hook that was used. |
| string | $release | The release of TriTan CMS that deprecated the hook. |
| string | $replacement | Optional. The hook that should have been used. |
| string | $message | Optional. A message regarding the change. |
_file_get_contents(string $filename, boolean $use_include_path = false, boolean $context = true)
Custom function to use curl, fopen, or use file_get_contents if curl is not available.
Uses trigger_include_path_search, resource_context and stream_context_create_options
filters.
| string | $filename | Resource to read. |
| boolean | $use_include_path | Whether or not to use include path. |
| boolean | $context | Whether or not to use a context resource. |
_incorrectly_called(string $function_name, string $message, string $release)
Mark something as being incorrectly called.
There is a hook incorrectly_called_run that will be called that can be used to get the backtrace up to what file and function called the deprecated function.
Default behavior is to trigger a user error if APP_ENV is set to DEV.
| string | $function_name | The function that was called. |
| string | $message | A message explaining what has been done incorrectly. |
| string | $release | The release of TriTan CMS where the message was added. |
_trigger_error(string $message, string $level = E_USER_NOTICE)
Wrapper function for the core PHP function: trigger_error.
This function makes the error a little more understandable for the end user to track down the issue.
| string | $message | Custom message to print. |
| string | $level | Predefined PHP error constant. |
add_admin_submenu(string $location, string $menu_title, string $menu_route, string $screen, string $permission = null) : false|string
Add an admin submenu page link.
Uses adminsubmenu$location_{$menu_route} filter hook.
| string | $location | Submenu location. |
| string | $menu_title | The text to be used for the menu. |
| string | $menu_route | The route part of the url. |
| string | $screen | Unique name of menu's screen. |
| string | $permission | The permission required for this menu to be displayed to the user. |
Return the new menu or false if permission is not met.
add_dashboard_submenu(string $menu_title, string $menu_route, string $screen, string $permission = null) : false|string
Adds an admin dashboard submenu page link.
| string | $menu_title | The text to be used for the menu. |
| string | $menu_route | The route part of the url. |
| string | $screen | Unique name of menu's screen. |
| string | $permission | The permission required for this menu to be displayed to the user. |
Return the new menu or false if permission is not met.
add_options_submenu(string $menu_title, string $menu_route, string $screen, string $permission = null) : false|string
Adds an options submenu page link.
| string | $menu_title | The text to be used for the menu. |
| string | $menu_route | The route part of the url. |
| string | $screen | Unique name of menu's screen. |
| string | $permission | The permission required for this menu to be displayed to the user. |
Return the new menu or false if permission is not met.
add_plugins_submenu(string $menu_title, string $menu_route, string $screen, string $permission = null) : false|string
Adds a plugin submenu page link.
| string | $menu_title | The text to be used for the menu. |
| string | $menu_route | The route part of the url. |
| string | $screen | Unique name of menu's screen. |
| string | $permission | The permission required for this menu to be displayed to the user. |
Return the new menu or false if permission is not met.
add_post_meta(integer $post_id, string $meta_key, mixed $meta_value, boolean $unique = false) : integer|false
Add meta data field to a post.
| integer | $post_id | Post ID. |
| string | $meta_key | Metadata name. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| boolean | $unique | Optional. Whether the same key should not be added. Default false. |
Meta ID on success, false on failure.
add_query_arg(string $key, string $value, string $url) : string
Retrieves a modified URL query string.
Uses query_arg_port filter hook.
| string | $key | A query variable key. |
| string | $value | A query variable value, or a URL to act upon. |
| string | $url | A URL to act upon. |
Returns modified url query string.
add_sites_submenu(string $menu_title, string $menu_route, string $screen, string $permission = null) : false|string
Adds a sites submenu page link.
| string | $menu_title | The text to be used for the menu. |
| string | $menu_route | The route part of the url. |
| string | $screen | Unique name of menu's screen. |
| string | $permission | The permission required for this menu to be displayed to the user. |
Return the new menu or false if permission is not met.
add_trailing_slash(string $string) : string
Appends a trailing slash.
Will remove trailing forward and backslashes if it exists already before adding a trailing forward slash. This prevents double slashing a string or path.
The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support.
| string | $string | What to add the trailing slash to. |
String with trailing slash added.
add_user_meta(integer $user_id, string $meta_key, mixed $meta_value, boolean $unique = false) : integer|false
Adds meta data to a user.
| integer | $user_id | User ID. |
| string | $meta_key | Metadata name. |
| mixed | $meta_value | Metadata value. |
| boolean | $unique | Optional. Whether the same key should not be added. Default false. |
Meta ID on success, false on failure.
add_users_submenu(string $menu_title, string $menu_route, string $screen, string $permission = null) : false|string
Adds a users submenu page link.
| string | $menu_title | The text to be used for the menu. |
| string | $menu_route | The route part of the url. |
| string | $screen | Unique name of menu's screen. |
| string | $permission | The permission required for this menu to be displayed to the user. |
Return the new menu or false if permission is not met.
admin_url(string $path = '', string $scheme = 'admin') : string
Returns the url to the admin area for a given site.
| string | $path | Optional. Path relative to the admin url. Default empty. |
| string | $scheme | Optional. The scheme to use. Accepts 'http' or 'https', to force those schemes. Default 'admin'. |
Admin url link with optional path appended.
checked(mixed $checked, mixed $current = true, boolean $echo = true) : string
Outputs the html checked attribute.
Compares the first two arguments and if identical marks as checked
| mixed | $checked | One of the values to compare |
| mixed | $current | (true) The other value to compare if not just true |
| boolean | $echo | Whether to echo or just return the string |
html attribute or empty string
checked_selected_helper(\any $helper, \any $current, boolean $echo, string $type) : string
Private helper function for checked, selected, and disabled.
Compares the first two arguments and if identical marks as $type
| \any | $helper | One of the values to compare |
| \any | $current | (true) The other value to compare if not just true |
| boolean | $echo | Whether to echo or just return the string |
| string | $type | The type of checked|selected|disabled we are doing |
html attribute or empty string
compare_releases(string $current, string $latest, string $operator = '>') : boolean
Compares release values.
| string | $current | Current release value. |
| string | $latest | Latest release value. |
| string | $operator | Operand use to compare current and latest release values. |
create_site_directories(integer $site_id, object $site, boolean $update) : boolean
Create the needed directories when a new site is created.
| integer | $site_id | Site ID. |
| object | $site | Site object. |
| boolean | $update | Whether the site is being created or updated. |
Returns true on success and false otherwise.
delete_post_meta(integer $post_id, string $meta_key, mixed $meta_value = '') : boolean
Remove metadata matching criteria from a post.
You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.
| integer | $post_id | Post ID. |
| string | $meta_key | Metadata name. |
| mixed | $meta_value | Optional. Metadata value. Must be serializable if non-scalar. Default empty. |
True on success, false on failure.
delete_user_meta(integer $user_id, string $meta_key, mixed $meta_value = '') : boolean
Remove metadata matching criteria from a user.
You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.
| integer | $user_id | User ID |
| string | $meta_key | Metadata name. |
| mixed | $meta_value | Optional. Metadata value. |
True on success, false on failure.
delete_user_option(integer $user_id, string $option_name, boolean $global = false) : boolean
Delete user option with global site capability.
User options are just like user metadata except that they have support for global site options. If the 'global' parameter is false, which it is by default it will prepend the TriTan CMS table prefix to the option name.
| integer | $user_id | User ID |
| string | $option_name | User option name. |
| boolean | $global | Optional. Whether option name is global or site specific. Default false (site specific). |
True on success, false on failure.
disabled(mixed $disabled, mixed $current = true, boolean $echo = true) : string
Outputs the html disabled attribute.
Compares the first two arguments and if identical marks as disabled
| mixed | $disabled | One of the values to compare |
| mixed | $current | (true) The other value to compare if not just true |
| boolean | $echo | Whether to echo or just return the string |
html attribute or empty string
do_parsecode(string $content) : string
Search content for parsecodes and filter parsecodes through their hooks.
If there are no parsecode tags defined, then the content will be returned without any filtering. This might cause issues when plugins are disabled but the parsecode will still show up in the post or content.
| string | $content | Content to search for parsecodes |
Content with parsecodes filtered out.
esc_attr__(string $string, \type $domain = 'tritan-cms') : string
Retrieve the translation of a string and escapes it for safe use in an attribute.
| string | $string | String to translate. |
| \type | $domain | Optional. Unique identifier for retrieving translated string. Default: 'tritan-cms'. |
Translated string.
esc_html__(string $string, \type $domain = 'tritan-cms') : string
Retrieve the translation of a string and escapes it for safe use in HTML blocks.
| string | $string | String to translate. |
| \type | $domain | Optional. Unique identifier for retrieving translated string. Default: 'tritan-cms'. |
Translated string.
esc_js(string $string) : string
Escaping for inline javascript.
Example usage:
$esc_js = json_encode("Joshua's \"code\"");
$attribute = esc_js("alert($esc_js);");
echo '<input type="button" value="push" onclick="'.$attribute.'" />';| string | $string |
Escaped inline javascript.
esc_url(string $url, array $scheme = array('http', 'https'), boolean $encode = false) : string
Escaping for url.
| string | $url | The url to be escaped. |
| array | $scheme | Optional. An array of acceptable schemes. |
| boolean | $encode | Whether url params should be encoded. |
The escaped $url after the esc_url filter is applied.
get_all_posts(string $post_type = null, integer $limit, null|integer $offset = null, $status = 'all') : array
Retrieve all published posts or all published posts by post type.
| string | $post_type | Post type. |
| integer | $limit | Number of posts to show. |
| null|integer | $offset | The offset of the first row to be returned. |
| $status |
get_parsecode_regex() : string
Retrieve the parsecode regular expression for searching.
The regular expression combines the parsecode tags in the regular expression in a regex class.
The regular expression contains 6 different sub matches to help with parsing.
1 - An extra [ to allow for escaping parsecodes with double [[]] 2 - The parsecode name 3 - The parsecode argument list 4 - The self closing / 5 - The content of a parsecode when it wraps some content. 6 - An extra ] to allow for escaping parsecodes with double [[]]
The parsecode search regular expression
get_permalink(integer|\TriTan\Common\Post\Post $post) : string
A function which retrieves a TriTan CMS post's permalink.
Purpose of this function is for the {$posttype}_link
filter.
| integer|\TriTan\Common\Post\Post | $post | Post id or Post. |
get_plugin_data(string $plugin_file, boolean $markup = true, boolean $translate = true) : array
Parses the plugin contents to retrieve plugin's metadata.
The metadata of the plugin's data searches for the following in the plugin's header. All plugin data must be on its own line. For plugin description, it must not have any newlines or only parts of the description will be displayed and the same goes for the plugin data. The below is formatted for printing.
/* Plugin Name: Name of Plugin Plugin URI: Link to plugin information Description: Plugin Description Author: Plugin author's name Author URI: Link to the author's web site Version: Plugin version value. Text Domain: Optional. Unique identifier, should be same as the one used in load_plugin_textdomain()
The first 8kB of the file will be pulled in and if the plugin data is not within that first 8kB, then the plugin author should correct their plugin and move the plugin data headers to the top.
The plugin file is assumed to have permissions to allow for scripts to read the file. This is not checked however and the file is only opened for reading.
| string | $plugin_file | Path to the plugin file |
| boolean | $markup | Optional. If the returned data should have HTML markup applied. Default true. |
| boolean | $translate | Optional. If the returned data should be translated. Default true. |
{ Plugin data. Values will be empty if not supplied by the plugin.
@type string $Name Name of the plugin. Should be unique.
@type string $Title Title of the plugin and link to the plugin's site (if set).
@type string $Description Plugin description.
@type string $Author Author's name.
@type string $AuthorURI Author's website address (if set).
@type string $Version Plugin version.
@type string $TextDomain Plugin textdomain.
@type string $DomainPath Plugins relative directory path to .mo files.
@type bool $Network Whether the plugin can only be activated network-wide.
}get_post(integer|\TriTan\Common\Post\Post|null $post, boolean $object = true) : array|object
Retrieves post data given a post ID or post array.
| integer|\TriTan\Common\Post\Post|null | $post | Post ID or post object. |
| boolean | $object | If set to true, data will return as an object, else as an array. Default: true. |
get_post_author(integer $post_id, boolean $reverse = false) : string
A function which retrieves a TriTan CMS post author.
Purpose of this function is for the post_author
filter.
| integer | $post_id | The unique id of a post. |
| boolean | $reverse | If first name should appear first or not. Default is false. |
get_post_created_time(\string $format = 'U', \bool $gmt = false, $post = null, \bool $translate = false) : string
A function which retrieves TriTan CMS post created time.
Purpose of this function is for the post_created_time
filter.
| \string | $format | |
| \bool | $gmt | |
| $post | ||
| \bool | $translate |
get_post_custom(integer $post_id) : array
Retrieve post meta fields, based on post ID.
The post meta fields are retrieved from the cache where possible, so the function is optimized to be called more than once.
| integer | $post_id | The post's id. |
Post meta for the given post.
get_post_custom_values(string $key = '', integer $post_id) : array|null
Retrieve values for a custom post field.
The parameters must not be considered optional. All of the post meta fields will be retrieved and only the meta field key values returned.
| string | $key | Optional. Meta field key. Default empty. |
| integer | $post_id | The post's id. |
Meta field values.
get_post_date(integer $post_id, string $type = 'published') : string
A function which retrieves TriTan CMS post date.
Uses call_user_func_array() function to return appropriate post date function.
Dynamic part is the variable $type, which calls the date function you need.
| integer | $post_id | The unique id of a post. |
| string | $type | Type of date to return: created, published, modified. Default: published. |
get_post_meta(integer $post_id, string $key = '', boolean $single = false) : mixed
Retrieve post meta field for a post.
| integer | $post_id | Post ID. |
| string | $key | Optional. The meta key to retrieve. By default, returns data for all keys. Default empty. |
| boolean | $single | Optional. Whether to return a single value. Default false. |
Will be an array if $single is false. Will be value of meta data field if $single is true.
get_post_time(integer $post_id, string $type = 'published') : string
A function which retrieves TriTan CMS post time.
Uses call_user_func_array() function to return appropriate post time function.
Dynamic part is the variable $type, which calls the date function you need.
| integer | $post_id | The unique id of a post. |
| string | $type | Type of date to return: created, published, modified. Default: published. |
get_posttype(integer|\TriTan\Common\Posttype\Posttype $posttype, boolean $object = true) : array|object
Retrieves post type data given a post type ID or post type array.
| integer|\TriTan\Common\Posttype\Posttype | $posttype | Posttype ID or postttype object. |
| boolean | $object | If set to true, data will return as an object, else as an array. Default: true. |
get_relative_url(integer|\TriTan\Common\Post\Post $post) : string
A function which retrieves a TriTan CMS post's relative url.
Purpose of this function is for the {$posttype}_relative_url
filter.
| integer|\TriTan\Common\Post\Post | $post | Post id or Post. |
get_site(integer|\TriTan\Common\Site\Site|null $site, boolean $object = true) : array|object
Retrieves site data given a site ID or post array.
| integer|\TriTan\Common\Site\Site|null | $site | Site ID or object. |
| boolean | $object | If set to true, data will return as an object, else as an array. Default: true. |
get_site_details(integer|string|array $fields = null, boolean $get_all = true) : boolean|\TriTan\Error|\TriTan\Site
Retrieve the details of a site from the site document and site options.
| integer|string|array | $fields | A site's id or an array of site data. |
| boolean | $get_all | Whether to retrieve all data or only data from site document. |
Site details on success or false.
get_user_avatar(string $email, integer $s = 80, string $class = '') : string
Retrieve the avatar `<img>` tag for user.
| string | User's email address. |
|
| integer | $s | Height and width of the avatar image file in pixels. Default 80. |
| string | $class | Class to add to |
<img> tag for user's avatar or default otherwise.
get_user_meta(integer $user_id, string $key = '', boolean $single = false) : mixed
Retrieve user meta field for a user.
| integer | $user_id | User ID. |
| string | $key | Optional. The meta key to retrieve. By default, returns data for all keys. |
| boolean | $single | Whether to return a single value. |
Will be an array if $single is false. Will be value of meta data field if $single is true.
get_user_option(string $option, integer $user) : mixed
Retrieve user option that can be either per Site or global.
If the user ID is not given, then the current user will be used instead. If the user ID is given, then the user data will be retrieved. The filter for the result, will also pass the original option name and finally the user data object as the third parameter.
The option will first check for the per site name and then the global name.
Uses get_user_option_$option filter.
| string | $option | User option name. |
| integer | $user | Optional. User ID. |
User option value on success, false on failure.
hash_equals(string $known_string, string $user_string) : boolean
Timing attack safe string comparison
Compares two strings using the same time whether they're equal or not. This function should be used to mitigate timing attacks; for instance, when testing crypt() password hashes.
| string | $known_string | The string of known length to compare against |
| string | $user_string | The user-supplied string |
Returns TRUE when the two strings are equal, FALSE otherwise.
home_url(string $path = '', string|null $scheme = null) : string
Returns the url for a given site where the front end is accessible.
The protocol will be 'https' if is_ssl() evaluates to true; If $scheme is
'http' or 'https', is_ssl() is overridden.
| string | $path | Optional. Path relative to the home url. Default empty. |
| string|null | $scheme | Optional. Scheme to give the home URL context. Accepts 'http', 'https', 'relative', or null. Default null. |
Home url link with optional path appended.
html_purify(string $string, boolean $is_image = false) : string
Makes content safe to print on screen.
This function should only be used on output. With the exception of uploading images, never use this function on input. All inputted data should be accepted and then purified on output for optimal results. For output of images, make sure to escape with esc_url().
| string | $string | Text to purify. |
| boolean | $is_image |
is_ttcms_error(mixed $object) : boolean
Check whether variable is an TriTan CMS Error.
Returns true if $object is an object of the \TriTan\Error class.
| mixed | $object | Check if unknown variable is an |
True, if \TriTan\Error. False, if not \TriTan\Error.
is_ttcms_exception(mixed $object) : boolean
Check whether variable is an TriTan CMS Exception.
Returns true if $object is an object of the \TriTan\Exception\BaseException class.
| mixed | $object | Check if unknown variable is an |
True, if \TriTan\Exception\BaseException. False, if not \TriTan\Exception\BaseException.
load_default_textdomain(string $domain, string $path) : boolean
Load default translated strings based on locale.
| string | $domain | Text domain. Unique identifier for retrieving translated strings. |
| string | $path | Path to the .mo file. |
True on success, false on failure.
load_plugin_textdomain(string $domain, string $plugin_rel_path = false) : boolean
Load a plugin's translated strings.
If the path is not given then it will be the root of the plugin directory.
| string | $domain | Unique identifier for retrieving translated strings |
| string | $plugin_rel_path | Optional. Relative path to TTCMS_PLUGIN_DIR where the locale directory resides. Default false. |
True when textdomain is successfully loaded, false otherwise.
login_url(string $redirect = '', string $path = '', string|null $scheme = 'login') : string
Returns the login url for a given site.
| string | $redirect | Path to redirect to on log in. |
| string | $path | Optional. Path relative to the login url. Default empty. |
| string|null | $scheme | Optional. Scheme to give the home URL context. Accepts 'http', 'https', 'relative', or null. Default 'login'. |
Returns the login url.
new_site_data(integer $site_id, object $site, boolean $update) : integer|boolean
Populates site options and user meta for site admin after new site is created.
| integer | $site_id | Site id of the newly created site. |
| object | $site | Site object of newly created site. |
| boolean | $update | Whether the site is being created or updated. |
Returns the site id if successful and false otherwise.
parsecode_atts(array $pairs, array $atts) : array
Combine user attributes with known attributes and fill in defaults when needed.
The pairs should be considered to be all of the attributes which are supported by the caller and given as a list. The returned attributes will only contain the attributes in the $pairs list.
If the $atts list has unsupported attributes, then they will be ignored and removed from the final returned list.
| array | $pairs | Entire list of supported attributes and their defaults. |
| array | $atts | User defined attributes in parsecode tag. |
Combined and filtered attribute list.
parsecode_parse_atts(string $text) : array
Retrieve all attributes from the parsecodes tag.
The attributes list has the attribute name as the key and the value of the attribute as the value in the key/value pair. This allows for easier retrieval of the attributes, since all attributes have to be known.
| string | $text |
List of attributes and their value.
php_like(string $pattern, string $subject) : boolean
SQL Like operator in PHP.
Returns true if match else false.
Example Usage:
php_like('%uc%','Lucy'); //true
php_like('%cy', 'Lucy'); //true
php_like('lu%', 'Lucy'); //true
php_like('%lu', 'Lucy'); //false
php_like('cy%', 'Lucy'); //false| string | $pattern | |
| string | $subject |
plugin_dir_path(string $filename) : string
Wrapper function for PluginFile::path() method.
Get the filesystem directory path (with trailing slash) for the plugin FILE passed in.
| string | $filename | The filename of the plugin (FILE). |
The filesystem path of the directory that contains the plugin.
plugins_url(string $path = '', string $plugin = '') : string
Retrieves a URL within the plugins or mu-plugins directory.
Defaults to the plugins directory URL if no arguments are supplied.
| string | $path | Optional. Extra path appended to the end of the URL, including the relative directory if $plugin is supplied. Default empty. |
| string | $plugin | Optional. A full path to a file inside a plugin or mu-plugin.
The URL will be relative to its directory. Default empty.
Typically this is done by passing |
Plugins URL link with optional paths appended.
register_activation_hook(string $filename, string $function)
Wrapper function for PluginRegisterActivationHook::activation() method.
When a plugin is activated, the action activate_pluginname hook is called.
pluginname is replaced by the actually file name of the plugin being activated.
So if the plugin is located at 'plugin/sample/sample.plugin.php', then the hook will
call 'activate_sample.plugin.php'.
| string | $filename | Plugin's filename. |
| string | $function | The function that should be triggered by the hook. |
register_deactivation_hook(string $filename, string $function)
Wrapper function for PluginRegisterActivationHook::deactivation() method.
When a plugin is deactivated, the action deactivate_pluginname hook is called.
pluginname is replaced by the actually file name of the plugin being deactivated.
So if the plugin is located at 'plugin/sample/sample.plugin.php', then the hook will
call 'deactivate_sample.plugin.php'.
| string | $filename | Plugin's filename. |
| string | $function | The function that should be triggered by the hook. |
remove_trailing_slash(string $string) : string
Removes trailing forward slashes and backslashes if they exist.
The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support.
| string | $string | What to remove the trailing slashes from. |
String without the trailing slashes.
reset_password(integer $user_id) : integer|\TriTan\Exception\Exception
Resets a user's password.
| integer | $user_id | ID of user who's password is to be reset. Default: 0. |
User id on success or Exception on failure.
safe_truncate(string $string, integer $length, string $append = '...') : string
Truncate a string to a specified length without cutting a word off
| string | $string | The string to truncate |
| integer | $length | The length to truncate the string to |
| string | $append | Text to append to the string IF it gets truncated, defaults to '...' |
sanitize_url(string $url, boolean $encode = false) : string
Sanitizes a url to be used safely.
Example usage:
$url = "http://www.example.com/?message=test&<script>alert('XSS');</script>";
sanitize_url($url); //returns 'http://www.example.com/?message=test&38;';| string | $url | The url to be sanitized. |
| boolean | $encode | Whether url params should be encoded. |
The sanitized $url after the sanitize_url filter is applied.
selected(mixed $selected, mixed $current = true, boolean $echo = true) : string
Outputs the html selected attribute.
Compares the first two arguments and if identical marks as selected
| mixed | $selected | One of the values to compare |
| mixed | $current | (true) The other value to compare if not just true |
| boolean | $echo | Whether to echo or just return the string |
html attribute or empty string
send_password_change_email(integer $user, string $password, array $userdata) : boolean|\PHPMailer\PHPMailer\Exception
Email sent to user with changed/updated password.
| integer | $user | User array. |
| string | $password | Plaintext password. |
| array | $userdata | Updated user array. |
set_email_template(string $body) : string
Add the template to the message body.
Looks for {content} into the template and replaces it with the message.
Uses email_template filter hook.
| string | $body | The message to templatize. |
$email The email surrounded by template.
set_url_scheme(string $url, string|null $scheme = null) : string
Sets the scheme for a URL.
| string | $url | Absolute URL that includes a scheme |
| string|null | $scheme | Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'admin', 'relative', 'rest' or null. Default null. |
$url URL with chosen scheme.
site_url(string $path = '', string $scheme = null) : string
Returns the url for a given site.
Returns 'https' if is_ssl() evaluates to true and 'http' otherwise. If $scheme is
'http' or 'https', is_ssl() is overridden.
| string | $path | Optional. Route relative to the site url. Default '/'. |
| string | $scheme | Optional. Scheme to give the site URL context. Accepts 'http', 'https', 'login', 'admin', or 'relative'. Default null. |
Site url link.
the_created_date(string $format = '', integer|\TriTan\Common\Post\Post $post = null) : string|integer|false
Retrieves TriTan CMS post created date.
| string | $format | Format to use for retrieving the date the post was written. Accepts 'G', 'U', or php date format value specified in 'date_format' option. Default empty. |
| integer|\TriTan\Common\Post\Post | $post | Post array or post id. |
Formatted date string or Unix timestamp if $format is 'U' or 'G'. False on failure.
the_created_time(string $format = '', integer|\TriTan\Common\Post\Post $post = null) : string|integer|false
Retrieves TriTan CMS post created time.
| string | $format | Format to use for retrieving the time the post was written. Accepts 'G', 'U', or php date format value specified in 'time_format' option. Default empty. |
| integer|\TriTan\Common\Post\Post | $post | Post array or post id. |
Formatted date string or Unix timestamp if $format is 'U' or 'G'. False on failure.
the_modified_date(string $format = '', integer|\TriTan\Common\Post\Post $post = null) : string|integer|false
Retrieves TriTan CMS post published date.
| string | $format | Format to use for retrieving the date the post was published. Accepts 'G', 'U', or php date format value specified in 'date_format' option. Default empty. |
| integer|\TriTan\Common\Post\Post | $post | Post array or post id. |
Formatted date string or Unix timestamp if $format is 'U' or 'G'. False on failure.
the_modified_time(string $format = '', integer|\TriTan\Common\Post\Post $post = null) : string|integer|false
Retrieves TriTan CMS post modified time.
| string | $format | Format to use for retrieving the time the post was modified. Accepts 'G', 'U', or php date format value specified in 'time_format' option. Default empty. |
| integer|\TriTan\Common\Post\Post | $post | Post array or post id. |
Formatted date string or Unix timestamp if $format is 'U' or 'G'. False on failure.
the_posts(string $post_type = null, integer $limit, null|integer $offset = null, string $status = 'all') : object
Wrapper function for get_all_posts.
| string | $post_type | The post type. |
| integer | $limit | Number of posts to show. |
| null|integer | $offset | The offset of the first row to be returned. |
| string | $status | Should it retrieve all statuses, published, draft, etc.? |
the_published_date(string $format = '', integer|\TriTan\Common\Post\Post $post = null) : string|integer|false
Retrieves TriTan CMS post published date.
| string | $format | Format to use for retrieving the date the post was published. Accepts 'G', 'U', or php date format value specified in 'date_format' option. Default empty. |
| integer|\TriTan\Common\Post\Post | $post | Post array or post id. |
Formatted date string or Unix timestamp if $format is 'U' or 'G'. False on failure.
the_published_time(string $format = '', integer|\TriTan\Common\Post\Post $post = null) : string|integer|false
Retrieves TriTan CMS post published time.
| string | $format | Format to use for retrieving the time the post was published. Accepts 'G', 'U', or php date format value specified in 'time_format' option. Default empty. |
| integer|\TriTan\Common\Post\Post | $post | Post array or post id. |
Formatted date string or Unix timestamp if $format is 'U' or 'G'. False on failure.
themes_url(string $path = '', string $theme = '') : string
Retrieves a URL within a site's theme directory.
Defaults to the site's theme directory URL if no arguments are supplied.
| string | $path | Optional. Extra path appended to the end of the URL, including the relative directory if $theme is supplied. Default empty. |
| string | $theme | Optional. A full path to a file inside a theme.
The URL will be relative to its directory. Default empty.
Typically this is done by passing |
Site's theme URL link with optional paths appended.
ttcms_admin_url(string $path = '', string $scheme = 'admin') : string
Returns the url to the admin area for a given site.
| string | $path | Optional. Path relative to the admin url. Default empty. |
| string | $scheme | Optional. The scheme to use. Accepts 'http' or 'https', to force those schemes. Default 'admin'. |
Admin url link with optional path appended.
ttcms_delete_post(integer $post_id) : boolean|\TriTan\Common\Post\Post
Deletes a post from the post document.
| integer | $post_id | The id of the post to delete. |
Post on success, false otherwise.
ttcms_delete_site(integer $site_id, boolean $exception = false) : boolean|\TriTan\Error
Deletes a site.
| integer | $site_id | ID of site to delete. |
| boolean | $exception | Whether to throw an exception. |
Returns true on delete or throw an Exception or Error if failed.
ttcms_delete_site_user(integer $user_id, array $params = array(), boolean $exception = false) : boolean|\TriTan\Exception\Exception|\TriTan\Error
Delete site user.
| integer | $user_id | The id of user to be deleted. |
| array | $params | User parameters (assign_id and role). |
| boolean | $exception | Whether or not to throw an exception. |
Returns true if successful or will throw and exception or error otherwise.
ttcms_delete_user(integer $user_id, integer $assign_id = null) : boolean
Deletes a user from the usermeta document. To delete user entirely from the system, see `ttcms_delete_site_user`.
| integer | $user_id | ID of user being deleted. |
| integer | $assign_id | ID of user to whom posts will be assigned. Default: NULL. |
ttcms_encode_email(string $string) : string
Searches for plain email addresses in given $string and encodes them (by default) with the help of ttcms_encode_email_str().
Regular expression is based on based on John Gruber's Markdown. http://daringfireball.net/projects/markdown/
| string | $string | Text with email addresses to encode |
$string Given text with encoded email addresses
ttcms_encode_email_str(string $string) : string
Encodes each character of the given string as either a decimal or hexadecimal entity, in the hopes of foiling most email address harvesting bots.
Based on Michel Fortin's PHP Markdown: http://michelf.com/projects/php-markdown/ Which is based on John Gruber's original Markdown: http://daringfireball.net/projects/markdown/ Whose code is based on a filter by Matthew Wickline, posted to the BBEdit-Talk with some optimizations by Milian Wolff.
| string | $string | Text with email addresses to encode |
$string Given text with encoded email addresses
ttcms_enqueue_css(string $config, string|array $asset, boolean|string $minify = false, string|null $plugin_slug = null) : string
Enqueues stylesheets.
Uses default_css_pipeline, plugin_css_pipeline and theme_css_pipeline
filter hooks.
Example Usage:
ttcms_enqueue_css('default', '//cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css')
ttcms_enqueue_css('plugin', ['fontawesome','select2-css'], false, plugin_basename( dirname(__FILE__) ))
ttcms_enqueue_css('theme', 'style.css')| string | $config | Set whether to use |
| string|array | $asset | Relative path or URL to stylesheet(s) to enqueue. |
| boolean|string | $minify | Enable css assets pipeline (concatenation and minification).
Use a string that evaluates to |
| string|null | $plugin_slug | Plugin slug to set plugin's asset location |
Stylesheet asset(s).
ttcms_enqueue_js(string $config, string|array $asset, boolean|string $minify = false, string|null $plugin_slug = null) : string
Enqueues javascript.
Uses default_js_pipeline, plugin_js_pipeline and theme_js_pipeline
filter hooks.
Example Usage:
ttcms_enqueue_js('default', 'jquery-ui')
ttcms_enqueue_js('plugin', 'select2-js', false, plugin_basename( dirname(__FILE__) ))
ttcms_enqueue_js('theme', 'config.js')| string | $config | Set whether to use |
| string|array | $asset | Relative path or URL to javascripts(s) to enqueue. |
| boolean|string | $minify | Enable js assets pipeline (concatenation and minification).
Use a string that evaluates to |
| string|null | $plugin_slug | Plugin slug to set plugin's asset location. |
Javascript asset(s).
ttcms_file_exists(string $filename, boolean $throw = true) : boolean
Checks whether a file or directory exists.
| string | $filename | Path to the file or directory. |
| boolean | $throw | Determines whether to do a simple check or throw an exception. Default: true. |
If file does not exist.
true if the file or directory specified by $filename exists; false otherwise.
ttcms_generate_password(integer $length = 12, boolean $special_chars = true, boolean $extra_special_chars = false) : string
Generates a random password drawn from the defined set of characters.
Uses random_lib library to create passwords with far less predictability.
| integer | $length | Optional. The length of password to generate. Default 12. |
| boolean | $special_chars | Optional. Whether to include standard special characters. Default true. |
| boolean | $extra_special_chars | Optional. Whether to include other special characters. Default false. |
The system generated password.
ttcms_get_file_data(string $file, array $default_headers, string $context = '') : array
Retrieve metadata from a file.
Searches for metadata in the first 8kB of a file, such as a plugin or layout. Each piece of metadata must be on its own line. Fields can not span multiple lines, the value will get cut at the end of the first line.
If the file data is not within that first 8kB, then the author should correct their plugin file and move the data headers to the top.
| string | $file | Path to the file. |
| array | $default_headers | List of headers, in the format array('HeaderKey' => 'Header Name'). |
| string | $context | Optional. If specified adds filter hook "extra_{$context}_headers". Default empty. |
Array of file headers in HeaderKey => Header Value format.
ttcms_home_url(string $path = '', string|null $scheme = null) : string
Returns the url for a given site where the front end is accessible.
The protocol will be 'https' if is_ssl() evaluates to true; If $scheme is
'http' or 'https', is_ssl() is overridden.
| string | $path | Optional. Path relative to the home url. Default empty. |
| string|null | $scheme | Optional. Scheme to give the home URL context. Accepts 'http', 'https', 'relative', or null. Default null. |
Home url link with optional path appended.
ttcms_insert_post(array $postdata, boolean $exception = false) : integer|\TriTan\Exception\Exception|null
Insert or update a post.
All of the $postdata array fields have filters associated with the values. The filters
have the prefix 'pre_' followed by the field name. An example using 'post_status' would have
the filter called, 'pre_post_status' that can be hooked into.
| array | $postdata | An array of data that is used for insert or update. |
| boolean | $exception | Whether or not to throw an exception. |
The newly created post's post_id or throws an exception or returns null if the post could not be created or updated.
ttcms_insert_posttype(array $posttypedata, $exception = false) : integer|\Exception|null
Insert or update a posttype.
All of the $posttypedata array fields have filters associated with the values. The filters
have the prefix 'pre_' followed by the field name. An example using 'posttype_title' would have
the filter called, 'pre_posttype_title' that can be hooked into.
| array | $posttypedata | An array of data that is used for insert or update. |
| $exception |
The newly created posttype's posttype_id, Exception or returns null if the posttype could not be created or updated.
ttcms_insert_site(array|\TriTan\Common\Site\Site $sitedata, boolean $exception = false) : integer|\TriTan\Exception\Exception|\TriTan\Error
Insert a site into the database.
Some of the $sitedata array fields have filters associated with the values. Exceptions are
'site_owner', 'site_registered' and 'sitemodified' The filters have the prefix 'pre'
followed by the field name. An example using 'site_name' would have the filter called,
'pre_site_name' that can be hooked into.
| array|\TriTan\Common\Site\Site | $sitedata | { An array or Site array of user data arguments. } |
| boolean | $exception | Whether to throw and exception or error. |
The newly created site's site_id or throws an Exception or Error if the site could not be created.
ttcms_insert_user(array|object|\TriTan\Common\User\User $userdata) : integer|\TriTan\Exception\Exception
Insert a user into the database.
Most of the $userdata array fields have filters associated with the values. Exceptions are
'user_id', 'user_url', 'user_admin_layout', 'user_admin_sidebar', 'user_admin_skin',
'user_registered' and 'usermodified'. The filters have the prefix 'pre' followed by
the field name. An example using 'user_bio' would have the filter called, 'pre_user_bio' that
can be hooked into.
| array|object|\TriTan\Common\User\User | $userdata | { An array, object or User object of user data arguments. } |
The newly created user's user_id or throws an exception if the user could not be created.
ttcms_list_sort(array $objects, \string/array $orderby = array(), string $order = 'ASC', boolean $preserve_keys = false) : array
Sort array of objects by field.
Example Usage:
ttcms_list_sort($post,'post_id','ASC', false);| array | $objects | Array of objects to sort. |
| \string/array | $orderby | Name of field or array of fields to filter by. |
| string | $order | (ASC|DESC) |
| boolean | $preserve_keys | Whether to preserve keys. |
Returns a sorted array.
ttcms_load_file(string $file, boolean $once = true, boolean|\Closure $show_errors = true) : mixed
Special function for file includes.
| string | $file | File which should be included/required. |
| boolean | $once | File should be included/required once. Default true. |
| boolean|\Closure | $show_errors | If true error will be processed, if Closure - only Closure will be called. Default true. |
ttcms_login_url(string $redirect = '', string $path = '', string|null $scheme = 'login') : string
Returns the login url for a given site.
| string | $redirect | Path to redirect to on log in. |
| string | $path | Optional. Path relative to the login url. Default empty. |
| string|null | $scheme | Optional. Scheme to give the home URL context. Accepts 'http', 'https', 'relative', or null. Default 'login'. |
Returns the login url.
ttcms_php_check_syntax(string $filename, boolean $check_includes = true) : void|\TriTan\Exception\Exception
Performs a syntax and error check of a given PHP script.
| string | $filename | PHP script/file to check. |
| boolean | $check_includes | If set to true, will check if other files have been included. |
If file does not exist or is not readable.
If file contains duplicate function names.
ttcms_pluralize(integer $quantity, string $singular, string $plural = null) : string
Pluralizes a word if quantity is not one.
Example Usage:
ttcms_pluralize(4, 'cat'); // cats
ttcms_pluralize(3, 'kitty'); // kitties
ttcms_pluralize(2, 'octopus', 'octopii'); // octopii
ttcms_pluralize(1, 'mouse', 'mice'); // mouse| integer | $quantity | Number of items. |
| string | $singular | Singular form of word. |
| string | $plural | Plural form of word; function will attempt to deduce plural form from singular if not provided. |
Pluralized word if quantity is not one, otherwise singular.
ttcms_post_slug_exist(integer|null $post_id, string $slug, string $post_type) : boolean
Checks if a slug exists among records from the post document.
| integer|null | $post_id | Post id to check against or null. |
| string | $slug | Slug to search for. |
| string | $post_type | The post type to filter. |
ttcms_remove_accents(string $string) : string
Converts all accent characters to ASCII characters.
If there are no accent characters, then the string given is just returned.
| string | $string | Text that might have accent characters |
Filtered string with replaced "nice" characters.
ttcms_sanitize_string(string $string, string $fallback_string = 'deprecated', string $context = 'save') : string
Sanitizes a string, or returns a fallback string.
Specifically, HTML and PHP tags are stripped. Further actions can be added via the plugin API. If $string is empty and $fallback_string is set, the latter will be used.
| string | $string | The string to be sanitized. |
| string | $fallback_string | Optional. A string to use if $string is empty. |
| string | $context | Optional. The operation for which the string is sanitized |
The sanitized string.
ttcms_site_url(string $path = '', string $scheme = null) : string
Returns the url for a given site.
Returns 'https' if is_ssl() evaluates to true and 'http' otherwise. If $scheme is
'http' or 'https', is_ssl() is overridden.
| string | $path | Optional. Route relative to the site url. Default '/'. |
| string | $scheme | Optional. Scheme to give the site URL context. Accepts 'http', 'https', 'login', 'admin', or 'relative'. Default null. |
Site url link.
ttcms_unique_post_slug(string $original_slug, string $original_title, integer|null $post_id, string $post_type) : string
Creates a unique post slug.
| string | $original_slug | Original slug of post. |
| string | $original_title | Original title of post. |
| integer|null | $post_id | Unique post id or null. |
| string | $post_type | Post type of post. |
Unique post slug.
ttcms_unique_posttype_slug(string $original_slug, string $original_title, integer $posttype_id) : string
Creates a unique posttype slug.
| string | $original_slug | Original slug of posttype. |
| string | $original_title | Original title of posttype. |
| integer | $posttype_id | Unique posttype id. |
Unique posttype slug.
ttcms_unique_site_slug(string $original_slug, string $original_title, integer|null $site_id) : string
Creates a unique site slug.
| string | $original_slug | Original slug of site. |
| string | $original_title | Original title of site. |
| integer|null | $site_id | Unique site id or null. |
Unique site slug.
ttcms_update_post(array|object $postdata, \bool $exception = false) : integer|\TriTan\Exception\Exception|null
Update a post in the post document.
See \ttcms_insert_post() For what fields can be set in $postdata.
| array|object | $postdata | An array of post data or a post object. |
| \bool | $exception |
The updated post's id or throw an Exception or return null if post could not be updated.
ttcms_update_posttype(array|object $posttypedata = array(), $exception = false) : integer|\Exception|null
Update a posttype in the post document.
See \ttcms_insert_posttype() For what fields can be set in $posttypedata.
| array|object | $posttypedata | An array of posttype data or a posttype object. |
| $exception |
The updated posttype's id, Exception or return null if posttype could not be updated.
ttcms_update_site(integer|object|\TriTan\Common\Site\Site $sitedata, \bool $exception = false) : integer|\TriTan\Exception\Exception|\TriTan\Error
Update a site in the database.
See ttcms_insert_site() For what fields can be set in $sitedata.
| integer|object|\TriTan\Common\Site\Site | $sitedata | An array of site data or a site object or site id. |
| \bool | $exception |
The updated site's id or throw an Exception or Error if the site could not be updated.
ttcms_update_user(object|\TriTan\Common\User\User $userdata) : integer|\TriTan\Exception\Exception
Update a user in the database.
It is possible to update a user's password by specifying the 'user_pass' value in the $userdata parameter array.
See \ttcms_insert_user() For what fields can be set in $userdata.
| object|\TriTan\Common\User\User | $userdata | An array of user data or a user object of type stdClass or User. |
The updated user's id or throw an Exception if the user could not be updated.
ttcms_validate_plugin(string $plugin_name)
Validates a plugin and checks to make sure there are no syntax and/or parsing errors.
Uses activate_plugin, activate_$plugin_name, and activated_plugin
actions hooks.
| string | $plugin_name | Name of the plugin file (i.e. disqus.plugin.php). |
update_meta_cache(string $meta_type, integer|array $array_ids) : array|false
Update the metadata cache for the specified arrays.
| string | $meta_type | Type of array metadata is for (e.g., post or user) |
| integer|array | $array_ids | Array or comma delimited list of array IDs to update cache for |
Metadata cache for the specified arrays, or false on failure.
update_post_meta(integer $post_id, string $meta_key, mixed $meta_value, mixed $prev_value = '') : integer|boolean
Update post meta field based on post ID.
Use the $prev_value parameter to differentiate between meta fields with the same key and post ID.
If the meta field for the post does not exist, it will be added.
| integer | $post_id | Post ID. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| mixed | $prev_value | Optional. Previous value to check before removing. Default empty. |
Meta ID if the key didn't exist, true on successful update, false on failure.
update_user_meta(integer $user_id, string $meta_key, mixed $meta_value, mixed $prev_value = '') : integer|boolean
Update user meta field based on user ID.
Use the $prev_value parameter to differentiate between meta fields with the same key and user ID.
If the meta field for the user does not exist, it will be added.
| integer | $user_id | User ID. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. |
| mixed | $prev_value | Optional. Previous value to check before removing. |
Meta ID if the key didn't exist, true on successful update, false on failure.
update_user_option(integer $user_id, string $option_name, mixed $newvalue, boolean $global = false) : integer|boolean
Update user option with global site capability.
User options are just like user metadata except that they have support for global site options. If the 'global' parameter is false, which it is by default it will prepend the TriTan CMS table prefix to the option name.
Deletes the user option if $newvalue is empty.
| integer | $user_id | User ID. |
| string | $option_name | User option name. |
| mixed | $newvalue | User option value. |
| boolean | $global | Optional. Whether option name is global or site specific. Default false (site specific). |
User meta ID if the option didn't exist, true on successful update, false on failure.
validate_username(string $username) : boolean
Checks whether the given username is valid.
Uses validate_username filter.
Example Usage:
if(validate_username('batman')) {
//do something;
}| string | $username | Username to check. |
Whether given username is valid.
withMock(\Closure $cb) : boolean
Example usage:
it('should use SomeInterface to do Something', withMock(function () { $mock = Mockery::mock('SomeInterface'); $mock->shouldReceive('someMethod') ->with('someValue') ->once() ->andReturn(true);
$sut = new SystemToTest($mock);
$sut->test();
}));| \Closure | $cb |