wpseek.com
A WordPress-centric search engine for devs and theme authors

wp-includes/functions.php › WordPress File

Functions187

› Main WordPress API

Function	Short description
absint	Convert a value to non-negative integer.
add_magic_quotes	Walks the array while sanitizing the contents.
add_query_arg	Retrieves a modified URL query string.
apache_mod_loaded	Does the specified module exist in the Apache config?
bool_from_yn	Whether input is yes or no.
build_query	Build URL query based on an associative and, or indexed array.
cache_javascript_headers	Set the headers for caching for 10 days with JavaScript content type.
current_datetime	Retrieves the current time as an object with the timezone from settings.
current_time	Retrieves the current time based on specified type.
date_i18n	Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.
dead_db	Load custom DB error or display WordPress DB error.
do_enclose	Check content for video and audio links to add as enclosures.
do_feed	Load the feed template from the use of an action hook.
do_feed_atom	Load either Atom comment feed or Atom posts feed.
do_feed_rdf	Load the RDF RSS 0.91 Feed template.
do_feed_rss	Load the RSS 1.0 Feed Template.
do_feed_rss2	Load either the RSS2 comment feed or the RSS2 posts feed.
do_robots	Displays the default robots.txt file content.
force_ssl_admin	Whether to force SSL used for the Administration Screens.
get_allowed_mime_types	Retrieve list of allowed mime types and file extensions.
get_dirsize	Get the size of a directory.
get_file_data	Retrieve metadata from a file.
get_main_network_id	Get the main network ID.
get_main_site_id	Gets the main site ID.
get_num_queries	Retrieve the number of database queries during the WordPress execution.
get_status_header_desc	Retrieve the description for the HTTP status.
get_tag_regex	Return RegEx body to liberally match an opening HTML tag.
get_temp_dir	Determine a writable directory for temporary files.
get_weekstartend	Get the week start and end from the datetime or date string from MySQL.
global_terms_enabled	Determine whether global terms are enabled.
human_readable_duration	Convert a duration to human readable format.
iis7_supports_permalinks	Check if IIS 7+ supports pretty permalinks.
is_blog_installed	Determines whether WordPress is already installed.
is_lighttpd_before_150	Is the server running earlier than 1.5.0 version of lighttpd?
is_main_network	Determine whether a network is the main network of the Multisite installation.
is_main_site	Determine whether a site is the main site of the current network.
is_new_day	Determines whether the publish date of the current post in the loop is different from the publish date of the previous post in the loop.
is_php_version_compatible	Checks compatibility with the current PHP version.
is_serialized	Check value to find if it was serialized.
is_serialized_string	Check whether serialized data is of string type.
is_site_meta_supported	Determines whether site meta is enabled.
is_wp_version_compatible	Checks compatibility with the current WordPress version.
maybe_serialize	Serialize data, if needed.
maybe_unserialize	Unserialize value only if it was serialized.
mbstring_binary_safe_encoding	Set the mbstring internal encoding to a binary safe encoding when func_overload is enabled.
mysql2date	Convert given MySQL date string into a different format.
mysql_to_rfc3339	Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601 (Y-m-d\TH:i:s).
nocache_headers	Set the headers to prevent caching for the different browsers.
number_format_i18n	Convert float number to format based on the locale.
path_is_absolute	Test if a given filesystem path is absolute.
path_join	Join two filesystem paths together.
recurse_dirsize	Get the size of a directory recursively.
remove_query_arg	Removes an item or items from a query string.
reset_mbstring_encoding	Reset the mbstring internal encoding to a users previously set encoding.
send_frame_options_header	Send a HTTP header to limit rendering of pages to same origin iframes.
send_nosniff_header	Send a HTTP header to disable content type sniffing in browsers which support it.
size_format	Convert number of bytes largest unit bytes will fit into.
smilies_init	Convert smiley code to the icon graphic file equivalent.
status_header	Set HTTP status header.
validate_file	Validates a file name and path against an allowed set of rules.
win_is_writable	Workaround for Windows bug in is_writable() function
wp	Set up the WordPress query.
wp_allowed_protocols	Retrieve a list of protocols to allow in HTML attributes.
wp_array_slice_assoc	Extract a slice of an array, given a list of keys.
wp_auth_check	Check whether a user is still logged in, for the heartbeat.
wp_auth_check_html	Output the HTML that shows the wp-login dialog when the user is no longer logged in.
wp_auth_check_load	Load the auth check for monitoring whether the user is still logged in.
wp_cache_get_last_changed	Get last changed date for the specified cache group.
wp_checkdate	Test if the supplied date is valid for the Gregorian calendar.
wp_check_filetype	Retrieve the file type from the file name.
wp_check_filetype_and_ext	Attempt to determine the real file type of a file.
wp_check_jsonp_callback	Checks that a JSONP callback is a valid JavaScript callback.
wp_date	Retrieves the date, in localized format.
wp_debug_backtrace_summary	Return a comma-separated string of functions that have been called to get to the current point in code.
wp_delete_file	Delete a file
wp_delete_file_from_directory	Deletes a file if its path is within the given directory.
wp_die	Kills WordPress execution and displays HTML page with an error message.
wp_direct_php_update_button	Display a button directly linking to a PHP update process.
wp_ext2type	Retrieve the file type based on the extension name.
wp_extract_urls	Use RegEx to extract URLs from arbitrary content.
wp_filter_object_list	Filters a list of objects, based on a set of key => value arguments.
wp_find_hierarchy_loop	Find hierarchy loops using a callback function that maps object IDs to parent IDs.
wp_find_hierarchy_loop_tortoise_hare	Use the "The Tortoise and the Hare" algorithm to detect loops.
wp_fuzzy_number_match	Check if two numbers are nearly the same.
wp_generate_uuid4	Generate a random UUID (version 4).
wp_get_default_update_php_url	Gets the default URL to learn more about updating the PHP version the site is running on.
wp_get_direct_php_update_url	Gets the URL for directly updating the PHP version the site is running on.
wp_get_ext_types	Retrieves the list of common file extensions and their types.
wp_get_http_headers	Retrieve HTTP Headers from URL.
wp_get_image_mime	Returns the real mime type of an image file.
wp_get_mime_types	Retrieve list of mime types and file extensions.
wp_get_nocache_headers	Get the header information to prevent caching.
wp_get_original_referer	Retrieve original referer that was posted, if it exists.
wp_get_raw_referer	Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
wp_get_referer	Retrieve referer from '_wp_http_referer' or HTTP referer.
wp_get_update_php_annotation	Returns the default annotation for the web hosting altering the "Update PHP" page URL.
wp_get_update_php_url	Gets the URL to learn more about updating the PHP version the site is running on.
wp_get_upload_dir	Retrieves uploads directory information.
wp_guess_url	Guess the URL for the site.
wp_is_numeric_array	Determines if the variable is a numeric-indexed array.
wp_is_stream	Test if a given path is a stream URL
wp_is_uuid	Validates that a UUID is valid.
wp_is_writable	Determine if a directory is writable.
wp_json_encode	Encode a variable into JSON, with some sanity checks.
wp_list_filter	Filters a list of objects, based on a set of key => value arguments.
wp_list_pluck	Pluck a certain field out of each object in a list.
wp_list_sort	Sorts a list of objects, based on one or more orderby arguments.
wp_maybe_decline_date	Determines if the date should be declined.
wp_maybe_load_widgets	Determines if Widgets library should be loaded.
wp_mkdir_p	Recursive directory creation based on full path.
wp_nonce_ays	Display "Are You Sure" message to confirm the action being taken.
wp_nonce_field	Retrieve or display nonce hidden field for forms.
wp_nonce_url	Retrieve URL with nonce added to URL query.
wp_normalize_path	Normalize a filesystem path.
wp_ob_end_flush_all	Flush all output buffers for PHP 5.2.
wp_original_referer_field	Retrieve or display original referer hidden field for forms.
wp_parse_args	Merge user defined arguments into defaults array.
wp_parse_id_list	Clean up an array, comma- or space-separated list of IDs.
wp_parse_list	Cleans up an array, comma- or space-separated list of scalar values.
wp_parse_slug_list	Clean up an array, comma- or space-separated list of slugs.
wp_post_preview_js	Outputs a small JS snippet on preview tabs/windows to remove `window.name` on unload.
wp_privacy_anonymize_data	Return uniform "anonymous" data by type.
wp_privacy_anonymize_ip	Return an anonymized IPv4 or IPv6 address.
wp_privacy_delete_old_export_files	Cleans up export files older than three days old.
wp_privacy_exports_dir	Returns the directory used to store personal data export files.
wp_privacy_exports_url	Returns the URL of the directory used to store personal data export files.
wp_raise_memory_limit	Attempts to raise the PHP memory limit for memory intensive processes.
wp_referer_field	Retrieve or display referer hidden field for forms.
wp_remote_fopen	HTTP request for URI to retrieve content.
wp_removable_query_args	Returns an array of single-use query variable names that can be removed from a URL.
wp_scheduled_delete	Permanently delete comments or posts of any type that have held a status of 'trash' for the number of days defined in EMPTY_TRASH_DAYS.
wp_schedule_delete_old_privacy_export_files	Schedule a `WP_Cron` job to delete expired export files.
wp_send_json	Send a JSON response back to an Ajax request.
wp_send_json_error	Send a JSON response back to an Ajax request, indicating failure.
wp_send_json_success	Send a JSON response back to an Ajax request, indicating success.
wp_site_admin_email_change_notification	Send an email to the old site admin email address when the site admin email address changes.
wp_suspend_cache_addition	Temporarily suspend cache additions.
wp_suspend_cache_invalidation	Suspend cache invalidation.
wp_timezone	Retrieves the timezone from site settings as a `DateTimeZone` object.
wp_timezone_choice	Gives a nicely-formatted list of timezone strings.
wp_timezone_override_offset	gmt_offset modification for smart timezone handling.
wp_timezone_string	Retrieves the timezone from site settings as a string.
wp_unique_filename	Get a filename that is sanitized and unique for the given directory.
wp_unique_id	Get unique ID.
wp_update_php_annotation	Prints the default annotation for the web host altering the "Update PHP" page URL.
wp_upload_bits	Create a file in the upload folder with given content.
wp_upload_dir	Returns an array containing the current upload directory's path and URL.
wp_validate_boolean	Filter/validate a variable as a boolean.
wp_widgets_add_menu	Append the Widgets menu to the themes main menu.
xmlrpc_getpostcategory	Retrieve the post category or categories from XMLRPC XML.
xmlrpc_getposttitle	Retrieve post title from XMLRPC XML.
xmlrpc_removepostdata	XMLRPC XML content without title and category elements.
_ajax_wp_die_handler	Kills WordPress execution and displays Ajax response with an error message.
_canonical_charset	Retrieve a canonical form of the provided charset appropriate for passing to PHP functions such as htmlspecialchars() and charset html attributes.
_cleanup_header_comment	Strip close comment and close php tags from file headers used by WP.
_config_wp_home	Retrieve the WordPress home page URL.
_config_wp_siteurl	Retrieve the WordPress site URL.
_default_wp_die_handler	Kills WordPress execution and displays HTML page with an error message.
_delete_option_fresh_site	Delete the fresh site option.
_deprecated_argument	Mark a function argument as deprecated and inform when it has been used.
_deprecated_constructor	Marks a constructor as deprecated and informs when it has been used.
_deprecated_file	Mark a file as deprecated and inform when it has been used.
_deprecated_function	Mark a function as deprecated and inform when it has been used.
_deprecated_hook	Marks a deprecated action or filter hook as deprecated and throws a notice.
_device_can_upload	Test if the current device has the capability to upload files.
_doing_it_wrong	Mark something as being incorrectly called.
_get_non_cached_ids	Retrieve IDs that are not already present in the cache.
_http_build_query	From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
_jsonp_wp_die_handler	Kills WordPress execution and displays JSONP response with an error message.
_json_wp_die_handler	Kills WordPress execution and displays JSON response with an error message.
_mce_set_direction	Set the localized direction for MCE plugin.
_scalar_wp_die_handler	Kills WordPress execution and displays an error message.
_wp_die_process_input	Processes arguments passed to wp_die() consistently for its handlers.
_wp_json_convert_string	Convert a string to UTF-8, so that it can be safely encoded to JSON.
_wp_json_prepare_data	Prepares response data to be serialized to JSON.
_wp_json_sanity_check	Perform sanity checks on data that shall be encoded to JSON.
_wp_mysql_week	Return a MySQL expression for selecting the week number based on the start_of_week option.
_wp_timezone_choice_usort_callback	Sort-helper for timezones.
_wp_upload_dir	A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
_xmlrpc_wp_die_handler	Kills WordPress execution and displays XML response with an error message.
_xml_wp_die_handler	Kills WordPress execution and displays XML response with an error message.
__return_empty_array	Returns an empty array.
__return_empty_string	Returns an empty string.
__return_false	Returns false.
__return_null	Returns null.
__return_true	Returns true.
__return_zero	Returns 0.