[ Index ]

PHP Cross Reference of BackPress




/includes/ -> functions.core.php (summary)

From WP wp-includes/functions.php Missing functions are indicated in comments

File Size: 1310 lines (34 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 41 functions


Functions that are not part of a class:

current_time( $type, $gmt = 0 )   X-Ref
Retrieve the current time based on specified type.

The 'mysql' type will return the time in the format for MySQL DATETIME field.
The 'timestamp' type will return the current timestamp.

If $gmt is set to either '1' or 'true', then both types will use GMT time.
if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.

param: string $type Either 'mysql' or 'timestamp'.
param: int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
return: int|string String if $type is 'gmt', int if $type is 'timestamp'.
since: 1.0.0

maybe_unserialize( $original )   X-Ref
Unserialize value only if it was serialized.

param: string $original Maybe unserialized original, if is needed.
return: mixed Unserialized data can be any type.
since: 2.0.0

is_serialized( $data )   X-Ref
Check value to find if it was serialized.

If $data is not an string, then returned value will always be false.
Serialized data is always a string.

param: mixed $data Value to check to see if was serialized.
return: bool False if not serialized and true if it was.
since: 2.0.5

is_serialized_string( $data )   X-Ref
Check whether serialized data is of string type.

param: mixed $data Serialized data
return: bool False if not a serialized string, true if it is.
since: 2.0.5

maybe_serialize( $data )   X-Ref
Serialize data, if needed.

param: mixed $data Data that might be serialized.
return: mixed A scalar data
since: 2.0.5

build_query( $data )   X-Ref
Build URL query based on an associative and, or indexed array.

This is a convenient function for easily building url queries. It sets the
separator to '&' and uses _http_build_query() function.

param: array $data URL-encode key/value pairs.
return: string URL encoded string
since: 2.3.0

add_query_arg()   X-Ref
Retrieve a modified URL query string.

You can rebuild the URL and append a new query variable to the URL query by
using this function. You can also retrieve the full URL with query data.

Adding a single key & value or an associative array. Setting a key value to
emptystring removes the key. Omitting oldquery_or_uri uses the $_SERVER

param: mixed $param1 Either newkey or an associative_array
param: mixed $param2 Either newvalue or oldquery or uri
param: mixed $param3 Optional. Old query or uri
return: string New URL query string.
since: 1.5.0

remove_query_arg( $key, $query=false )   X-Ref
Removes an item or list from the query string.

param: string|array $key Query key or keys to remove.
param: bool $query When false uses the $_SERVER value.
return: string New URL query string.
since: 1.5.0

wp_remote_fopen( $uri )   X-Ref
HTTP request for URI to retrieve content.

param: string $uri URI/URL of web page to retrieve.
return: bool|string HTTP content. False on failure.
since: 1.5.1

get_status_header_desc( $code )   X-Ref
Retrieve the description for the HTTP status.

param: int $code HTTP status code.
return: string Empty string if not found, or description if found.
since: 2.3.0

status_header( $header )   X-Ref
Set HTTP status header.

param: int $header HTTP status code
return: null Does not return anything.
since: 2.0.0

wp_get_nocache_headers()   X-Ref
Gets the header information to prevent caching.

The several different headers cover the different ways cache prevention is handled
by different browsers

return: array The associative array of header names and field values.
since: 2.8

nocache_headers()   X-Ref
Sets the headers to prevent caching for the different browsers.

Different browsers support different nocache headers, so several headers must
be sent so that all of them get the point that no caching should occur.

since: 2.0.0

cache_javascript_headers()   X-Ref
Set the headers for caching for 10 days with JavaScript content type.

since: 2.1.0

wp_referer_field( $echo = true)   X-Ref
Retrieve or display referer hidden field for forms.

The referer link is the current Request URI from the server super global. The
input name is '_wp_http_referer', in case you wanted to check manually.

param: bool $echo Whether to echo or return the referer field.
return: string Referer field.
since: 2.0.4

wp_original_referer_field( $echo = true, $jump_back_to = 'current' )   X-Ref
Retrieve or display original referer hidden field for forms.

The input name is '_wp_original_http_referer' and will be either the same
value of {@link wp_referer_field()}, if that was posted already or it will
be the current page, if it doesn't exist.

param: bool $echo Whether to echo the original http referer
param: string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to.
return: string Original referer field.
since: 2.0.4

wp_get_referer()   X-Ref
Retrieve referer from '_wp_http_referer', HTTP referer, or current page respectively.

return: string|bool False on failure. Referer URL on success.
since: 2.0.4

wp_get_original_referer()   X-Ref
Retrieve original referer that was posted, if it exists.

return: string|bool False if no original referer or original referer if set.
since: 2.0.4

wp_parse_args( $args, $defaults = '' )   X-Ref
Merge user defined arguments into defaults array.

This function is used throughout WordPress to allow for both string or array
to be merged into another array.

param: string|array $args Value to merge with $defaults
param: array $defaults Array that serves as the defaults.
return: array Merged user defined values with defaults.
since: 2.2.0

absint( $maybeint )   X-Ref
Converts value to nonnegative integer.

param: mixed $maybeint Data you wish to have convered to an nonnegative integer
return: int An nonnegative integer
since: 2.5.0

is_lighttpd_before_150()   X-Ref
Is the server running earlier than 1.5.0 version of lighttpd

return: bool Whether the server is running lighttpd < 1.5.0
since: 2.5.0

apache_mod_loaded($mod, $default = false)   X-Ref
Does the specified module exist in the apache config?

param: string $mod e.g. mod_rewrite
param: bool $default The default return value if the module is not found
return: bool
since: 2.5.0

validate_file( $file, $allowed_files = '' )   X-Ref
File validates against allowed set of defined rules.

A return value of '1' means that the $file contains either '..' or './'. A
return value of '2' means that the $file contains ':' after the first
character. A return value of '3' means that the file is not in the allowed
files list.

param: string $file File path.
param: array $allowed_files List of allowed files.
return: int 0 means nothing is wrong, greater than 0 means something was wrong.
since: 1.2.0

is_ssl()   X-Ref
Determine if SSL is used.

return: bool True if SSL, false if not used.
since: 2.6.0

force_ssl_login($force = '')   X-Ref
Whether SSL login should be forced.

param: string|bool $force Optional.
return: bool True if forced, false if not forced.
since: 2.6.0

force_ssl_admin($force = '')   X-Ref
Whether to force SSL used for the Administration Panels.

param: string|bool $force
return: bool True if forced, false if not forced.
since: 2.6.0

wp_timezone_override_offset()   X-Ref
gmt_offset modification for smart timezone handling

Overrides the gmt_offset option if we have a timezone_string available

wp_timezone_supported()   X-Ref
Check for PHP timezone support

_wp_timezone_choice_usort_callback( $a, $b )   X-Ref
No description

wp_timezone_choice( $selected_zone )   X-Ref
Gives a nicely formatted list of timezone strings // temporary! Not in final

param: $selected_zone string Selected Zone

_cleanup_header_comment($str)   X-Ref
Strip close comment and close php tags from file headers used by WP
See http://core.trac.wordpress.org/ticket/8497

since: 2.8

__return_true()   X-Ref
Returns true.

Useful for returning true to filters easily.

return: bool true
since: 3.0.0

__return_false()   X-Ref
Returns false.

Useful for returning false to filters easily.

return: bool false
since: 3.0.0

__return_zero()   X-Ref
Returns 0.

Useful for returning 0 to filters easily.

return: int 0
since: 3.0.0

__return_empty_array()   X-Ref
Returns an empty array.

Useful for returning an empty array to filters easily.

return: array Empty array
since: 3.0.0

__return_null()   X-Ref
Returns null.

Useful for returning null to filters easily.

return: null
since: 3.4.0

wp_clone( $object )   X-Ref
Copy an object.

Returns a cloned copy of an object.

param: object $object The object to clone
return: object The cloned object
since: 2.7.0

backpress_gmt_strtotime( $string )   X-Ref
BackPress only below

backpress_convert_object( &$object, $output )   X-Ref
No description

backpress_die( $message, $title = '', $args = array()   X-Ref
Kill BackPress execution and display HTML message with error message.

This function calls the die() PHP function. The difference is that a message
in HTML will be displayed to the user. It is recommended to use this function
only when the execution should not continue any further. It is not
recommended to call this function very often and normally you should try to
handle as many errors as possible silently.

param: string $message Error message.
param: string $title Error title.
param: string|array $args Optional arguments to control behaviour.

backpress_set_cookie()   X-Ref
Acts the same as core PHP setcookie() but its arguments are run through the backpress_set_cookie filter.

If the filter returns false, setcookie() isn't called.

Generated: Tue Feb 19 01:01:37 2019 Cross-referenced by PHPXref 0.7.1