help([bool $withDocumentation=true], [$format='<div class="twig-documentation"><div class="function-signature"><span class="function"><span class="function-name">%1$s</span>(<span class="function-arguments">%2$s</span>)</span><span class="function-return">:%3$s</span></div><pre class="documentation">%4$s</pre></div>']):
List all the functions registered with Twig module @param bool $withDocumentation @param string $format @return string
getFunctions([bool $withDocumentation=false], [$format='']):array
Retrieve information about the registered functions to be used on Twig @param bool $withDocumentation @return array
callFunction(string $function, [...$args]):
Call the Twig registered function with the given args @param string $function @param mixed $args @return mixed function result
header($header, [$replace], [$http_response_code]):
headers_sent([$file], [$line]):
printf($format, [...$args]):
sprintf($format, [...$args]):
var_dump(...$vars):
print_r($var, [$return]):
is_array($var):
is_subclass_of($object, $class_name, [$allow_string]):
is_a($object, $class_name):bool
Check if the specified object is an instance of the given class name @param mixed $object @param string $class_name @return bool
get_class([$object]):
uniqid([$prefix], [$more_entropy]):
implode($glue, $pieces):
explode($separator, $str, [$limit]):
json_encode($value, [$options], [$depth]):
json_decode($json, [$assoc], [$depth], [$options]):
json_last_error_msg():
json_last_error():
shuffle($array):
Shuffles the elements in an array @param array $array The array to shuffle @return array shuffled array
nl_br($str, [$is_xhtml]):
error_log($message, [$message_type], [$destination], [$extra_headers]):
array_reverse($input, [$preserve_keys]):
array_column($arg, $column_key, [$index_key]):
array_unique($arg, [$flags]):
function_exists([string $name='']):bool
Check if the specified function is registered on Twig module
class_exists($classname, [$autoload]):
filter_has_var($type, $variable_name):
filter_input($type, $variable_name, [$filter], [$options]):
setcookie($name, [$value], [$expires_or_options], [$path], [$domain], [$secure], [$httponly]):
urlencode($str):
http_build_query($formdata, [$prefix], [$arg_separator], [$enc_type]):
preg_replace($regex, $replace, $subject, [$limit], [$count]):
preg_quote($str, [$delim_char]):
preg_match($pattern, $subject, [$subpatterns], [$flags], [$offset]):
preg_match_all($pattern, $subject, [$subpatterns], [$flags], [$offset]):
__($text, [$domain='default']):
Retrieve the translation of $text. If there is no translation, or the text domain isn't loaded, the original text is returned. @since 2.1.0 @param string $text Text to translate. @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings. Default 'default'. @return string Translated text.
_e($text, [$domain='default']):
Display translated text. @since 1.2.0 @param string $text Text to translate. @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings. Default 'default'.
esc_url($url, [$protocols=NULL], [$_context='display']):
Checks and cleans a URL. A number of characters are removed from the URL. If the URL is for displaying (the default behaviour) ampersands are also replaced. The {@see 'clean_url'} filter is applied to the returned cleaned URL. @since 2.8.0 @param string $url The URL to be cleaned. @param string[] $protocols Optional. An array of acceptable protocols. Defaults to return value of wp_allowed_protocols(). @param string $_context Private. Use esc_url_raw() for database usage. @return string The cleaned URL after the {@see 'clean_url'} filter is applied. An empty string is returned if `$url` specifies a protocol other than those in `$protocols`, or if `$url` contains an empty string.
esc_attr($text):
Escaping for HTML attributes. @since 2.8.0 @param string $text @return string
esc_attr__($text, [$domain='default']):
Retrieve the translation of $text and escapes it for safe use in an attribute. If there is no translation, or the text domain isn't loaded, the original text is returned. @since 2.8.0 @param string $text Text to translate. @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings. Default 'default'. @return string Translated text on success, original text on failure.
do_action($hook_name, [...$arg]):
Calls the callback functions that have been added to an action hook. This function invokes all functions attached to action hook `$hook_name`. It is possible to create new action hooks by simply calling this function, specifying the name of the new hook using the `$hook_name` parameter. You can pass extra arguments to the hooks, much like you can with `apply_filters()`. Example usage: // The action callback function. function example_callback( $arg1, $arg2 ) { // (maybe) do something with the args. } add_action( 'example_action', 'example_callback', 10, 2 ); /* * Trigger the actions by calling the 'example_callback()' function * that's hooked onto `example_action` above. * * - 'example_action' is the action hook. * - $arg1 and $arg2 are the additional arguments passed to the callback. $value = do_action( 'example_action', $arg1, $arg2 ); @since 1.2.0 @since 5.3.0 Formalized the existing and already documented `...$arg` parameter by adding it to the function signature. @global WP_Hook[] $wp_filter Stores all of the filters and actions. @global int[] $wp_actions Stores the number of times each action was triggered. @global string[] $wp_current_filter Stores the list of current filters with the current one last. @param string $hook_name The name of the action to be executed. @param mixed ...$arg Optional. Additional arguments which are passed on to the functions hooked to the action. Default empty.
apply_filters($hook_name, $value, [...$args]):
Calls the callback functions that have been added to a filter hook. This function invokes all functions attached to filter hook `$hook_name`. It is possible to create new filter hooks by simply calling this function, specifying the name of the new hook using the `$hook_name` parameter. The function also allows for multiple additional arguments to be passed to hooks. Example usage: // The filter callback function. function example_callback( $string, $arg1, $arg2 ) { // (maybe) modify $string. return $string; } add_filter( 'example_filter', 'example_callback', 10, 3 ); /* * Apply the filters by calling the 'example_callback()' function * that's hooked onto `example_filter` above. * * - 'example_filter' is the filter hook. * - 'filter me' is the value being filtered. * - $arg1 and $arg2 are the additional arguments passed to the callback. $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 ); @since 0.71 @since 6.0.0 Formalized the existing and already documented `...$args` parameter by adding it to the function signature. @global WP_Hook[] $wp_filter Stores all of the filters and actions. @global string[] $wp_current_filter Stores the list of current filters with the current one last. @param string $hook_name The name of the filter hook. @param mixed $value The value to filter. @param mixed ...$args Additional parameters to pass to the callback functions. @return mixed The filtered value after all hooked functions are applied to it.
get_option($option, [$default=false]):
Retrieve a site option @param string $option Name of the option to retrieve @param mixed $default Default value when no option value is found @return mixed Option value or $default value
get_header([$name=NULL], [$args=[]]):
Load header template. Includes the header template for a theme or if a name is specified then a specialised header will be included. For the parameter, if the file is called "header-special.php" then specify "special". @since 1.5.0 @since 5.5.0 A return value was added. @since 5.5.0 The `$args` parameter was added. @param string $name The name of the specialised header. @param array $args Optional. Additional arguments passed to the header template. Default empty array. @return void|false Void on success, false if the template does not exist.
get_template_part($slug, [$name=NULL], [$args=[]]):
Loads a template part into a template. Provides a simple mechanism for child themes to overload reusable sections of code in the theme. Includes the named template part for a theme or if a name is specified then a specialised part will be included. If the theme contains no {slug}.php file then no template will be included. The template is included using require, not require_once, so you may include the same template part multiple times. For the $name parameter, if the file is called "{slug}-special.php" then specify "special". @since 3.0.0 @since 5.5.0 A return value was added. @since 5.5.0 The `$args` parameter was added. @param string $slug The slug name for the generic template. @param string $name The name of the specialised template. @param array $args Optional. Additional arguments passed to the template. Default empty array. @return void|false Void on success, false if the template does not exist.
get_sidebar([$name=NULL], [$args=[]]):
Load sidebar template. Includes the sidebar template for a theme or if a name is specified then a specialised sidebar will be included. For the parameter, if the file is called "sidebar-special.php" then specify "special". @since 1.5.0 @since 5.5.0 A return value was added. @since 5.5.0 The `$args` parameter was added. @param string $name The name of the specialised sidebar. @param array $args Optional. Additional arguments passed to the sidebar template. Default empty array. @return void|false Void on success, false if the template does not exist.
get_footer([$name=NULL], [$args=[]]):
Load footer template. Includes the footer template for a theme or if a name is specified then a specialised footer will be included. For the parameter, if the file is called "footer-special.php" then specify "special". @since 1.5.0 @since 5.5.0 A return value was added. @since 5.5.0 The `$args` parameter was added. @param string $name The name of the specialised footer. @param array $args Optional. Additional arguments passed to the footer template. Default empty array. @return void|false Void on success, false if the template does not exist.
get_search_form([$args=[]]):
Display search form. Will first attempt to locate the searchform.php file in either the child or the parent, then load it. If it doesn't exist, then the default search form will be displayed. The default search form is HTML, which will be displayed. There is a filter applied to the search form HTML in order to edit or replace it. The filter is {@see 'get_search_form'}. This function is primarily used by themes which want to hardcode the search form into the sidebar and also by the search widget in WordPress. There is also an action that is called whenever the function is run called, {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the search relies on or various formatting that applies to the beginning of the search. To give a few examples of what it can be used for. @since 2.7.0 @since 5.2.0 The `$args` array parameter was added in place of an `$echo` boolean flag. @param array $args { Optional. Array of display arguments. @type bool $echo Whether to echo or return the form. Default true. @type string $aria_label ARIA label for the search form. Useful to distinguish multiple search forms on the same page and improve accessibility. Default empty. } @return void|string Void if 'echo' argument is true, search form HTML if 'echo' is false.
get_query_var($var, [$default='']):
Retrieves the value of a query variable in the WP_Query class. @since 1.5.0 @since 3.9.0 The `$default` argument was introduced. @global WP_Query $wp_query WordPress Query object. @param string $var The variable key to retrieve. @param mixed $default Optional. Value to return if the query variable is not set. Default empty. @return mixed Contents of the query variable.
paginate_links([$args='']):
Retrieves paginated links for archive post pages. Technically, the function can be used to create paginated link list for any area. The 'base' argument is used to reference the url, which will be used to create the paginated links. The 'format' argument is then used for replacing the page number. It is however, most likely and by default, to be used on the archive post pages. The 'type' argument controls format of the returned value. The default is 'plain', which is just a string with the links separated by a newline character. The other possible values are either 'array' or 'list'. The 'array' value will return an array of the paginated link list to offer full control of display. The 'list' value will place all of the paginated links in an unordered HTML list. The 'total' argument is the total amount of pages and is an integer. The 'current' argument is the current page number and is also an integer. An example of the 'base' argument is "http://example.com/all_posts.php%_%" and the '%_%' is required. The '%_%' will be replaced by the contents of in the 'format' argument. An example for the 'format' argument is "?page=%#%" and the '%#%' is also required. The '%#%' will be replaced with the page number. You can include the previous and next links in the list by setting the 'prev_next' argument to true, which it is by default. You can set the previous text, by using the 'prev_text' argument. You can set the next text by setting the 'next_text' argument. If the 'show_all' argument is set to true, then it will show all of the pages instead of a short list of the pages near the current page. By default, the 'show_all' is set to false and controlled by the 'end_size' and 'mid_size' arguments. The 'end_size' argument is how many numbers on either the start and the end list edges, by default is 1. The 'mid_size' argument is how many numbers to either side of current page, but not including current page. It is possible to add query vars to the link by using the 'add_args' argument and see add_query_arg() for more information. The 'before_page_number' and 'after_page_number' arguments allow users to augment the links themselves. Typically this might be to add context to the numbered links so that screen reader users understand what the links are for. The text strings are added before and after the page number - within the anchor tag. @since 2.1.0 @since 4.9.0 Added the `aria_current` argument. @global WP_Query $wp_query WordPress Query object. @global WP_Rewrite $wp_rewrite WordPress rewrite component. @param string|array $args { Optional. Array or string of arguments for generating paginated links for archives. @type string $base Base of the paginated url. Default empty. @type string $format Format for the pagination structure. Default empty. @type int $total The total amount of pages. Default is the value WP_Query's `max_num_pages` or 1. @type int $current The current page number. Default is 'paged' query var or 1. @type string $aria_current The value for the aria-current attribute. Possible values are 'page', 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'. @type bool $show_all Whether to show all pages. Default false. @type int $end_size How many numbers on either the start and the end list edges. Default 1. @type int $mid_size How many numbers to either side of the current pages. Default 2. @type bool $prev_next Whether to include the previous and next links in the list. Default true. @type bool $prev_text The previous page text. Default '« Previous'. @type bool $next_text The next page text. Default 'Next »'. @type string $type Controls format of the returned value. Possible values are 'plain', 'array' and 'list'. Default is 'plain'. @type array $add_args An array of query args to add. Default false. @type string $add_fragment A string to append to each link. Default empty. @type string $before_page_number A string to appear before the page number. Default empty. @type string $after_page_number A string to append after the page number. Default empty. } @return string|array|void String of page links or array of page links, depending on 'type' argument. Void if total number of pages is less than 2.
get_pagenum_link([$pagenum=1], [$escape=true]):
Retrieves the link for a page number. @since 1.5.0 @global WP_Rewrite $wp_rewrite WordPress rewrite component. @param int $pagenum Optional. Page number. Default 1. @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true. Otherwise, prepares the URL with esc_url_raw(). @return string The link URL for the given page number.
add_query_arg([...$args]):
Retrieves a modified URL query string. You can rebuild the URL and append query variables to the URL query by using this function. There are two ways to use this function; either a single key and value, or an associative array. Using a single key and value: add_query_arg( 'key', 'value', 'http://example.com' ); Using an associative array: add_query_arg( array( 'key1' => 'value1', 'key2' => 'value2', ), 'http://example.com' ); Omitting the URL from either use results in the current URL being used (the value of `$_SERVER['REQUEST_URI']`). Values are expected to be encoded appropriately with urlencode() or rawurlencode(). Setting any query variable's value to boolean false removes the key (see remove_query_arg()). Important: The return value of add_query_arg() is not escaped by default. Output should be late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting (XSS) attacks. @since 1.5.0 @since 5.3.0 Formalized the existing and already documented parameters by adding `...$args` to the function signature. @param string|array $key Either a query variable key, or an associative array of query variables. @param string $value Optional. Either a query variable value, or a URL to act upon. @param string $url Optional. A URL to act upon. @return string New URL query string (unescaped).
remove_query_arg($key, [$query=false]):
Removes an item or items from a query string. @since 1.5.0 @param string|string[] $key Query key or keys to remove. @param false|string $query Optional. When false uses the current URL. Default false. @return string New URL query string.
get_query_var_paged():
Get the 'paged' or 'page' query var @return int The 'paged' or 'page' query var value
wp_query([$args=[]]):
Instanciates a new WP_Query object @param array $args Arguments for \WP_Query @return \WP_Query @see \WP_Query
query_posts($query):
Sets up The Loop with query parameters. Note: This function will completely override the main query and isn't intended for use by plugins or themes. Its overly-simplistic approach to modifying the main query can be problematic and should be avoided wherever possible. In most cases, there are better, more performant options for modifying the main query such as via the {@see 'pre_get_posts'} action within WP_Query. This must not be used within the WordPress Loop. @since 1.5.0 @global WP_Query $wp_query WordPress Query object. @param array|string $query Array or string of WP_Query arguments. @return WP_Post[]|int[] Array of post objects or post IDs.
wp_reset_query():
Destroys the previous query and sets up a new query. This should be used after query_posts() and before another query_posts(). This will remove obscure bugs that occur when the previous WP_Query object is not destroyed properly before another is set up. @since 2.3.0 @global WP_Query $wp_query WordPress Query object. @global WP_Query $wp_the_query Copy of the global WP_Query instance created during wp_reset_query().
wp_reset_postdata():
After looping through a separate query, this function restores the $post global to the current post in the main query. @since 3.0.0 @global WP_Query $wp_query WordPress Query object.
get_search_query([$escaped=true]):
Retrieves the contents of the search WordPress query variable. The search query string is passed through esc_attr() to ensure that it is safe for placing in an HTML attribute. @since 2.3.0 @param bool $escaped Whether the result is escaped. Default true. Only use when you are later escaping it. Do not use unescaped. @return string
get_queried_object_id():
Retrieves the ID of the currently queried object. Wrapper for WP_Query::get_queried_object_id(). @since 3.1.0 @global WP_Query $wp_query WordPress Query object. @return int ID of the queried object.
posts():
Simulates the posts loop @return \WP_Post|array|null
have_posts():
Determines whether current WordPress query has posts to loop over. @since 1.5.0 @global WP_Query $wp_query WordPress Query object. @return bool True if posts are available, false if end of the loop.
found_posts():
Check found_posts from the global $wp_query @return bool @uses global $wp_query
the_post():
Iterate the post index in the loop. @since 1.5.0 @global WP_Query $wp_query WordPress Query object.
get_post([$post=NULL], [$output='OBJECT'], [$filter='raw']):
Retrieves post data given a post ID or post object. See sanitize_post() for optional $filter values. Also, the parameter `$post`, must be given as a variable, since it is passed by reference. @since 1.5.1 @global WP_Post $post Global post object. @param int|WP_Post|null $post Optional. Post ID or post object. `null`, `false`, `0` and other PHP falsey values return the current global post inside the loop. A numerically valid post ID that points to a non-existent post returns `null`. Defaults to global $post. @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT. @param string $filter Optional. Type of filter to apply. Accepts 'raw', 'edit', 'db', or 'display'. Default 'raw'. @return WP_Post|array|null Type corresponding to $output on success or null on failure. When $output is OBJECT, a `WP_Post` instance is returned.
get_the_ID():
Retrieves the ID of the current item in the WordPress Loop. @since 2.1.0 @return int|false The ID of the current item in the WordPress Loop. False if $post is not set.
the_ID():
Displays the ID of the current item in the WordPress Loop. @since 0.71
the_permalink([$post=0]):
Displays the permalink for the current post. @since 1.2.0 @since 4.4.0 Added the `$post` parameter. @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
get_permalink([$post=0], [$leavename=false]):
Retrieve the full permalink for the current post or post ID. @param int|\WP_Post $post @param bool $leavename = false @return string
the_title_attribute([$args='']):
Sanitizes the current title when retrieving or displaying. Works like the_title(), except the parameters can be in a string or an array. See the function for what can be override in the $args parameter. The title before it is displayed will have the tags stripped and esc_attr() before it is passed to the user or displayed. The default as with the_title(), is to display the title. @since 2.3.0 @param string|array $args { Title attribute arguments. Optional. @type string $before Markup to prepend to the title. Default empty. @type string $after Markup to append to the title. Default empty. @type bool $echo Whether to echo or return the title. Default true for echo. @type WP_Post $post Current post object to retrieve the title for. } @return void|string Void if 'echo' argument is true, the title attribute if 'echo' is false.
the_title([$before=''], [$after=''], [$echo=true]):
Displays or retrieves the current post title with optional markup. @since 0.71 @param string $before Optional. Markup to prepend to the title. Default empty. @param string $after Optional. Markup to append to the title. Default empty. @param bool $echo Optional. Whether to echo or return the title. Default true for echo. @return void|string Void if `$echo` argument is true, current post title if `$echo` is false.
get_the_title([$post=0]):
Retrieves the post title. If the post is protected and the visitor is not an admin, then "Protected" will be inserted before the post title. If the post is private, then "Private" will be inserted before the post title. @since 0.71 @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. @return string
the_content([$more_link_text=NULL], [$strip_teaser=false]):
Displays the post content. @since 0.71 @param string $more_link_text Optional. Content for when there is more text. @param bool $strip_teaser Optional. Strip teaser content before the more text. Default false.
get_the_content([$post=0]):
Retrieve the post content @param int|\WP_Post $post @return string
has_excerpt([$post=0]):
Determines whether the post has a custom excerpt. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. @since 2.3.0 @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. @return bool True if the post has a custom excerpt, false otherwise.
the_excerpt():
Displays the post excerpt. @since 0.71
get_the_excerpt([$post=0]):
Retrieve the post excerpt @param int|\WP_Post $post @return string
get_the_time([$format=''], [$post=NULL]):
Retrieve the time at which the post was written. @since 1.5.0 @param string $format Optional. Format to use for retrieving the time the post was written. Accepts 'G', 'U', or PHP date format. Defaults to the 'time_format' option. @param int|WP_Post $post WP_Post object or ID. Default is global `$post` object. @return string|int|false Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. False on failure.
get_the_modified_date([$format=''], [$post=NULL]):
Retrieve the date on which the post was last modified. @since 2.1.0 @since 4.6.0 Added the `$post` parameter. @param string $format Optional. PHP date format. Defaults to the 'date_format' option. @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. @return string|int|false Date the current post was modified. False on failure.
get_the_modified_time([$format=''], [$post=NULL]):
Retrieve the time at which the post was last modified. @since 2.0.0 @since 4.6.0 Added the `$post` parameter. @param string $format Optional. Format to use for retrieving the time the post was modified. Accepts 'G', 'U', or PHP date format. Defaults to the 'time_format' option. @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. @return string|int|false Formatted date string or Unix timestamp. False on failure.
get_the_date([$format=''], [$post=NULL]):
Retrieve the date on which the post was written. Unlike the_date() this function will always return the date. Modify output with the {@see 'get_the_date'} filter. @since 3.0.0 @param string $format Optional. PHP date format. Defaults to the 'date_format' option. @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. @return string|int|false Date the current post was written. False on failure.
the_posts_pagination([$args=[]]):
Displays a paginated navigation to next/previous set of posts, when applicable. @since 4.1.0 @param array $args Optional. See get_the_posts_pagination() for available arguments. Default empty array.
get_post_field($field, [$post=NULL], [$context='display']):
Retrieve data from a post field based on Post ID. Examples of the post field will be, 'post_type', 'post_status', 'post_content', etc and based off of the post object property or key names. The context values are based off of the taxonomy filter functions and supported values are found within those functions. @since 2.3.0 @since 4.5.0 The `$post` parameter was made optional. @see sanitize_post_field() @param string $field Post field name. @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post. @param string $context Optional. How to filter the field. Accepts 'raw', 'edit', 'db', or 'display'. Default 'display'. @return string The value of the post field on success, empty string on failure.
get_page_by_path($page_path, [$output='OBJECT'], [$post_type='page']):
Retrieves a page given its path. @since 2.1.0 @global wpdb $wpdb WordPress database abstraction object. @param string $page_path Page path. @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT. @param string|array $post_type Optional. Post type or array of post types. Default 'page'. @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
get_post_type([$post=NULL]):
Retrieves the post type of the current post or of a given post. @since 2.1.0 @param int|WP_Post|null $post Optional. Post ID or post object. Default is global $post. @return string|false Post type on success, false on failure.
get_post_singleValue($key, [$post_id=0]):
Retrieve a post custom value @param string $key with the key name to get. @param int $post_id with the post id. @return mixed value or false @uses get_the_ID @uses get_post_custom_values
wp_get_upload_dir():
Retrieves uploads directory information. Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory. Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases when not uploading files. @since 4.5.0 @see wp_upload_dir() @return array See wp_upload_dir() for description.
wp_get_attachment_url([$attachment_id=0]):
Retrieve the URL for an attachment. @since 2.1.0 @global string $pagenow The filename of the current screen. @param int $attachment_id Optional. Attachment post ID. Defaults to global $post. @return string|false Attachment URL, otherwise false.
wp_get_attachment_image_src($attachment_id, [$size='thumbnail'], [$icon=false]):
Retrieves an image to represent an attachment. @since 2.5.0 @param int $attachment_id Image attachment ID. @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'thumbnail'. @param bool $icon Optional. Whether the image should fall back to a mime type icon. Default false. @return array|false { Array of image data, or boolean false if no image is available. @type string $0 Image source URL. @type int $1 Image width in pixels. @type int $2 Image height in pixels. @type bool $3 Whether the image is a resized image. }
wp_get_attachment_image_srcset($attachment_id, [$size='medium'], [$image_meta=NULL]):
Retrieves the value for an image attachment's 'srcset' attribute. @since 4.4.0 @see wp_calculate_image_srcset() @param int $attachment_id Image attachment ID. @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'medium'. @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. Default null. @return string|false A 'srcset' value string or false.
wp_get_attachment_image_sizes($attachment_id, [$size='medium'], [$image_meta=NULL]):
Retrieves the value for an image attachment's 'sizes' attribute. @since 4.4.0 @see wp_calculate_image_sizes() @param int $attachment_id Image attachment ID. @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'medium'. @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. Default null. @return string|false A valid source size value for use in a 'sizes' attribute or false.
wp_get_post_terms([$post_id=0], [$taxonomy='post_tag'], [$args=[]]):
Retrieves the terms for a post. @since 2.8.0 @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. Default 0. @param string|string[] $taxonomy Optional. The taxonomy slug or array of slugs for which to retrieve terms. Default 'post_tag'. @param array $args { Optional. Term query parameters. See WP_Term_Query::__construct() for supported arguments. @type string $fields Term fields to retrieve. Default 'all'. } @return array|WP_Error Array of WP_Term objects on success or empty array if no terms were found. WP_Error object if `$taxonomy` doesn't exist.
get_post_ancestors([$post=NULL], [$excludeCurrent=false]):
Retrieve the post ancestors @param int|\WP_Post $post @param bool $excludeCurrent post @return array Post ancestors IDs
get_pages([$args=[]]):
Retrieve the page children @param array $args \get_pages args where child_of defaults to current page ID @return array Pages @uses \get_pages
wp_list_pages([$args=[]]):
Retrieve the page children @param array $args \wp_list_pages args where 'child_of' defaults to current page ID and 'walker' defaults to default @return array Pages @uses \wp_list_pages
is_single([$post='']):
Determines whether the query is for an existing single post. Works for any post type, except attachments and pages If the $post parameter is specified, this function will additionally check if the query is for one of the Posts specified. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. @since 1.5.0 @see is_page() @see is_singular() @global WP_Query $wp_query WordPress Query object. @param int|string|int[]|string[] $post Optional. Post ID, title, slug, or array of such to check against. Default empty. @return bool Whether the query is for an existing single post.
is_singular([$post_types='']):
Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types). If the $post_types parameter is specified, this function will additionally check if the query is for one of the Posts Types specified. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. @since 1.5.0 @see is_page() @see is_single() @global WP_Query $wp_query WordPress Query object. @param string|string[] $post_types Optional. Post type or array of post types to check against. Default empty. @return bool Whether the query is for an existing single post or any of the given post types.
is_search():
Determines whether the query is for a search. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. @since 1.5.0 @global WP_Query $wp_query WordPress Query object. @return bool Whether the query is for a search.
get_taxonomies([$args=[]], [$output='names'], [$operator='and']):
Retrieves a list of registered taxonomy names or objects. @since 3.0.0 @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. @param array $args Optional. An array of `key => value` arguments to match against the taxonomy objects. Default empty array. @param string $output Optional. The type of output to return in the array. Accepts either taxonomy 'names' or 'objects'. Default 'names'. @param string $operator Optional. The logical operation to perform. Accepts 'and' or 'or'. 'or' means only one element from the array needs to match; 'and' means all elements must match. Default 'and'. @return string[]|WP_Taxonomy[] An array of taxonomy names or objects.
get_terms([$args=[]], [$deprecated='']):
Retrieves the terms in a given taxonomy or list of taxonomies. You can fully inject any customizations to the query before it is sent, as well as control the output with a filter. The return type varies depending on the value passed to `$args['fields']`. See WP_Term_Query::get_terms() for details. In all cases, a `WP_Error` object will be returned if an invalid taxonomy is requested. The {@see 'get_terms'} filter will be called when the cache has the term and will pass the found term along with the array of $taxonomies and array of $args. This filter is also called before the array of terms is passed and will pass the array of terms, along with the $taxonomies and $args. The {@see 'list_terms_exclusions'} filter passes the compiled exclusions along with the $args. The {@see 'get_terms_orderby'} filter passes the `ORDER BY` clause for the query along with the $args array. Prior to 4.5.0, the first parameter of `get_terms()` was a taxonomy or list of taxonomies: $terms = get_terms( 'post_tag', array( 'hide_empty' => false, ) ); Since 4.5.0, taxonomies should be passed via the 'taxonomy' argument in the `$args` array: $terms = get_terms( array( 'taxonomy' => 'post_tag', 'hide_empty' => false, ) ); @since 2.3.0 @since 4.2.0 Introduced 'name' and 'childless' parameters. @since 4.4.0 Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter. Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return a list of WP_Term objects. @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter. Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata. @since 4.8.0 Introduced 'suppress_filter' parameter. @internal The `$deprecated` parameter is parsed for backward compatibility only. @param array|string $args Optional. Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments. Default empty array. @param array|string $deprecated Optional. Argument array, when using the legacy function parameter format. If present, this parameter will be interpreted as `$args`, and the first function parameter will be parsed as a taxonomy or array of taxonomies. Default empty. @return WP_Term[]|int[]|string[]|string|WP_Error Array of terms, a count thereof as a numeric string, or WP_Error if any of the taxonomies do not exist. See the function description for more information.
edit_post_link([$text=NULL], [$before=''], [$after=''], [$id=0], [$class='post-edit-link']):
Displays the edit post link for post. @since 1.0.0 @since 4.4.0 The `$class` argument was added. @param string $text Optional. Anchor text. If null, default is 'Edit This'. Default null. @param string $before Optional. Display before edit link. Default empty. @param string $after Optional. Display after edit link. Default empty. @param int|WP_Post $id Optional. Post ID or post object. Default is the global `$post`. @param string $class Optional. Add custom class to link. Default 'post-edit-link'.
can_edit_post([$id=0]):
Can the current user edit the given post? @param int|\WP_Post $id @return bool
headless():
Check if the page request is for headless content @return bool
language_attributes([$doctype='html']):
Displays the language attributes for the 'html' tag. Builds up a set of HTML attributes containing the text direction and language information for the page. @since 2.1.0 @since 4.3.0 Converted into a wrapper for get_language_attributes(). @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'.
get_bloginfo([$show=''], [$filter='raw']):
Retrieves information about the current site. Possible values for `$show` include: - 'name' - Site title (set in Settings > General) - 'description' - Site tagline (set in Settings > General) - 'wpurl' - The WordPress address (URL) (set in Settings > General) - 'url' - The Site address (URL) (set in Settings > General) - 'admin_email' - Admin email (set in Settings > General) - 'charset' - The "Encoding for pages and feeds" (set in Settings > Reading) - 'version' - The current WordPress version - 'html_type' - The content-type (default: "text/html"). Themes and plugins can override the default value using the {@see 'pre_option_html_type'} filter - 'text_direction' - The text direction determined by the site's language. is_rtl() should be used instead - 'language' - Language code for the current site - 'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme will take precedence over this value - 'stylesheet_directory' - Directory path for the active theme. An active child theme will take precedence over this value - 'template_url' / 'template_directory' - URL of the active theme's directory. An active child theme will NOT take precedence over this value - 'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php) - 'atom_url' - The Atom feed URL (/feed/atom) - 'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rdf) - 'rss_url' - The RSS 0.92 feed URL (/feed/rss) - 'rss2_url' - The RSS 2.0 feed URL (/feed) - 'comments_atom_url' - The comments Atom feed URL (/comments/feed) - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed) Some `$show` values are deprecated and will be removed in future versions. These options will trigger the _deprecated_argument() function. Deprecated arguments include: - 'siteurl' - Use 'url' instead - 'home' - Use 'url' instead @since 0.71 @global string $wp_version The WordPress version string. @param string $show Optional. Site info to retrieve. Default empty (site name). @param string $filter Optional. How to filter what is retrieved. Default 'raw'. @return string Mostly string values, might be empty.
bloginfo([$show='']):
Displays information about the current site. @since 0.71 @see get_bloginfo() For possible `$show` values @param string $show Optional. Site information to display. Default empty.
get_theme_mod($name, [$default=false]):
Retrieves theme modification value for the active theme. If the modification name does not exist and `$default` is a string, then the default will be passed through the {@link https://www.php.net/sprintf sprintf()} PHP function with the template directory URI as the first value and the stylesheet directory URI as the second value. @since 2.1.0 @param string $name Theme modification name. @param mixed $default Optional. Theme modification default value. Default false. @return mixed Theme modification value.
get_theme_support($feature, [...$args]):
Gets the theme support arguments passed when registering that support. Example usage: get_theme_support( 'custom-logo' ); get_theme_support( 'custom-header', 'width' ); @since 3.1.0 @since 5.3.0 Formalized the existing and already documented `...$args` parameter by adding it to the function signature. @global array $_wp_theme_features @param string $feature The feature to check. See add_theme_support() for the list of possible values. @param mixed ...$args Optional extra arguments to be checked against certain features. @return mixed The array of extra arguments or the value for the registered feature.
current_theme_supports($feature, [...$args]):
Checks a theme's support for a given feature. Example usage: current_theme_supports( 'custom-logo' ); current_theme_supports( 'html5', 'comment-form' ); @since 2.9.0 @since 5.3.0 Formalized the existing and already documented `...$args` parameter by adding it to the function signature. @global array $_wp_theme_features @param string $feature The feature being checked. See add_theme_support() for the list of possible values. @param mixed ...$args Optional extra arguments to be checked against certain features. @return bool True if the active theme supports the feature, false otherwise.
wp_head():
Fire the wp_head action. See {@see 'wp_head'}. @since 1.2.0
wp_footer():
Fire the wp_footer action. See {@see 'wp_footer'}. @since 1.5.1
wp_title([$sep='»'], [$display=true], [$seplocation='']):
Display or retrieve page title for all areas of blog. By default, the page title will display the separator before the page title, so that the blog title will be before the page title. This is not good for title display, since the blog title shows up on most tabs and not what is important, which is the page that the user is looking at. There are also SEO benefits to having the blog title after or to the 'right' of the page title. However, it is mostly common sense to have the blog title to the right with most browsers supporting tabs. You can achieve this by using the seplocation parameter and setting the value to 'right'. This change was introduced around 2.5.0, in case backward compatibility of themes is important. @since 1.0.0 @global WP_Locale $wp_locale WordPress date and time locale object. @param string $sep Optional. How to separate the various items within the page title. Default '»'. @param bool $display Optional. Whether to display or retrieve title. Default true. @param string $seplocation Optional. Location of the separator ('left' or 'right'). @return string|void String when `$display` is false, nothing otherwise.
body_class([$class='']):
Displays the class names for the body element. @since 2.8.0 @param string|string[] $class Space-separated string or array of class names to add to the class list.
wp_nav_menu([$args=[]]):
Displays a navigation menu. @since 3.0.0 @since 4.7.0 Added the `item_spacing` argument. @since 5.5.0 Added the `container_aria_label` argument. @param array $args { Optional. Array of nav menu arguments. @type int|string|WP_Term $menu Desired menu. Accepts a menu ID, slug, name, or object. Default empty. @type string $menu_class CSS class to use for the ul element which forms the menu. Default 'menu'. @type string $menu_id The ID that is applied to the ul element which forms the menu. Default is the menu slug, incremented. @type string $container Whether to wrap the ul, and what to wrap it with. Default 'div'. @type string $container_class Class that is applied to the container. Default 'menu-{menu slug}-container'. @type string $container_id The ID that is applied to the container. Default empty. @type string $container_aria_label The aria-label attribute that is applied to the container when it's a nav element. Default empty. @type callable|false $fallback_cb If the menu doesn't exist, a callback function will fire. Default is 'wp_page_menu'. Set to false for no fallback. @type string $before Text before the link markup. Default empty. @type string $after Text after the link markup. Default empty. @type string $link_before Text before the link text. Default empty. @type string $link_after Text after the link text. Default empty. @type bool $echo Whether to echo the menu or return it. Default true. @type int $depth How many levels of the hierarchy are to be included. 0 means all. Default 0. Default 0. @type object $walker Instance of a custom walker class. Default empty. @type string $theme_location Theme location to be used. Must be registered with register_nav_menu() in order to be selectable by the user. @type string $items_wrap How the list items should be wrapped. Uses printf() format with numbered placeholders. Default is a ul with an id and class. @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'. } @return void|string|false Void if 'echo' argument is true, menu output if 'echo' is false. False if there are no items or no menu was found.
site_url([$path=''], [$scheme=NULL]):
Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. Returns the 'site_url' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden. @since 3.0.0 @param string $path Optional. Path relative to the site URL. Default empty. @param string|null $scheme Optional. Scheme to give the site URL context. See set_url_scheme(). @return string Site URL link with optional path appended.
network_site_url([$path=''], [$scheme=NULL]):
Retrieves the site URL for the current network. Returns the site URL with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden. @since 3.0.0 @see set_url_scheme() @param string $path Optional. Path relative to the site URL. Default empty. @param string|null $scheme Optional. Scheme to give the site URL context. Accepts 'http', 'https', or 'relative'. Default null. @return string Site URL link with optional path appended.
home_url([$path=''], [$scheme=NULL]):
Retrieves the URL for the current site where the front end is accessible. Returns the 'home' option with the appropriate protocol. The protocol will be 'https' if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. If `$scheme` is 'http' or 'https', is_ssl() is overridden. @since 3.0.0 @param string $path Optional. Path relative to the home URL. Default empty. @param string|null $scheme Optional. Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null. Default null. @return string Home URL link with optional path appended.
admin_url([$path=''], [$scheme='admin']):
Retrieves the URL to the admin area for the current site. @since 2.6.0 @param string $path Optional. Path relative to the admin URL. Default 'admin'. @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes. @return string Admin URL link with optional path appended.
is_user_logged_in():
Determines whether the current visitor is a logged in user. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. @since 2.0.0 @return bool True if user is logged in, false if not logged in.
wp_logout_url([$redirect='']):
Retrieves the logout URL. Returns the URL that allows the user to log out of the site. @since 2.7.0 @param string $redirect Path to redirect to on logout. @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().
wp_login_url([$redirect=''], [$force_reauth=false]):
Retrieves the login URL. @since 2.7.0 @param string $redirect Path to redirect to on log in. @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default false. @return string The login URL. Not HTML-encoded.
current_user_can($capability, [...$args]):
Returns whether the current user has the specified capability. This function also accepts an ID of an object to check against if the capability is a meta capability. Meta capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`. Example usage: current_user_can( 'edit_posts' ); current_user_can( 'edit_post', $post->ID ); current_user_can( 'edit_post_meta', $post->ID, $meta_key ); While checking against particular roles in place of a capability is supported in part, this practice is discouraged as it may produce unreliable results. Note: Will always return true if the current user is a super admin, unless specifically denied. @since 2.0.0 @since 5.3.0 Formalized the existing and already documented `...$args` parameter by adding it to the function signature. @since 5.8.0 Converted to wrapper for the user_can() function. @see WP_User::has_cap() @see map_meta_cap() @param string $capability Capability name. @param mixed ...$args Optional further parameters, typically starting with an object ID. @return bool Whether the current user has the given capability. If `$capability` is a meta cap and `$object_id` is passed, whether the current user has the given meta capability for the given object.
wp_remote_request($url, [$args=[]]):
Performs an HTTP request and returns its response. There are other API functions available which abstract away the HTTP method: - Default 'GET' for wp_remote_get() - Default 'POST' for wp_remote_post() - Default 'HEAD' for wp_remote_head() @since 2.7.0 @see WP_Http::request() For information on default arguments. @param string $url URL to retrieve. @param array $args Optional. Request arguments. Default empty array. @return array|WP_Error { The response array or a WP_Error on failure. @type string[] $headers Array of response headers keyed by their name. @type string $body Response body. @type array $response { Data about the HTTP response. @type int|false $code HTTP response code. @type string|false $message HTTP response message. } @type WP_HTTP_Cookie[] $cookies Array of response cookies. @type WP_HTTP_Requests_Response|null $http_response Raw HTTP response object. }
language_slug():
Retrieve the current language slug @return string Current language slug
translate($strings, [$defaultLocale='en']):
Selects a string from the list of strings using the current language slug as the key @param array $strings Translation strings in the format [{'slug_1'=>'Translation 1'},{'slug_N'=>'Translation N'}] @param string $defaultLocale Default locale to choose if the current language slug is not found @return string
credits([$creditsString=''], [$year=NULL], [$repeat=true]):
Formats a credits string to be used on the page footer @param string $creditsString Copyright string @param int $year The year the project was published @param bool $repeat @return string Credits string
is_wp_error($thing):
Checks whether the given variable is a WordPress Error. Returns whether `$thing` is an instance of the `WP_Error` class. @since 2.1.0 @param mixed $thing The variable to check. @return bool Whether the variable is an instance of WP_Error.
is_module_enabled([string $module='']):
Check if the given module is enabled or not @param string $module Module name @return bool Module state
uses_page_builder([int $postId=0]):
Check if the given post uses a page builder or not @param int|\WP_Post $postId @return bool
get_template_directory_uri():
Retrieves template directory URI for the active theme. @since 1.5.0 @return string URI to active theme's template directory.
get_stylesheet_directory_uri():
Retrieves stylesheet directory URI for the active theme. @since 1.5.0 @return string URI to active theme's stylesheet directory.
pt_IPLeiria_UED_WP_Theme_IPLeiria_Bootstrap_MegaMenu_Bootstrap_MegaMenu__isMegaMenuEnabledFor([$location='primary']):
Check if the megamenu is enabled for the given menu (location) @return boolean true if megamenu is enabled for the given location, false otherwise
Bootstrap_MegaMenu_Bootstrap_MegaMenu__isMegaMenuEnabledFor([$location='primary']):
Check if the megamenu is enabled for the given menu (location) @return boolean true if megamenu is enabled for the given location, false otherwise
isMegaMenuEnabledFor([$location='primary']):
Check if the megamenu is enabled for the given menu (location) @return boolean true if megamenu is enabled for the given location, false otherwise
pt_IPLeiria_UED_WP_Theme_IPLeiria_CacheManager__addScriptContent($content, [$type='js'], [$section='footer']):
Adds the script content to the specified section with the specified type @param string $content @param string $type @param string $section
CacheManager__addScriptContent($content, [$type='js'], [$section='footer']):
Adds the script content to the specified section with the specified type @param string $content @param string $type @param string $section
pt_IPLeiria_UED_WP_Theme_IPLeiria_CacheManager__enqueueScript($script):
Enqueue a JavaScript file on the cache manager queue or mark it for loading (if it was previously registered with \pt\IPLeiria\UED\WP\Theme\IPLeiria\CacheManager::register_script() @param string $script Handle of the script to be loaded
CacheManager__enqueueScript($script):
Enqueue a JavaScript file on the cache manager queue or mark it for loading (if it was previously registered with \pt\IPLeiria\UED\WP\Theme\IPLeiria\CacheManager::register_script() @param string $script Handle of the script to be loaded
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getThemeCoordinator():
Credits__getThemeCoordinator():
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getThemeDesigner():
Credits__getThemeDesigner():
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getThemeDeveloper():
Credits__getThemeDeveloper():
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getThemeName():
Credits__getThemeName():
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getThemeVersion():
Credits__getThemeVersion():
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getContentAuthors([$linkFormat='<a href="%1$s" title="%2$s" rel="author">%3$s</a>']):
Credits__getContentAuthors([$linkFormat='<a href="%1$s" title="%2$s" rel="author">%3$s</a>']):
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getCreditsString([$string=''], [$initialDate=NULL], [$doAgain=true]):
Credits__getCreditsString([$string=''], [$initialDate=NULL], [$doAgain=true]):
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getWorpressPlugins([$linkFormat='<a href="%1$s" title="%2$s" rel="external noreferrer noopener" target="_blank">%3$s</a>']):
Credits__getWorpressPlugins([$linkFormat='<a href="%1$s" title="%2$s" rel="external noreferrer noopener" target="_blank">%3$s</a>']):
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getSystemOS():
Retrieve the system OS @return string
Credits__getSystemOS():
Retrieve the system OS @return string
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getSystemServer():
Retrieve the system Web Server @return string
Credits__getSystemServer():
Retrieve the system Web Server @return string
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getSystemPHPVersion([$versionFormat='%1$d.%2$d']):
Retrieve the PHP version information @param string $versionFormat Version format where %1$d is the PHP_MAJOR_VERSION, %2$d is PHP_MINOR_VERSION and %3$d is PHP_RELEASE_VERSION @return string
Credits__getSystemPHPVersion([$versionFormat='%1$d.%2$d']):
Retrieve the PHP version information @param string $versionFormat Version format where %1$d is the PHP_MAJOR_VERSION, %2$d is PHP_MINOR_VERSION and %3$d is PHP_RELEASE_VERSION @return string
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getPlatformVersion():
Retrieve the platform (WordPress) version @return string
Credits__getPlatformVersion():
Retrieve the platform (WordPress) version @return string
pt_IPLeiria_UED_WP_Theme_IPLeiria_Credits__getThemeVariable($varName, [$stylesheet=NULL]):
Retrieve theme metadata
Credits__getThemeVariable($varName, [$stylesheet=NULL]):
Retrieve theme metadata
has_header_image():
Checks whether a header image is set or not. @since 4.2.0 @see get_header_image() @return bool Whether a header image is set or not.
get_header_image():
Retrieves header image for custom header. @since 2.1.0 @return string|false
get_header_image_tag([$attr=[]]):
Creates image tag markup for a custom header image. @since 4.4.0 @param array $attr Optional. Additional attributes for the image tag. Can be used to override the default attributes. Default empty. @return string HTML image element markup or empty string on failure.
is_random_header_image([$type='any']):
Checks if random header image is in use. Always true if user expressly chooses the option in Appearance > Header. Also true if theme has multiple header images registered, no specific header image is chosen, and theme turns on random headers with add_theme_support(). @since 3.2.0 @param string $type The random pool to use. Possible values include 'any', 'default', 'uploaded'. Default 'any'. @return bool
get_random_header_image():
Gets random header image URL from registered images in theme. @since 3.2.0 @return string Path to header image.
get_uploaded_header_images():
Gets the header images uploaded for the active theme. @since 3.2.0 @return array
has_header_video():
Checks whether a header video is set or not. @since 4.7.0 @see get_header_video_url() @return bool Whether a header video is set or not.
get_header_video_url():
Retrieves header video URL for custom header. Uses a local video if present, or falls back to an external video. @since 4.7.0 @return string|false Header video URL or false if there is no video.
get_header_video_settings():
Retrieves header video settings. @since 4.7.0 @return array
has_custom_header():
Checks whether a custom header is set or not. @since 4.7.0 @return bool True if a custom header is set. False if not.
is_header_video_active():
Checks whether the custom header video is eligible to show on the current page. @since 4.7.0 @return bool True if the custom header video should be shown. False if not.
get_custom_header():
Gets the header image data. @since 3.4.0 @global array $_wp_default_headers @return object
get_custom_header_markup():
Print the markup for a custom header. A container div will always be printed in the Customizer preview. @since 4.7.0
pt_IPLeiria_UED_WP_Theme_IPLeiria_CustomHeader__getAttachmentImages($attachment_id, [$size='full'], [$image_meta=NULL]):
Retrieves the value for an image attachment's 'srcset' attribute. @since 4.4.0 @see wp_get_attachment_image_srcset() @param int $attachment_id Image attachment ID. @param array|string $size Optional. Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'full'. @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. Default null. @return array|bool A 'srcset' value array or false.
CustomHeader__getAttachmentImages($attachment_id, [$size='full'], [$image_meta=NULL]):
Retrieves the value for an image attachment's 'srcset' attribute. @since 4.4.0 @see wp_get_attachment_image_srcset() @param int $attachment_id Image attachment ID. @param array|string $size Optional. Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'full'. @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. Default null. @return array|bool A 'srcset' value array or false.
pt_IPLeiria_UED_WP_Theme_IPLeiria_CustomPostFields__getField([$field_slug=NULL], [$wrap_with='%s'], [$post_id=0], [$args=[]]):
Render a field value @param string $field_slug @param string $wrap_with @param int $post_id @param array $args @return string
CustomPostFields__getField([$field_slug=NULL], [$wrap_with='%s'], [$post_id=0], [$args=[]]):
Render a field value @param string $field_slug @param string $wrap_with @param int $post_id @param array $args @return string
pt_IPLeiria_UED_WP_Theme_IPLeiria_Language__getCurrentLanguage([$default=''], [$type='slug']):
Get the given type value for the current language or $default @param string $default the default value to return if the translation module is not found @param string $type the type of the value to get for the current language @return string with the type value for the current language
Language__getCurrentLanguage([$default=''], [$type='slug']):
Get the given type value for the current language or $default @param string $default the default value to return if the translation module is not found @param string $type the type of the value to get for the current language @return string with the type value for the current language
pt_IPLeiria_UED_WP_Theme_IPLeiria_Language__getLanguages([$args=[]]):
Get the site languages @param array $args extra arguments for the multilang function @return array with the site languages @see setLanguages for $args reference
Language__getLanguages([$args=[]]):
Get the site languages @param array $args extra arguments for the multilang function @return array with the site languages @see setLanguages for $args reference
pt_IPLeiria_UED_WP_Theme_IPLeiria_Language__getAllLanguages([$args=[]]):
Get the site languages (including the empty ones) @param array $args extra arguments for the multilang function @return array with the site languages @see setLanguages for $args reference
Language__getAllLanguages([$args=[]]):
Get the site languages (including the empty ones) @param array $args extra arguments for the multilang function @return array with the site languages @see setLanguages for $args reference
pt_IPLeiria_UED_WP_Theme_IPLeiria_Language__getLanguageSelector():
Generates the HTML for a language selector @return string with the generated HTML
Language__getLanguageSelector():
Generates the HTML for a language selector @return string with the generated HTML
has_post_thumbnail([$post=NULL]):
Determines whether a post has an image attached. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. @since 2.9.0 @since 4.4.0 `$post` can be a post ID or WP_Post object. @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. @return bool Whether the post has an image attached.
get_the_post_thumbnail([$post=NULL], [$size='post-thumbnail'], [$attr='']):
Retrieves the post thumbnail. When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size is registered, which differs from the 'thumbnail' image size managed via the Settings > Media screen. When using the_post_thumbnail() or related functions, the 'post-thumbnail' image size is used by default, though a different size can be specified instead as needed. @since 2.9.0 @since 4.4.0 `$post` can be a post ID or WP_Post object. @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'post-thumbnail'. @param string|array $attr Optional. Query string or array of attributes. Default empty. @return string The post thumbnail image tag.
the_post_thumbnail([$size='post-thumbnail'], [$attr='']):
Displays the post thumbnail. When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size is registered, which differs from the 'thumbnail' image size managed via the Settings > Media screen. When using the_post_thumbnail() or related functions, the 'post-thumbnail' image size is used by default, though a different size can be specified instead as needed. @since 2.9.0 @see get_the_post_thumbnail() @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'post-thumbnail'. @param string|array $attr Optional. Query string or array of attributes. Default empty.
get_the_post_thumbnail_url([$post=NULL], [$size='post-thumbnail']):
Returns the post thumbnail URL. @since 4.4.0 @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. @param string|int[] $size Optional. Registered image size to retrieve the source for or a flat array of height and width dimensions. Default 'post-thumbnail'. @return string|false Post thumbnail URL or false if no image is available. If `$size` does not match any registered image size, the original image URL will be returned.
the_post_thumbnail_url([$size='post-thumbnail']):
Displays the post thumbnail URL. @since 4.4.0 @param string|int[] $size Optional. Image size to use. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'post-thumbnail'.
get_the_post_thumbnail_caption([$post=NULL]):
Returns the post thumbnail caption. @since 4.6.0 @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. @return string Post thumbnail caption.
get_post_thumbnail_id([$post=NULL]):
Retrieves the post thumbnail ID. @since 2.9.0 @since 4.4.0 `$post` can be a post ID or WP_Post object. @since 5.5.0 The return value for a non-existing post was changed to false instead of an empty string. @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. @return int|false Post thumbnail ID (which can be 0 if the thumbnail is not set), or false if the post does not exist.
get_the_post_thumbnail_attributes([$post=NULL], [$size='post-thumbnail'], [$attributes=[]]):
get_the_target([$post_id=0], [$default='']):
the_target([$post_id=0], [$default='']):