diff --git a/js/autocomplete.wordpress.js b/js/autocomplete.wordpress.js
index a8ba33c..079b486 100644
--- a/js/autocomplete.wordpress.js
+++ b/js/autocomplete.wordpress.js
@@ -1 +1,2 @@
-var autocomplete_wordpress = jQuery.parseJSON( '{"add_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key"},{"required":"yes","param":"string $meta_value Metadata value"},{"required":"no","param":"bool $unique Optional, default is false. Whether the specified metadata key should be unique for the object. If true, and the object already has a value for the specified metadata key, no change will be made"}],"desc":"Add metadata for the specified object.","returns":"bool The meta ID on successful update, false on failure."},"update_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key"},{"required":"yes","param":"string $meta_value Metadata value"},{"required":"no","param":"string $prev_value Optional. If specified, only update existing metadata entries with the specified value. Otherwise, update all entries."}],"desc":"Update metadata for the specified object.  If no value already exists for the specified object ID and metadata key, the metadata will be added.","returns":"bool True on successful update, false on failure."},"delete_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key"},{"required":"no","param":"string $meta_value Optional. Metadata value. If specified, only delete metadata entries with this value. Otherwise, delete all entries with the specified meta_key."},{"required":"no","param":"bool $delete_all Optional, default is false. If true, delete matching metadata entries for all objects, ignoring the specified object_id. Otherwise, only delete matching metadata entries for the specified object_id."}],"desc":"Delete metadata for the specified object.","returns":"bool True on successful delete, false on failure."},"get_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"no","param":"string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for the specified object."},{"required":"no","param":"bool $single Optional, default is false. If true, return only the first value of the specified meta_key. This parameter has no effect if meta_key is not specified."}],"desc":"Retrieve metadata for the specified object.","returns":"string|array Single metadata value, or array of values"},"metadata_exists":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key."}],"desc":"Determine if a meta key is set for a given object","returns":"boolean true of the key is set, false if not."},"get_metadata_by_mid":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $meta_id ID for a specific meta row"}],"desc":"Get meta data by meta ID","returns":"object Meta object or false."},"update_metadata_by_mid":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $meta_id ID for a specific meta row"},{"required":"yes","param":"string $meta_value Metadata value"},{"required":"no","param":"string $meta_key Optional, you can provide a meta key to update it"}],"desc":"Update meta data by meta ID","returns":"bool True on successful update, false on failure."},"delete_metadata_by_mid":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $meta_id ID for a specific meta row"}],"desc":"Delete meta data by meta ID","returns":"bool True on successful delete, false on failure."},"update_meta_cache":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int|array $object_ids array or comma delimited list of object IDs to update cache for"}],"desc":"Update the metadata cache for the specified objects.","returns":"mixed Metadata cache for the specified objects, or false on failure."},"get_meta_sql":{"params":[{"required":"yes","param":"array $meta_query A meta query"},{"required":"yes","param":"string $type Type of meta"},{"required":"yes","param":"string $primary_table "},{"required":"yes","param":"string $primary_id_column "},{"required":"no","param":"object $context (optional) The main query object"}],"desc":"Given a meta query, generates SQL clauses to be appended to a main query","returns":"array( 'join' => $join_sql, 'where' => $where_sql )"},"_get_meta_table":{"params":[{"required":"yes","param":"string $type Type of object to get metadata table for (e.g., comment, post, or user)"}],"desc":"Retrieve the name of the metadata table for the specified object type.","returns":"mixed Metadata table name, or false if no metadata table exists"},"is_protected_meta":{"params":[{"required":"yes","param":"string $meta_key Meta key"}],"desc":"Determine whether a meta key is protected","returns":"bool True if the key is protected, false otherwise."},"sanitize_meta":{"params":[{"required":"yes","param":"string $meta_key Meta key"},{"required":"yes","param":"mixed $meta_value Meta value to sanitize"},{"required":"yes","param":"string $meta_type Type of meta"}],"desc":"Sanitize meta value","returns":"mixed Sanitized $meta_value"},"register_meta":{"params":[{"required":"yes","param":"string $meta_type Type of meta"},{"required":"yes","param":"string $meta_key Meta key"},{"required":"yes","param":"string|array $sanitize_callback A function or method to call when sanitizing the value of $meta_key."},{"required":"no","param":"string|array $auth_callback Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks."},{"required":"yes","param":"array $args Arguments"}],"desc":"Register meta key","returns":""},"add_rewrite_rule":{"params":[{"required":"yes","param":"string $regex Regular Expression to match request against."},{"required":"yes","param":"string $redirect Page to redirect to."},{"required":"no","param":"string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'."}],"desc":"Add a straight rewrite rule.","returns":""},"add_rewrite_tag":{"params":[{"required":"yes","param":"string $tagname "},{"required":"yes","param":"string $regex "}],"desc":"Add a new tag (like %postname%).","returns":""},"add_permastruct":{"params":[{"required":"yes","param":"string $name Name for permalink structure."},{"required":"yes","param":"string $struct Permalink structure."},{"required":"yes","param":"bool $with_front Prepend front base to permalink structure."}],"desc":"Add permalink structure.","returns":""},"add_feed":{"params":[{"required":"yes","param":"string $feedname "},{"required":"yes","param":"callback $function Callback to run on feed display."}],"desc":"Add a new feed type like /atom1/.","returns":"string Feed action name."},"flush_rewrite_rules":{"params":[{"required":"yes","param":"bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules transient (soft flush). Default is true (hard)."}],"desc":"Remove rewrite rules and then recreate rewrite rules.","returns":""},"add_rewrite_endpoint":{"params":[{"required":"yes","param":"unknown_type $name "},{"required":"yes","param":"unknown_type $places "}],"desc":"Add an endpoint, like /trackback/.","returns":""},"_wp_filter_taxonomy_base":{"params":[{"required":"yes","param":"string $base The taxonomy base that we're going to filter"}],"desc":"Filter the URL base for taxonomies.","returns":"string "},"url_to_postid":{"params":[{"required":"yes","param":"string $url Permalink to check."}],"desc":"Examine a url and try to determine the post ID it represents.","returns":"int Post ID, or 0 on failure."},"fetch_rss":{"params":[{"required":"yes","param":"string $url URL to retrieve feed"}],"desc":"Build Magpie object based on RSS from URL.","returns":"bool|MagpieRSS false on failure or MagpieRSS object on success."},"_fetch_remote_file":{"params":[{"required":"yes","param":"string $url URL to retrieve"},{"required":"no","param":"array $headers Optional. Headers to send to the URL."}],"desc":"Retrieve URL headers and content using WP HTTP Request API.","returns":"Snoopy style response"},"_response_to_rss":{"params":[{"required":"yes","param":"unknown_type $resp "}],"desc":"Retrieve","returns":"unknown "},"init":{"params":[],"desc":"Set up constants with default values, unless user overrides.","returns":""},"is_info":{"params":[],"desc":"","returns":""},"is_success":{"params":[],"desc":"","returns":""},"is_redirect":{"params":[],"desc":"","returns":""},"is_error":{"params":[],"desc":"","returns":""},"is_client_error":{"params":[],"desc":"","returns":""},"is_server_error":{"params":[],"desc":"","returns":""},"parse_w3cdtf":{"params":[],"desc":"","returns":""},"wp_rss":{"params":[{"required":"yes","param":"string $url URL of feed to display. Will not auto sense feed URL."},{"required":"no","param":"int $num_items Optional. Number of items to display, default is all."}],"desc":"Display all RSS items in a HTML ordered list.","returns":""},"get_rss":{"params":[{"required":"yes","param":"string $url URL of feed to display. Will not auto sense feed URL."},{"required":"no","param":"int $num_items Optional. Number of items to display, default is all."}],"desc":"Display RSS items in HTML list items.","returns":"bool False on failure."},"get_bloginfo_rss":{"params":[{"required":"yes","param":"string $show See get_bloginfo() for possible values."}],"desc":"RSS container for the bloginfo function.","returns":"string "},"bloginfo_rss":{"params":[{"required":"yes","param":"string $show See get_bloginfo() for possible values."}],"desc":"Display RSS container for the bloginfo function.","returns":""},"get_default_feed":{"params":[],"desc":"Retrieve the default feed.","returns":"string Default feed, or for example 'rss2', 'atom', etc."},"get_wp_title_rss":{"params":[{"required":"no","param":"string $sep Optional.How to separate the title. See wp_title() for more info."}],"desc":"Retrieve the blog title for the feed title.","returns":"string Error message on failure or blog title on success."},"wp_title_rss":{"params":[{"required":"no","param":"string $sep Optional."}],"desc":"Display the blog title for display of the feed title.","returns":""},"get_the_title_rss":{"params":[],"desc":"Retrieve the current post title for the feed.","returns":"string Current post title."},"the_title_rss":{"params":[],"desc":"Display the post title in the feed.","returns":""},"get_the_content_feed":{"params":[{"required":"yes","param":"string $feed_type The type of feed. rss2 | atom | rss | rdf"}],"desc":"Retrieve the post content for feeds.","returns":""},"the_content_feed":{"params":[{"required":"yes","param":"string $feed_type The type of feed. rss2 | atom | rss | rdf"}],"desc":"Display the post content for feeds.","returns":""},"the_excerpt_rss":{"params":[],"desc":"Display the post excerpt for the feed.","returns":""},"the_permalink_rss":{"params":[],"desc":"Display the permalink to the post for use in feeds.","returns":""},"comments_link_feed":{"params":[],"desc":"Outputs the link to the comments for the current post in an xml safe way","returns":"none "},"comment_guid":{"params":[{"required":"no","param":"int|object $comment_id Optional comment object or id. Defaults to global comment object."}],"desc":"Display the feed GUID for the current comment.","returns":""},"get_comment_guid":{"params":[{"required":"no","param":"int|object $comment_id Optional comment object or id. Defaults to global comment object."}],"desc":"Retrieve the feed GUID for the current comment.","returns":"bool|string false on failure or guid for comment on success."},"comment_link":{"params":[],"desc":"Display the link to the comments.","returns":""},"get_comment_author_rss":{"params":[],"desc":"Retrieve the current comment author for use in the feeds.","returns":"string Comment Author"},"comment_author_rss":{"params":[],"desc":"Display the current comment author in the feed.","returns":""},"comment_text_rss":{"params":[],"desc":"Display the current comment content for use in the feeds.","returns":""},"get_the_category_rss":{"params":[{"required":"no","param":"string $type Optional, default is the type returned by get_default_feed()."}],"desc":"Retrieve all of the post categories, formatted for use in feeds.","returns":"string All of the post categories for displaying in the feed."},"the_category_rss":{"params":[{"required":"no","param":"string $type Optional, default is the type returned by get_default_feed()."}],"desc":"Display the post categories in the feed.","returns":""},"html_type_rss":{"params":[],"desc":"Display the HTML type based on the blog setting.","returns":""},"rss_enclosure":{"params":[],"desc":"Display the rss enclosure for the current post.","returns":""},"atom_enclosure":{"params":[],"desc":"Display the atom enclosure for the current post.","returns":""},"prep_atom_text_construct":{"params":[{"required":"yes","param":"string $data Input string"}],"desc":"Determine the type of a string of data with the data formatted.","returns":"array array(type, value)"},"self_link":{"params":[],"desc":"Display the link for the currently displayed feed in a XSS safe way.","returns":""},"feed_content_type":{"params":[],"desc":"Return the content type for specified feed type.","returns":""},"fetch_feed":{"params":[{"required":"yes","param":"string $url URL to retrieve feed"}],"desc":"Build SimplePie object based on RSS or Atom feed from URL.","returns":"WP_Error|SimplePie WP_Error object on failure or SimplePie object on success"},"is_rtl":{"params":[],"desc":"Checks if current locale is RTL.","returns":"bool Whether locale is RTL."},"is_subdomain_install":{"params":[],"desc":"Whether a subdomain configuration is enabled.","returns":"bool True if subdomain configuration is enabled, false otherwise."},"wp_get_active_network_plugins":{"params":[],"desc":"Returns array of network plugin files to be included in global scope.","returns":"array Files to include"},"ms_site_check":{"params":[],"desc":"Checks status of current blog.","returns":"bool|string Returns true on success, or drop-in file to include."},"get_current_site_name":{"params":[],"desc":"Sets current site name.","returns":"object $current_site object with site_name"},"wpmu_current_site":{"params":[],"desc":"Sets current_site object.","returns":"object $current_site object"},"ms_not_installed":{"params":[],"desc":"Displays a failure message.","returns":""},"_walk_bookmarks":{"params":[{"required":"yes","param":"array $bookmarks List of bookmarks to traverse"},{"required":"no","param":"string|array $args Optional. Overwrite the defaults."}],"desc":"The formatted output of a list of bookmarks.","returns":"string Formatted output in HTML"},"wp_list_bookmarks":{"params":[{"required":"no","param":"string|array $args Optional. Overwrite the defaults of the function"}],"desc":"Retrieve or echo all of the bookmarks.","returns":"string|null Will only return if echo option is set to not echo. Default is not return anything."},"check_comment":{"params":[{"required":"yes","param":"string $author Comment Author's name"},{"required":"yes","param":"string $email Comment Author's email"},{"required":"yes","param":"string $url Comment Author's URL"},{"required":"yes","param":"string $comment Comment contents"},{"required":"yes","param":"string $user_ip Comment Author's IP address"},{"required":"yes","param":"string $user_agent Comment Author's User Agent"},{"required":"yes","param":"string $comment_type Comment type, either user submitted comment, trackback, or pingback"}],"desc":"Checks whether a comment passes internal checks to be allowed to add.","returns":"bool Whether the checks passed (true) and the comments should be displayed or set to moderated"},"get_approved_comments":{"params":[{"required":"yes","param":"int $post_id The ID of the post"}],"desc":"Retrieve the approved comments for post $post_id.","returns":"array $comments The approved comments"},"get_comment":{"params":[{"required":"yes","param":"object|string|int $comment Comment to retrieve."},{"required":"no","param":"string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants."}],"desc":"Retrieves comment data given a comment ID or comment object.","returns":"object|array|null Depends on $output value."},"get_comments":{"params":[{"required":"no","param":"mixed $args Optional. Array or string of options to override defaults."}],"desc":"Retrieve a list of comments.","returns":"array List of comments."},"get_comment_statuses":{"params":[],"desc":"Retrieve all of the WordPress supported comment statuses.","returns":"array List of comment statuses."},"get_lastcommentmodified":{"params":[{"required":"yes","param":"string $timezone Which timezone to use in reference to 'gmt', 'blog', or 'server' locations."}],"desc":"The date the last comment was modified.","returns":"string Last comment modified date."},"get_comment_count":{"params":[{"required":"no","param":"int $post_id Optional. Comment amount in post if > 0, else total comments blog wide."}],"desc":"The amount of comments in a post or total comments.","returns":"array The amount of spam, approved, awaiting moderation, and total comments."},"add_comment_meta":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"bool $unique Optional, default is false. Whether the same key should not be added."}],"desc":"Add meta data field to a comment.","returns":"bool False for failure. True for success."},"delete_comment_meta":{"params":[{"required":"yes","param":"int $comment_id comment ID"},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"no","param":"mixed $meta_value Optional. Metadata value."}],"desc":"Remove metadata matching criteria from a comment.","returns":"bool False for failure. True for success."},"get_comment_meta":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $key The meta key to retrieve."},{"required":"yes","param":"bool $single Whether to return a single value."}],"desc":"Retrieve comment meta field for a comment.","returns":"mixed Will be an array if $single is false. Will be value of meta data field if $single is true."},"update_comment_meta":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"mixed $prev_value Optional. Previous value to check before removing."}],"desc":"Update comment meta field based on comment ID.","returns":"bool False on failure, true if success."},"sanitize_comment_cookies":{"params":[],"desc":"Sanitizes the cookies sent to the user already.","returns":""},"wp_allow_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment"}],"desc":"Validates whether this comment is allowed to be made.","returns":"mixed Signifies the approval status (0|1|'spam')"},"check_comment_flood_db":{"params":[{"required":"yes","param":"string $ip Comment IP."},{"required":"yes","param":"string $email Comment author email address."},{"required":"yes","param":"string $date MySQL time string."}],"desc":"Check whether comment flooding is occurring.","returns":""},"separate_comments":{"params":[{"required":"yes","param":"array $comments Array of comments"}],"desc":"Separates an array of comments into an array keyed by comment_type.","returns":"array Array of comments keyed by comment_type."},"get_comment_pages_count":{"params":[{"required":"no","param":"array $comments Optional array of comment objects. Defaults to $wp_query->comments"},{"required":"no","param":"int $per_page Optional comments per page."},{"required":"no","param":"boolean $threaded Optional control over flat or threaded comments."}],"desc":"Calculate the total number of comment pages.","returns":"int Number of comment pages."},"get_page_of_comment":{"params":[{"required":"yes","param":"int $comment_ID Comment ID."},{"required":"no","param":"array $args Optional args."}],"desc":"Calculate what page number a comment will appear on for comment paging.","returns":"int|null Comment page number or null on error."},"wp_blacklist_check":{"params":[{"required":"yes","param":"string $author The author of the comment"},{"required":"yes","param":"string $email The email of the comment"},{"required":"yes","param":"string $url The url used in the comment"},{"required":"yes","param":"string $comment The comment content"},{"required":"yes","param":"string $user_ip The comment author IP address"},{"required":"yes","param":"string $user_agent The author's browser user agent"}],"desc":"Does comment contain blacklisted characters or words.","returns":"bool True if comment contains blacklisted content, false if comment does not"},"wp_count_comments":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Retrieve total comments for blog or single post.","returns":"object Comment stats."},"wp_delete_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID"},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Default is false."}],"desc":"Trashes or deletes a comment.","returns":"bool False if delete comment query failure, true on success."},"wp_trash_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Moves a comment to the Trash","returns":"mixed False on failure"},"wp_untrash_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Removes a comment from the Trash","returns":"mixed False on failure"},"wp_spam_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Marks a comment as Spam","returns":"mixed False on failure"},"wp_unspam_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Removes a comment from the Spam","returns":"mixed False on failure"},"wp_get_comment_status":{"params":[{"required":"yes","param":"int $comment_id Comment ID"}],"desc":"The status of a comment by ID.","returns":"string|bool Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure."},"wp_transition_comment_status":{"params":[{"required":"yes","param":"string $new_status New comment status."},{"required":"yes","param":"string $old_status Previous comment status."},{"required":"yes","param":"object $comment Comment data."}],"desc":"Call hooks for when a comment status transition occurs.","returns":""},"wp_get_current_commenter":{"params":[],"desc":"Get current commenter's name, email, and URL.","returns":"array Comment author, email, url respectively."},"wp_insert_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment."}],"desc":"Inserts a comment to the database.","returns":"int The new comment's ID."},"wp_filter_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment."}],"desc":"Filters and sanitizes comment data.","returns":"array Parsed comment information."},"wp_throttle_comment_flood":{"params":[{"required":"yes","param":"bool $block Whether plugin has already blocked comment."},{"required":"yes","param":"int $time_lastcomment Timestamp for last comment."},{"required":"yes","param":"int $time_newcomment Timestamp for new comment."}],"desc":"Whether comment should be blocked because of comment flood.","returns":"bool Whether comment should be blocked."},"wp_new_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment."}],"desc":"Adds a new comment to the database.","returns":"int The ID of the comment after adding."},"wp_set_comment_status":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'delete'."},{"required":"yes","param":"bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false."}],"desc":"Sets the status of a comment.","returns":"bool False on failure or deletion and true on success."},"wp_update_comment":{"params":[{"required":"yes","param":"array $commentarr Contains information on the comment."}],"desc":"Updates an existing comment in the database.","returns":"int Comment was updated if value is 1, or was not updated if value is 0."},"wp_defer_comment_counting":{"params":[{"required":"yes","param":"bool $defer "}],"desc":"Whether to defer comment counting.","returns":"unknown "},"wp_update_comment_count":{"params":[{"required":"yes","param":"int $post_id Post ID"},{"required":"yes","param":"bool $do_deferred Whether to process previously deferred post comment counts"}],"desc":"Updates the comment count for post(s).","returns":"bool True on success, false on failure"},"wp_update_comment_count_now":{"params":[{"required":"yes","param":"int $post_id Post ID"}],"desc":"Updates the comment count for the post.","returns":"bool False on '0' $post_id or if post with ID does not exist. True on success."},"discover_pingback_server_uri":{"params":[{"required":"yes","param":"string $url URL to ping."},{"required":"yes","param":"int $deprecated Not Used."}],"desc":"Finds a pingback server URI based on the given URL.","returns":"bool|string False on failure, string containing URI on success."},"do_all_pings":{"params":[],"desc":"Perform all pingbacks, enclosures, trackbacks, and send to pingback services.","returns":""},"do_trackbacks":{"params":[{"required":"yes","param":"int $post_id Post ID to do trackbacks on."}],"desc":"Perform trackbacks.","returns":""},"generic_ping":{"params":[{"required":"yes","param":"int $post_id Post ID. Not actually used."}],"desc":"Sends pings to all of the ping site services.","returns":"int Same as Post ID from parameter"},"pingback":{"params":[{"required":"yes","param":"string $content Post content to check for links."},{"required":"yes","param":"int $post_ID Post ID."}],"desc":"Pings back the links found in a post.","returns":""},"privacy_ping_filter":{"params":[{"required":"yes","param":"mixed $sites Will return if blog is public, will not return if not public."}],"desc":"Check whether blog is public before returning sites.","returns":"mixed Empty string if blog is not public, returns $sites, if site is public."},"trackback":{"params":[{"required":"yes","param":"string $trackback_url URL to send trackbacks."},{"required":"yes","param":"string $title Title of post."},{"required":"yes","param":"string $excerpt Excerpt of post."},{"required":"yes","param":"int $ID Post ID."}],"desc":"Send a Trackback.","returns":"mixed Database query from update."},"weblog_ping":{"params":[{"required":"yes","param":"string $server Host of blog to connect to."},{"required":"yes","param":"string $path Path to send the ping."}],"desc":"Send a pingback.","returns":""},"clean_comment_cache":{"params":[{"required":"yes","param":"int|array $ids Comment ID or array of comment IDs to remove from cache"}],"desc":"Removes comment ID from the comment cache.","returns":""},"update_comment_cache":{"params":[{"required":"yes","param":"array $comments Array of comment row objects"}],"desc":"Updates the comment cache of given comments.","returns":""},"_close_comments_for_old_posts":{"params":[{"required":"yes","param":"object $posts Post data object."},{"required":"yes","param":"object $query Query object."}],"desc":"Close comments on old posts on the fly, without any extra DB queries.  Hooked to the_posts.","returns":"object "},"_close_comments_for_old_post":{"params":[{"required":"yes","param":"bool $open Comments open or closed"},{"required":"yes","param":"int $post_id Post ID"}],"desc":"Close comments on an old post.  Hooked to comments_open and pings_open.","returns":"bool $open"},"get_query_var":{"params":[{"required":"yes","param":"string $var The variable key to retrieve."}],"desc":"Retrieve variable in the WP_Query class.","returns":"mixed "},"get_queried_object":{"params":[],"desc":"Retrieve the currently-queried object.  Wrapper for $wp_query->get_queried_object()","returns":"object "},"get_queried_object_id":{"params":[],"desc":"Retrieve ID of the current queried object. Wrapper for $wp_query->get_queried_object_id()","returns":"int "},"set_query_var":{"params":[{"required":"yes","param":"string $var Query variable key."},{"required":"yes","param":"mixed $value "}],"desc":"Set query variable.","returns":"null "},"query_posts":{"params":[{"required":"yes","param":"string $query "}],"desc":"Set up The Loop with query parameters.","returns":"array List of posts"},"wp_reset_query":{"params":[],"desc":"Destroy the previous query and set up a new query.","returns":""},"wp_reset_postdata":{"params":[],"desc":"After looping through a separate query, this function restores the $post global to the current post in the main query","returns":""},"is_archive":{"params":[],"desc":"Is the query for an archive page?","returns":"bool "},"is_post_type_archive":{"params":[{"required":"no","param":"mixed $post_types Optional. Post type or array of posts types to check against."}],"desc":"Is the query for a post type archive page?","returns":"bool "},"is_attachment":{"params":[],"desc":"Is the query for an attachment page?","returns":"bool "},"is_author":{"params":[{"required":"no","param":"mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames"}],"desc":"Is the query for an author archive page?","returns":"bool "},"is_category":{"params":[{"required":"no","param":"mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs."}],"desc":"Is the query for a category archive page?","returns":"bool "},"is_tag":{"params":[{"required":"no","param":"mixed $slug Optional. Tag slug or array of slugs."}],"desc":"Is the query for a tag archive page?","returns":"bool "},"is_tax":{"params":[{"required":"no","param":"mixed $taxonomy Optional. Taxonomy slug or slugs."},{"required":"no","param":"mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs."}],"desc":"Is the query for a taxonomy archive page?","returns":"bool "},"is_comments_popup":{"params":[],"desc":"Whether the current URL is within the comments popup window.","returns":"bool "},"is_date":{"params":[],"desc":"Is the query for a date archive?","returns":"bool "},"is_day":{"params":[],"desc":"Is the query for a day archive?","returns":"bool "},"is_feed":{"params":[{"required":"no","param":"string|array $feeds Optional feed types to check."}],"desc":"Is the query for a feed?","returns":"bool "},"is_comment_feed":{"params":[],"desc":"Is the query for a comments feed?","returns":"bool "},"is_front_page":{"params":[],"desc":"Is the query for the front page of the site?","returns":"bool True, if front of site."},"is_home":{"params":[],"desc":"Is the query for the blog homepage?","returns":"bool True if blog view homepage."},"is_month":{"params":[],"desc":"Is the query for a month archive?","returns":"bool "},"is_page":{"params":[{"required":"yes","param":"mixed $page Page ID, title, slug, or array of such."}],"desc":"Is the query for a single page?","returns":"bool "},"is_paged":{"params":[],"desc":"Is the query for paged result and not for the first page?","returns":"bool "},"is_preview":{"params":[],"desc":"Is the query for a post or page preview?","returns":"bool "},"is_robots":{"params":[],"desc":"Is the query for the robots file?","returns":"bool "},"is_search":{"params":[],"desc":"Is the query for a search?","returns":"bool "},"is_single":{"params":[{"required":"yes","param":"mixed $post Post ID, title, slug, or array of such."}],"desc":"Is the query for a single post?","returns":"bool "},"is_singular":{"params":[{"required":"no","param":"mixed $post_types Optional. Post Type or array of Post Types"}],"desc":"Is the query for a single post of any post type (post, attachment, page, ... )?","returns":"bool "},"is_time":{"params":[],"desc":"Is the query for a specific time?","returns":"bool "},"is_trackback":{"params":[],"desc":"Is the query for a trackback endpoint call?","returns":"bool "},"is_year":{"params":[],"desc":"Is the query for a specific year?","returns":"bool "},"is_404":{"params":[],"desc":"Is the query a 404 (returns no results)?","returns":"bool "},"is_main_query":{"params":[],"desc":"Is the query the main query?","returns":"bool "},"have_posts":{"params":[],"desc":"Whether current WordPress query has results to loop over.","returns":"bool "},"in_the_loop":{"params":[],"desc":"Whether the caller is in the Loop.","returns":"bool True if caller is within loop, false if loop hasn't started or ended."},"rewind_posts":{"params":[],"desc":"Rewind the loop posts.","returns":"null "},"the_post":{"params":[],"desc":"Iterate the post index in the loop.","returns":""},"have_comments":{"params":[],"desc":"Whether there are comments to loop over.","returns":"bool "},"the_comment":{"params":[],"desc":"Iterate comment index in the comment loop.","returns":"object "},"wp_old_slug_redirect":{"params":[],"desc":"Redirect old slugs to the correct permalink.","returns":"null If no link is found, null is returned."},"setup_postdata":{"params":[{"required":"yes","param":"object $post Post data."}],"desc":"Set up global post data.","returns":"bool True when finished."},"is_child_theme":{"params":[],"desc":"Whether a child theme is in use.","returns":"bool true if a child theme is in use, false otherwise."},"get_stylesheet":{"params":[],"desc":"Retrieve name of the current stylesheet.","returns":"string Stylesheet name."},"get_stylesheet_directory":{"params":[],"desc":"Retrieve stylesheet directory path for current theme.","returns":"string Path to current theme directory."},"get_stylesheet_directory_uri":{"params":[],"desc":"Retrieve stylesheet directory URI.","returns":"string "},"get_stylesheet_uri":{"params":[],"desc":"Retrieve URI of current theme stylesheet.","returns":"string "},"get_locale_stylesheet_uri":{"params":[],"desc":"Retrieve localized stylesheet URI.","returns":"string "},"get_template":{"params":[],"desc":"Retrieve name of the current theme.","returns":"string Template name."},"get_template_directory":{"params":[],"desc":"Retrieve current theme directory.","returns":"string Template directory path."},"get_template_directory_uri":{"params":[],"desc":"Retrieve theme directory URI.","returns":"string Template directory URI."},"get_theme_data":{"params":[{"required":"yes","param":"string $theme_file Theme file path."}],"desc":"Retrieve theme data from parsed theme file.","returns":"array Theme data."},"get_themes":{"params":[],"desc":"Retrieve list of themes with theme data in theme directory.","returns":"array Theme list with theme data."},"get_theme_roots":{"params":[],"desc":"Retrieve theme roots.","returns":"array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root."},"get_theme":{"params":[{"required":"yes","param":"string $theme Theme name."}],"desc":"Retrieve theme data.","returns":"array|null Null, if theme name does not exist. Theme data, if exists."},"get_current_theme":{"params":[],"desc":"Retrieve current theme display name.","returns":"string "},"register_theme_directory":{"params":[{"required":"yes","param":"string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR"}],"desc":"Register a directory that contains themes.","returns":"bool "},"search_theme_directories":{"params":[],"desc":"Search all registered theme directories for complete and valid themes.","returns":"array Valid themes found"},"get_theme_root":{"params":[{"required":"yes","param":"string $stylesheet_or_template The stylesheet or template name of the theme"}],"desc":"Retrieve path to themes directory.","returns":"string Theme path."},"get_theme_root_uri":{"params":[{"required":"yes","param":"string $stylesheet_or_template The stylesheet or template name of the theme"}],"desc":"Retrieve URI for themes directory.","returns":"string Themes URI."},"get_raw_theme_root":{"params":[{"required":"yes","param":"string $stylesheet_or_template The stylesheet or template name of the theme"}],"desc":"Get the raw theme root relative to the content directory with no filters applied.","returns":"string Theme root"},"get_query_template":{"params":[{"required":"yes","param":"string $type Filename without extension."},{"required":"no","param":"array $templates An optional list of template candidates"}],"desc":"Retrieve path to a template","returns":"string Full path to file."},"get_index_template":{"params":[],"desc":"Retrieve path of index template in current or parent template.","returns":"string "},"get_404_template":{"params":[],"desc":"Retrieve path of 404 template in current or parent template.","returns":"string "},"get_archive_template":{"params":[],"desc":"Retrieve path of archive template in current or parent template.","returns":"string "},"get_author_template":{"params":[],"desc":"Retrieve path of author template in current or parent template.","returns":"string "},"get_category_template":{"params":[],"desc":"Retrieve path of category template in current or parent template.","returns":"string "},"get_tag_template":{"params":[],"desc":"Retrieve path of tag template in current or parent template.","returns":"string "},"get_taxonomy_template":{"params":[],"desc":"Retrieve path of taxonomy template in current or parent template.","returns":"string "},"get_date_template":{"params":[],"desc":"Retrieve path of date template in current or parent template.","returns":"string "},"get_home_template":{"params":[],"desc":"Retrieve path of home template in current or parent template.","returns":"string "},"get_front_page_template":{"params":[],"desc":"Retrieve path of front-page template in current or parent template.","returns":"string "},"get_page_template":{"params":[],"desc":"Retrieve path of page template in current or parent template.","returns":"string "},"get_paged_template":{"params":[],"desc":"Retrieve path of paged template in current or parent template.","returns":"string "},"get_search_template":{"params":[],"desc":"Retrieve path of search template in current or parent template.","returns":"string "},"get_single_template":{"params":[],"desc":"Retrieve path of single template in current or parent template.","returns":"string "},"get_attachment_template":{"params":[],"desc":"Retrieve path of attachment template in current or parent template.","returns":"string "},"get_comments_popup_template":{"params":[],"desc":"Retrieve path of comment popup template in current or parent template.","returns":"string "},"locate_template":{"params":[{"required":"yes","param":"string|array $template_names Template file(s) to search for, in order."},{"required":"yes","param":"bool $load If true the template file will be loaded if it is found."},{"required":"yes","param":"bool $require_once Whether to require_once or require. Default true. Has no effect if $load is false."}],"desc":"Retrieve the name of the highest priority template file that exists.","returns":"string The template filename if one is located."},"load_template":{"params":[{"required":"yes","param":"string $_template_file Path to template file."},{"required":"yes","param":"bool $require_once Whether to require_once or require. Default true."}],"desc":"Require the template file with WordPress environment.","returns":""},"locale_stylesheet":{"params":[],"desc":"Display localized stylesheet link element.","returns":""},"preview_theme":{"params":[],"desc":"Start preview theme output buffer.","returns":""},"_preview_theme_template_filter":{"params":[],"desc":"Private function to modify the current template when previewing a theme","returns":"string "},"_preview_theme_stylesheet_filter":{"params":[],"desc":"Private function to modify the current stylesheet when previewing a theme","returns":"string "},"preview_theme_ob_filter":{"params":[{"required":"yes","param":"string $content "}],"desc":"Callback function for ob_start() to capture all links in the theme.","returns":"string "},"preview_theme_ob_filter_callback":{"params":[{"required":"yes","param":"array $matches "}],"desc":"Manipulates preview theme links in order to control and maintain location.","returns":"string "},"switch_theme":{"params":[{"required":"yes","param":"string $template Template name"},{"required":"yes","param":"string $stylesheet Stylesheet name."}],"desc":"Switches current theme to new template and stylesheet names.","returns":""},"validate_current_theme":{"params":[],"desc":"Checks that current theme files 'index.php' and 'style.css' exists.","returns":"bool "},"get_theme_mods":{"params":[],"desc":"Retrieve all theme modifications.","returns":"array Theme modifications."},"get_theme_mod":{"params":[{"required":"yes","param":"string $name Theme modification name."},{"required":"yes","param":"bool|string $default "}],"desc":"Retrieve theme modification value for the current theme.","returns":"string "},"set_theme_mod":{"params":[{"required":"yes","param":"string $name Theme modification name."},{"required":"yes","param":"string $value theme modification value."}],"desc":"Update theme modification value for the current theme.","returns":""},"remove_theme_mod":{"params":[{"required":"yes","param":"string $name Theme modification name."}],"desc":"Remove theme modification name from current theme list.","returns":"null "},"remove_theme_mods":{"params":[],"desc":"Remove theme modifications option for current theme.","returns":""},"get_header_textcolor":{"params":[],"desc":"Retrieve text color for custom header.","returns":"string "},"header_textcolor":{"params":[],"desc":"Display text color for custom header.","returns":""},"get_header_image":{"params":[],"desc":"Retrieve header image for custom header.","returns":"string "},"get_random_header_image":{"params":[],"desc":"Get random header image from registered images in theme.","returns":"string Path to header image"},"is_random_header_image":{"params":[{"required":"yes","param":"string $type The random pool to use. any|default|uploaded"}],"desc":"Check if random header image is in use.","returns":"boolean "},"header_image":{"params":[],"desc":"Display header image path.","returns":""},"get_uploaded_header_images":{"params":[],"desc":"Get the header images uploaded for the current theme.","returns":"array "},"add_custom_image_header":{"params":[{"required":"yes","param":"callback $header_callback Call on 'wp_head' action."},{"required":"yes","param":"callback $admin_header_callback Call on custom header administration screen."},{"required":"no","param":"callback $admin_image_div_callback Output a custom header image div on the custom header administration screen. Optional."}],"desc":"Add callbacks for image header display.","returns":""},"remove_custom_image_header":{"params":[],"desc":"Remove image header support.","returns":"bool Whether support was removed."},"register_default_headers":{"params":[{"required":"yes","param":"array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys."}],"desc":"Register a selection of default headers to be displayed by the custom header admin UI.","returns":""},"unregister_default_headers":{"params":[{"required":"yes","param":"string|array $header The header string id (key of array) to remove, or an array thereof."}],"desc":"Unregister default headers.","returns":"True on success, false on failure."},"get_background_image":{"params":[],"desc":"Retrieve background image for custom background.","returns":"string "},"background_image":{"params":[],"desc":"Display background image path.","returns":""},"get_background_color":{"params":[],"desc":"Retrieve value for custom background color.","returns":"string "},"background_color":{"params":[],"desc":"Display background color value.","returns":""},"add_custom_background":{"params":[{"required":"yes","param":"callback $header_callback Call on 'wp_head' action."},{"required":"yes","param":"callback $admin_header_callback Call on custom background administration screen."},{"required":"no","param":"callback $admin_image_div_callback Output a custom background image div on the custom background administration screen. Optional."}],"desc":"Add callbacks for background image display.","returns":""},"remove_custom_background":{"params":[],"desc":"Remove custom background support.","returns":"bool Whether support was removed."},"_custom_background_cb":{"params":[],"desc":"Default custom background callback.","returns":""},"add_editor_style":{"params":[{"required":"no","param":"mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root. Defaults to 'editor-style.css'"}],"desc":"Add callback for custom TinyMCE editor stylesheets.","returns":""},"remove_editor_styles":{"params":[],"desc":"Removes all visual editor stylesheets.","returns":"bool True on success, false if there were no stylesheets to remove."},"add_theme_support":{"params":[{"required":"yes","param":"string $feature the feature being added"}],"desc":"Allows a theme to register its support of a certain feature","returns":""},"get_theme_support":{"params":[{"required":"yes","param":"string $feature the feature to check"}],"desc":"Gets the theme support arguments passed when registering that support","returns":"array The array of extra arguments"},"remove_theme_support":{"params":[{"required":"yes","param":"string $feature the feature being added"}],"desc":"Allows a theme to de-register its support of a certain feature","returns":"bool Whether feature was removed."},"_remove_theme_support":{"params":[],"desc":"Do not use. Removes theme support internally, ignorant of the blacklist.","returns":""},"current_theme_supports":{"params":[{"required":"yes","param":"string $feature the feature being checked"}],"desc":"Checks a theme's support for a given feature","returns":"boolean "},"require_if_theme_supports":{"params":[{"required":"yes","param":"string $feature the feature being checked"},{"required":"yes","param":"string $include the file containing the functions that implement the feature"}],"desc":"Checks a theme's support for a given feature before loading the functions which implement it.","returns":""},"_delete_attachment_theme_mod":{"params":[{"required":"yes","param":"int $id the attachment id"}],"desc":"Checks an attachment being deleted to see if it's a header or background image.","returns":""},"check_theme_switched":{"params":[],"desc":"Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load","returns":""},"set_current_user":{"params":[{"required":"yes","param":"int|null $id User ID."},{"required":"no","param":"string $name Optional. The user's username"}],"desc":"Changes the current user by ID or name.","returns":"object returns wp_set_current_user()"},"get_userdatabylogin":{"params":[{"required":"yes","param":"string $user_login User's username"}],"desc":"Retrieve user info by login name.","returns":"bool|object False on failure, User DB row object"},"get_user_by_email":{"params":[{"required":"yes","param":"string $email User's email address"}],"desc":"Retrieve user info by email.","returns":"bool|object False on failure, User DB row object"},"wp_setcookie":{"params":[{"required":"yes","param":"string $username The user's username"},{"required":"no","param":"string $password Optional. The user's password"},{"required":"no","param":"bool $already_md5 Optional. Whether the password has already been through MD5"},{"required":"no","param":"string $home Optional. Will be used instead of COOKIEPATH if set"},{"required":"no","param":"string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set"},{"required":"no","param":"bool $remember Optional. Remember that the user is logged in"}],"desc":"Sets a cookie for a user who just logged in. This function is deprecated.","returns":""},"wp_clearcookie":{"params":[],"desc":"Clears the authentication cookie, logging the user out. This function is deprecated.","returns":""},"wp_get_cookie_login":{"params":[],"desc":"Gets the user cookie login. This function is deprecated.","returns":"bool Always returns false"},"wp_login":{"params":[{"required":"yes","param":"string $username User's username"},{"required":"yes","param":"string $password User's password"},{"required":"yes","param":"bool $deprecated Not used"}],"desc":"Checks a users login information and logs them in if it checks out. This function is deprecated.","returns":"bool False on login failure, true on successful check"},"wp_set_current_user":{"params":[{"required":"yes","param":"int $id User ID"},{"required":"yes","param":"string $name User's username"}],"desc":"Changes the current user by ID or name.","returns":"WP_User Current user User object"},"wp_get_current_user":{"params":[],"desc":"Retrieve the current user object.","returns":"WP_User Current user WP_User object"},"get_currentuserinfo":{"params":[],"desc":"Populate global variables with information about the currently logged in user.","returns":"bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set"},"get_userdata":{"params":[{"required":"yes","param":"int $user_id User ID"}],"desc":"Retrieve user info by user ID.","returns":"bool|object False on failure, WP_User object on success"},"get_user_by":{"params":[{"required":"yes","param":"string $field The field to retrieve the user with. id | slug | email | login"},{"required":"yes","param":"int|string $value A value for $field. A user ID, slug, email address, or login name."}],"desc":"Retrieve user info by a given field","returns":"bool|object False on failure, WP_User object on success"},"cache_users":{"params":[{"required":"yes","param":"array $user_ids User ID numbers list"}],"desc":"Retrieve info for user lists to prevent multiple queries by get_userdata()","returns":""},"wp_mail":{"params":[{"required":"yes","param":"string|array $to Array or comma-separated list of email addresses to send message."},{"required":"yes","param":"string $subject Email subject"},{"required":"yes","param":"string $message Message contents"},{"required":"no","param":"string|array $headers Optional. Additional headers."},{"required":"no","param":"string|array $attachments Optional. Files to attach."}],"desc":"Send mail, similar to PHP's mail","returns":"bool Whether the email contents were sent successfully."},"wp_authenticate":{"params":[{"required":"yes","param":"string $username User's username"},{"required":"yes","param":"string $password User's password"}],"desc":"Checks a user's login information and logs them in if it checks out.","returns":"WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object."},"wp_logout":{"params":[],"desc":"Log the current user out.","returns":""},"wp_validate_auth_cookie":{"params":[{"required":"no","param":"string $cookie Optional. If used, will validate contents instead of cookie's"},{"required":"no","param":"string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in"}],"desc":"Validates authentication cookie.","returns":"bool|int False if invalid cookie, User ID if valid."},"wp_generate_auth_cookie":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"int $expiration Cookie expiration in seconds"},{"required":"no","param":"string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in"}],"desc":"Generate authentication cookie contents.","returns":"string Authentication cookie contents"},"wp_parse_auth_cookie":{"params":[{"required":"yes","param":"string $cookie "},{"required":"no","param":"string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in"}],"desc":"Parse a cookie into its components","returns":"array Authentication cookie components"},"wp_set_auth_cookie":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"bool $remember Whether to remember the user"}],"desc":"Sets the authentication cookies based User ID.","returns":""},"wp_clear_auth_cookie":{"params":[],"desc":"Removes all of the cookies associated with authentication.","returns":""},"is_user_logged_in":{"params":[],"desc":"Checks if the current visitor is a logged in user.","returns":"bool True if user is logged in, false if not logged in."},"auth_redirect":{"params":[],"desc":"Checks if a user is logged in, if not it redirects them to the login page.","returns":""},"check_admin_referer":{"params":[{"required":"yes","param":"string $action Action nonce"},{"required":"yes","param":"string $query_arg where to look for nonce in $_REQUEST (since 2.5)"}],"desc":"Makes sure that a user was referred from another admin page.","returns":""},"check_ajax_referer":{"params":[{"required":"yes","param":"string $action Action nonce"},{"required":"yes","param":"string $query_arg where to look for nonce in $_REQUEST (since 2.5)"}],"desc":"Verifies the AJAX request to prevent processing requests external of the blog.","returns":""},"wp_redirect":{"params":[{"required":"yes","param":"string $location The path to redirect to"},{"required":"yes","param":"int $status Status code to use"}],"desc":"Redirects to another page.","returns":"bool False if $location is not set"},"wp_sanitize_redirect":{"params":[],"desc":"Sanitizes a URL for use in a redirect.","returns":"string redirect-sanitized URL"},"wp_safe_redirect":{"params":[],"desc":"Performs a safe (local) redirect, using wp_redirect().","returns":"void Does not return anything"},"wp_validate_redirect":{"params":[{"required":"yes","param":"string $location The redirect to validate"},{"required":"yes","param":"string $default The value to return is $location is not allowed"}],"desc":"Validates a URL for use in a redirect.","returns":"string redirect-sanitized URL"},"wp_notify_postauthor":{"params":[{"required":"yes","param":"int $comment_id Comment ID"},{"required":"no","param":"string $comment_type Optional. The comment type either 'comment' (default), 'trackback', or 'pingback'"}],"desc":"Notify an author of a comment/trackback/pingback to one of their posts.","returns":"bool False if user email does not exist. True on completion."},"wp_notify_moderator":{"params":[{"required":"yes","param":"int $comment_id Comment ID"}],"desc":"Notifies the moderator of the blog about a new comment that is awaiting approval.","returns":"bool Always returns true"},"wp_password_change_notification":{"params":[{"required":"yes","param":"object $user User Object"}],"desc":"Notify the blog admin of a user changing password, normally via email.","returns":""},"wp_new_user_notification":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"no","param":"string $plaintext_pass Optional. The user's plaintext password"}],"desc":"Notify the blog admin of a new user, normally via email.","returns":""},"wp_nonce_tick":{"params":[],"desc":"Get the time-dependent variable for nonce creation.","returns":"int "},"wp_verify_nonce":{"params":[{"required":"yes","param":"string $nonce Nonce that was used in the form to verify"},{"required":"yes","param":"string|int $action Should give context to what is taking place and be the same when nonce was created."}],"desc":"Verify that correct nonce was used with time limit.","returns":"bool Whether the nonce check passed or failed."},"wp_create_nonce":{"params":[{"required":"yes","param":"string|int $action Scalar value to add context to the nonce."}],"desc":"Creates a random, one time use token.","returns":"string The one use form token"},"wp_salt":{"params":[{"required":"yes","param":"string $scheme Authentication scheme"}],"desc":"Get salt to add to hashes to help prevent attacks.","returns":"string Salt value"},"wp_hash":{"params":[{"required":"yes","param":"string $data Plain text to hash"}],"desc":"Get hash of given string.","returns":"string Hash of $data"},"wp_hash_password":{"params":[{"required":"yes","param":"string $password Plain text user password to hash"}],"desc":"Create a hash (encrypt) of a plain text password.","returns":"string The hash string of the password"},"wp_check_password":{"params":[{"required":"yes","param":"string $password Plaintext user's password"},{"required":"yes","param":"string $hash Hash of the user's password to check against."}],"desc":"Checks the plaintext password against the encrypted Password.","returns":"bool False, if the $password does not match the hashed password"},"wp_generate_password":{"params":[{"required":"yes","param":"int $length The length of password to generate"},{"required":"yes","param":"bool $special_chars Whether to include standard special characters. Default true."},{"required":"yes","param":"bool $extra_special_chars Whether to include other special characters. Used when generating secret keys and salts. Default false."}],"desc":"Generates a random password drawn from the defined set of characters.","returns":"string The random password"},"wp_rand":{"params":[{"required":"no","param":"int $min Lower limit for the generated number (optional, default is 0)"},{"required":"no","param":"int $max Upper limit for the generated number (optional, default is 4294967295)"}],"desc":"Generates a random number","returns":"int A random number between min and max"},"wp_set_password":{"params":[{"required":"yes","param":"string $password The plaintext new user password"},{"required":"yes","param":"int $user_id User ID"}],"desc":"Updates the user's password with a new encrypted one.","returns":""},"get_avatar":{"params":[{"required":"yes","param":"int|string|object $id_or_email A user ID, email address, or comment object"},{"required":"yes","param":"int $size Size of the avatar image"},{"required":"yes","param":"string $default URL to a default image to use if no avatar is available"},{"required":"yes","param":"string $alt Alternate text to use in image tag. Defaults to blank"}],"desc":"Retrieve the avatar for a user who provided a user ID or email address.","returns":"string <img> tag for the user's avatar"},"wp_text_diff":{"params":[{"required":"yes","param":"string $left_string "old" (left) version of string"},{"required":"yes","param":"string $right_string "new" (right) version of string"},{"required":"no","param":"string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults."}],"desc":"Displays a human readable HTML representation of the difference between two strings.","returns":"string Empty string if strings are equivalent or HTML with differences."},"get_comment_author":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to retrieve the author. Optional."}],"desc":"Retrieve the author of the current comment.","returns":"string The comment author"},"comment_author":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author. Optional."}],"desc":"Displays the author of the current comment.","returns":""},"get_comment_author_email":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's email. Optional."}],"desc":"Retrieve the email of the author of the current comment.","returns":"string The current comment author's email"},"comment_author_email":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's email. Optional."}],"desc":"Display the email of the author of the current global $comment.","returns":""},"comment_author_email_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Display the html email link to the author of the current comment.","returns":""},"get_comment_author_email_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Return the html email link to the author of the current comment.","returns":""},"get_comment_author_link":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's link. Optional."}],"desc":"Retrieve the html link to the url of the author of the current comment.","returns":"string Comment Author name or HTML link for author's URL"},"comment_author_link":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's link. Optional."}],"desc":"Display the html link to the url of the author of the current comment.","returns":""},"get_comment_author_IP":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's IP address. Optional."}],"desc":"Retrieve the IP address of the author of the current comment.","returns":"string The comment author's IP address."},"comment_author_IP":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's IP address. Optional."}],"desc":"Display the IP address of the author of the current comment.","returns":""},"get_comment_author_url":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's URL. Optional."}],"desc":"Retrieve the url of the author of the current comment.","returns":"string "},"comment_author_url":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's URL. Optional."}],"desc":"Display the url of the author of the current comment.","returns":""},"get_comment_author_url_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Retrieves the HTML link of the url of the author of the current comment.","returns":"string The HTML link between the $before and $after parameters"},"comment_author_url_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Displays the HTML link of the url of the author of the current comment.","returns":""},"comment_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list"},{"required":"no","param":"int $comment_id An optional comment ID"},{"required":"no","param":"int $post_id An optional post ID"},{"required":"yes","param":"bool $echo Whether comment_class should echo or return"}],"desc":"Generates semantic classes for each comment element","returns":""},"get_comment_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list"},{"required":"no","param":"int $comment_id An optional comment ID"},{"required":"no","param":"int $post_id An optional post ID"}],"desc":"Returns the classes for the comment div as an array","returns":"array Array of classes"},"get_comment_date":{"params":[{"required":"yes","param":"string $d The format of the date (defaults to user's config)"},{"required":"no","param":"int $comment_ID The ID of the comment for which to get the date. Optional."}],"desc":"Retrieve the comment date of the current comment.","returns":"string The comment's date"},"comment_date":{"params":[{"required":"yes","param":"string $d The format of the date (defaults to user's config)"},{"required":"no","param":"int $comment_ID The ID of the comment for which to print the date. Optional."}],"desc":"Display the comment date of the current comment.","returns":""},"get_comment_excerpt":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the excerpt. Optional."}],"desc":"Retrieve the excerpt of the current comment.","returns":"string The maybe truncated comment with 20 words or less"},"comment_excerpt":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the excerpt. Optional."}],"desc":"Display the excerpt of the current comment.","returns":""},"get_comment_ID":{"params":[],"desc":"Retrieve the comment id of the current comment.","returns":"int The comment ID"},"comment_ID":{"params":[],"desc":"Displays the comment id of the current comment.","returns":""},"get_comment_link":{"params":[{"required":"yes","param":"object|string|int $comment Comment to retrieve."},{"required":"no","param":"array $args Optional args."}],"desc":"Retrieve the link to a given comment.","returns":"string The permalink to the given comment."},"get_comments_link":{"params":[{"required":"no","param":"int $post_id Optional post id"}],"desc":"Retrieves the link to the current post comments.","returns":"string The link to the comments"},"comments_link":{"params":[{"required":"yes","param":"string $deprecated Not Used"},{"required":"yes","param":"bool $deprecated_2 Not Used"}],"desc":"Displays the link to the current post comments.","returns":""},"get_comments_number":{"params":[{"required":"yes","param":"int $post_id The Post ID"}],"desc":"Retrieve the amount of comments a post has.","returns":"int The number of comments a post has"},"comments_number":{"params":[{"required":"yes","param":"string $zero Text for no comments"},{"required":"yes","param":"string $one Text for one comment"},{"required":"yes","param":"string $more Text for more than one comment"},{"required":"yes","param":"string $deprecated Not used."}],"desc":"Display the language string for the number of comments the current post has.","returns":""},"get_comment_text":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the text. Optional."}],"desc":"Retrieve the text of the current comment.","returns":"string The comment content"},"comment_text":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the text. Optional."}],"desc":"Displays the text of the current comment.","returns":""},"get_comment_time":{"params":[{"required":"no","param":"string $d Optional. The format of the time (defaults to user's config)"},{"required":"yes","param":"bool $gmt Whether to use the GMT date"},{"required":"yes","param":"bool $translate Whether to translate the time (for use in feeds)"}],"desc":"Retrieve the comment time of the current comment.","returns":"string The formatted time"},"comment_time":{"params":[{"required":"no","param":"string $d Optional. The format of the time (defaults to user's config)"}],"desc":"Display the comment time of the current comment.","returns":""},"get_comment_type":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the type. Optional."}],"desc":"Retrieve the comment type of the current comment.","returns":"string The comment type"},"comment_type":{"params":[{"required":"yes","param":"string $commenttxt The string to display for comment type"},{"required":"yes","param":"string $trackbacktxt The string to display for trackback type"},{"required":"yes","param":"string $pingbacktxt The string to display for pingback type"}],"desc":"Display the comment type of the current comment.","returns":""},"get_trackback_url":{"params":[],"desc":"Retrieve The current post's trackback URL.","returns":"string The trackback URL after being filtered"},"trackback_url":{"params":[{"required":"yes","param":"bool $deprecated_echo Remove backwards compat in 2.5"}],"desc":"Displays the current post's trackback URL.","returns":"void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead."},"trackback_rdf":{"params":[{"required":"yes","param":"int $deprecated Not used (Was $timezone = 0)"}],"desc":"Generates and displays the RDF for the trackback information of current post.","returns":""},"comments_open":{"params":[{"required":"no","param":"int $post_id An optional post ID to check instead of the current post."}],"desc":"Whether the current post is open for comments.","returns":"bool True if the comments are open"},"pings_open":{"params":[{"required":"no","param":"int $post_id An optional post ID to check instead of the current post."}],"desc":"Whether the current post is open for pings.","returns":"bool True if pings are accepted"},"wp_comment_form_unfiltered_html_nonce":{"params":[],"desc":"Displays form token for unfiltered comments.","returns":""},"comments_template":{"params":[{"required":"no","param":"string $file Optional, default '/comments.php'. The file to load"},{"required":"no","param":"bool $separate_comments Optional, whether to separate the comments by comment type. Default is false."}],"desc":"Loads the comment template specified in $file.","returns":"null Returns null if no comments appear"},"comments_popup_script":{"params":[{"required":"no","param":"int $width Optional. The width of the popup window"},{"required":"no","param":"int $height Optional. The height of the popup window"},{"required":"no","param":"string $file Optional. Sets the location of the popup window"}],"desc":"Displays the JS popup script to show a comment.","returns":""},"comments_popup_link":{"params":[{"required":"yes","param":"string $zero The string to display when no comments"},{"required":"yes","param":"string $one The string to display when only one comment is available"},{"required":"yes","param":"string $more The string to display when there are more than one comment"},{"required":"yes","param":"string $css_class The CSS class to use for comments"},{"required":"yes","param":"string $none The string to display when comments have been turned off"}],"desc":"Displays the link to the comments popup window for the current post ID.","returns":"null Returns null on single posts and pages."},"get_comment_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int $comment Optional. Comment being replied to."},{"required":"no","param":"int $post Optional. Post that the comment is going to be displayed on."}],"desc":"Retrieve HTML content for reply to comment link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"comment_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int $comment Optional. Comment being replied to."},{"required":"no","param":"int $post Optional. Post that the comment is going to be displayed on."}],"desc":"Displays the HTML content for reply to comment link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"get_post_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int|object $post Optional. Post that the comment is going to be displayed on. Defaults to current post."}],"desc":"Retrieve HTML content for reply to post link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"post_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int|object $post Optional. Post that the comment is going to be displayed on."}],"desc":"Displays the HTML content for reply to post link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"get_cancel_comment_reply_link":{"params":[{"required":"no","param":"string $text Optional. Text to display for cancel reply link."}],"desc":"Retrieve HTML content for cancel comment reply link.","returns":""},"cancel_comment_reply_link":{"params":[{"required":"no","param":"string $text Optional. Text to display for cancel reply link."}],"desc":"Display HTML content for cancel comment reply link.","returns":""},"get_comment_id_fields":{"params":[],"desc":"Retrieve hidden input HTML for replying to comments.","returns":"string Hidden input HTML for replying to comments"},"comment_id_fields":{"params":[],"desc":"Output hidden input HTML for replying to comments.","returns":""},"comment_form_title":{"params":[{"required":"no","param":"string $noreplytext Optional. Text to display when not replying to a comment."},{"required":"no","param":"string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to."},{"required":"no","param":"string $linktoparent Optional. Boolean to control making the author's name a link to their comment."}],"desc":"Display text based on comment reply status. Only affects users with Javascript disabled.","returns":""},"wp_list_comments":{"params":[{"required":"yes","param":"string|array $args Formatting options"},{"required":"no","param":"array $comments Optional array of comment objects. Defaults to $wp_query->comments"}],"desc":"List comments","returns":""},"comment_form":{"params":[{"required":"yes","param":"array $args Options for strings, fields etc in the form"},{"required":"yes","param":"mixed $post_id Post ID to generate the form for, uses the current post if null"}],"desc":"Outputs a complete commenting form for use within a template.","returns":"void "},"is_wp_error":{"params":[{"required":"yes","param":"mixed $thing Check if unknown variable is WordPress Error object."}],"desc":"Check whether variable is a WordPress Error.","returns":"bool True, if WP_Error. False, if not WP_Error."},"image_constrain_size_for_editor":{"params":[{"required":"yes","param":"int $width Width of the image"},{"required":"yes","param":"int $height Height of the image"},{"required":"yes","param":"string|array $size Size of what the result image should be."}],"desc":"Scale down the default size of an image.","returns":"array Width and height of what the result image should resize to."},"image_hwstring":{"params":[{"required":"no","param":"int|string $width Optional. Width attribute value."},{"required":"no","param":"int|string $height Optional. Height attribute value."}],"desc":"Retrieve width and height attributes using given width and height values.","returns":"string HTML attributes for width and, or height."},"image_downsize":{"params":[{"required":"yes","param":"int $id Attachment ID for image."},{"required":"no","param":"array|string $size Optional, default is 'medium'. Size of image, either array or string."}],"desc":"Scale an image to fit a particular size (such as 'thumb' or 'medium').","returns":"bool|array False on failure, array on success."},"add_image_size":{"params":[],"desc":"Registers a new image size","returns":""},"set_post_thumbnail_size":{"params":[],"desc":"Registers an image size for the post thumbnail","returns":""},"get_image_tag":{"params":[{"required":"yes","param":"int $id Attachment ID."},{"required":"yes","param":"string $alt Image Description for the alt attribute."},{"required":"yes","param":"string $title Image Description for the title attribute."},{"required":"yes","param":"string $align Part of the class name for aligning the image."},{"required":"no","param":"string $size Optional. Default is 'medium'."}],"desc":"An <img src /> tag for an image attachment, scaling it down if requested.","returns":"string HTML IMG element for given image attachment"},"wp_load_image":{"params":[{"required":"yes","param":"string $file Filename of the image to load."}],"desc":"Load an image from a string, if PHP supports it.","returns":"resource The resulting image resource on success, Error string on failure."},"wp_constrain_dimensions":{"params":[{"required":"yes","param":"int $current_width Current width of the image."},{"required":"yes","param":"int $current_height Current height of the image."},{"required":"no","param":"int $max_width Optional. Maximum wanted width."},{"required":"no","param":"int $max_height Optional. Maximum wanted height."}],"desc":"Calculates the new dimensions for a downsampled image.","returns":"array First item is the width, the second item is the height."},"image_resize_dimensions":{"params":[{"required":"yes","param":"int $orig_w Original width."},{"required":"yes","param":"int $orig_h Original height."},{"required":"yes","param":"int $dest_w New width."},{"required":"yes","param":"int $dest_h New height."},{"required":"no","param":"bool $crop Optional, default is false. Whether to crop image or resize."}],"desc":"Retrieve calculated resized dimensions for use in imagecopyresampled().","returns":"bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function."},"image_resize":{"params":[{"required":"yes","param":"string $file Image file path."},{"required":"yes","param":"int $max_w Maximum width to resize to."},{"required":"yes","param":"int $max_h Maximum height to resize to."},{"required":"no","param":"bool $crop Optional. Whether to crop image or resize."},{"required":"no","param":"string $suffix Optional. File suffix."},{"required":"no","param":"string $dest_path Optional. New image file path."},{"required":"no","param":"int $jpeg_quality Optional, default is 90. Image quality percentage."}],"desc":"Scale down an image to fit a particular size and save a new copy of the image.","returns":"mixed WP_Error on failure. String with new destination path."},"image_make_intermediate_size":{"params":[{"required":"yes","param":"string $file File path."},{"required":"yes","param":"int $width Image width."},{"required":"yes","param":"int $height Image height."},{"required":"no","param":"bool $crop Optional, default is false. Whether to crop image to specified height and width or resize."}],"desc":"Resize an image to make a thumbnail or intermediate size.","returns":"bool|array False, if no image was created. Metadata array on success."},"image_get_intermediate_size":{"params":[{"required":"yes","param":"int $post_id Attachment ID for image."},{"required":"no","param":"array|string $size Optional, default is 'thumbnail'. Size of image, either array or string."}],"desc":"Retrieve the image's intermediate size (resized) path, width, and height.","returns":"bool|array False on failure or array of file path, width, and height on success."},"get_intermediate_image_sizes":{"params":[],"desc":"Get the available image sizes","returns":"array Returns a filtered array of image size strings"},"wp_get_attachment_image_src":{"params":[{"required":"yes","param":"int $attachment_id Image attachment ID."},{"required":"no","param":"string $size Optional, default is 'thumbnail'."},{"required":"no","param":"bool $icon Optional, default is false. Whether it is an icon."}],"desc":"Retrieve an image to represent an attachment.","returns":"bool|array Returns an array (url, width, height), or false, if no image is available."},"wp_get_attachment_image":{"params":[{"required":"yes","param":"int $attachment_id Image attachment ID."},{"required":"no","param":"string $size Optional, default is 'thumbnail'."},{"required":"no","param":"bool $icon Optional, default is false. Whether it is an icon."}],"desc":"Get an HTML img element representing an image attachment","returns":"string HTML img element or empty string on failure."},"_wp_post_thumbnail_class_filter":{"params":[{"required":"yes","param":"array $attr Attributes including src, class, alt, title"}],"desc":"Adds a 'wp-post-image' class to post thumbnails Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to dynamically add/remove itself so as to only filter post thumbnails","returns":"array "},"_wp_post_thumbnail_class_filter_add":{"params":[],"desc":"Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter","returns":""},"_wp_post_thumbnail_class_filter_remove":{"params":[],"desc":"Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter","returns":""},"img_caption_shortcode":{"params":[{"required":"yes","param":"array $attr Attributes attributed to the shortcode."},{"required":"no","param":"string $content Optional. Shortcode content."}],"desc":"The Caption shortcode.","returns":"string "},"gallery_shortcode":{"params":[{"required":"yes","param":"array $attr Attributes of the shortcode."}],"desc":"The Gallery shortcode.","returns":"string HTML content to display gallery."},"previous_image_link":{"params":[{"required":"no","param":"string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;"},{"required":"no","param":"string $text Optional, default is false. If included, link will reflect $text variable."}],"desc":"Display previous image link that has the same post parent.","returns":"string HTML content."},"next_image_link":{"params":[{"required":"no","param":"string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;"},{"required":"no","param":"string $text Optional, default is false. If included, link will reflect $text variable."}],"desc":"Display next image link that has the same post parent.","returns":"string HTML content."},"adjacent_image_link":{"params":[{"required":"no","param":"bool $prev Optional. Default is true to display previous link, false for next."}],"desc":"Display next or previous image link that has the same post parent.","returns":""},"get_attachment_taxonomies":{"params":[{"required":"yes","param":"int|array|object $attachment Attachment ID, Attachment data array, or Attachment data object."}],"desc":"Retrieve taxonomies attached to the attachment.","returns":"array Empty array on failure. List of taxonomies on success."},"gd_edit_image_support":{"params":[{"required":"yes","param":"string $mime_type "}],"desc":"Check if the installed version of GD supports particular image type","returns":"bool "},"wp_imagecreatetruecolor":{"params":[{"required":"yes","param":"int $width Image width"},{"required":"yes","param":"int $height Image height"}],"desc":"Create new GD image resource with transparency support","returns":"image resource"},"wp_embed_register_handler":{"params":[],"desc":"Register an embed handler. This function should probably only be used for sites that do not support oEmbed.","returns":""},"wp_embed_unregister_handler":{"params":[],"desc":"Unregister a previously registered embed handler.","returns":""},"wp_embed_defaults":{"params":[],"desc":"Create default array of embed parameters.","returns":"array Default embed parameters."},"wp_expand_dimensions":{"params":[{"required":"yes","param":"int $example_width The width of an example embed."},{"required":"yes","param":"int $example_height The height of an example embed."},{"required":"yes","param":"int $max_width The maximum allowed width."},{"required":"yes","param":"int $max_height The maximum allowed height."}],"desc":"Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.","returns":"array The maximum possible width and height based on the example ratio."},"wp_oembed_get":{"params":[{"required":"yes","param":"string $url The URL that should be embedded."},{"required":"yes","param":"array $args Additional arguments and parameters."}],"desc":"Attempts to fetch the embed HTML for a provided URL using oEmbed.","returns":"string The original URL on failure or the embed HTML on success."},"wp_oembed_add_provider":{"params":[{"required":"yes","param":"string $format The format of URL that this provider can handle. You can use asterisks as wildcards."},{"required":"yes","param":"string $provider The URL to the oEmbed provider."},{"required":"yes","param":"boolean $regex Whether the $format parameter is in a regex format."}],"desc":"Adds a URL format and oEmbed provider URL pair.","returns":""},"wp_maybe_load_embeds":{"params":[],"desc":"Determines if default embed handlers should be loaded.","returns":""},"wp_embed_handler_googlevideo":{"params":[{"required":"yes","param":"array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}."},{"required":"yes","param":"array $attr Embed attributes."},{"required":"yes","param":"string $url The original URL that was matched by the regex."},{"required":"yes","param":"array $rawattr The original unmodified attributes."}],"desc":"The Google Video embed handler callback. Google Video does not support oEmbed.","returns":"string The embed HTML."},"wp_cache_add":{"params":[{"required":"yes","param":"int|string $key The cache key to use for retrieval later"},{"required":"yes","param":"mixed $data The data to add to the cache store"},{"required":"yes","param":"string $group The group to add the cache to"},{"required":"yes","param":"int $expire When the cache data should be expired"}],"desc":"Adds data to the cache, if the cache key doesn't already exist.","returns":"unknown "},"wp_cache_close":{"params":[],"desc":"Closes the cache.","returns":"bool Always returns True"},"wp_cache_decr":{"params":[{"required":"yes","param":"int|string $key The cache key to increment"},{"required":"yes","param":"int $offset The amount by which to decrement the item's value. Default is 1."},{"required":"yes","param":"string $group The group the key is in."}],"desc":"Decrement numeric cache item's value","returns":"false|int False on failure, the item's new value on success."},"wp_cache_delete":{"params":[{"required":"yes","param":"int|string $key What the contents in the cache are called"},{"required":"yes","param":"string $group Where the cache contents are grouped"}],"desc":"Removes the cache contents matching key and group.","returns":"bool True on successful removal, false on failure"},"wp_cache_flush":{"params":[],"desc":"Removes all cache items.","returns":"bool Always returns true"},"wp_cache_get":{"params":[{"required":"yes","param":"int|string $key What the contents in the cache are called"},{"required":"yes","param":"string $group Where the cache contents are grouped"},{"required":"yes","param":"bool $force Whether to force an update of the local cache from the persistent cache (default is false)"}],"desc":"Retrieves the cache contents from the cache by key and group.","returns":"bool|mixed False on failure to retrieve contents or the cache contents on success"},"wp_cache_incr":{"params":[{"required":"yes","param":"int|string $key The cache key to increment"},{"required":"yes","param":"int $offset The amount by which to increment the item's value. Default is 1."},{"required":"yes","param":"string $group The group the key is in."}],"desc":"Increment numeric cache item's value","returns":"false|int False on failure, the item's new value on success."},"wp_cache_init":{"params":[],"desc":"Sets up Object Cache Global and assigns it.","returns":""},"wp_cache_replace":{"params":[{"required":"yes","param":"int|string $key What to call the contents in the cache"},{"required":"yes","param":"mixed $data The contents to store in the cache"},{"required":"yes","param":"string $group Where to group the cache contents"},{"required":"yes","param":"int $expire When to expire the cache contents"}],"desc":"Replaces the contents of the cache with new data.","returns":"bool False if cache key and group already exist, true on success"},"wp_cache_set":{"params":[{"required":"yes","param":"int|string $key What to call the contents in the cache"},{"required":"yes","param":"mixed $data The contents to store in the cache"},{"required":"yes","param":"string $group Where to group the cache contents"},{"required":"yes","param":"int $expire When to expire the cache contents"}],"desc":"Saves the data to the cache.","returns":"bool False if cache key and group already exist, true on success"},"wp_cache_add_global_groups":{"params":[{"required":"yes","param":"string|array $groups A group or an array of groups to add"}],"desc":"Adds a group or set of groups to the list of global groups.","returns":""},"wp_cache_add_non_persistent_groups":{"params":[{"required":"yes","param":"string|array $groups A group or an array of groups to add"}],"desc":"Adds a group or set of groups to the list of non-persistent groups.","returns":""},"wp_cache_reset":{"params":[],"desc":"Reset internal cache keys and structures.  If the cache backend uses global blog or site IDs as part of its cache keys, this function instructs the backend to reset those keys and perform any cleanup since blog or site IDs have changed since cache init.","returns":""},"wp_initial_constants":{"params":[],"desc":"Defines initial WordPress constants","returns":""},"wp_plugin_directory_constants":{"params":[],"desc":"Defines plugin directory WordPress constants","returns":""},"wp_cookie_constants":{"params":[],"desc":"Defines cookie related WordPress constants","returns":""},"wp_ssl_constants":{"params":[],"desc":"Defines cookie related WordPress constants","returns":""},"wp_functionality_constants":{"params":[],"desc":"Defines functionality related WordPress constants","returns":""},"wp_templating_constants":{"params":[],"desc":"Defines templating related WordPress constants","returns":""},"_":{"params":[],"desc":"","returns":""},"mb_substr":{"params":[],"desc":"","returns":""},"_mb_substr":{"params":[],"desc":"","returns":""},"hash_hmac":{"params":[],"desc":"","returns":""},"_hash_hmac":{"params":[],"desc":"","returns":""},"json_encode":{"params":[],"desc":"","returns":""},"json_decode":{"params":[],"desc":"","returns":""},"_json_decode_object_helper":{"params":[],"desc":"","returns":""},"wp_widget_rss_output":{"params":[{"required":"yes","param":"string|array|object $rss RSS url."},{"required":"yes","param":"array $args Widget arguments."}],"desc":"Display the RSS entries in a list.","returns":""},"wp_widget_rss_form":{"params":[{"required":"yes","param":"array|string $args Values for input fields."},{"required":"yes","param":"array $inputs Override default display options."}],"desc":"Display RSS widget options form.","returns":""},"wp_widget_rss_process":{"params":[{"required":"yes","param":"array $widget_rss RSS widget feed data. Expects unescaped data."},{"required":"no","param":"bool $check_feed Optional, default is true. Whether to check feed for errors."}],"desc":"Process RSS feed widget data and optionally retrieve feed items.","returns":"array "},"wp_widgets_init":{"params":[],"desc":"Register all of the default WordPress widgets on startup.","returns":""},"get_all_category_ids":{"params":[],"desc":"Retrieves all category IDs.","returns":"object List of all of the category IDs."},"get_categories":{"params":[{"required":"no","param":"string|array $args Optional. Change the defaults retrieving categories."}],"desc":"Retrieve list of category objects.","returns":"array List of categories."},"get_category":{"params":[{"required":"yes","param":"int|object $category Category ID or Category row object"},{"required":"no","param":"string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional. Default is raw or no WordPress defined filter will applied."}],"desc":"Retrieves category data given a category ID or category object.","returns":"mixed Category data in type defined by $output parameter."},"get_category_by_path":{"params":[{"required":"yes","param":"string $category_path URL containing category slugs."},{"required":"no","param":"bool $full_match Optional. Whether full path should be matched."},{"required":"no","param":"string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N"}],"desc":"Retrieve category based on URL containing the category slug.","returns":"null|object|array Null on failure. Type is based on $output value."},"get_category_by_slug":{"params":[{"required":"yes","param":"string $slug The category slug."}],"desc":"Retrieve category object by category slug.","returns":"object Category data object"},"get_cat_ID":{"params":[{"required":"no","param":"string $cat_name Optional. Default is 'General' and can be any category name."}],"desc":"Retrieve the ID of a category from its name.","returns":"int 0, if failure and ID of category on success."},"get_cat_name":{"params":[{"required":"yes","param":"int $cat_id Category ID"}],"desc":"Retrieve the name of a category from its ID.","returns":"string Category name, or an empty string if category doesn't exist."},"cat_is_ancestor_of":{"params":[{"required":"yes","param":"int|object $cat1 ID or object to check if this is the parent category."},{"required":"yes","param":"int|object $cat2 The child category."}],"desc":"Check if a category is an ancestor of another category.","returns":"bool Whether $cat2 is child of $cat1"},"sanitize_category":{"params":[{"required":"yes","param":"object|array $category Category data"},{"required":"no","param":"string $context Optional. Default is 'display'."}],"desc":"Sanitizes category data based on context.","returns":"object|array Same type as $category with sanitized data for safe use."},"sanitize_category_field":{"params":[{"required":"yes","param":"string $field Category key to sanitize"},{"required":"yes","param":"mixed $value Category value to sanitize"},{"required":"yes","param":"int $cat_id Category ID"},{"required":"yes","param":"string $context What filter to use, 'raw', 'display', etc."}],"desc":"Sanitizes data in single category key field.","returns":"mixed Same type as $value after $value has been sanitized."},"get_tags":{"params":[{"required":"yes","param":"string|array $args Tag arguments to use when retrieving tags."}],"desc":"Retrieves all post tags.","returns":"array List of tags."},"get_tag":{"params":[{"required":"yes","param":"int|object $tag "},{"required":"no","param":"string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional. Default is raw or no WordPress defined filter will applied."}],"desc":"Retrieve post tag by tag ID or tag object.","returns":"object|array Return type based on $output value."},"clean_category_cache":{"params":[{"required":"yes","param":"int $id Category ID"}],"desc":"Remove the category cache data based on ID.","returns":""},"_make_cat_compat":{"params":[{"required":"yes","param":"array|object $category Category Row object or array"}],"desc":"Update category structure to old pre 2.3 from new taxonomy structure.","returns":""},"_wp_http_get_object":{"params":[],"desc":"Returns the initialized WP_Http Object","returns":"WP_Http HTTP Transport object."},"wp_remote_request":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_get":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request using the GET method.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_post":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request using the POST method.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_head":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request using the HEAD method.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_retrieve_headers":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the headers from the raw response.","returns":"array The headers of the response. Empty array if incorrect parameter given."},"wp_remote_retrieve_header":{"params":[{"required":"yes","param":"array $response "},{"required":"yes","param":"string $header Header name to retrieve value from."}],"desc":"Retrieve a single header by name from the raw response.","returns":"string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist."},"wp_remote_retrieve_response_code":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the response code from the raw response.","returns":"string the response code. Empty string on incorrect parameter given."},"wp_remote_retrieve_response_message":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the response message from the raw response.","returns":"string The response message. Empty string on incorrect parameter given."},"wp_remote_retrieve_body":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the body from the raw response.","returns":"string The body of the response. Empty string if no body or incorrect parameter given."},"wp_http_supports":{"params":[{"required":"yes","param":"array $capabilities Array of capabilities to test or a wp_remote_request() $args array."},{"required":"no","param":"string $url Optional. If given, will check if the URL requires SSL and adds that requirement to the capabilities array."}],"desc":"Determines if there is an HTTP Transport that can process this request.","returns":"bool "},"wptexturize":{"params":[{"required":"yes","param":"string $text The text to be formatted"}],"desc":"Replaces common plain text characters into formatted entities","returns":"string The string replaced with html entities"},"_wptexturize_pushpop_element":{"params":[{"required":"yes","param":"string $text Text to check. First character is assumed to be $opening"},{"required":"yes","param":"array $stack Array used as stack of opened tag elements"},{"required":"yes","param":"string $disabled_elements Tags to match against formatted as regexp sub-expression"},{"required":"yes","param":"string $opening Tag opening character, assumed to be 1 character long"},{"required":"yes","param":"string $opening Tag closing character"}],"desc":"Search for disabled element tags. Push element to stack on tag open and pop on tag close. Assumes first character of $text is tag opening.","returns":"object "},"clean_pre":{"params":[{"required":"yes","param":"array|string $matches The array or string"}],"desc":"Accepts matches array from preg_replace_callback in wpautop() or a string.","returns":"string The pre block without paragraph/line-break conversion."},"wpautop":{"params":[{"required":"yes","param":"string $pee The text which has to be formatted."},{"required":"no","param":"int|bool $br Optional. If set, this will convert all remaining line-breaks after paragraphing. Default true."}],"desc":"Replaces double line-breaks with paragraph elements.","returns":"string Text which has been converted into correct paragraph tags."},"_autop_newline_preservation_helper":{"params":[{"required":"yes","param":"array $matches preg_replace_callback matches array"}],"desc":"Newline preservation help function for wpautop","returns":""},"shortcode_unautop":{"params":[{"required":"yes","param":"string $pee The content."}],"desc":"Don't auto-p wrap shortcodes that stand alone","returns":"string The filtered content."},"seems_utf8":{"params":[{"required":"yes","param":"string $str The string to be checked"}],"desc":"Checks to see if a string is utf8 encoded.","returns":"bool True if $str fits a UTF-8 model, false otherwise."},"_wp_specialchars":{"params":[{"required":"yes","param":"string $string The text which is to be encoded."},{"required":"no","param":"mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES."},{"required":"no","param":"string $charset Optional. The character encoding of the string. Default is false."},{"required":"no","param":"boolean $double_encode Optional. Whether to encode existing html entities. Default is false."}],"desc":"Converts a number of special characters into their HTML entities.","returns":"string The encoded text with HTML entities."},"wp_specialchars_decode":{"params":[{"required":"yes","param":"string $string The text which is to be decoded."},{"required":"no","param":"mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old _wp_specialchars() values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES."}],"desc":"Converts a number of HTML entities into their special characters.","returns":"string The decoded text without HTML entities."},"wp_check_invalid_utf8":{"params":[{"required":"yes","param":"string $string The text which is to be checked."},{"required":"no","param":"boolean $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false."}],"desc":"Checks for invalid UTF8 in a string.","returns":"string The checked text."},"utf8_uri_encode":{"params":[{"required":"yes","param":"string $utf8_string "},{"required":"yes","param":"int $length Max length of the string"}],"desc":"Encode the Unicode values to be used in the URI.","returns":"string String with Unicode encoded for URI."},"remove_accents":{"params":[{"required":"yes","param":"string $string Text that might have accent characters"}],"desc":"Converts all accent characters to ASCII characters.","returns":"string Filtered string with replaced "nice" characters."},"sanitize_file_name":{"params":[{"required":"yes","param":"string $filename The filename to be sanitized"}],"desc":"Sanitizes a filename replacing whitespace with dashes","returns":"string The sanitized filename"},"sanitize_user":{"params":[{"required":"yes","param":"string $username The username to be sanitized."},{"required":"yes","param":"bool $strict If set limits $username to specific characters. Default false."}],"desc":"Sanitize username stripping out unsafe characters.","returns":"string The sanitized username, after passing through filters."},"sanitize_key":{"params":[{"required":"yes","param":"string $key String key"}],"desc":"Sanitize a string key.","returns":"string Sanitized key"},"sanitize_title":{"params":[{"required":"yes","param":"string $title The string to be sanitized."},{"required":"no","param":"string $fallback_title Optional. A title to use if $title is empty."},{"required":"no","param":"string $context Optional. The operation for which the string is sanitized"}],"desc":"Sanitizes title or use fallback title.","returns":"string The sanitized string."},"sanitize_title_for_query":{"params":[],"desc":"","returns":""},"sanitize_title_with_dashes":{"params":[{"required":"yes","param":"string $title The title to be sanitized."},{"required":"no","param":"string $raw_title Optional. Not used."},{"required":"no","param":"string $context Optional. The operation for which the string is sanitized."}],"desc":"Sanitizes title, replacing whitespace and a few other characters with dashes.","returns":"string The sanitized title."},"sanitize_sql_orderby":{"params":[{"required":"yes","param":"string $orderby Order by string to be checked."}],"desc":"Ensures a string is a valid SQL order by clause.","returns":"string|false Returns the order by clause if it is a match, false otherwise."},"sanitize_html_class":{"params":[{"required":"yes","param":"string $class The classname to be sanitized"},{"required":"no","param":"string $fallback Optional. The value to return if the sanitization end's up as an empty string. Defaults to an empty string."}],"desc":"Santizes a html classname to ensure it only contains valid characters","returns":"string The sanitized value"},"convert_chars":{"params":[{"required":"yes","param":"string $content String of characters to be converted."},{"required":"yes","param":"string $deprecated Not used."}],"desc":"Converts a number of characters from a string.","returns":"string Converted string."},"balanceTags":{"params":[{"required":"yes","param":"string $text Text to be balanced"},{"required":"yes","param":"bool $force Forces balancing, ignoring the value of the option. Default false."}],"desc":"Will only balance the tags if forced to and the option is set to balance tags.","returns":"string Balanced text"},"force_balance_tags":{"params":[{"required":"yes","param":"string $text Text to be balanced."}],"desc":"Balances tags of string using a modified stack.","returns":"string Balanced text."},"format_to_edit":{"params":[{"required":"yes","param":"string $content The text about to be edited."},{"required":"yes","param":"bool $richedit Whether the $content should pass through htmlspecialchars(). Default false."}],"desc":"Acts on text which is about to be edited.","returns":"string The text after the filter (and possibly htmlspecialchars()) has been run."},"format_to_post":{"params":[{"required":"yes","param":"string $content The text to pass through the filter."}],"desc":"Holder for the 'format_to_post' filter.","returns":"string Text returned from the 'format_to_post' filter."},"zeroise":{"params":[{"required":"yes","param":"mixed $number Number to append zeros to if not greater than threshold."},{"required":"yes","param":"int $threshold Digit places number needs to be to not have zeros added."}],"desc":"Add leading zeros when necessary.","returns":"string Adds leading zeros to number if needed."},"backslashit":{"params":[{"required":"yes","param":"string $string Value to which backslashes will be added."}],"desc":"Adds backslashes before letters and before a number at the start of a string.","returns":"string String with backslashes inserted."},"trailingslashit":{"params":[{"required":"yes","param":"string $string What to add the trailing slash to."}],"desc":"Appends a trailing slash.","returns":"string String with trailing slash added."},"untrailingslashit":{"params":[{"required":"yes","param":"string $string What to remove the trailing slash from."}],"desc":"Removes trailing slash if it exists.","returns":"string String without the trailing slash."},"addslashes_gpc":{"params":[{"required":"yes","param":"string $gpc The string returned from HTTP request data."}],"desc":"Adds slashes to escape strings.","returns":"string Returns a string escaped with slashes."},"stripslashes_deep":{"params":[{"required":"yes","param":"array|string $value The array or string to be stripped."}],"desc":"Navigates through an array and removes slashes from the values.","returns":"array|string Stripped array (or string in the callback)."},"urlencode_deep":{"params":[{"required":"yes","param":"array|string $value The array or string to be encoded."}],"desc":"Navigates through an array and encodes the values to be used in a URL.","returns":"array|string $value The encoded array (or string from the callback)."},"antispambot":{"params":[{"required":"yes","param":"string $emailaddy Email address."},{"required":"no","param":"int $mailto Optional. Range from 0 to 1. Used for encoding."}],"desc":"Converts email addresses characters to HTML entities to block spam bots.","returns":"string Converted email address."},"_make_url_clickable_cb":{"params":[{"required":"yes","param":"array $matches Single Regex Match."}],"desc":"Callback to convert URI match to HTML A element.","returns":"string HTML A element with URI address."},"_make_web_ftp_clickable_cb":{"params":[{"required":"yes","param":"array $matches Single Regex Match."}],"desc":"Callback to convert URL match to HTML A element.","returns":"string HTML A element with URL address."},"_make_email_clickable_cb":{"params":[{"required":"yes","param":"array $matches Single Regex Match."}],"desc":"Callback to convert email address match to HTML A element.","returns":"string HTML A element with email address."},"make_clickable":{"params":[{"required":"yes","param":"string $ret Content to convert URIs."}],"desc":"Convert plaintext URI to HTML links.","returns":"string Content with converted URIs."},"wp_rel_nofollow":{"params":[{"required":"yes","param":"string $text Content that may contain HTML A elements."}],"desc":"Adds rel nofollow string to all HTML A elements in content.","returns":"string Converted content."},"wp_rel_nofollow_callback":{"params":[{"required":"yes","param":"array $matches Single Match"}],"desc":"Callback to used to add rel=nofollow string to HTML A element.","returns":"string HTML A Element with rel nofollow."},"translate_smiley":{"params":[{"required":"yes","param":"string $smiley Smiley code to convert to image."}],"desc":"Convert one smiley code to the icon graphic file equivalent.","returns":"string Image string for smiley."},"convert_smilies":{"params":[{"required":"yes","param":"string $text Content to convert smilies from text."}],"desc":"Convert text equivalent of smilies to images.","returns":"string Converted content with text smilies replaced with images."},"is_email":{"params":[{"required":"yes","param":"string $email Email address to verify."},{"required":"yes","param":"boolean $deprecated Deprecated."}],"desc":"Verifies that an email is valid.","returns":"string|bool Either false or the valid email address."},"wp_iso_descrambler":{"params":[{"required":"yes","param":"string $string Subject line"}],"desc":"Convert to ASCII from email subjects.","returns":"string Converted string to ASCII"},"_wp_iso_convert":{"params":[{"required":"yes","param":"array $match the preg_replace_callback matches array"}],"desc":"Helper function to convert hex encoded chars to ascii","returns":""},"get_gmt_from_date":{"params":[{"required":"yes","param":"string $string The date to be converted."},{"required":"yes","param":"string $format The format string for the returned date (default is Y-m-d H:i:s)"}],"desc":"Returns a date in the GMT equivalent.","returns":"string GMT version of the date provided."},"get_date_from_gmt":{"params":[{"required":"yes","param":"string $string The date to be converted."},{"required":"yes","param":"string $format The format string for the returned date (default is Y-m-d H:i:s)"}],"desc":"Converts a GMT date into the correct format for the blog.","returns":"string Formatted date relative to the GMT offset."},"iso8601_timezone_to_offset":{"params":[{"required":"yes","param":"string $timezone Either 'Z' for 0 offset or '\u00b1hhmm'."}],"desc":"Computes an offset in seconds from an iso8601 timezone.","returns":"int|float The offset in seconds."},"iso8601_to_datetime":{"params":[{"required":"yes","param":"string $date_string Date and time in ISO 8601 format {@link http://en.wikipedia.org/wiki/ISO_8601}."},{"required":"no","param":"string $timezone Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'."}],"desc":"Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].","returns":"string The date and time in MySQL DateTime format - Y-m-d H:i:s."},"popuplinks":{"params":[{"required":"yes","param":"string $text Content to replace links to open in a new window."}],"desc":"Adds a element attributes to open links in new windows.","returns":"string Content that has filtered links."},"sanitize_email":{"params":[{"required":"yes","param":"string $email Email address to filter."}],"desc":"Strips out all characters that are not allowable in an email.","returns":"string Filtered email address."},"human_time_diff":{"params":[{"required":"yes","param":"int $from Unix timestamp from which the difference begins."},{"required":"no","param":"int $to Optional. Unix timestamp to end the time difference. Default becomes time() if not set."}],"desc":"Determines the difference between two timestamps.","returns":"string Human readable time difference."},"wp_trim_excerpt":{"params":[{"required":"no","param":"string $text Optional. The excerpt. If set to empty, an excerpt is generated."}],"desc":"Generates an excerpt from the content, if needed.","returns":"string The excerpt."},"wp_trim_words":{"params":[{"required":"yes","param":"string $text Text to trim."},{"required":"yes","param":"int $num_words Number of words. Default 55."},{"required":"yes","param":"string $more What to append if $text needs to be trimmed. Default '…'."}],"desc":"Trims text to a certain number of words.","returns":"string Trimmed text."},"ent2ncr":{"params":[{"required":"yes","param":"string $text The text within which entities will be converted."}],"desc":"Converts named entities into numbered entities.","returns":"string Text with converted entities."},"wp_richedit_pre":{"params":[{"required":"yes","param":"string $text The text to be formatted."}],"desc":"Formats text for the rich text editor.","returns":"string The formatted text after filter is applied."},"wp_htmledit_pre":{"params":[{"required":"yes","param":"string $output The text to be formatted."}],"desc":"Formats text for the HTML editor.","returns":"string Formatted text after filter applied."},"_deep_replace":{"params":[{"required":"yes","param":"string|array $search "},{"required":"yes","param":"string $subject "}],"desc":"Perform a deep string replace operation to ensure the values in $search are no longer present","returns":"string The processed string"},"esc_sql":{"params":[{"required":"yes","param":"string $sql Unescaped SQL data"}],"desc":"Escapes data for use in a MySQL query","returns":"string The cleaned $sql"},"esc_url":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"no","param":"array $protocols Optional. An array of acceptable protocols. Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn' if not set."},{"required":"yes","param":"string $_context Private. Use esc_url_raw() for database usage."}],"desc":"Checks and cleans a URL.","returns":"string The cleaned $url after the 'clean_url' filter is applied."},"esc_url_raw":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"yes","param":"array $protocols An array of acceptable protocols."}],"desc":"Performs esc_url() for database usage.","returns":"string The cleaned URL."},"htmlentities2":{"params":[{"required":"yes","param":"string $myHTML The text to be converted."}],"desc":"Convert entities, while preserving already-encoded entities.","returns":"string Converted text."},"esc_js":{"params":[{"required":"yes","param":"string $text The text to be escaped."}],"desc":"Escape single quotes, htmlspecialchar " < > &, and fix line endings.","returns":"string Escaped text."},"esc_html":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for HTML blocks.","returns":"string "},"esc_attr":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for HTML attributes.","returns":"string "},"esc_textarea":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for textarea values.","returns":"string "},"tag_escape":{"params":[{"required":"yes","param":"string $tag_name "}],"desc":"Escape a HTML tag name.","returns":"string "},"like_escape":{"params":[{"required":"yes","param":"string $text The text to be escaped."}],"desc":"Escapes text for SQL LIKE special characters % and _.","returns":"string text, safe for inclusion in LIKE query."},"wp_make_link_relative":{"params":[{"required":"yes","param":"string $link Full URL path."}],"desc":"Convert full URL paths to absolute paths.","returns":"string Absolute path."},"sanitize_option":{"params":[{"required":"yes","param":"string $option The name of the option."},{"required":"yes","param":"string $value The unsanitised value."}],"desc":"Sanitises various option values based on the nature of the option.","returns":"string Sanitized value."},"wp_parse_str":{"params":[{"required":"yes","param":"string $string The string to be parsed."},{"required":"yes","param":"array $array Variables will be stored in this array."}],"desc":"Parses a string into variables to be stored in an array.","returns":""},"wp_pre_kses_less_than":{"params":[{"required":"yes","param":"string $text Text to be converted."}],"desc":"Convert lone less than signs.","returns":"string Converted text."},"wp_pre_kses_less_than_callback":{"params":[{"required":"yes","param":"array $matches Populated by matches to preg_replace."}],"desc":"Callback function used by preg_replace.","returns":"string The text returned after esc_html if needed."},"wp_sprintf":{"params":[{"required":"yes","param":"string $pattern The string which formatted args are inserted."},{"required":"yes","param":"mixed $args,... Arguments to be formatted into the $pattern string."}],"desc":"WordPress implementation of PHP sprintf() with filters.","returns":"string The formatted string."},"wp_sprintf_l":{"params":[{"required":"yes","param":"string $pattern Content containing '%l' at the beginning."},{"required":"yes","param":"array $args List items to prepend to the content and replace '%l'."}],"desc":"Localize list items before the rest of the content.","returns":"string Localized list items and rest of the content."},"wp_html_excerpt":{"params":[{"required":"yes","param":"integer $str String to get the excerpt from."},{"required":"yes","param":"integer $count Maximum number of characters to take."}],"desc":"Safely extracts not more than the first $count characters from html string.","returns":"string The excerpt."},"links_add_base_url":{"params":[{"required":"yes","param":"string $content String to search for links in."},{"required":"yes","param":"string $base The base URL to prefix to links."},{"required":"yes","param":"array $attrs The attributes which should be processed."}],"desc":"Add a Base url to relative links in passed content.","returns":"string The processed content."},"_links_add_base":{"params":[{"required":"yes","param":"string $m The matched link."}],"desc":"Callback to add a base url to relative links in passed content.","returns":"string The processed link."},"links_add_target":{"params":[{"required":"yes","param":"string $content String to search for links in."},{"required":"yes","param":"string $target The Target to add to the links."},{"required":"yes","param":"array $tags An array of tags to apply to."}],"desc":"Adds a Target attribute to all links in passed content.","returns":"string The processed content."},"_links_add_target":{"params":[{"required":"yes","param":"string $m The matched link."}],"desc":"Callback to add a target attribute to all links in passed content.","returns":"string The processed link."},"normalize_whitespace":{"params":[],"desc":"","returns":""},"wp_strip_all_tags":{"params":[{"required":"yes","param":"string $string String containing HTML tags"},{"required":"no","param":"bool $remove_breaks optional Whether to remove left over line breaks and white space chars"}],"desc":"Properly strip all HTML tags including script and style","returns":"string The processed string."},"sanitize_text_field":{"params":[{"required":"yes","param":"string $str "}],"desc":"Sanitize a string from user input or from the db","returns":"string "},"wp_basename":{"params":[{"required":"yes","param":"string $path A path."},{"required":"yes","param":"string $suffix If the filename ends in suffix this will also be cut off."}],"desc":"i18n friendly version of basename()","returns":"string "},"capital_P_dangit":{"params":[],"desc":"Forever eliminate "Wordpress" from the planet (or at least the little bit we can influence).","returns":""},"sanitize_mime_type":{"params":[{"required":"yes","param":"string $mime_type Mime type"}],"desc":"Sanitize a mime type","returns":"string Sanitized mime type"},"wp_kses":{"params":[{"required":"yes","param":"string $string Content to filter through kses"},{"required":"yes","param":"array $allowed_html List of allowed HTML elements"},{"required":"no","param":"array $allowed_protocols Optional. Allowed protocol in links."}],"desc":"Filters content and keeps only allowable HTML elements.","returns":"string Filtered content with only allowed HTML elements"},"wp_kses_hook":{"params":[{"required":"yes","param":"string $string Content to filter through kses"},{"required":"yes","param":"array $allowed_html List of allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocol in links"}],"desc":"You add any kses hooks here.","returns":"string Filtered content through 'pre_kses' hook"},"wp_kses_version":{"params":[],"desc":"This function returns kses' version number.","returns":"string KSES Version Number"},"wp_kses_split":{"params":[{"required":"yes","param":"string $string Content to filter"},{"required":"yes","param":"array $allowed_html Allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Searches for HTML tags, no matter how malformed.","returns":"string Content with fixed HTML tags"},"_wp_kses_split_callback":{"params":[],"desc":"Callback for wp_kses_split.","returns":""},"wp_kses_split2":{"params":[{"required":"yes","param":"string $string Content to filter"},{"required":"yes","param":"array $allowed_html Allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Callback for wp_kses_split for fixing malformed HTML tags.","returns":"string Fixed HTML element"},"wp_kses_attr":{"params":[{"required":"yes","param":"string $element HTML element/tag"},{"required":"yes","param":"string $attr HTML attributes from HTML element to closing HTML element tag"},{"required":"yes","param":"array $allowed_html Allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Removes all attributes, if none are allowed for this element.","returns":"string Sanitized HTML element"},"wp_kses_hair":{"params":[{"required":"yes","param":"string $attr Attribute list from HTML element to closing HTML element tag"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Builds an attribute list from string containing attributes.","returns":"array List of attributes after parsing"},"wp_kses_check_attr_val":{"params":[{"required":"yes","param":"string $value Attribute value"},{"required":"yes","param":"string $vless Whether the value is valueless. Use 'y' or 'n'"},{"required":"yes","param":"string $checkname What $checkvalue is checking for."},{"required":"yes","param":"mixed $checkvalue What constraint the value should pass"}],"desc":"Performs different checks for attribute values.","returns":"bool Whether check passes"},"wp_kses_bad_protocol":{"params":[{"required":"yes","param":"string $string Content to filter bad protocols from"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Sanitize string from bad protocols.","returns":"string Filtered content"},"wp_kses_no_null":{"params":[{"required":"yes","param":"string $string "}],"desc":"Removes any NULL characters in $string.","returns":"string "},"wp_kses_stripslashes":{"params":[{"required":"yes","param":"string $string String to strip slashes"}],"desc":"Strips slashes from in front of quotes.","returns":"string Fixed string with quoted slashes"},"wp_kses_array_lc":{"params":[{"required":"yes","param":"array $inarray Unfiltered array"}],"desc":"Goes through an array and changes the keys to all lower case.","returns":"array Fixed array with all lowercase keys"},"wp_kses_js_entities":{"params":[{"required":"yes","param":"string $string "}],"desc":"Removes the HTML JavaScript entities found in early versions of Netscape 4.","returns":"string "},"wp_kses_html_error":{"params":[{"required":"yes","param":"string $string "}],"desc":"Handles parsing errors in wp_kses_hair().","returns":"string "},"wp_kses_bad_protocol_once":{"params":[{"required":"yes","param":"string $string Content to check for bad protocols"},{"required":"yes","param":"string $allowed_protocols Allowed protocols"}],"desc":"Sanitizes content from bad protocols and other characters.","returns":"string Sanitized content"},"wp_kses_bad_protocol_once2":{"params":[{"required":"yes","param":"string $string URI scheme to check against the whitelist"},{"required":"yes","param":"string $allowed_protocols Allowed protocols"}],"desc":"Callback for wp_kses_bad_protocol_once() regular expression.","returns":"string Sanitized content"},"wp_kses_normalize_entities":{"params":[{"required":"yes","param":"string $string Content to normalize entities"}],"desc":"Converts and fixes HTML entities.","returns":"string Content with normalized entities"},"wp_kses_named_entities":{"params":[{"required":"yes","param":"array $matches preg_replace_callback() matches array"}],"desc":"Callback for wp_kses_normalize_entities() regular expression.","returns":"string Correctly encoded entity"},"wp_kses_normalize_entities2":{"params":[{"required":"yes","param":"array $matches preg_replace_callback() matches array"}],"desc":"Callback for wp_kses_normalize_entities() regular expression.","returns":"string Correctly encoded entity"},"wp_kses_normalize_entities3":{"params":[{"required":"yes","param":"array $matches preg_replace_callback() matches array"}],"desc":"Callback for wp_kses_normalize_entities() for regular expression.","returns":"string Correctly encoded entity"},"valid_unicode":{"params":[{"required":"yes","param":"int $i Unicode value"}],"desc":"Helper function to determine if a Unicode value is valid.","returns":"bool True if the value was a valid Unicode number"},"wp_kses_decode_entities":{"params":[{"required":"yes","param":"string $string Content to change entities"}],"desc":"Convert all entities to their character counterparts.","returns":"string Content after decoded entities"},"_wp_kses_decode_entities_chr":{"params":[{"required":"yes","param":"array $match preg match"}],"desc":"Regex callback for wp_kses_decode_entities()","returns":"string "},"_wp_kses_decode_entities_chr_hexdec":{"params":[{"required":"yes","param":"array $match preg match"}],"desc":"Regex callback for wp_kses_decode_entities()","returns":"string "},"wp_filter_kses":{"params":[{"required":"yes","param":"string $data Content to filter, expected to be escaped with slashes"}],"desc":"Sanitize content with allowed HTML Kses rules.","returns":"string Filtered content"},"wp_kses_data":{"params":[{"required":"yes","param":"string $data Content to filter, expected to not be escaped"}],"desc":"Sanitize content with allowed HTML Kses rules.","returns":"string Filtered content"},"wp_filter_post_kses":{"params":[{"required":"yes","param":"string $data Post content to filter, expected to be escaped with slashes"}],"desc":"Sanitize content for allowed HTML tags for post content.","returns":"string Filtered post content with allowed HTML tags and attributes intact."},"wp_kses_post":{"params":[{"required":"yes","param":"string $data Post content to filter"}],"desc":"Sanitize content for allowed HTML tags for post content.","returns":"string Filtered post content with allowed HTML tags and attributes intact."},"wp_filter_nohtml_kses":{"params":[{"required":"yes","param":"string $data Content to strip all HTML from"}],"desc":"Strips all of the HTML in the content.","returns":"string Filtered content without any HTML"},"kses_init_filters":{"params":[],"desc":"Adds all Kses input form content filters.","returns":""},"kses_remove_filters":{"params":[],"desc":"Removes all Kses input form content filters.","returns":""},"kses_init":{"params":[],"desc":"Sets up most of the Kses filters for input form content.","returns":""},"safecss_filter_attr":{"params":[],"desc":"Inline CSS filter","returns":""},"create_initial_post_types":{"params":[],"desc":"Creates the initial post types when 'init' action is fired.","returns":""},"get_attached_file":{"params":[{"required":"yes","param":"int $attachment_id Attachment ID."},{"required":"yes","param":"bool $unfiltered Whether to apply filters."}],"desc":"Retrieve attached file path based on attachment ID.","returns":"string The file path to the attached file."},"update_attached_file":{"params":[{"required":"yes","param":"int $attachment_id Attachment ID"},{"required":"yes","param":"string $file File path for the attachment"}],"desc":"Update attachment file path based on attachment ID.","returns":"bool False on failure, true on success."},"_wp_relative_upload_path":{"params":[{"required":"yes","param":"string $path Full path to the file"}],"desc":"Return relative path to an uploaded file.","returns":"string relative path on success, unchanged path on failure."},"get_children":{"params":[{"required":"no","param":"mixed $args Optional. User defined arguments for replacing the defaults."},{"required":"no","param":"string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N."}],"desc":"Retrieve all children of the post parent ID.","returns":"array|bool False on failure and the type will be determined by $output parameter."},"get_extended":{"params":[{"required":"yes","param":"string $post Post content."}],"desc":"Get extended entry info (<!--more-->).","returns":"array Post before ('main') and after ('extended')."},"get_post":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."},{"required":"no","param":"string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N."},{"required":"no","param":"string $filter Optional, default is raw."}],"desc":"Retrieves post data given a post ID or post object.","returns":"mixed Post data"},"get_post_ancestors":{"params":[{"required":"yes","param":"int|object $post Post ID or post object"}],"desc":"Retrieve ancestors of a post.","returns":"array Ancestor IDs or empty array if none are found."},"get_post_field":{"params":[{"required":"yes","param":"string $field Post field name"},{"required":"yes","param":"id $post Post ID"},{"required":"no","param":"string $context Optional. How to filter the field. Default is display."}],"desc":"Retrieve data from a post field based on Post ID.","returns":"WP_Error|string Value in post field or WP_Error on failure"},"get_post_mime_type":{"params":[{"required":"no","param":"int $ID Optional. Post ID."}],"desc":"Retrieve the mime type of an attachment based on the ID.","returns":"bool|string False on failure or returns the mime type"},"get_post_format":{"params":[{"required":"yes","param":"int|object $post A post"}],"desc":"Retrieve the format slug for a post","returns":"mixed The format if successful. False if no format is set. WP_Error if errors."},"has_post_format":{"params":[{"required":"yes","param":"string $format The format to check for"},{"required":"yes","param":"object|id $post The post to check. If not supplied, defaults to the current post if used in the loop."}],"desc":"Check if a post has a particular format","returns":"bool True if the post has the format, false otherwise."},"set_post_format":{"params":[{"required":"yes","param":"int|object $post The post for which to assign a format"},{"required":"yes","param":"string $format A format to assign. Use an empty string or array to remove all formats from the post."}],"desc":"Assign a format to a post","returns":"mixed WP_Error on error. Array of affected term IDs on success."},"get_post_status":{"params":[{"required":"yes","param":"int $ID Post ID"}],"desc":"Retrieve the post status based on the Post ID.","returns":"string|bool Post status or false on failure."},"get_post_statuses":{"params":[],"desc":"Retrieve all of the WordPress supported post statuses.","returns":"array List of post statuses."},"get_page_statuses":{"params":[],"desc":"Retrieve all of the WordPress support page statuses.","returns":"array List of page statuses."},"register_post_status":{"params":[{"required":"yes","param":"string $post_status Name of the post status."},{"required":"yes","param":"array|string $args See above description."}],"desc":"Register a post type. Do not use before init.","returns":""},"get_post_status_object":{"params":[{"required":"yes","param":"string $post_status The name of a registered post status"}],"desc":"Retrieve a post status object by name","returns":"object A post status object"},"get_post_stati":{"params":[{"required":"yes","param":"array|string $args An array of key => value arguments to match against the post status objects."},{"required":"yes","param":"string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default."},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."}],"desc":"Get a list of all registered post status objects.","returns":"array A list of post type names or objects"},"is_post_type_hierarchical":{"params":[{"required":"yes","param":"string $post_type Post type name"}],"desc":"Whether the post type is hierarchical.","returns":"bool Whether post type is hierarchical."},"post_type_exists":{"params":[{"required":"yes","param":"string $post_type Post type name"}],"desc":"Checks if a post type is registered.","returns":"bool Whether post type is registered."},"get_post_type":{"params":[{"required":"no","param":"mixed $the_post Optional. Post object or post ID."}],"desc":"Retrieve the post type of the current post or of a given post.","returns":"bool|string post type or false on failure."},"get_post_type_object":{"params":[{"required":"yes","param":"string $post_type The name of a registered post type"}],"desc":"Retrieve a post type object by name","returns":"object A post type object"},"get_post_types":{"params":[{"required":"yes","param":"array|string $args An array of key => value arguments to match against the post type objects."},{"required":"yes","param":"string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default."},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."}],"desc":"Get a list of all registered post type objects.","returns":"array A list of post type names or objects"},"register_post_type":{"params":[{"required":"yes","param":"string $post_type Name of the post type."},{"required":"yes","param":"array|string $args See above description."}],"desc":"Register a post type. Do not use before init.","returns":"object|WP_Error the registered post type object, or an error object"},"get_post_type_capabilities":{"params":[{"required":"yes","param":"object $args Post type registration arguments"}],"desc":"Builds an object with all post type capabilities out of a post type object","returns":"object object with all the capabilities as member variables"},"_post_type_meta_capabilities":{"params":[],"desc":"Stores or returns a list of post type meta caps for map_meta_cap().","returns":""},"get_post_type_labels":{"params":[{"required":"yes","param":"object $post_type_object "}],"desc":"Builds an object with all post type labels out of a post type object","returns":"object object with all the labels as member variables"},"_get_custom_object_labels":{"params":[],"desc":"Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object","returns":""},"_add_post_type_submenus":{"params":[],"desc":"Adds submenus for post types.","returns":""},"add_post_type_support":{"params":[{"required":"yes","param":"string $post_type The post type for which to add the feature"},{"required":"yes","param":"string|array $feature the feature being added, can be an array of feature strings or a single string"}],"desc":"Register support of certain features for a post type.","returns":""},"remove_post_type_support":{"params":[{"required":"yes","param":"string $post_type The post type for which to remove the feature"},{"required":"yes","param":"string $feature The feature being removed"}],"desc":"Remove support for a feature from a post type.","returns":""},"post_type_supports":{"params":[{"required":"yes","param":"string $post_type The post type being checked"},{"required":"yes","param":"string $feature the feature being checked"}],"desc":"Checks a post type's support for a given feature","returns":"boolean "},"set_post_type":{"params":[{"required":"no","param":"int $post_id Post ID to change post type. Not actually optional."},{"required":"no","param":"string $post_type Optional, default is post. Supported values are 'post' or 'page' to name a few."}],"desc":"Updates the post type for the post ID.","returns":"int Amount of rows changed. Should be 1 for success and 0 for failure."},"get_posts":{"params":[{"required":"no","param":"array $args Optional. Overrides defaults."}],"desc":"Retrieve list of latest posts or posts matching criteria.","returns":"array List of posts."},"add_post_meta":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"bool $unique Optional, default is false. Whether the same key should not be added."}],"desc":"Add meta data field to a post.","returns":"bool False for failure. True for success."},"delete_post_meta":{"params":[{"required":"yes","param":"int $post_id post ID"},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"no","param":"mixed $meta_value Optional. Metadata value."}],"desc":"Remove metadata matching criteria from a post.","returns":"bool False for failure. True for success."},"get_post_meta":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $key The meta key to retrieve."},{"required":"yes","param":"bool $single Whether to return a single value."}],"desc":"Retrieve post meta field for a post.","returns":"mixed Will be an array if $single is false. Will be value of meta data field if $single is true."},"update_post_meta":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"mixed $prev_value Optional. Previous value to check before removing."}],"desc":"Update post meta field based on post ID.","returns":"bool False on failure, true if success."},"delete_post_meta_by_key":{"params":[{"required":"yes","param":"string $post_meta_key Key to search for when deleting."}],"desc":"Delete everything from post meta matching meta key.","returns":"bool Whether the post meta key was deleted from the database"},"get_post_custom":{"params":[{"required":"yes","param":"int $post_id post ID"}],"desc":"Retrieve post meta fields, based on post ID.","returns":"array "},"get_post_custom_keys":{"params":[{"required":"yes","param":"int $post_id post ID"}],"desc":"Retrieve meta field names for a post.","returns":"array|null Either array of the keys, or null if keys could not be retrieved."},"get_post_custom_values":{"params":[{"required":"yes","param":"string $key Meta field key."},{"required":"yes","param":"int $post_id Post ID"}],"desc":"Retrieve values for a custom post field.","returns":"array Meta field values."},"is_sticky":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Check if post is sticky.","returns":"bool Whether post is sticky."},"sanitize_post":{"params":[{"required":"yes","param":"object|array $post The Post Object or Array"},{"required":"no","param":"string $context Optional, default is 'display'. How to sanitize post fields."}],"desc":"Sanitize every post field.","returns":"object|array The now sanitized Post Object or Array (will be the same type as $post)"},"sanitize_post_field":{"params":[{"required":"yes","param":"string $field The Post Object field name."},{"required":"yes","param":"mixed $value The Post Object value."},{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display', 'attribute' and 'js'."}],"desc":"Sanitize post field based on context.","returns":"mixed Sanitized value."},"stick_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Make a post sticky.","returns":""},"unstick_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Unstick a post.","returns":""},"wp_count_posts":{"params":[{"required":"no","param":"string $type Optional. Post type to retrieve count"},{"required":"no","param":"string $perm Optional. 'readable' or empty."}],"desc":"Count number of posts of a post type and is user has permissions to view.","returns":"object Number of posts for each status"},"wp_count_attachments":{"params":[{"required":"no","param":"string|array $mime_type Optional. Array or comma-separated list of MIME patterns."}],"desc":"Count number of attachments for the mime type(s).","returns":"array Number of posts for each mime type."},"wp_match_mime_types":{"params":[{"required":"yes","param":"string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or flash (same as *flash*)."},{"required":"yes","param":"string|array $real_mime_types post_mime_type values"}],"desc":"Check a MIME-Type against a list.","returns":"array array(wildcard=>array(real types))"},"wp_post_mime_type_where":{"params":[{"required":"yes","param":"string|array $post_mime_types List of mime types or comma separated string of mime types."},{"required":"no","param":"string $table_alias Optional. Specify a table alias, if needed."}],"desc":"Convert MIME types into SQL.","returns":"string The SQL AND clause for mime searching."},"wp_delete_post":{"params":[{"required":"yes","param":"int $postid Post ID."},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Defaults to false."}],"desc":"Trashes or deletes a post or page.","returns":"mixed False on failure"},"wp_trash_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Moves a post or page to the Trash","returns":"mixed False on failure"},"wp_untrash_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Restores a post or page from the Trash","returns":"mixed False on failure"},"wp_trash_post_comments":{"params":[{"required":"yes","param":"int $post Post ID or object."}],"desc":"Moves comments for a post to the trash","returns":"mixed False on failure"},"wp_untrash_post_comments":{"params":[{"required":"yes","param":"int $post Post ID or object."}],"desc":"Restore comments for a post from the trash","returns":"mixed False on failure"},"wp_get_post_categories":{"params":[{"required":"no","param":"int $post_id Optional. The Post ID."},{"required":"no","param":"array $args Optional. Overwrite the defaults."}],"desc":"Retrieve the list of categories for a post.","returns":"array "},"wp_get_post_tags":{"params":[{"required":"no","param":"int $post_id Optional. The Post ID"},{"required":"no","param":"array $args Optional. Overwrite the defaults"}],"desc":"Retrieve the tags for a post.","returns":"array List of post tags."},"wp_get_post_terms":{"params":[{"required":"no","param":"int $post_id Optional. The Post ID"},{"required":"yes","param":"string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag."},{"required":"no","param":"array $args Optional. Overwrite the defaults"}],"desc":"Retrieve the terms for a post.","returns":"array List of post tags."},"wp_get_recent_posts":{"params":[{"required":"yes","param":"string $deprecated Deprecated."},{"required":"no","param":"array $args Optional. Overrides defaults."},{"required":"no","param":"string $output Optional."}],"desc":"Retrieve number of recent posts.","returns":"unknown. "},"wp_get_single_post":{"params":[{"required":"yes","param":"int $postid Post ID."},{"required":"yes","param":"string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A."}],"desc":"Retrieve a single post, based on post ID.","returns":"object|array Post object or array holding post contents and information"},"wp_insert_post":{"params":[{"required":"yes","param":"array $postarr Elements that make up post to insert."},{"required":"no","param":"bool $wp_error Optional. Allow return of WP_Error on failure."}],"desc":"Insert a post.","returns":"int|WP_Error The value 0 or WP_Error on failure. The post ID on success."},"wp_update_post":{"params":[{"required":"yes","param":"array|object $postarr Post data. Arrays are expected to be escaped, objects are not."}],"desc":"Update a post with new post data.","returns":"int 0 on failure, Post ID on success."},"wp_publish_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Publish a post by transitioning the post status.","returns":"null "},"check_and_publish_future_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Publish future post and make sure post ID has future post status.","returns":"null Nothing is returned. Which can mean that no action is required or post was published."},"wp_unique_post_slug":{"params":[{"required":"yes","param":"string $slug the desired slug (post_name)"},{"required":"yes","param":"integer $post_ID "},{"required":"yes","param":"string $post_status no uniqueness checks are made if the post is still draft or pending"},{"required":"yes","param":"string $post_type "},{"required":"yes","param":"integer $post_parent "}],"desc":"Computes a unique slug for the post, when given the desired slug and some post details.","returns":"string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)"},"wp_add_post_tags":{"params":[{"required":"yes","param":"int $post_id Post ID"},{"required":"yes","param":"string $tags The tags to set for the post, separated by commas."}],"desc":"Adds tags to a post.","returns":"bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise"},"wp_set_post_tags":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $tags The tags to set for the post, separated by commas."},{"required":"yes","param":"bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags."}],"desc":"Set the tags for a post.","returns":"mixed Array of affected term IDs. WP_Error or false on failure."},"wp_set_post_terms":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $tags The tags to set for the post, separated by commas."},{"required":"yes","param":"bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags."}],"desc":"Set the terms for a post.","returns":"mixed Array of affected term IDs. WP_Error or false on failure."},"wp_set_post_categories":{"params":[{"required":"yes","param":"int $post_ID Post ID."},{"required":"no","param":"array $post_categories Optional. List of categories."}],"desc":"Set categories for a post.","returns":"bool|mixed "},"wp_transition_post_status":{"params":[{"required":"yes","param":"string $new_status Transition to this post status."},{"required":"yes","param":"string $old_status Previous post status."},{"required":"yes","param":"object $post Post data."}],"desc":"Transition the post status of a post.","returns":""},"add_ping":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $uri Ping URI."}],"desc":"Add a URL to those already pung.","returns":"int How many rows were updated."},"get_enclosed":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Retrieve enclosures already enclosed for a post.","returns":"array List of enclosures"},"get_pung":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Retrieve URLs already pinged for a post.","returns":"array "},"get_to_ping":{"params":[{"required":"yes","param":"int $post_id Post ID"}],"desc":"Retrieve URLs that need to be pinged.","returns":"array "},"trackback_url_list":{"params":[{"required":"yes","param":"string $tb_list Comma separated list of URLs"},{"required":"yes","param":"int $post_id Post ID"}],"desc":"Do trackbacks for a list of URLs.","returns":""},"get_all_page_ids":{"params":[],"desc":"Get a list of page IDs.","returns":"array List of page IDs."},"get_page":{"params":[{"required":"yes","param":"mixed $page Page object or page ID. Passed by reference."},{"required":"yes","param":"string $output What to output. OBJECT, ARRAY_A, or ARRAY_N."},{"required":"yes","param":"string $filter How the return value should be filtered."}],"desc":"Retrieves page data given a page ID or page object.","returns":"mixed Page data."},"get_page_by_path":{"params":[{"required":"yes","param":"string $page_path Page path"},{"required":"no","param":"string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT."},{"required":"no","param":"string $post_type Optional. Post type. Default page."}],"desc":"Retrieves a page given its path.","returns":"mixed Null when complete."},"get_page_by_title":{"params":[{"required":"yes","param":"string $page_title Page title"},{"required":"no","param":"string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT."},{"required":"no","param":"string $post_type Optional. Post type. Default page."}],"desc":"Retrieve a page given its title.","returns":"mixed "},"get_page_children":{"params":[{"required":"yes","param":"int $page_id Page ID."},{"required":"yes","param":"array $pages List of pages' objects."}],"desc":"Retrieve child pages from list of pages matching page ID.","returns":"array "},"get_page_hierarchy":{"params":[{"required":"yes","param":"array $pages Posts array."},{"required":"yes","param":"int $page_id Parent page ID."}],"desc":"Order the pages with children under parents in a flat list.","returns":"array A list arranged by hierarchy. Children immediately follow their parents."},"_page_traverse_name":{"params":[],"desc":"function to traverse and return all the nested children post names of a root page.","returns":""},"get_page_uri":{"params":[{"required":"yes","param":"mixed $page Page object or page ID."}],"desc":"Builds URI for a page.","returns":"string Page URI."},"get_pages":{"params":[{"required":"no","param":"mixed $args Optional. Array or string of options that overrides defaults."}],"desc":"Retrieve a list of pages.","returns":"array List of pages matching defaults or $args"},"is_local_attachment":{"params":[{"required":"yes","param":"string $url URL to check"}],"desc":"Check if the attachment URI is local one and is really an attachment.","returns":"bool True on success, false on failure."},"wp_insert_attachment":{"params":[{"required":"yes","param":"string|array $object Arguments to override defaults."},{"required":"no","param":"string $file Optional filename."},{"required":"yes","param":"int $parent Parent post ID."}],"desc":"Insert an attachment.","returns":"int Attachment ID."},"wp_delete_attachment":{"params":[{"required":"yes","param":"int $post_id Attachment ID."},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Defaults to false."}],"desc":"Trashes or deletes an attachment.","returns":"mixed False on failure. Post data on success."},"wp_get_attachment_metadata":{"params":[{"required":"yes","param":"int $post_id Attachment ID"},{"required":"no","param":"bool $unfiltered Optional, default is false. If true, filters are not run."}],"desc":"Retrieve attachment meta field for attachment ID.","returns":"string|bool Attachment meta field. False on failure."},"wp_update_attachment_metadata":{"params":[{"required":"yes","param":"int $post_id Attachment ID."},{"required":"yes","param":"array $data Attachment data."}],"desc":"Update metadata for an attachment.","returns":"int "},"wp_get_attachment_url":{"params":[{"required":"yes","param":"int $post_id Attachment ID."}],"desc":"Retrieve the URL for an attachment.","returns":"string "},"wp_get_attachment_thumb_file":{"params":[{"required":"yes","param":"int $post_id Attachment ID."}],"desc":"Retrieve thumbnail for an attachment.","returns":"mixed False on failure. Thumbnail file path on success."},"wp_get_attachment_thumb_url":{"params":[{"required":"yes","param":"int $post_id Attachment ID"}],"desc":"Retrieve URL for an attachment thumbnail.","returns":"string|bool False on failure. Thumbnail URL on success."},"wp_attachment_is_image":{"params":[{"required":"yes","param":"int $post_id Attachment ID"}],"desc":"Check if the attachment is an image.","returns":"bool "},"wp_mime_type_icon":{"params":[{"required":"yes","param":"string $mime MIME type"}],"desc":"Retrieve the icon for a MIME type.","returns":"string|bool "},"wp_check_for_changed_slugs":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"object $post The Post Object"},{"required":"yes","param":"object $post_before The Previous Post Object"}],"desc":"Checked for changed slugs for published post objects and save the old slug.","returns":"int Same as $post_id"},"get_private_posts_cap_sql":{"params":[{"required":"yes","param":"string $post_type currently only supports 'post' or 'page'."}],"desc":"Retrieve the private post SQL based on capability.","returns":"string SQL code that can be added to a where clause."},"get_posts_by_author_sql":{"params":[{"required":"yes","param":"string $post_type Post type."},{"required":"no","param":"bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term."},{"required":"no","param":"int $post_author Optional. Query posts having a single author ID."}],"desc":"Retrieve the post SQL based on capability, author, and type.","returns":"string SQL WHERE code that can be added to a query."},"get_lastpostdate":{"params":[{"required":"yes","param":"string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'."}],"desc":"Retrieve the date that the last post was published.","returns":"string The date of the last post."},"get_lastpostmodified":{"params":[{"required":"yes","param":"string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'."}],"desc":"Retrieve last post modified date depending on timezone.","returns":"string The date the post was last modified."},"_get_last_post_time":{"params":[{"required":"yes","param":"string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'."},{"required":"yes","param":"string $field Field to check. Can be 'date' or 'modified'."}],"desc":"Retrieve latest post date data based on timezone.","returns":"string The date."},"update_post_cache":{"params":[{"required":"yes","param":"array $posts Array of post objects"}],"desc":"Updates posts in cache.","returns":""},"clean_post_cache":{"params":[{"required":"yes","param":"int $id The Post ID in the cache to clean"}],"desc":"Will clean the post in the cache.","returns":""},"update_page_cache":{"params":[{"required":"yes","param":"array $pages list of page objects"}],"desc":"Alias of update_post_cache().","returns":""},"clean_page_cache":{"params":[{"required":"yes","param":"int $id Page ID to clean"}],"desc":"Will clean the page in the cache.","returns":""},"update_post_caches":{"params":[{"required":"yes","param":"array $posts Array of Post objects"},{"required":"yes","param":"string $post_type The post type of the posts in $posts. Default is 'post'."},{"required":"yes","param":"bool $update_term_cache Whether to update the term cache. Default is true."},{"required":"yes","param":"bool $update_meta_cache Whether to update the meta cache. Default is true."}],"desc":"Call major cache updating functions for list of Post objects.","returns":""},"update_postmeta_cache":{"params":[{"required":"yes","param":"array $post_ids List of post IDs."}],"desc":"Updates metadata cache for list of post IDs.","returns":"bool|array Returns false if there is nothing to update or an array of metadata."},"clean_attachment_cache":{"params":[{"required":"yes","param":"int $id The attachment ID in the cache to clean"},{"required":"no","param":"bool $clean_terms optional. Whether to clean terms cache"}],"desc":"Will clean the attachment in the cache.","returns":""},"_transition_post_status":{"params":[{"required":"yes","param":"string $new_status New post status"},{"required":"yes","param":"string $old_status Previous post status"},{"required":"yes","param":"object $post Object type containing the post information"}],"desc":"Hook for managing future post transitions to published.","returns":""},"_future_post_hook":{"params":[{"required":"yes","param":"int $deprecated Not used. Can be set to null. Never implemented. Not marked as deprecated with _deprecated_argument() as it conflicts with wp_transition_post_status() and the default filter for _future_post_hook()."},{"required":"yes","param":"object $post Object type containing the post information"}],"desc":"Hook used to schedule publication for a post marked for the future.","returns":""},"_publish_post_hook":{"params":[{"required":"yes","param":"int $post_id The ID in the database table of the post being published"}],"desc":"Hook to schedule pings and enclosures when a post is published.","returns":""},"_save_post_hook":{"params":[{"required":"yes","param":"int $post_id The ID in the database table for the $post"},{"required":"yes","param":"object $post Object type containing the post information"}],"desc":"Hook used to prevent page/post cache and rewrite rules from staying dirty.","returns":""},"_get_post_ancestors":{"params":[{"required":"yes","param":"object $_post Post data."}],"desc":"Retrieve post ancestors and append to post ancestors property.","returns":"null When nothing needs to be done."},"_wp_post_revision_fields":{"params":[{"required":"no","param":"array $post Optional a post array to be processed for insertion as a post revision."},{"required":"no","param":"bool $autosave optional Is the revision an autosave?"}],"desc":"Determines which fields of posts are to be saved in revisions.","returns":"array Post array ready to be inserted as a post revision or array of fields that can be versioned."},"wp_save_post_revision":{"params":[{"required":"yes","param":"int $post_id The ID of the post to save as a revision."}],"desc":"Saves an already existing post as a post revision.","returns":"mixed Null or 0 if error, new revision ID, if success."},"wp_get_post_autosave":{"params":[{"required":"yes","param":"int $post_id The post ID."}],"desc":"Retrieve the autosaved data of the specified post.","returns":"object|bool The autosaved data or false on failure or when no autosave exists."},"_wp_get_post_autosave_hack":{"params":[{"required":"yes","param":"object $query WP_Query object"}],"desc":"Internally used to hack WP_Query into submission.","returns":""},"wp_is_post_revision":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."}],"desc":"Determines if the specified post is a revision.","returns":"bool|int False if not a revision, ID of revision's parent otherwise."},"wp_is_post_autosave":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."}],"desc":"Determines if the specified post is an autosave.","returns":"bool|int False if not a revision, ID of autosave's parent otherwise"},"_wp_put_post_revision":{"params":[{"required":"yes","param":"int|object|array $post Post ID, post object OR post array."},{"required":"no","param":"bool $autosave Optional. Is the revision an autosave?"}],"desc":"Inserts post data into the posts table as a post revision.","returns":"mixed Null or 0 if error, new revision ID if success."},"wp_get_post_revision":{"params":[{"required":"yes","param":"int|object $post Post ID or post object"},{"required":"no","param":"string $output Optional. OBJECT, ARRAY_A, or ARRAY_N."},{"required":"no","param":"string $filter Optional sanitation filter. @see sanitize_post()"}],"desc":"Gets a post revision.","returns":"mixed Null if error or post object if success"},"wp_restore_post_revision":{"params":[{"required":"yes","param":"int|object $revision_id Revision ID or revision object."},{"required":"no","param":"array $fields Optional. What fields to restore from. Defaults to all."}],"desc":"Restores a post to the specified revision.","returns":"mixed Null if error, false if no fields to restore, (int) post ID if success."},"wp_delete_post_revision":{"params":[{"required":"yes","param":"int|object $revision_id Revision ID or revision object."}],"desc":"Deletes a revision.","returns":"mixed Null or WP_Error if error, deleted post if success."},"wp_get_post_revisions":{"params":[{"required":"yes","param":"int|object $post_id Post ID or post object"}],"desc":"Returns all revisions of specified post.","returns":"array empty if no revisions"},"_set_preview":{"params":[],"desc":"","returns":""},"_show_post_preview":{"params":[],"desc":"","returns":""},"wp_get_post_parent_id":{"params":[{"required":"yes","param":"int $post_id "}],"desc":"Returns the post's parent's post_ID","returns":"int|bool false on error"},"wp_check_post_hierarchy_for_loops":{"params":[{"required":"yes","param":"int $post_parent ID of the parent for the post we're checking."}],"desc":"Checks the given subset of the post hierarchy for hierarchy loops.","returns":"int The new post_parent for the post."},"get_post_format_strings":{"params":[],"desc":"Returns an array of post format slugs to their translated and pretty display versions","returns":"array The array of translations"},"get_post_format_slugs":{"params":[],"desc":"Retrieves an array of post format slugs.","returns":"array The array of post format slugs."},"get_post_format_string":{"params":[{"required":"yes","param":"string $slug A post format slug"}],"desc":"Returns a pretty, translated version of a post format slug","returns":"string The translated post format name"},"set_post_thumbnail":{"params":[{"required":"yes","param":"int|object $post Post ID or object where thumbnail should be attached."},{"required":"yes","param":"int $thumbnail_id Thumbnail to attach."}],"desc":"Sets a post thumbnail.","returns":"bool True on success, false on failure."},"delete_post_thumbnail":{"params":[{"required":"yes","param":"int|object $post Post ID or object where thumbnail should be removed from."}],"desc":"Removes a post thumbnail.","returns":"bool True on success, false on failure."},"get_post_format_link":{"params":[{"required":"yes","param":"string $format Post format"}],"desc":"Returns a link to a post format index.","returns":"string Link"},"_post_format_request":{"params":[],"desc":"Filters the request to allow for the format prefix.","returns":""},"_post_format_link":{"params":[],"desc":"Filters the post format term link to remove the format prefix.","returns":""},"_post_format_get_term":{"params":[],"desc":"Remove the post format prefix from the name property of the term object created by get_term().","returns":""},"_post_format_get_terms":{"params":[],"desc":"Remove the post format prefix from the name property of the term objects created by get_terms().","returns":""},"_post_format_wp_get_object_terms":{"params":[],"desc":"Remove the post format prefix from the name property of the term objects created by wp_get_object_terms().","returns":""},"_update_term_count_on_transition_post_status":{"params":[{"required":"yes","param":"string $new_status "},{"required":"yes","param":"string $old_status "},{"required":"yes","param":"object $post "}],"desc":"Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts.","returns":""},"wp_print_scripts":{"params":[],"desc":"Prints script tags in document head.","returns":""},"wp_register_script":{"params":[{"required":"yes","param":"string $handle Script name"},{"required":"yes","param":"string $src Script url"},{"required":"no","param":"array $deps (optional) Array of script names on which this script depends"},{"required":"no","param":"string|bool $ver (optional) Script version (used for cache busting), set to NULL to disable"},{"required":"no","param":"bool $in_footer (optional) Whether to enqueue the script before </head> or before </body>"}],"desc":"Register new Javascript file.","returns":"null "},"wp_localize_script":{"params":[{"required":"yes","param":"string $handle The script handle that was registered or used in script-loader"},{"required":"yes","param":"string $object_name Name for the created JS object. This is passed directly so it should be qualified JS variable /a-zA-Z0-9_+/"},{"required":"yes","param":"array $l10n Associative PHP array containing the translated strings. HTML entities will be converted and the array will be JSON encoded."}],"desc":"Wrapper for $wp_scripts->localize().","returns":"bool Whether the localization was added successfully."},"wp_deregister_script":{"params":[],"desc":"Remove a registered script.","returns":""},"wp_enqueue_script":{"params":[],"desc":"Enqueues script.","returns":""},"wp_dequeue_script":{"params":[],"desc":"Remove an enqueued script.","returns":""},"wp_script_is":{"params":[{"required":"yes","param":"string $handle Handle used to add script."},{"required":"no","param":"string $list Optional, defaults to 'queue'. Others values are 'registered', 'queue', 'done', 'to_do'"}],"desc":"Check whether script has been added to WordPress Scripts.","returns":"bool "},"wpmu_update_blogs_date":{"params":[],"desc":"Update the last_updated field for the current blog.","returns":""},"get_blogaddress_by_id":{"params":[{"required":"yes","param":"int $blog_id Blog ID"}],"desc":"Get a full blog URL, given a blog id.","returns":"string "},"get_blogaddress_by_name":{"params":[{"required":"yes","param":"string $blogname The (subdomain or directory) name"}],"desc":"Get a full blog URL, given a blog name.","returns":"string "},"get_blogaddress_by_domain":{"params":[{"required":"yes","param":"string $domain "},{"required":"yes","param":"string $path "}],"desc":"Get a full blog URL, given a domain and a path.","returns":"string "},"get_id_from_blogname":{"params":[{"required":"yes","param":"string $name "}],"desc":"Given a blog's (subdomain or directory) name, retrieve it's id.","returns":"int A blog id"},"get_blog_details":{"params":[{"required":"yes","param":"int|string|array $fields A blog ID, a blog name, or an array of fields to query against."},{"required":"yes","param":"bool $get_all Whether to retrieve all details or only the details in the blogs table. Default is true."}],"desc":"Retrieve the details for a blog from the blogs table and blog options.","returns":"object Blog details."},"refresh_blog_details":{"params":[{"required":"yes","param":"int $blog_id Blog ID"}],"desc":"Clear the blog details cache.","returns":""},"update_blog_details":{"params":[{"required":"yes","param":"int $blog_id Blog ID"},{"required":"yes","param":"array $details Array of details keyed by blogs table field names."}],"desc":"Update the details for a blog. Updates the blogs table for a given blog id.","returns":"bool True if update succeeds, false otherwise."},"get_blog_option":{"params":[{"required":"no","param":"int $blog_id Optional. Blog ID, can be null to refer to the current blog."},{"required":"yes","param":"string $setting Name of option to retrieve. Should already be SQL-escaped."},{"required":"no","param":"string $default (optional) Default value returned if option not found."}],"desc":"Retrieve option value based on setting name and blog_id.","returns":"mixed Value set for the option."},"add_blog_option":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $key The option key"},{"required":"yes","param":"mixed $value The option value"}],"desc":"Add an option for a particular blog.","returns":"bool True on success, false on failure."},"delete_blog_option":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $key The option key"}],"desc":"Delete an option for a particular blog.","returns":"bool True on success, false on failure."},"update_blog_option":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $key The option key"},{"required":"yes","param":"mixed $value The option value"}],"desc":"Update an option for a particular blog.","returns":"bool True on success, false on failrue."},"switch_to_blog":{"params":[{"required":"yes","param":"int $new_blog The id of the blog you want to switch to. Default: current blog"},{"required":"yes","param":"bool $validate Whether to check if $new_blog exists before proceeding"}],"desc":"Switch the current blog.","returns":"bool True on success, False if the validation failed"},"restore_current_blog":{"params":[],"desc":"Restore the current blog, after calling switch_to_blog()","returns":"bool True on success, False if we're already on the current blog"},"is_archived":{"params":[{"required":"yes","param":"int $id The blog id"}],"desc":"Check if a particular blog is archived.","returns":"string Whether the blog is archived or not"},"update_archived":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $archived The new status"}],"desc":"Update the 'archived' status of a particular blog.","returns":"string $archived"},"update_blog_status":{"params":[{"required":"yes","param":"int $blog_id BLog ID"},{"required":"yes","param":"string $pref A field name"},{"required":"yes","param":"string $value Value for $pref"}],"desc":"Update a blog details field.","returns":"string $value"},"get_blog_status":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $pref A field name"}],"desc":"Get a blog details field.","returns":"bool $value"},"get_last_updated":{"params":[{"required":"yes","param":"mixed $deprecated Not used"},{"required":"yes","param":"int $start The offset"},{"required":"yes","param":"int $quantity The maximum number of blogs to retrieve. Default is 40."}],"desc":"Get a list of most recently updated blogs.","returns":"array The list of blogs"},"_update_blog_date_on_post_publish":{"params":[{"required":"yes","param":"string $new_status The new post status"},{"required":"yes","param":"string $old_status The old post status"},{"required":"yes","param":"object $post Post object"}],"desc":"Handler for updating the blog date when a post is published or an already published post is changed.","returns":""},"get_header":{"params":[{"required":"yes","param":"string $name The name of the specialised header."}],"desc":"Load header template.","returns":""},"get_footer":{"params":[{"required":"yes","param":"string $name The name of the specialised footer."}],"desc":"Load footer template.","returns":""},"get_sidebar":{"params":[{"required":"yes","param":"string $name The name of the specialised sidebar."}],"desc":"Load sidebar template.","returns":""},"get_template_part":{"params":[{"required":"yes","param":"string $slug The slug name for the generic template."},{"required":"yes","param":"string $name The name of the specialised template."}],"desc":"Load a template part into a template","returns":""},"get_search_form":{"params":[{"required":"yes","param":"boolean $echo Default to echo and not return the form."}],"desc":"Display search form.","returns":""},"wp_loginout":{"params":[{"required":"no","param":"string $redirect Optional path to redirect to on login/logout."},{"required":"yes","param":"boolean $echo Default to echo and not return the link."}],"desc":"Display the Log In/Out link.","returns":""},"wp_logout_url":{"params":[{"required":"yes","param":"string $redirect Path to redirect to on logout."}],"desc":"Returns the Log Out URL.","returns":""},"wp_login_url":{"params":[{"required":"yes","param":"string $redirect Path to redirect to on login."},{"required":"yes","param":"bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false."}],"desc":"Returns the Log In URL.","returns":"string A log in url"},"wp_login_form":{"params":[{"required":"yes","param":"array $args Configuration options to modify the form output"}],"desc":"Provides a simple login form for use anywhere within WordPress. By default, it echoes the HTML immediately. Pass array('echo'=>false) to return the string instead.","returns":"Void, or string containing the form"},"wp_lostpassword_url":{"params":[{"required":"yes","param":"string $redirect Path to redirect to on login."}],"desc":"Returns the Lost Password URL.","returns":""},"wp_register":{"params":[{"required":"yes","param":"string $before Text to output before the link (defaults to <li>)."},{"required":"yes","param":"string $after Text to output after the link (defaults to </li>)."},{"required":"yes","param":"boolean $echo Default to echo and not return the link."}],"desc":"Display the Registration or Admin link.","returns":""},"wp_meta":{"params":[],"desc":"Theme container function for the 'wp_meta' action.","returns":""},"bloginfo":{"params":[{"required":"yes","param":"string $show What to display."}],"desc":"Display information about the blog.","returns":""},"get_bloginfo":{"params":[{"required":"yes","param":"string $show Blog info to retrieve."},{"required":"yes","param":"string $filter How to filter what is retrieved."}],"desc":"Retrieve information about the blog.","returns":"string Mostly string values, might be empty."},"get_current_blog_id":{"params":[],"desc":"Retrieve the current blog id","returns":"int Blog id"},"wp_title":{"params":[{"required":"no","param":"string $sep Optional, default is '»'. How to separate the various items within the page title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."},{"required":"no","param":"string $seplocation Optional. Direction to display title, 'right'."}],"desc":"Display or retrieve page title for all areas of blog.","returns":"string|null String on retrieve, null when displaying."},"single_post_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for post.","returns":"string|null Title when retrieving, null when displaying or failure."},"post_type_archive_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve title for a post type archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_cat_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for category archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_tag_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for tag post archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_term_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for taxonomy term archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_month_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for post archive based on date.","returns":"string|null Title when retrieving, null when displaying or failure."},"get_archives_link":{"params":[{"required":"yes","param":"string $url URL to archive."},{"required":"yes","param":"string $text Archive text description."},{"required":"no","param":"string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom."},{"required":"no","param":"string $before Optional."},{"required":"no","param":"string $after Optional."}],"desc":"Retrieve archive link content based on predefined or custom code.","returns":"string HTML link content for archive."},"wp_get_archives":{"params":[{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Display archive links based on type and format.","returns":""},"calendar_week_mod":{"params":[{"required":"yes","param":"int $num Number of day."}],"desc":"Get number of days since the start of the week.","returns":"int Days since the start of the week."},"get_calendar":{"params":[{"required":"no","param":"bool $initial Optional, default is true. Use initial calendar names."},{"required":"no","param":"bool $echo Optional, default is true. Set to false for return."}],"desc":"Display calendar with days that have posts as links.","returns":""},"delete_get_calendar_cache":{"params":[],"desc":"Purge the cached results of get_calendar.","returns":""},"allowed_tags":{"params":[],"desc":"Display all of the allowed tags in HTML format with attributes.","returns":"string HTML allowed tags entity encoded."},"the_date_xml":{"params":[],"desc":"Outputs the date in iso8601 format for xml files.","returns":""},"the_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format defaults to the date_format option if not specified."},{"required":"no","param":"string $before Optional. Output before the date."},{"required":"no","param":"string $after Optional. Output after the date."},{"required":"no","param":"bool $echo Optional, default is display. Whether to echo the date or return it."}],"desc":"Display or Retrieve the date the current $post was written (once per date)","returns":"string|null Null if displaying, string if retrieving."},"get_the_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format defaults to the date_format option if not specified."}],"desc":"Retrieve the date the current $post was written.","returns":"string|null Null if displaying, string if retrieving."},"the_modified_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format defaults to the date_format option if not specified."},{"required":"no","param":"string $before Optional. Output before the date."},{"required":"no","param":"string $after Optional. Output after the date."},{"required":"no","param":"bool $echo Optional, default is display. Whether to echo the date or return it."}],"desc":"Display the date on which the post was last modified.","returns":"string|null Null if displaying, string if retrieving."},"get_the_modified_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format. Defaults to the "date_format" option"}],"desc":"Retrieve the date on which the post was last modified.","returns":"string "},"the_time":{"params":[{"required":"yes","param":"string $d Either 'G', 'U', or php date format."}],"desc":"Display the time at which the post was written.","returns":""},"get_the_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option."},{"required":"no","param":"int|object $post Optional post ID or object. Default is global $post object."}],"desc":"Retrieve the time at which the post was written.","returns":"string "},"get_post_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format."},{"required":"no","param":"bool $gmt Optional, default is false. Whether to return the gmt time."},{"required":"no","param":"int|object $post Optional post ID or object. Default is global $post object."},{"required":"yes","param":"bool $translate Whether to translate the time string"}],"desc":"Retrieve the time at which the post was written.","returns":"string "},"the_modified_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option."}],"desc":"Display the time at which the post was last modified.","returns":""},"get_the_modified_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option."}],"desc":"Retrieve the time at which the post was last modified.","returns":"string "},"get_post_modified_time":{"params":[{"required":"no","param":"string $d Optional, default is 'U'. Either 'G', 'U', or php date format."},{"required":"no","param":"bool $gmt Optional, default is false. Whether to return the gmt time."},{"required":"no","param":"int|object $post Optional, default is global post object. A post_id or post object"},{"required":"no","param":"bool $translate Optional, default is false. Whether to translate the result"}],"desc":"Retrieve the time at which the post was last modified.","returns":"string Returns timestamp"},"the_weekday":{"params":[],"desc":"Display the weekday on which the post was written.","returns":""},"the_weekday_date":{"params":[{"required":"no","param":"string $before Optional Output before the date."},{"required":"no","param":"string $after Optional Output after the date."}],"desc":"Display the weekday on which the post was written.","returns":""},"wp_head":{"params":[],"desc":"Fire the wp_head action","returns":""},"wp_footer":{"params":[],"desc":"Fire the wp_footer action","returns":""},"feed_links":{"params":[{"required":"no","param":"array $args Optional arguments."}],"desc":"Display the links to the general feeds.","returns":""},"feed_links_extra":{"params":[{"required":"no","param":"array $args Optional arguments."}],"desc":"Display the links to the extra feeds such as category feeds.","returns":""},"rsd_link":{"params":[],"desc":"Display the link to the Really Simple Discovery service endpoint.","returns":""},"wlwmanifest_link":{"params":[],"desc":"Display the link to the Windows Live Writer manifest file.","returns":""},"noindex":{"params":[],"desc":"Display a noindex meta tag if required by the blog configuration.","returns":""},"wp_no_robots":{"params":[],"desc":"Display a noindex meta tag.","returns":""},"rich_edit_exists":{"params":[],"desc":"Determine if TinyMCE is available.","returns":"bool Whether TinyMCE exists."},"user_can_richedit":{"params":[],"desc":"Whether the user should have a WYSIWIG editor.","returns":"bool "},"wp_default_editor":{"params":[],"desc":"Find out which editor should be displayed by default.","returns":"string Either 'tinymce', or 'html', or 'test'"},"wp_editor":{"params":[{"required":"yes","param":"string $content Initial content for the editor."},{"required":"yes","param":"string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /a-z+/."},{"required":"yes","param":"array $settings See _WP_Editors::editor()."}],"desc":"Renders an editor.","returns":""},"get_search_query":{"params":[{"required":"yes","param":"bool $escaped Whether the result is escaped. Default true. Only use when you are later escaping it. Do not use unescaped."}],"desc":"Retrieve the contents of the search WordPress query variable.","returns":"string "},"the_search_query":{"params":[],"desc":"Display the contents of the search query variable.","returns":""},"language_attributes":{"params":[{"required":"yes","param":"string $doctype The type of html document (xhtml|html)."}],"desc":"Display the language attributes for the html tag.","returns":""},"paginate_links":{"params":[{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Retrieve paginated link for archive post pages.","returns":"array|string String of page links or array of page links."},"wp_admin_css_color":{"params":[{"required":"yes","param":"string $key The unique key for this theme."},{"required":"yes","param":"string $name The name of the theme."},{"required":"yes","param":"string $url The url of the css file containing the colour scheme."},{"required":"no","param":"array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme."}],"desc":"Registers an admin colour scheme css file.","returns":""},"register_admin_color_schemes":{"params":[],"desc":"Registers the default Admin color schemes","returns":""},"wp_admin_css_uri":{"params":[{"required":"yes","param":"string $file file relative to wp-admin/ without its ".css" extension."}],"desc":"Display the URL of a WordPress admin CSS file.","returns":""},"wp_admin_css":{"params":[{"required":"no","param":"string $file Optional. Style handle name or file name (without ".css" extension) relative to wp-admin/. Defaults to 'wp-admin'."},{"required":"no","param":"bool $force_echo Optional. Force the stylesheet link to be printed rather than enqueued."}],"desc":"Enqueues or directly prints a stylesheet link to the specified CSS file.","returns":""},"add_thickbox":{"params":[],"desc":"Enqueues the default ThickBox js and css.","returns":""},"wp_generator":{"params":[],"desc":"Display the XHTML generator that is generated on the wp_head hook.","returns":""},"the_generator":{"params":[{"required":"yes","param":"string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export)."}],"desc":"Display the generator XML or Comment for RSS, ATOM, etc.","returns":""},"get_the_generator":{"params":[{"required":"yes","param":"string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export)."}],"desc":"Creates the generator XML or Comment for RSS, ATOM, etc.","returns":"string The HTML content for the generator."},"checked":{"params":[{"required":"yes","param":"mixed $checked One of the values to compare"},{"required":"yes","param":"mixed $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"}],"desc":"Outputs the html checked attribute.","returns":"string html attribute or empty string"},"selected":{"params":[{"required":"yes","param":"mixed $selected One of the values to compare"},{"required":"yes","param":"mixed $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"}],"desc":"Outputs the html selected attribute.","returns":"string html attribute or empty string"},"disabled":{"params":[{"required":"yes","param":"mixed $disabled One of the values to compare"},{"required":"yes","param":"mixed $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"}],"desc":"Outputs the html disabled attribute.","returns":"string html attribute or empty string"},"__checked_selected_helper":{"params":[{"required":"yes","param":"any $helper One of the values to compare"},{"required":"yes","param":"any $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"},{"required":"yes","param":"string $type The type of checked|selected|disabled we are doing"}],"desc":"Private helper function for checked, selected, and disabled.","returns":"string html attribute or empty string"},"add_shortcode":{"params":[{"required":"yes","param":"string $tag Shortcode tag to be searched in post content."},{"required":"yes","param":"callable $func Hook to run when shortcode is found."}],"desc":"Add hook for shortcode tag.","returns":""},"remove_shortcode":{"params":[{"required":"yes","param":"string $tag shortcode tag to remove hook for."}],"desc":"Removes hook for shortcode.","returns":""},"remove_all_shortcodes":{"params":[],"desc":"Clear all shortcodes.","returns":""},"do_shortcode":{"params":[{"required":"yes","param":"string $content Content to search for shortcodes"}],"desc":"Search content for shortcodes and filter shortcodes through their hooks.","returns":"string Content with shortcodes filtered out."},"get_shortcode_regex":{"params":[],"desc":"Retrieve the shortcode regular expression for searching.","returns":"string The shortcode search regular expression"},"do_shortcode_tag":{"params":[{"required":"yes","param":"array $m Regular expression match array"}],"desc":"Regular Expression callable for do_shortcode() for calling shortcode hook.","returns":"mixed False on failure."},"shortcode_parse_atts":{"params":[{"required":"yes","param":"string $text "}],"desc":"Retrieve all attributes from the shortcodes tag.","returns":"array List of attributes and their value."},"shortcode_atts":{"params":[{"required":"yes","param":"array $pairs Entire list of supported attributes and their defaults."},{"required":"yes","param":"array $atts User defined attributes in shortcode tag."}],"desc":"Combine user attributes with known attributes and fill in defaults when needed.","returns":"array Combined and filtered attribute list."},"strip_shortcodes":{"params":[{"required":"yes","param":"string $content Content to remove shortcode tags."}],"desc":"Remove all shortcode tags from the given content.","returns":"string Content without shortcode tags."},"strip_shortcode_tag":{"params":[],"desc":"","returns":""},"get_the_author":{"params":[{"required":"yes","param":"string $deprecated Deprecated."}],"desc":"Retrieve the author of the current post.","returns":"string The author's display name."},"the_author":{"params":[{"required":"yes","param":"string $deprecated Deprecated."},{"required":"yes","param":"string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it."}],"desc":"Display the name of the author of the current post.","returns":"string The author's display name, from get_the_author()."},"get_the_modified_author":{"params":[],"desc":"Retrieve the author who last edited the current post.","returns":"string The author's display name."},"the_modified_author":{"params":[],"desc":"Display the name of the author who last edited the current post.","returns":"string The author's display name, from get_the_modified_author()."},"get_the_author_meta":{"params":[{"required":"yes","param":"string $field selects the field of the users record."},{"required":"no","param":"int $user_id Optional. User ID."}],"desc":"Retrieve the requested data of the author of the current post.","returns":"string The author's field from the current author's DB object."},"the_author_meta":{"params":[{"required":"yes","param":"string $field selects the field of the users record."},{"required":"no","param":"int $user_id Optional. User ID."}],"desc":"Retrieve the requested data of the author of the current post.","returns":""},"get_the_author_link":{"params":[],"desc":"Retrieve either author's link or author's name.","returns":""},"the_author_link":{"params":[],"desc":"Display either author's link or author's name.","returns":""},"get_the_author_posts":{"params":[],"desc":"Retrieve the number of posts by the author of the current post.","returns":"int The number of posts by the author."},"the_author_posts":{"params":[],"desc":"Display the number of posts by the author of the current post.","returns":""},"the_author_posts_link":{"params":[{"required":"yes","param":"string $deprecated Deprecated."}],"desc":"Display an HTML link to the author page of the author of the current post.","returns":""},"get_author_posts_url":{"params":[],"desc":"Retrieve the URL to the author page for the user with the ID provided.","returns":"string The URL to the author's page."},"wp_list_authors":{"params":[{"required":"yes","param":"array $args The argument array."}],"desc":"List all the authors of the blog, with several options available.","returns":"null|string The output, if echo is set to false."},"is_multi_author":{"params":[],"desc":"Does this site have more than one author","returns":"bool Whether or not we have more than one author"},"__clear_multi_author_cache":{"params":[],"desc":"Helper function to clear the cache for number of authors.","returns":""},"the_permalink":{"params":[],"desc":"Display the permalink for the current post.","returns":""},"user_trailingslashit":{"params":[{"required":"yes","param":"string $string URL with or without a trailing slash."},{"required":"yes","param":"string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter."}],"desc":"Retrieve trailing slash string, if blog set for adding trailing slashes.","returns":"string "},"permalink_anchor":{"params":[{"required":"yes","param":"string $mode Permalink mode can be either 'title', 'id', or default, which is 'id'."}],"desc":"Display permalink anchor for current post.","returns":""},"get_permalink":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional, defaults to false. Whether to keep post name or page name."}],"desc":"Retrieve full permalink for current post or post ID.","returns":"string "},"get_post_permalink":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional, defaults to false. Whether to keep post name."},{"required":"no","param":"bool $sample Optional, defaults to false. Is it a sample permalink."}],"desc":"Retrieve the permalink for a post with a custom post type.","returns":"string "},"post_permalink":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"yes","param":"mixed $deprecated Not used."}],"desc":"Retrieve permalink from post ID.","returns":"string "},"get_page_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional, defaults to false. Whether to keep page name."},{"required":"no","param":"bool $sample Optional, defaults to false. Is it a sample permalink."}],"desc":"Retrieve the permalink for current page or page ID.","returns":"string "},"_get_page_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional. Leave name."},{"required":"no","param":"bool $sample Optional. Sample permalink."}],"desc":"Retrieve the page permalink.","returns":"string "},"get_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Retrieve permalink for attachment.","returns":"string "},"get_year_link":{"params":[{"required":"yes","param":"int|bool $year False for current year or year for permalink."}],"desc":"Retrieve the permalink for the year archives.","returns":"string "},"get_month_link":{"params":[{"required":"yes","param":"bool|int $year False for current year. Integer of year."},{"required":"yes","param":"bool|int $month False for current month. Integer of month."}],"desc":"Retrieve the permalink for the month archives with year.","returns":"string "},"get_day_link":{"params":[{"required":"yes","param":"bool|int $year False for current year. Integer of year."},{"required":"yes","param":"bool|int $month False for current month. Integer of month."},{"required":"yes","param":"bool|int $day False for current day. Integer of day."}],"desc":"Retrieve the permalink for the day archives with year and month.","returns":"string "},"the_feed_link":{"params":[{"required":"yes","param":"string $anchor The link's anchor text."},{"required":"no","param":"string $feed Optional, defaults to default feed. Feed type."}],"desc":"Display the permalink for the feed type.","returns":""},"get_feed_link":{"params":[{"required":"no","param":"string $feed Optional, defaults to default feed. Feed type."}],"desc":"Retrieve the permalink for the feed type.","returns":"string "},"get_post_comments_feed_link":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the permalink for the post comments feed.","returns":"string "},"post_comments_feed_link":{"params":[{"required":"yes","param":"string $link_text Descriptive text."},{"required":"no","param":"int $post_id Optional post ID. Default to current post."},{"required":"no","param":"string $feed Optional. Feed format."}],"desc":"Display the comment feed link for a post.","returns":"string Link to the comment feed for the current post."},"get_author_feed_link":{"params":[{"required":"yes","param":"int $author_id ID of an author."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the feed link for a given author.","returns":"string Link to the feed for the author specified by $author_id."},"get_category_feed_link":{"params":[{"required":"yes","param":"int $cat_id ID of a category."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the feed link for a category.","returns":"string Link to the feed for the category specified by $cat_id."},"get_term_feed_link":{"params":[{"required":"yes","param":"int $term_id ID of a category."},{"required":"no","param":"string $taxonomy Optional. Taxonomy of $term_id"},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the feed link for a term.","returns":"string Link to the feed for the term specified by $term_id and $taxonomy."},"get_tag_feed_link":{"params":[{"required":"yes","param":"int $tag_id Tag ID."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve permalink for feed of tag.","returns":"string "},"get_edit_tag_link":{"params":[{"required":"yes","param":"int $tag_id Tag ID"},{"required":"yes","param":"string $taxonomy Taxonomy"}],"desc":"Retrieve edit tag link.","returns":"string "},"edit_tag_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"yes","param":"int|object $tag Tag object or ID"}],"desc":"Display or retrieve edit tag link with formatting.","returns":"string HTML content."},"get_edit_term_link":{"params":[{"required":"yes","param":"int $term_id Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy"},{"required":"yes","param":"string $object_type The object type"}],"desc":"Retrieve edit term url.","returns":"string "},"edit_term_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"yes","param":"object $term Term object"}],"desc":"Display or retrieve edit term link with formatting.","returns":"string HTML content."},"get_search_link":{"params":[{"required":"no","param":"string $query Optional. The query string to use. If empty the current query is used."}],"desc":"Retrieve permalink for search.","returns":"string "},"get_search_feed_link":{"params":[{"required":"no","param":"string $search_query Optional. Search query."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the permalink for the feed of the search results.","returns":"string "},"get_search_comments_feed_link":{"params":[{"required":"no","param":"string $search_query Optional. Search query."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the permalink for the comments feed of the search results.","returns":"string "},"get_post_type_archive_link":{"params":[{"required":"yes","param":"string $post_type Post type"}],"desc":"Retrieve the permalink for a post type archive.","returns":"string "},"get_post_type_archive_feed_link":{"params":[{"required":"yes","param":"string $post_type Post type"},{"required":"no","param":"string $feed Optional. Feed type"}],"desc":"Retrieve the permalink for a post type archive feed.","returns":"string "},"get_edit_post_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"string $context Optional, defaults to display. How to write the '&', defaults to '&'."}],"desc":"Retrieve edit posts link for post.","returns":"string "},"edit_post_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Display edit post link for post.","returns":""},"get_delete_post_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"yes","param":"string $deprecated Not used."},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Default is false."}],"desc":"Retrieve delete posts link for post.","returns":"string "},"get_edit_comment_link":{"params":[{"required":"no","param":"int $comment_id Optional. Comment ID."}],"desc":"Retrieve edit comment link.","returns":"string "},"edit_comment_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."}],"desc":"Display or retrieve edit comment link with formatting.","returns":"string|null HTML content, if $echo is set to false."},"get_edit_bookmark_link":{"params":[{"required":"no","param":"int $link Optional. Bookmark ID."}],"desc":"Display edit bookmark (literally a URL external to blog) link.","returns":"string "},"edit_bookmark_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"no","param":"int $bookmark Optional. Bookmark ID."}],"desc":"Display edit bookmark (literally a URL external to blog) link anchor content.","returns":""},"get_previous_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Retrieve previous post that is adjacent to current post.","returns":"mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists."},"get_next_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Retrieve next post that is adjacent to current post.","returns":"mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists."},"get_adjacent_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $previous Optional. Whether to retrieve previous post."}],"desc":"Retrieve adjacent post.","returns":"mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists."},"get_adjacent_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $previous Optional, default is true. Whether to display link to previous or next post."}],"desc":"Get adjacent post relational link.","returns":"string "},"adjacent_posts_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display relational links for the posts adjacent to the current post.","returns":""},"adjacent_posts_rel_link_wp_head":{"params":[],"desc":"Display relational links for the posts adjacent to the current post for single post pages.","returns":""},"next_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display relational link for the next post adjacent to the current post.","returns":""},"prev_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display relational link for the previous post adjacent to the current post.","returns":""},"get_boundary_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether returned post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $start Optional. Whether to retrieve first or last post."}],"desc":"Retrieve boundary post.","returns":"object "},"previous_post_link":{"params":[{"required":"no","param":"string $format Optional. Link anchor format."},{"required":"no","param":"string $link Optional. Link permalink format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display previous post link that is adjacent to the current post.","returns":""},"next_post_link":{"params":[{"required":"no","param":"string $format Optional. Link anchor format."},{"required":"no","param":"string $link Optional. Link permalink format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display next post link that is adjacent to the current post.","returns":""},"adjacent_post_link":{"params":[{"required":"yes","param":"string $format Link anchor format."},{"required":"yes","param":"string $link Link permalink format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $previous Optional, default is true. Whether to display link to previous or next post."}],"desc":"Display adjacent post link.","returns":""},"get_pagenum_link":{"params":[{"required":"no","param":"int $pagenum Optional. Page ID."}],"desc":"Retrieve links for page numbers.","returns":"string "},"get_next_posts_page_link":{"params":[{"required":"no","param":"int $max_page Optional. Max pages."}],"desc":"Retrieve next posts page link.","returns":"string "},"next_posts":{"params":[{"required":"no","param":"int $max_page Optional. Max pages."},{"required":"no","param":"boolean $echo Optional. Echo or return;"}],"desc":"Display or return the next posts page link.","returns":""},"get_next_posts_link":{"params":[{"required":"yes","param":"string $label Content for link text."},{"required":"no","param":"int $max_page Optional. Max pages."}],"desc":"Return the next posts page link.","returns":"string|null "},"next_posts_link":{"params":[{"required":"yes","param":"string $label Content for link text."},{"required":"no","param":"int $max_page Optional. Max pages."}],"desc":"Display the next posts page link.","returns":""},"get_previous_posts_page_link":{"params":[],"desc":"Retrieve previous posts page link.","returns":"string|null "},"previous_posts":{"params":[{"required":"no","param":"boolean $echo Optional. Echo or return;"}],"desc":"Display or return the previous posts page link.","returns":""},"get_previous_posts_link":{"params":[{"required":"no","param":"string $label Optional. Previous page link text."}],"desc":"Return the previous posts page link.","returns":"string|null "},"previous_posts_link":{"params":[{"required":"no","param":"string $label Optional. Previous page link text."}],"desc":"Display the previous posts page link.","returns":""},"get_posts_nav_link":{"params":[{"required":"no","param":"string|array $args Optional args."}],"desc":"Return post pages link navigation for previous and next pages.","returns":"string The posts link navigation."},"posts_nav_link":{"params":[{"required":"no","param":"string $sep Optional. Separator for posts navigation links."},{"required":"no","param":"string $prelabel Optional. Label for previous pages."},{"required":"no","param":"string $nxtlabel Optional Label for next pages."}],"desc":"Display post pages link navigation for previous and next pages.","returns":""},"get_comments_pagenum_link":{"params":[{"required":"no","param":"int $pagenum Optional. Page number."}],"desc":"Retrieve comments page number link.","returns":"string "},"get_next_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for link text."},{"required":"no","param":"int $max_page Optional. Max page."}],"desc":"Return the link to next comments page.","returns":"string|null "},"next_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for link text."},{"required":"no","param":"int $max_page Optional. Max page."}],"desc":"Display the link to next comments page.","returns":""},"get_previous_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for comments link text."}],"desc":"Return the previous comments page link.","returns":"string|null "},"previous_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for comments link text."}],"desc":"Display the previous comments page link.","returns":""},"paginate_comments_links":{"params":[{"required":"no","param":"string|array $args Optional args. See paginate_links()."}],"desc":"Create pagination links for the comments on the current post.","returns":"string Markup for pagination links."},"get_shortcut_link":{"params":[],"desc":"Retrieve shortcut link.","returns":"string "},"home_url":{"params":[{"required":"no","param":"string $path (optional) Path relative to the home url."},{"required":"no","param":"string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'."}],"desc":"Retrieve the home url for the current site.","returns":"string Home url link with optional path appended."},"get_home_url":{"params":[{"required":"no","param":"int $blog_id (optional) Blog ID. Defaults to current blog."},{"required":"no","param":"string $path (optional) Path relative to the home url."},{"required":"no","param":"string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'."}],"desc":"Retrieve the home url for a given site.","returns":"string Home url link with optional path appended."},"site_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the site url."},{"required":"no","param":"string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'."}],"desc":"Retrieve the site url for the current site.","returns":"string Site url link with optional path appended."},"get_site_url":{"params":[{"required":"no","param":"int $blog_id (optional) Blog ID. Defaults to current blog."},{"required":"no","param":"string $path Optional. Path relative to the site url."},{"required":"no","param":"string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'."}],"desc":"Retrieve the site url for a given site.","returns":"string Site url link with optional path appended."},"admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for the current site.","returns":"string Admin url link with optional path appended."},"get_admin_url":{"params":[{"required":"no","param":"int $blog_id (optional) Blog ID. Defaults to current blog."},{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for a given site.","returns":"string Admin url link with optional path appended."},"includes_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the includes url."}],"desc":"Retrieve the url to the includes directory.","returns":"string Includes url link with optional path appended."},"content_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the content url."}],"desc":"Retrieve the url to the content directory.","returns":"string Content url link with optional path appended."},"plugins_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the plugins url."},{"required":"no","param":"string $plugin Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__"}],"desc":"Retrieve the url to the plugins directory or to a specific file within that directory.","returns":"string Plugins url link with optional path appended."},"network_site_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the site url."},{"required":"no","param":"string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'."}],"desc":"Retrieve the site url for the current network.","returns":"string Site url link with optional path appended."},"network_home_url":{"params":[{"required":"no","param":"string $path (optional) Path relative to the home url."},{"required":"no","param":"string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'."}],"desc":"Retrieve the home url for the current network.","returns":"string Home url link with optional path appended."},"network_admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for the network.","returns":"string Admin url link with optional path appended."},"user_admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for the current user.","returns":"string Admin url link with optional path appended."},"self_admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for either the current blog or the network depending on context.","returns":"string Admin url link with optional path appended."},"get_dashboard_url":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"no","param":"string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins."},{"required":"yes","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."}],"desc":"Get the URL to the user's dashboard.","returns":"string Dashboard url link with optional path appended."},"get_edit_profile_url":{"params":[{"required":"yes","param":"int $user User ID"},{"required":"yes","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."}],"desc":"Get the URL to the user's profile editor.","returns":"string Dashboard url link with optional path appended."},"rel_canonical":{"params":[],"desc":"Output rel=canonical for singular queries.","returns":""},"wp_get_shortlink":{"params":[{"required":"yes","param":"int $id A post or blog id. Default is 0, which means the current post or blog."},{"required":"yes","param":"string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'."},{"required":"yes","param":"bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this."}],"desc":"Return a shortlink for a post, page, attachment, or blog.","returns":"string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled."},"wp_shortlink_wp_head":{"params":[],"desc":"Inject rel=shortlink into head if a shortlink is defined for the current page.","returns":""},"wp_shortlink_header":{"params":[],"desc":"Send a Link: rel=shortlink header if a shortlink is defined for the current page.","returns":""},"the_shortlink":{"params":[{"required":"no","param":"string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'"},{"required":"no","param":"string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title."},{"required":"no","param":"string $before Optional HTML to display before the link."},{"required":"no","param":"string $after Optional HTML to display after the link."}],"desc":"Display the Short Link for a Post","returns":""},"create_initial_taxonomies":{"params":[],"desc":"Creates the initial taxonomies when 'init' action is fired.","returns":""},"get_taxonomies":{"params":[{"required":"yes","param":"array $args An array of key => value arguments to match against the taxonomy objects."},{"required":"yes","param":"string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default."},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."}],"desc":"Get a list of registered taxonomy objects.","returns":"array A list of taxonomy names or objects"},"get_object_taxonomies":{"params":[{"required":"yes","param":"array|string|object $object Name of the type of taxonomy object, or an object (row from posts)"},{"required":"yes","param":"string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default."}],"desc":"Return all of the taxonomy names that are of $object_type.","returns":"array The names of all taxonomy of $object_type."},"get_taxonomy":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object to return"}],"desc":"Retrieves the taxonomy object of $taxonomy.","returns":"object|bool The Taxonomy Object or false if $taxonomy doesn't exist"},"taxonomy_exists":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"}],"desc":"Checks that the taxonomy name exists.","returns":"bool Whether the taxonomy exists."},"is_taxonomy_hierarchical":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"}],"desc":"Whether the taxonomy object is hierarchical.","returns":"bool Whether the taxonomy is hierarchical"},"register_taxonomy":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"},{"required":"yes","param":"array|string $object_type Name of the object type for the taxonomy object."},{"required":"yes","param":"array|string $args See above description for the two keys values."}],"desc":"Create or modify a taxonomy object. Do not use before init.","returns":""},"get_taxonomy_labels":{"params":[{"required":"yes","param":"object $tax Taxonomy object"}],"desc":"Builds an object with all taxonomy labels out of a taxonomy object","returns":"object object with all the labels as member variables"},"register_taxonomy_for_object_type":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"},{"required":"yes","param":"array|string $object_type Name of the object type"}],"desc":"Add an already registered taxonomy to an object type.","returns":"bool True if successful, false if not"},"get_objects_in_term":{"params":[{"required":"yes","param":"int|array $term_ids Term id or array of term ids of terms that will be used"},{"required":"yes","param":"string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names"},{"required":"yes","param":"array|string $args Change the order of the object_ids, either ASC or DESC"}],"desc":"Retrieve object_ids of valid taxonomy and term.","returns":"WP_Error|array If the taxonomy does not exist, then WP_Error will be returned. On success the array can be empty meaning that there are no $object_ids found or it will return the $object_ids found."},"get_tax_sql":{"params":[{"required":"yes","param":"array $tax_query A compact tax query"},{"required":"yes","param":"string $primary_table "},{"required":"yes","param":"string $primary_id_column "}],"desc":"Given a taxonomy query, generates SQL to be appended to a main query.","returns":"array "},"get_term":{"params":[{"required":"yes","param":"int|object $term If integer, will get from database. If object will apply filters and return $term."},{"required":"yes","param":"string $taxonomy Taxonomy name that $term is part of."},{"required":"yes","param":"string $output Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional, default is raw or no WordPress defined filter will applied."}],"desc":"Get all Term data from database by Term ID.","returns":"mixed|null|WP_Error Term Row from database. Will return null if $term is empty. If taxonomy does not exist then WP_Error will be returned."},"get_term_by":{"params":[{"required":"yes","param":"string $field Either 'slug', 'name', or 'id'"},{"required":"yes","param":"string|int $value Search for this term value"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"yes","param":"string $output Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional, default is raw or no WordPress defined filter will applied."}],"desc":"Get all Term data from database by Term field and data.","returns":"mixed Term Row from database. Will return false if $taxonomy does not exist or $term was not found."},"get_term_children":{"params":[{"required":"yes","param":"string $term_id ID of Term to get children"},{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Merge all term children into a single array of their IDs.","returns":"array|WP_Error List of Term Objects. WP_Error returned if $taxonomy does not exist"},"get_term_field":{"params":[{"required":"yes","param":"string $field Term field to fetch"},{"required":"yes","param":"int $term Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"no","param":"string $context Optional, default is display. Look at sanitize_term_field() for available options."}],"desc":"Get sanitized Term field.","returns":"mixed Will return an empty string if $term is not an object or if $field is not set in $term."},"get_term_to_edit":{"params":[{"required":"yes","param":"int|object $id Term ID or Object"},{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Sanitizes Term for editing.","returns":"mixed|null|WP_Error Will return empty string if $term is not an object."},"get_terms":{"params":[{"required":"yes","param":"string|array $taxonomies Taxonomy name or list of Taxonomy names"},{"required":"yes","param":"string|array $args The values of what to search for when returning terms"}],"desc":"Retrieve the terms in a given taxonomy or list of taxonomies.","returns":"array|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies do not exist."},"term_exists":{"params":[{"required":"yes","param":"int|string $term The term to check"},{"required":"yes","param":"string $taxonomy The taxonomy name to use"},{"required":"yes","param":"int $parent ID of parent term under which to confine the exists search."}],"desc":"Check if Term exists.","returns":"mixed Get the term id or Term Object, if exists."},"sanitize_term":{"params":[{"required":"yes","param":"array|object $term The term to check"},{"required":"yes","param":"string $taxonomy The taxonomy name to use"},{"required":"yes","param":"string $context Default is 'display'."}],"desc":"Sanitize Term all fields.","returns":"array|object Term with all fields sanitized"},"sanitize_term_field":{"params":[{"required":"yes","param":"string $field Term field to sanitize"},{"required":"yes","param":"string $value Search for this term value"},{"required":"yes","param":"int $term_id Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"yes","param":"string $context Either edit, db, display, attribute, or js."}],"desc":"Cleanse the field value in the term based on the context.","returns":"mixed sanitized field"},"wp_count_terms":{"params":[{"required":"yes","param":"string $taxonomy Taxonomy name"},{"required":"yes","param":"array|string $args Overwrite defaults. See get_terms()"}],"desc":"Count how many terms are in Taxonomy.","returns":"int How many terms are in $taxonomy"},"wp_delete_object_term_relationships":{"params":[{"required":"yes","param":"int $object_id The term Object Id that refers to the term"},{"required":"yes","param":"string|array $taxonomies List of Taxonomy Names or single Taxonomy name."}],"desc":"Will unlink the object from the taxonomy or taxonomies.","returns":""},"wp_delete_term":{"params":[{"required":"yes","param":"int $term Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"no","param":"array|string $args Optional. Change 'default' term id and override found term ids."}],"desc":"Removes a term from the database.","returns":"bool|WP_Error Returns false if not term; true if completes delete action."},"wp_delete_category":{"params":[{"required":"yes","param":"int $cat_ID "}],"desc":"Deletes one existing category.","returns":"mixed Returns true if completes delete action; false if term doesn't exist; Zero on attempted deletion of default Category; WP_Error object is also a possibility."},"wp_get_object_terms":{"params":[{"required":"yes","param":"int|array $object_ids The ID(s) of the object(s) to retrieve."},{"required":"yes","param":"string|array $taxonomies The taxonomies to retrieve terms from."},{"required":"yes","param":"array|string $args Change what is returned"}],"desc":"Retrieves the terms associated with the given object(s), in the supplied taxonomies.","returns":"array|WP_Error The requested term data or empty array if no terms found. WP_Error if $taxonomy does not exist."},"wp_insert_term":{"params":[{"required":"yes","param":"string $term The term to add or update."},{"required":"yes","param":"string $taxonomy The taxonomy to which to add the term"},{"required":"yes","param":"array|string $args Change the values of the inserted term"}],"desc":"Adds a new term to the database. Optionally marks it as an alias of an existing term.","returns":"array|WP_Error The Term ID and Term Taxonomy ID"},"wp_set_object_terms":{"params":[{"required":"yes","param":"int $object_id The object to relate to."},{"required":"yes","param":"array|int|string $terms The slug or id of the term, will replace all existing related terms in this taxonomy."},{"required":"yes","param":"array|string $taxonomy The context in which to relate the term to the object."},{"required":"yes","param":"bool $append If false will delete difference of terms."}],"desc":"Create Term and Taxonomy Relationships.","returns":"array|WP_Error Affected Term IDs"},"wp_unique_term_slug":{"params":[{"required":"yes","param":"string $slug The string that will be tried for a unique slug"},{"required":"yes","param":"object $term The term object that the $slug will belong too"}],"desc":"Will make slug unique, if it isn't already.","returns":"string Will return a true unique slug."},"wp_update_term":{"params":[{"required":"yes","param":"int $term_id The ID of the term"},{"required":"yes","param":"string $taxonomy The context in which to relate the term to the object."},{"required":"yes","param":"array|string $args Overwrite term field values"}],"desc":"Update term based on arguments provided.","returns":"array|WP_Error Returns Term ID and Taxonomy Term ID"},"wp_defer_term_counting":{"params":[{"required":"no","param":"bool $defer Optional. Enable if true, disable if false."}],"desc":"Enable or disable term counting.","returns":"bool Whether term counting is enabled or disabled."},"wp_update_term_count":{"params":[{"required":"yes","param":"int|array $terms The term_taxonomy_id of the terms"},{"required":"yes","param":"string $taxonomy The context of the term."}],"desc":"Updates the amount of terms in taxonomy.","returns":"bool If no terms will return false, and if successful will return true."},"wp_update_term_count_now":{"params":[{"required":"yes","param":"array $terms The term_taxonomy_id of terms to update."},{"required":"yes","param":"string $taxonomy The context of the term."}],"desc":"Perform term count update immediately.","returns":"bool Always true when complete."},"clean_object_term_cache":{"params":[{"required":"yes","param":"int|array $object_ids Single or list of term object ID(s)"},{"required":"yes","param":"array|string $object_type The taxonomy object type"}],"desc":"Removes the taxonomy relationship to terms from the cache.","returns":""},"clean_term_cache":{"params":[{"required":"yes","param":"int|array $ids Single or list of Term IDs"},{"required":"yes","param":"string $taxonomy Can be empty and will assume tt_ids, else will use for context."},{"required":"yes","param":"bool $clean_taxonomy Whether to clean taxonomy wide caches (true), or just individual term object caches (false). Default is true."}],"desc":"Will remove all of the term ids from the cache.","returns":""},"get_object_term_cache":{"params":[{"required":"yes","param":"int|array $id Term object ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Retrieves the taxonomy relationship to the term object id.","returns":"bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id."},"update_object_term_cache":{"params":[{"required":"yes","param":"string|array $object_ids Single or list of term object ID(s)"},{"required":"yes","param":"array|string $object_type The taxonomy object type"}],"desc":"Updates the cache for Term ID(s).","returns":"null|bool Null value is given with empty $object_ids. False if"},"update_term_cache":{"params":[{"required":"yes","param":"array $terms List of Term objects to change"},{"required":"no","param":"string $taxonomy Optional. Update Term to this taxonomy in cache"}],"desc":"Updates Terms to Taxonomy in cache.","returns":""},"_get_term_hierarchy":{"params":[{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Retrieves children of taxonomy as Term IDs.","returns":"array Empty if $taxonomy isn't hierarchical or returns children as Term IDs."},"_get_term_children":{"params":[{"required":"yes","param":"int $term_id The ancestor term: all returned terms should be descendants of $term_id."},{"required":"yes","param":"array $terms The set of terms---either an array of term objects or term IDs---from which those that are descendants of $term_id will be chosen."},{"required":"yes","param":"string $taxonomy The taxonomy which determines the hierarchy of the terms."}],"desc":"Get the subset of $terms that are descendants of $term_id.","returns":"array The subset of $terms that are descendants of $term_id."},"_pad_term_counts":{"params":[{"required":"yes","param":"array $terms List of Term IDs"},{"required":"yes","param":"string $taxonomy Term Context"}],"desc":"Add count of children to parent count.","returns":"null Will break from function if conditions are not met."},"_update_post_term_count":{"params":[{"required":"yes","param":"array $terms List of Term taxonomy IDs"},{"required":"yes","param":"object $taxonomy Current taxonomy object of terms"}],"desc":"Will update term count based on object types of the current taxonomy.","returns":""},"_update_generic_term_count":{"params":[{"required":"yes","param":"array $terms List of Term taxonomy IDs"},{"required":"yes","param":"object $taxonomy Current taxonomy object of terms"}],"desc":"Will update term count based on number of objects.","returns":""},"get_term_link":{"params":[{"required":"yes","param":"object|int|string $term "},{"required":"no","param":"string $taxonomy (optional if $term is object)"}],"desc":"Generates a permalink for a taxonomy term archive.","returns":"string|WP_Error HTML link to taxonomy term archive on success, WP_Error if term does not exist."},"the_taxonomies":{"params":[{"required":"yes","param":"array $args Override the defaults."}],"desc":"Display the taxonomies of a post with available options.","returns":""},"get_the_taxonomies":{"params":[{"required":"no","param":"int $post Optional. Post ID or will use Global Post ID (in loop)."},{"required":"yes","param":"array $args Override the defaults."}],"desc":"Retrieve all taxonomies associated with a post.","returns":"array "},"get_post_taxonomies":{"params":[{"required":"no","param":"int $post Optional. Post ID"}],"desc":"Retrieve all taxonomies of a post with just the names.","returns":"array "},"is_object_in_term":{"params":[{"required":"yes","param":"int $object_id ID of the object (post ID, link ID, ...)"},{"required":"yes","param":"string $taxonomy Single taxonomy name"},{"required":"no","param":"int|string|array $terms Optional. Term term_id, name, slug or array of said"}],"desc":"Determine if the given object is associated with any of the given terms.","returns":"bool|WP_Error. WP_Error on input error."},"is_object_in_taxonomy":{"params":[{"required":"yes","param":"string $object_type Object type string"},{"required":"yes","param":"string $taxonomy Single taxonomy name"}],"desc":"Determine if the given object type is associated with the given taxonomy.","returns":"bool True if object is associated with the taxonomy, otherwise false."},"get_ancestors":{"params":[{"required":"yes","param":"int $object_id The ID of the object"},{"required":"yes","param":"string $object_type The type of object for which we'll be retrieving ancestors."}],"desc":"Get an array of ancestor IDs for a given object.","returns":"array of ancestors from lowest to highest in the hierarchy."},"wp_get_term_taxonomy_parent_id":{"params":[{"required":"yes","param":"int $term_id "},{"required":"yes","param":"string $taxonomy "}],"desc":"Returns the term's parent's term_ID","returns":"int|bool false on error"},"wp_check_term_hierarchy_for_loops":{"params":[{"required":"yes","param":"int $parent term_id of the parent for the term we're checking."},{"required":"yes","param":"int $term_id The term we're checking."},{"required":"yes","param":"string $taxonomy The taxonomy of the term we're checking."}],"desc":"Checks the given subset of the term hierarchy for hierarchy loops.","returns":"int The new parent for the term."},"mysql2date":{"params":[{"required":"yes","param":"string $dateformatstring Either 'G', 'U', or php date format."},{"required":"yes","param":"string $mysqlstring Time from mysql DATETIME field."},{"required":"no","param":"bool $translate Optional. Default is true. Will switch format to locale."}],"desc":"Converts MySQL DATETIME field to user specified date format.","returns":"string Date formatted by $dateformatstring or locale (if available)."},"current_time":{"params":[{"required":"yes","param":"string $type Either 'mysql' or 'timestamp'."},{"required":"no","param":"int|bool $gmt Optional. Whether to use GMT timezone. Default is false."}],"desc":"Retrieve the current time based on specified type.","returns":"int|string String if $type is 'gmt', int if $type is 'timestamp'."},"date_i18n":{"params":[{"required":"yes","param":"string $dateformatstring Format to display the date."},{"required":"no","param":"int $unixtimestamp Optional. Unix timestamp."},{"required":"no","param":"bool $gmt Optional, default is false. Whether to convert to GMT for time."}],"desc":"Retrieve the date in localized format, based on timestamp.","returns":"string The date, translated if locale specifies it."},"number_format_i18n":{"params":[{"required":"yes","param":"int $number The number to convert based on locale."},{"required":"yes","param":"int $decimals Precision of the number of decimal places."}],"desc":"Convert integer number to format based on the locale.","returns":"string Converted number in string format."},"size_format":{"params":[{"required":"yes","param":"int|string $bytes Number of bytes. Note max integer size for integers."},{"required":"yes","param":"int $decimals Precision of number of decimal places. Deprecated."}],"desc":"Convert number of bytes largest unit bytes will fit into.","returns":"bool|string False on failure. Number string on success."},"get_weekstartend":{"params":[{"required":"yes","param":"string $mysqlstring Date or datetime field type from mysql."},{"required":"no","param":"int $start_of_week Optional. Start of the week as an integer."}],"desc":"Get the week start and end from the datetime or date string from mysql.","returns":"array Keys are 'start' and 'end'."},"maybe_unserialize":{"params":[{"required":"yes","param":"string $original Maybe unserialized original, if is needed."}],"desc":"Unserialize value only if it was serialized.","returns":"mixed Unserialized data can be any type."},"is_serialized":{"params":[{"required":"yes","param":"mixed $data Value to check to see if was serialized."}],"desc":"Check value to find if it was serialized.","returns":"bool False if not serialized and true if it was."},"is_serialized_string":{"params":[{"required":"yes","param":"mixed $data Serialized data"}],"desc":"Check whether serialized data is of string type.","returns":"bool False if not a serialized string, true if it is."},"get_option":{"params":[{"required":"yes","param":"string $option Name of option to retrieve. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $default Optional. Default value to return if the option does not exist."}],"desc":"Retrieve option value based on name of option.","returns":"mixed Value set for the option."},"wp_protect_special_option":{"params":[{"required":"yes","param":"string $option Option name."}],"desc":"Protect WordPress special option from being modified.","returns":""},"form_option":{"params":[{"required":"yes","param":"string $option Option name."}],"desc":"Print option value after sanitizing for forms.","returns":""},"wp_load_alloptions":{"params":[],"desc":"Loads and caches all autoloaded options, if available or all options.","returns":"array List of all options."},"wp_load_core_site_options":{"params":[{"required":"no","param":"int $site_id Optional site ID for which to query the options. Defaults to the current site."}],"desc":"Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.","returns":""},"update_option":{"params":[{"required":"yes","param":"string $option Option name. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $newvalue Option value. Expected to not be SQL-escaped."}],"desc":"Update the value of an option that was already added.","returns":"bool False if value was not updated and true if value was updated."},"add_option":{"params":[{"required":"yes","param":"string $option Name of option to add. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $deprecated Optional. Description. Not used anymore."},{"required":"no","param":"bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up."}],"desc":"Add a new option.","returns":"bool False if option was not added and true if option was added."},"delete_option":{"params":[{"required":"yes","param":"string $option Name of option to remove. Expected to not be SQL-escaped."}],"desc":"Removes option by name. Prevents removal of protected WordPress options.","returns":"bool True, if option is successfully deleted. False on failure."},"delete_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."}],"desc":"Delete a transient.","returns":"bool true if successful, false otherwise"},"get_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped"}],"desc":"Get the value of a transient.","returns":"mixed Value of transient"},"set_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $value Transient value. Expected to not be SQL-escaped."},{"required":"yes","param":"int $expiration Time until expiration in seconds, default 0"}],"desc":"Set/update the value of a transient.","returns":"bool False if value was not set and true if value was set."},"wp_user_settings":{"params":[],"desc":"Saves and restores user interface settings stored in a cookie.","returns":""},"get_user_setting":{"params":[{"required":"yes","param":"string $name The name of the setting."},{"required":"no","param":"string $default Optional default value to return when $name is not set."}],"desc":"Retrieve user interface setting value based on setting name.","returns":"mixed the last saved user setting or the default value/false if it doesn't exist."},"set_user_setting":{"params":[{"required":"yes","param":"string $name The name of the setting."},{"required":"yes","param":"string $value The value for the setting."}],"desc":"Add or update user interface setting.","returns":"bool true if set successfully/false if not."},"delete_user_setting":{"params":[{"required":"yes","param":"mixed $names The name or array of names of the setting to be deleted."}],"desc":"Delete user interface settings.","returns":"bool true if deleted successfully/false if not."},"get_all_user_settings":{"params":[],"desc":"Retrieve all user interface settings.","returns":"array the last saved user settings or empty array."},"wp_set_all_user_settings":{"params":[{"required":"yes","param":"unknown $all "}],"desc":"Private. Set all user interface settings.","returns":"bool "},"delete_all_user_settings":{"params":[],"desc":"Delete the user settings of the current user.","returns":""},"maybe_serialize":{"params":[{"required":"yes","param":"mixed $data Data that might be serialized."}],"desc":"Serialize data, if needed.","returns":"mixed A scalar data"},"xmlrpc_getposttitle":{"params":[{"required":"yes","param":"string $content XMLRPC XML Request content"}],"desc":"Retrieve post title from XMLRPC XML.","returns":"string Post title"},"xmlrpc_getpostcategory":{"params":[{"required":"yes","param":"string $content XMLRPC XML Request content"}],"desc":"Retrieve the post category or categories from XMLRPC XML.","returns":"string|array List of categories or category name."},"xmlrpc_removepostdata":{"params":[{"required":"yes","param":"string $content XMLRPC XML Request content"}],"desc":"XMLRPC XML content without title and category elements.","returns":"string XMLRPC XML Request content without title and category elements."},"debug_fopen":{"params":[{"required":"yes","param":"string $filename File path to debug file."},{"required":"yes","param":"string $mode Same as fopen() mode parameter."}],"desc":"Open the file handle for debugging.","returns":"bool|resource File handle. False on failure."},"debug_fwrite":{"params":[{"required":"yes","param":"resource $fp File handle for debugging file."},{"required":"yes","param":"string $string Content to write to debug file."}],"desc":"Write contents to the file used for debugging.","returns":""},"debug_fclose":{"params":[{"required":"yes","param":"resource $fp Debug File handle."}],"desc":"Close the debugging file handle.","returns":""},"do_enclose":{"params":[{"required":"yes","param":"string $content Post Content"},{"required":"yes","param":"int $post_ID Post ID"}],"desc":"Check content for video and audio links to add as enclosures.","returns":""},"wp_get_http":{"params":[{"required":"yes","param":"string $url URL to fetch."},{"required":"no","param":"string|bool $file_path Optional. File path to write request to."},{"required":"yes","param":"int $red (private) The number of Redirects followed, Upon 5 being hit, returns false."}],"desc":"Perform a HTTP HEAD or GET request.","returns":"bool|string False on failure and string of headers if HEAD request."},"wp_get_http_headers":{"params":[{"required":"yes","param":"string $url "},{"required":"yes","param":"bool $deprecated Not Used."}],"desc":"Retrieve HTTP Headers from URL.","returns":"bool|string False on failure, headers on success."},"is_new_day":{"params":[],"desc":"Whether today is a new day.","returns":"int 1 when new day, 0 if not a new day."},"build_query":{"params":[{"required":"yes","param":"array $data URL-encode key/value pairs."}],"desc":"Build URL query based on an associative and, or indexed array.","returns":"string URL encoded string"},"_http_build_query":{"params":[],"desc":"","returns":""},"add_query_arg":{"params":[{"required":"yes","param":"mixed $param1 Either newkey or an associative_array"},{"required":"yes","param":"mixed $param2 Either newvalue or oldquery or uri"},{"required":"no","param":"mixed $param3 Optional. Old query or uri"}],"desc":"Retrieve a modified URL query string.","returns":"string New URL query string."},"remove_query_arg":{"params":[{"required":"yes","param":"string|array $key Query key or keys to remove."},{"required":"yes","param":"bool $query When false uses the $_SERVER value."}],"desc":"Removes an item or list from the query string.","returns":"string New URL query string."},"add_magic_quotes":{"params":[{"required":"yes","param":"array $array Array to used to walk while sanitizing contents."}],"desc":"Walks the array while sanitizing the contents.","returns":"array Sanitized $array."},"wp_remote_fopen":{"params":[{"required":"yes","param":"string $uri URI/URL of web page to retrieve."}],"desc":"HTTP request for URI to retrieve content.","returns":"bool|string HTTP content. False on failure."},"wp":{"params":[{"required":"yes","param":"string $query_vars Default WP_Query arguments."}],"desc":"Set up the WordPress query.","returns":""},"get_status_header_desc":{"params":[{"required":"yes","param":"int $code HTTP status code."}],"desc":"Retrieve the description for the HTTP status.","returns":"string Empty string if not found, or description if found."},"status_header":{"params":[{"required":"yes","param":"int $header HTTP status code"}],"desc":"Set HTTP status header.","returns":"unknown "},"wp_get_nocache_headers":{"params":[],"desc":"Gets the header information to prevent caching.","returns":"array The associative array of header names and field values."},"nocache_headers":{"params":[],"desc":"Sets the headers to prevent caching for the different browsers.","returns":""},"cache_javascript_headers":{"params":[],"desc":"Set the headers for caching for 10 days with JavaScript content type.","returns":""},"get_num_queries":{"params":[],"desc":"Retrieve the number of database queries during the WordPress execution.","returns":"int Number of database queries"},"bool_from_yn":{"params":[{"required":"yes","param":"string $yn Character string containing either 'y' or 'n'"}],"desc":"Whether input is yes or no. Must be 'y' to be true.","returns":"bool True if yes, false on anything else"},"do_feed":{"params":[],"desc":"Loads the feed template from the use of an action hook.","returns":""},"do_feed_rdf":{"params":[],"desc":"Load the RDF RSS 0.91 Feed template.","returns":""},"do_feed_rss":{"params":[],"desc":"Load the RSS 1.0 Feed Template.","returns":""},"do_feed_rss2":{"params":[{"required":"yes","param":"bool $for_comments True for the comment feed, false for normal feed."}],"desc":"Load either the RSS2 comment feed or the RSS2 posts feed.","returns":""},"do_feed_atom":{"params":[{"required":"yes","param":"bool $for_comments True for the comment feed, false for normal feed."}],"desc":"Load either Atom comment feed or Atom posts feed.","returns":""},"do_robots":{"params":[],"desc":"Display the robots.txt file content.","returns":""},"is_blog_installed":{"params":[],"desc":"Test whether blog is already installed.","returns":"bool Whether blog is already installed."},"wp_nonce_url":{"params":[{"required":"yes","param":"string $actionurl URL to add nonce action"},{"required":"no","param":"string $action Optional. Nonce action name"}],"desc":"Retrieve URL with nonce added to URL query.","returns":"string URL with nonce action added."},"wp_nonce_field":{"params":[{"required":"no","param":"string $action Optional. Action name."},{"required":"no","param":"string $name Optional. Nonce name."},{"required":"no","param":"bool $referer Optional, default true. Whether to set the referer field for validation."},{"required":"no","param":"bool $echo Optional, default true. Whether to display or return hidden form field."}],"desc":"Retrieve or display nonce hidden field for forms.","returns":"string Nonce field."},"wp_referer_field":{"params":[{"required":"yes","param":"bool $echo Whether to echo or return the referer field."}],"desc":"Retrieve or display referer hidden field for forms.","returns":"string Referer field."},"wp_original_referer_field":{"params":[{"required":"yes","param":"bool $echo Whether to echo the original http referer"},{"required":"no","param":"string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to."}],"desc":"Retrieve or display original referer hidden field for forms.","returns":"string Original referer field."},"wp_get_referer":{"params":[],"desc":"Retrieve referer from '_wp_http_referer' or HTTP referer. If it's the same as the current request URL, will return false.","returns":"string|bool False on failure. Referer URL on success."},"wp_get_original_referer":{"params":[],"desc":"Retrieve original referer that was posted, if it exists.","returns":"string|bool False if no original referer or original referer if set."},"wp_mkdir_p":{"params":[{"required":"yes","param":"string $target Full path to attempt to create."}],"desc":"Recursive directory creation based on full path.","returns":"bool Whether the path was created. True if path already exists."},"path_is_absolute":{"params":[{"required":"yes","param":"string $path File path"}],"desc":"Test if a give filesystem path is absolute ('/foo/bar', 'c:windows').","returns":"bool True if path is absolute, false is not absolute."},"path_join":{"params":[{"required":"yes","param":"string $base "},{"required":"yes","param":"string $path "}],"desc":"Join two filesystem paths together (e.g. 'give me $path relative to $base').","returns":"string The path with the base or absolute path."},"get_temp_dir":{"params":[],"desc":"Determines a writable directory for temporary files.","returns":"string Writable temporary directory"},"wp_upload_dir":{"params":[{"required":"no","param":"string $time Optional. Time formatted in 'yyyy/mm'."}],"desc":"Get an array containing the current upload directory's path and url.","returns":"array See above for description."},"wp_unique_filename":{"params":[{"required":"yes","param":"string $dir "},{"required":"yes","param":"string $filename "},{"required":"yes","param":"mixed $unique_filename_callback Callback."}],"desc":"Get a filename that is sanitized and unique for the given directory.","returns":"string New filename, if given wasn't unique."},"wp_upload_bits":{"params":[{"required":"yes","param":"string $name "},{"required":"yes","param":"null $deprecated Never used. Set to null."},{"required":"yes","param":"mixed $bits File content"},{"required":"no","param":"string $time Optional. Time formatted in 'yyyy/mm'."}],"desc":"Create a file in the upload folder with given content.","returns":"array "},"wp_ext2type":{"params":[{"required":"yes","param":"string $ext The extension to search."}],"desc":"Retrieve the file type based on the extension name.","returns":"string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found."},"wp_check_filetype":{"params":[{"required":"yes","param":"string $filename File name or path."},{"required":"no","param":"array $mimes Optional. Key is the file extension with value as the mime type."}],"desc":"Retrieve the file type from the file name.","returns":"array Values with extension first and mime type."},"wp_check_filetype_and_ext":{"params":[{"required":"yes","param":"string $file Full path to the image."},{"required":"yes","param":"string $filename The filename of the image (may differ from $file due to $file being in a tmp directory)"},{"required":"no","param":"array $mimes Optional. Key is the file extension with value as the mime type."}],"desc":"Attempt to determine the real file type of a file.","returns":"array Values for the extension, MIME, and either a corrected filename or false if original $filename is valid"},"get_allowed_mime_types":{"params":[],"desc":"Retrieve list of allowed mime types and file extensions.","returns":"array Array of mime types keyed by the file extension regex corresponding to those types."},"wp_explain_nonce":{"params":[{"required":"yes","param":"string $action Nonce action."}],"desc":"Retrieve nonce action "Are you sure" message.","returns":"string Are you sure message."},"wp_nonce_ays":{"params":[{"required":"yes","param":"string $action The nonce action."}],"desc":"Display "Are You Sure" message to confirm the action being taken.","returns":""},"wp_die":{"params":[{"required":"yes","param":"string $message Error message."},{"required":"yes","param":"string $title Error title."},{"required":"no","param":"string|array $args Optional arguments to control behavior."}],"desc":"Kill WordPress execution and display HTML message with error message.","returns":""},"_default_wp_die_handler":{"params":[{"required":"yes","param":"string $message Error message."},{"required":"yes","param":"string $title Error title."},{"required":"no","param":"string|array $args Optional arguments to control behavior."}],"desc":"Kill WordPress execution and display HTML message with error message.","returns":""},"_xmlrpc_wp_die_handler":{"params":[{"required":"yes","param":"string $message Error message."},{"required":"yes","param":"string $title Error title."},{"required":"no","param":"string|array $args Optional arguments to control behavior."}],"desc":"Kill WordPress execution and display XML message with error message.","returns":""},"_xmlrpc_wp_die_filter":{"params":[],"desc":"Filter to enable special wp_die handler for xmlrpc requests.","returns":""},"_config_wp_home":{"params":[{"required":"yes","param":"string $url URL for the home location"}],"desc":"Retrieve the WordPress home page URL.","returns":"string Homepage location."},"_config_wp_siteurl":{"params":[{"required":"yes","param":"string $url URL to set the WordPress site location."}],"desc":"Retrieve the WordPress site URL.","returns":"string The WordPress Site URL"},"_mce_set_direction":{"params":[{"required":"yes","param":"array $input MCE plugin array."}],"desc":"Set the localized direction for MCE plugin.","returns":"array Direction set for 'rtl', if needed by locale."},"smilies_init":{"params":[],"desc":"Convert smiley code to the icon graphic file equivalent.","returns":""},"wp_parse_args":{"params":[{"required":"yes","param":"string|array $args Value to merge with $defaults"},{"required":"yes","param":"array $defaults Array that serves as the defaults."}],"desc":"Merge user defined arguments into defaults array.","returns":"array Merged user defined values with defaults."},"wp_parse_id_list":{"params":[{"required":"yes","param":"array|string $list "}],"desc":"Clean up an array, comma- or space-separated list of IDs.","returns":"array Sanitized array of IDs"},"wp_array_slice_assoc":{"params":[{"required":"yes","param":"array $array The original array"},{"required":"yes","param":"array $keys The list of keys"}],"desc":"Extract a slice of an array, given a list of keys.","returns":"array The array slice"},"wp_filter_object_list":{"params":[{"required":"yes","param":"array $list An array of objects to filter"},{"required":"yes","param":"array $args An array of key => value arguments to match against each object"},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."},{"required":"yes","param":"bool|string $field A field from the object to place instead of the entire object"}],"desc":"Filters a list of objects, based on a set of key => value arguments.","returns":"array A list of objects or object fields"},"wp_list_filter":{"params":[{"required":"yes","param":"array $list An array of objects to filter"},{"required":"yes","param":"array $args An array of key => value arguments to match against each object"},{"required":"yes","param":"string $operator The logical operation to perform: 'AND' means all elements from the array must match; 'OR' means only one element needs to match; 'NOT' means no elements may match. The default is 'AND'."}],"desc":"Filters a list of objects, based on a set of key => value arguments.","returns":"array "},"wp_list_pluck":{"params":[{"required":"yes","param":"array $list A list of objects or arrays"},{"required":"yes","param":"int|string $field A field from the object to place instead of the entire object"}],"desc":"Pluck a certain field out of each object in a list.","returns":"array "},"wp_maybe_load_widgets":{"params":[],"desc":"Determines if Widgets library should be loaded.","returns":""},"wp_widgets_add_menu":{"params":[],"desc":"Append the Widgets menu to the themes main menu.","returns":""},"wp_ob_end_flush_all":{"params":[],"desc":"Flush all output buffers for PHP 5.2.","returns":""},"dead_db":{"params":[],"desc":"Load custom DB error or display WordPress DB error.","returns":""},"absint":{"params":[{"required":"yes","param":"mixed $maybeint Data you wish to have converted to a nonnegative integer"}],"desc":"Converts value to nonnegative integer.","returns":"int An nonnegative integer"},"url_is_accessable_via_ssl":{"params":[{"required":"yes","param":"string $url "}],"desc":"Determines if the blog can be accessed over SSL.","returns":"bool Whether SSL access is available"},"_deprecated_function":{"params":[{"required":"yes","param":"string $function The function that was called"},{"required":"yes","param":"string $version The version of WordPress that deprecated the function"},{"required":"no","param":"string $replacement Optional. The function that should have been called"}],"desc":"Marks a function as deprecated and informs when it has been used.","returns":""},"_deprecated_file":{"params":[{"required":"yes","param":"string $file The file that was included"},{"required":"yes","param":"string $version The version of WordPress that deprecated the file"},{"required":"no","param":"string $replacement Optional. The file that should have been included based on ABSPATH"},{"required":"no","param":"string $message Optional. A message regarding the change"}],"desc":"Marks a file as deprecated and informs when it has been used.","returns":""},"_deprecated_argument":{"params":[{"required":"yes","param":"string $function The function that was called"},{"required":"yes","param":"string $version The version of WordPress that deprecated the argument used"},{"required":"no","param":"string $message Optional. A message regarding the change."}],"desc":"Marks a function argument as deprecated and informs when it has been used.","returns":""},"_doing_it_wrong":{"params":[{"required":"yes","param":"string $function The function that was called."},{"required":"yes","param":"string $message A message explaining what has been done incorrectly."},{"required":"yes","param":"string $version The version of WordPress where the message was added."}],"desc":"Marks something as being incorrectly called.","returns":""},"is_lighttpd_before_150":{"params":[],"desc":"Is the server running earlier than 1.5.0 version of lighttpd?","returns":"bool Whether the server is running lighttpd < 1.5.0"},"apache_mod_loaded":{"params":[{"required":"yes","param":"string $mod e.g. mod_rewrite"},{"required":"yes","param":"bool $default The default return value if the module is not found"}],"desc":"Does the specified module exist in the Apache config?","returns":"bool "},"iis7_supports_permalinks":{"params":[],"desc":"Check if IIS 7 supports pretty permalinks.","returns":"bool "},"validate_file":{"params":[{"required":"yes","param":"string $file File path."},{"required":"yes","param":"array $allowed_files List of allowed files."}],"desc":"File validates against allowed set of defined rules.","returns":"int 0 means nothing is wrong, greater than 0 means something was wrong."},"is_ssl":{"params":[],"desc":"Determine if SSL is used.","returns":"bool True if SSL, false if not used."},"force_ssl_login":{"params":[{"required":"no","param":"string|bool $force Optional."}],"desc":"Whether SSL login should be forced.","returns":"bool True if forced, false if not forced."},"force_ssl_admin":{"params":[{"required":"yes","param":"string|bool $force "}],"desc":"Whether to force SSL used for the Administration Screens.","returns":"bool True if forced, false if not forced."},"wp_guess_url":{"params":[],"desc":"Guess the URL for the site.","returns":"string "},"wp_suspend_cache_addition":{"params":[{"required":"no","param":"bool $suspend Optional. Suspends additions if true, re-enables them if false."}],"desc":"Temporarily suspend cache additions.","returns":"bool The current suspend setting"},"wp_suspend_cache_invalidation":{"params":[{"required":"yes","param":"bool $suspend Whether to suspend or enable cache invalidation"}],"desc":"Suspend cache invalidation.","returns":"bool The current suspend setting"},"get_site_option":{"params":[{"required":"yes","param":"string $option Name of option to retrieve. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $default Optional value to return if option doesn't exist. Default false."},{"required":"yes","param":"bool $use_cache Whether to use cache. Multisite only. Default true."}],"desc":"Retrieve site option value based on name of option.","returns":"mixed Value set for the option."},"add_site_option":{"params":[{"required":"yes","param":"string $option Name of option to add. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped."}],"desc":"Add a new site option.","returns":"bool False if option was not added and true if option was added."},"delete_site_option":{"params":[{"required":"yes","param":"string $option Name of option to remove. Expected to not be SQL-escaped."}],"desc":"Removes site option by name.","returns":"bool True, if succeed. False, if failure."},"update_site_option":{"params":[{"required":"yes","param":"string $option Name of option. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $value Option value. Expected to not be SQL-escaped."}],"desc":"Update the value of a site option that was already added.","returns":"bool False if value was not updated and true if value was updated."},"delete_site_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."}],"desc":"Delete a site transient.","returns":"bool True if successful, false otherwise"},"get_site_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."}],"desc":"Get the value of a site transient.","returns":"mixed Value of transient"},"set_site_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $value Transient value. Expected to not be SQL-escaped."},{"required":"yes","param":"int $expiration Time until expiration in seconds, default 0"}],"desc":"Set/update the value of a site transient.","returns":"bool False if value was not set and true if value was set."},"is_main_site":{"params":[{"required":"no","param":"int $blog_id optional blog id to test (default current blog)"}],"desc":"Is main site?","returns":"bool True if not multisite or $blog_id is main site"},"global_terms_enabled":{"params":[],"desc":"Whether global terms are enabled.","returns":"bool True if multisite and global terms enabled"},"wp_timezone_override_offset":{"params":[],"desc":"gmt_offset modification for smart timezone handling.","returns":"float|bool "},"_wp_timezone_choice_usort_callback":{"params":[{"required":"yes","param":"unknown_type $a "},{"required":"yes","param":"unknown_type $b "}],"desc":"{@internal Missing Short Description}}","returns":"int "},"wp_timezone_choice":{"params":[{"required":"yes","param":"string $selected_zone Selected Zone"}],"desc":"Gives a nicely formatted list of timezone strings. // temporary! Not in final","returns":"string "},"_cleanup_header_comment":{"params":[{"required":"yes","param":"string $str "}],"desc":"Strip close comment and close php tags from file headers used by WP.","returns":"string "},"wp_scheduled_delete":{"params":[],"desc":"Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.","returns":""},"get_file_data":{"params":[{"required":"yes","param":"string $file Path to the file"},{"required":"yes","param":"array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name')"},{"required":"yes","param":"string $context If specified adds filter hook "extra_{$context}_headers""}],"desc":"Retrieve metadata from a file.","returns":""},"_search_terms_tidy":{"params":[{"required":"yes","param":"string $t "}],"desc":"Used internally to tidy up the search terms.","returns":"string "},"__return_true":{"params":[],"desc":"Returns true.","returns":"bool true"},"__return_false":{"params":[],"desc":"Returns false.","returns":"bool false"},"__return_zero":{"params":[],"desc":"Returns 0.","returns":"int 0"},"__return_empty_array":{"params":[],"desc":"Returns an empty array.","returns":"array Empty array"},"send_nosniff_header":{"params":[],"desc":"Send a HTTP header to disable content type sniffing in browsers which support it.","returns":"none "},"_wp_mysql_week":{"params":[{"required":"yes","param":"string $column "}],"desc":"Returns a MySQL expression for selecting the week number based on the start_of_week option.","returns":"string "},"wp_find_hierarchy_loop":{"params":[{"required":"yes","param":"callback $callback function that accepts ( ID, $callback_args ) and outputs parent_ID"},{"required":"yes","param":"int $start The ID to start the loop check at"},{"required":"yes","param":"int $start_parent the parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback"},{"required":"no","param":"array $callback_args optional additional arguments to send to $callback"}],"desc":"Finds hierarchy loops using a callback function that maps object IDs to parent IDs.","returns":"array IDs of all members of loop"},"wp_find_hierarchy_loop_tortoise_hare":{"params":[{"required":"yes","param":"callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID"},{"required":"yes","param":"int $start The ID to start the loop check at"},{"required":"yes","param":"array $override an array of ( ID => parent_ID, ... ) to use instead of $callback"},{"required":"no","param":"array $callback_args optional additional arguments to send to $callback"},{"required":"yes","param":"bool $_return_loop Return loop members or just detect presence of loop? Only set to true if you already know the given $start is part of a loop (otherwise the returned array might include branches)"}],"desc":"Uses the "The Tortoise and the Hare" algorithm to detect loops.","returns":"mixed scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop"},"send_frame_options_header":{"params":[],"desc":"Send a HTTP header to limit rendering of pages to same origin iframes.","returns":"none "},"wp_allowed_protocols":{"params":[],"desc":"Retrieve a list of protocols to allow in HTML attributes.","returns":"array Array of allowed protocols"},"get_sitestats":{"params":[],"desc":"Gets the network's site and user counts.","returns":"array Site and user count for the network."},"get_admin_users_for_domain":{"params":[{"required":"no","param":"string $sitedomain Optional. Site domain."},{"required":"no","param":"string $path Optional. Site path."}],"desc":"Get the admin for a domain/path combination.","returns":"array The network admins"},"get_active_blog_for_user":{"params":[{"required":"yes","param":"int $user_id The unique ID of the user"}],"desc":"Get one of a user's active blogs","returns":"object The blog object"},"get_user_count":{"params":[],"desc":"The number of active users in your installation.","returns":"int "},"get_blog_count":{"params":[{"required":"no","param":"int $id Optional. A site_id."}],"desc":"The number of active sites on your installation.","returns":"int "},"get_blog_post":{"params":[{"required":"yes","param":"int $blog_id ID of the blog."},{"required":"yes","param":"int $post_id ID of the post you're looking for."}],"desc":"Get a blog post from any site on the network.","returns":"object The post."},"add_user_to_blog":{"params":[{"required":"yes","param":"int $blog_id ID of the blog you're adding the user to."},{"required":"yes","param":"int $user_id ID of the user you're adding."},{"required":"yes","param":"string $role The role you want the user to have"}],"desc":"Add a user to a blog.","returns":"bool "},"remove_user_from_blog":{"params":[{"required":"yes","param":"int $user_id ID of the user you're removing."},{"required":"yes","param":"int $blog_id ID of the blog you're removing the user from."},{"required":"no","param":"string $reassign Optional. A user to whom to reassign posts."}],"desc":"Remove a user from a blog.","returns":"bool "},"create_empty_blog":{"params":[{"required":"yes","param":"string $domain The new blog's domain."},{"required":"yes","param":"string $path The new blog's path."},{"required":"yes","param":"string $string The new blog's title."},{"required":"no","param":"int $site Optional. Defaults to 1."}],"desc":"Create an empty blog.","returns":"int The ID of the newly created blog"},"get_blog_permalink":{"params":[{"required":"yes","param":"int $_blog_id ID of the source blog."},{"required":"yes","param":"int $post_id ID of the desired post."}],"desc":"Get the permalink for a post on another blog.","returns":"string The post's permalink"},"get_blog_id_from_url":{"params":[{"required":"yes","param":"string $domain "},{"required":"no","param":"string $path Optional. Not required for subdomain installations."}],"desc":"Get a blog's numeric ID from its URL.","returns":"int "},"is_email_address_unsafe":{"params":[{"required":"yes","param":"string $user_email The email provided by the user at registration."}],"desc":"Checks an email address against a list of banned domains.","returns":"bool Returns true when the email address is banned."},"wpmu_validate_user_signup":{"params":[{"required":"yes","param":"string $user_name The login name provided by the user."},{"required":"yes","param":"string $user_email The email provided by the user."}],"desc":"Processes new user registrations.","returns":"array Contains username, email, and error messages."},"wpmu_validate_blog_signup":{"params":[{"required":"yes","param":"string $blogname The blog name provided by the user. Must be unique."},{"required":"yes","param":"string $blog_title The blog title provided by the user."}],"desc":"Processes new site registrations.","returns":"array Contains the new site data and error messages."},"wpmu_signup_blog":{"params":[{"required":"yes","param":"string $domain The requested domain."},{"required":"yes","param":"string $path The requested path."},{"required":"yes","param":"string $title The requested site title."},{"required":"yes","param":"string $user The user's requested login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, contains the requested privacy setting and lang_id."}],"desc":"Record site signup information for future activation.","returns":""},"wpmu_signup_user":{"params":[{"required":"yes","param":"string $user The user's requested login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, this is an empty array."}],"desc":"Record user signup information for future activation.","returns":""},"wpmu_signup_blog_notification":{"params":[{"required":"yes","param":"string $domain The new blog domain."},{"required":"yes","param":"string $path The new blog path."},{"required":"yes","param":"string $title The site title."},{"required":"yes","param":"string $user The user's login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, contains the requested privacy setting and lang_id."},{"required":"yes","param":"string $key The activation key created in wpmu_signup_blog()"}],"desc":"Notify user of signup success.","returns":"bool "},"wpmu_signup_user_notification":{"params":[{"required":"yes","param":"string $user The user's login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, an empty array."},{"required":"yes","param":"string $key The activation key created in wpmu_signup_user()"}],"desc":"Notify user of signup success.","returns":"bool "},"wpmu_activate_signup":{"params":[{"required":"yes","param":"string $key The activation key provided to the user."}],"desc":"Activate a signup.","returns":"array An array containing information about the activated user and/or blog"},"wpmu_create_user":{"params":[{"required":"yes","param":"string $user_name The new user's login name."},{"required":"yes","param":"string $password The new user's password."},{"required":"yes","param":"string $email The new user's email address."}],"desc":"Create a user.","returns":"mixed Returns false on failure, or int $user_id on success"},"wpmu_create_blog":{"params":[{"required":"yes","param":"string $domain The new site's domain."},{"required":"yes","param":"string $path The new site's path."},{"required":"yes","param":"string $title The new site's title."},{"required":"yes","param":"int $user_id The user ID of the new site's admin."},{"required":"no","param":"array $meta Optional. Used to set initial site options."},{"required":"no","param":"int $site_id Optional. Only relevant on multi-network installs."}],"desc":"Create a site.","returns":"mixed Returns WP_Error object on failure, int $blog_id on success"},"newblog_notify_siteadmin":{"params":[{"required":"yes","param":"int $blog_id The new site's ID."}],"desc":"Notifies the network admin that a new site has been activated.","returns":"bool "},"newuser_notify_siteadmin":{"params":[{"required":"yes","param":"int $user_id The new user's ID."}],"desc":"Notifies the network admin that a new user has been activated.","returns":"bool "},"domain_exists":{"params":[{"required":"yes","param":"string $domain The domain to be checked."},{"required":"yes","param":"string $path The path to be checked."},{"required":"no","param":"int $site_id Optional. Relevant only on multi-network installs."}],"desc":"Check whether a blogname is already taken.","returns":"int "},"insert_blog":{"params":[{"required":"yes","param":"string $domain The domain of the new site."},{"required":"yes","param":"string $path The path of the new site."},{"required":"yes","param":"int $site_id Unless you're running a multi-network install, be sure to set this value to 1."}],"desc":"Store basic site info in the blogs table.","returns":"int The ID of the new row"},"install_blog":{"params":[{"required":"yes","param":"int $blog_id The value returned by insert_blog()."},{"required":"yes","param":"string $blog_title The title of the new site."}],"desc":"Install an empty blog.","returns":""},"install_blog_defaults":{"params":[{"required":"yes","param":"int $blog_id Ignored in this function."},{"required":"yes","param":"int $user_id "}],"desc":"Set blog defaults.","returns":""},"wpmu_welcome_notification":{"params":[{"required":"yes","param":"int $blog_id "},{"required":"yes","param":"int $user_id "},{"required":"yes","param":"string $password "},{"required":"yes","param":"string $title The new blog's title"},{"required":"no","param":"array $meta Optional. Not used in the default function, but is passed along to hooks for customization."}],"desc":"Notify a user that her blog activation has been successful.","returns":"bool "},"wpmu_welcome_user_notification":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"string $password "},{"required":"no","param":"array $meta Optional. Not used in the default function, but is passed along to hooks for customization."}],"desc":"Notify a user that her account activation has been successful.","returns":"bool "},"get_current_site":{"params":[],"desc":"Get the current site info.","returns":"object "},"get_user_id_from_string":{"params":[{"required":"yes","param":"string $string "}],"desc":"Get a numeric user ID from either an email address or a login.","returns":"int "},"get_most_recent_post_of_user":{"params":[{"required":"yes","param":"int $user_id "}],"desc":"Get a user's most recent post.","returns":"array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts"},"get_dirsize":{"params":[{"required":"yes","param":"string $directory "}],"desc":"Get the size of a directory.","returns":"int "},"recurse_dirsize":{"params":[{"required":"yes","param":"string $directory "}],"desc":"Get the size of a directory recursively.","returns":"int "},"upload_is_user_over_quota":{"params":[{"required":"no","param":"bool $echo Optional. If $echo is set and the quota is exceeded, a warning message is echoed. Default is true."}],"desc":"Check whether a blog has used its allotted upload space.","returns":"int "},"check_upload_mimes":{"params":[{"required":"yes","param":"array $mimes "}],"desc":"Check an array of MIME types against a whitelist.","returns":"array "},"update_posts_count":{"params":[],"desc":"Update a blog's post count.","returns":""},"wpmu_log_new_registrations":{"params":[{"required":"yes","param":"int $blog_id "},{"required":"yes","param":"int $user_id "}],"desc":"Logs user registrations.","returns":""},"fix_import_form_size":{"params":[{"required":"yes","param":"int $size "}],"desc":"Get the remaining upload space for this blog.","returns":"int "},"global_terms":{"params":[{"required":"yes","param":"int $term_id An ID for a term on the current blog."}],"desc":"Maintains a canonical list of terms by syncing terms created for each blog with the global terms table.","returns":"int An ID from the global terms table mapped from $term_id."},"redirect_this_site":{"params":[],"desc":"Ensure that the current site's domain is listed in the allowed redirect host list.","returns":"array The current site's domain"},"upload_is_file_too_big":{"params":[{"required":"yes","param":"array $upload "}],"desc":"Check whether an upload is too big.","returns":"mixed If the upload is under the size limit, $upload is returned. Otherwise returns an error message."},"signup_nonce_fields":{"params":[],"desc":"Add a nonce field to the signup page.","returns":""},"signup_nonce_check":{"params":[{"required":"yes","param":"array $result "}],"desc":"Process the signup nonce created in signup_nonce_fields().","returns":"array "},"maybe_redirect_404":{"params":[],"desc":"Correct 404 redirects when NOBLOGREDIRECT is defined.","returns":""},"maybe_add_existing_user_to_blog":{"params":[],"desc":"Add a new user to a blog by visiting /newbloguser/username/.","returns":""},"add_existing_user_to_blog":{"params":[{"required":"yes","param":"array $details "}],"desc":"Add a user to a blog based on details from maybe_add_existing_user_to_blog().","returns":""},"add_new_user_to_blog":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"string $email "},{"required":"yes","param":"array $meta "}],"desc":"Add a newly created user to the appropriate blog","returns":""},"fix_phpmailer_messageid":{"params":[],"desc":"Correct From host on outgoing mail to match the site domain","returns":""},"is_user_spammy":{"params":[{"required":"yes","param":"string $username "}],"desc":"Check to see whether a user is marked as a spammer, based on username","returns":"bool "},"update_blog_public":{"params":[{"required":"yes","param":"int $old_value "},{"required":"yes","param":"int $value The new public value"}],"desc":"Update this blog's 'public' setting in the global blogs table.","returns":"bool "},"get_dashboard_blog":{"params":[],"desc":"Get the "dashboard blog", the blog where users without a blog edit their profile data.","returns":"int "},"is_user_option_local":{"params":[{"required":"yes","param":"string $key "},{"required":"no","param":"int $user_id Optional. Defaults to current user."},{"required":"no","param":"int $blog_id Optional. Defaults to current blog."}],"desc":"Check whether a usermeta key has to do with the current blog.","returns":"bool "},"users_can_register_signup_filter":{"params":[],"desc":"Check whether users can self-register, based on Network settings.","returns":"bool "},"welcome_user_msg_filter":{"params":[{"required":"yes","param":"string $text "}],"desc":"Ensure that the welcome message is not empty. Currently unused.","returns":"string "},"force_ssl_content":{"params":[{"required":"yes","param":"string|bool $force "}],"desc":"Whether to force SSL on content.","returns":"bool True if forced, false if not forced."},"filter_SSL":{"params":[],"desc":"Formats an String URL to use HTTPS if HTTP is found.","returns":""},"wp_schedule_update_network_counts":{"params":[],"desc":"Schedule update of the network-wide counts for the current network.","returns":""},"wp_update_network_counts":{"params":[],"desc":"Update the network-wide counts for the current network.","returns":""},"ms_upload_constants":{"params":[],"desc":"Defines Multisite upload constants.","returns":""},"ms_cookie_constants":{"params":[],"desc":"Defines Multisite cookie constants.","returns":""},"ms_file_constants":{"params":[],"desc":"Defines Multisite file constants.","returns":""},"ms_subdomain_constants":{"params":[],"desc":"Defines Multisite subdomain constants and handles warnings and notices.","returns":""},"get_postdata":{"params":[{"required":"yes","param":"int $postid "}],"desc":"Entire Post data.","returns":"array "},"start_wp":{"params":[],"desc":"Sets up the WordPress Loop.","returns":""},"the_category_ID":{"params":[{"required":"yes","param":"bool $echo "}],"desc":"Return or Print Category ID.","returns":"null|int "},"the_category_head":{"params":[{"required":"yes","param":"string $before "},{"required":"yes","param":"string $after "}],"desc":"Print category with optional text before and after.","returns":""},"previous_post":{"params":[{"required":"yes","param":"string $format "},{"required":"yes","param":"string $previous "},{"required":"yes","param":"string $title "},{"required":"yes","param":"string $in_same_cat "},{"required":"yes","param":"int $limitprev "},{"required":"yes","param":"string $excluded_categories "}],"desc":"Prints link to the previous post.","returns":""},"next_post":{"params":[{"required":"yes","param":"string $format "},{"required":"yes","param":"string $next "},{"required":"yes","param":"string $title "},{"required":"yes","param":"string $in_same_cat "},{"required":"yes","param":"int $limitnext "},{"required":"yes","param":"string $excluded_categories "}],"desc":"Prints link to the next post.","returns":""},"user_can_create_post":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $blog_id Not Used"},{"required":"yes","param":"int $category_id Not Used"}],"desc":"Whether user can create a post.","returns":"bool "},"user_can_create_draft":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $blog_id Not Used"},{"required":"yes","param":"int $category_id Not Used"}],"desc":"Whether user can create a post.","returns":"bool "},"user_can_edit_post":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can edit a post.","returns":"bool "},"user_can_delete_post":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool "},"user_can_set_post_date":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $blog_id Not Used"},{"required":"yes","param":"int $category_id Not Used"}],"desc":"Whether user can set new posts' dates.","returns":"bool "},"user_can_edit_post_date":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool returns true if $user_id can edit $post_id's date"},"user_can_edit_post_comments":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool returns true if $user_id can edit $post_id's comments"},"user_can_delete_post_comments":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool returns true if $user_id can delete $post_id's comments"},"user_can_edit_user":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $other_user "}],"desc":"Can user can edit other user.","returns":"bool "},"get_linksbyname":{"params":[{"required":"no","param":"string $cat_name Optional. The category name to use. If no match is found uses all."},{"required":"no","param":"string $before Optional. The html to output before the link."},{"required":"no","param":"string $after Optional. The html to output after the link."},{"required":"no","param":"string $between Optional. The html to output between the link/image and it's description. Not used if no image or $show_images is true."},{"required":"no","param":"bool $show_images Optional. Whether to show images (if defined)."},{"required":"no","param":"string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"no","param":"bool $show_description Optional. Whether to show the description if show_images=false/not defined."},{"required":"no","param":"bool $show_rating Optional. Show rating stars/chars."},{"required":"no","param":"int $limit Optional. Limit to X entries. If not specified, all entries are shown."},{"required":"no","param":"int $show_updated Optional. Whether to show last updated timestamp"}],"desc":"Gets the links associated with category $cat_name.","returns":""},"wp_get_linksbyname":{"params":[{"required":"yes","param":"string $category The category to use."},{"required":"yes","param":"string $args "}],"desc":"Gets the links associated with the named category.","returns":"bool|null "},"get_linkobjectsbyname":{"params":[{"required":"yes","param":"string $cat_name The category name to use. If no match is found uses all."},{"required":"yes","param":"string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."}],"desc":"Gets an array of link objects associated with category $cat_name.","returns":"unknown "},"get_linkobjects":{"params":[{"required":"yes","param":"int $category The category to use. If no category supplied uses all"},{"required":"yes","param":"string $orderby the order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."}],"desc":"Gets an array of link objects associated with category n.","returns":"unknown "},"get_linksbyname_withrating":{"params":[{"required":"yes","param":"string $cat_name The category name to use. If no match is found uses all"},{"required":"yes","param":"string $before The html to output before the link"},{"required":"yes","param":"string $after The html to output after the link"},{"required":"yes","param":"string $between The html to output between the link/image and it's description. Not used if no image or show_images is true"},{"required":"yes","param":"bool $show_images Whether to show images (if defined)."},{"required":"yes","param":"string $orderby the order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"bool $show_description Whether to show the description if show_images=false/not defined"},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."},{"required":"yes","param":"int $show_updated Whether to show last updated timestamp"}],"desc":"Gets the links associated with category 'cat_name' and display rating stars/chars.","returns":""},"get_links_withrating":{"params":[{"required":"yes","param":"int $category The category to use. If no category supplied uses all"},{"required":"yes","param":"string $before The html to output before the link"},{"required":"yes","param":"string $after The html to output after the link"},{"required":"yes","param":"string $between The html to output between the link/image and it's description. Not used if no image or show_images == true"},{"required":"yes","param":"bool $show_images Whether to show images (if defined)."},{"required":"yes","param":"string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"bool $show_description Whether to show the description if show_images=false/not defined."},{"required":"yes","param":"string $limit Limit to X entries. If not specified, all entries are shown."},{"required":"yes","param":"int $show_updated Whether to show last updated timestamp"}],"desc":"Gets the links associated with category n and display rating stars/chars.","returns":""},"get_autotoggle":{"params":[{"required":"yes","param":"int $id The category to get. If no category supplied uses 0"}],"desc":"Gets the auto_toggle setting.","returns":"int Only returns 0."},"list_cats":{"params":[{"required":"yes","param":"int $optionall "},{"required":"yes","param":"string $all "},{"required":"yes","param":"string $sort_column "},{"required":"yes","param":"string $sort_order "},{"required":"yes","param":"string $file "},{"required":"yes","param":"bool $list "},{"required":"yes","param":"int $optiondates "},{"required":"yes","param":"int $optioncount "},{"required":"yes","param":"int $hide_empty "},{"required":"yes","param":"int $use_desc_for_title "},{"required":"yes","param":"bool $children "},{"required":"yes","param":"int $child_of "},{"required":"yes","param":"int $categories "},{"required":"yes","param":"int $recurse "},{"required":"yes","param":"string $feed "},{"required":"yes","param":"string $feed_image "},{"required":"yes","param":"string $exclude "},{"required":"yes","param":"bool $hierarchical "}],"desc":"","returns":"unknown "},"wp_list_cats":{"params":[{"required":"yes","param":"string|array $args "}],"desc":"","returns":"unknown "},"dropdown_cats":{"params":[{"required":"yes","param":"int $optionall "},{"required":"yes","param":"string $all "},{"required":"yes","param":"string $orderby "},{"required":"yes","param":"string $order "},{"required":"yes","param":"int $show_last_update "},{"required":"yes","param":"int $show_count "},{"required":"yes","param":"int $hide_empty "},{"required":"yes","param":"bool $optionnone "},{"required":"yes","param":"int $selected "},{"required":"yes","param":"int $exclude "}],"desc":"","returns":"unknown "},"list_authors":{"params":[{"required":"yes","param":"bool $optioncount "},{"required":"yes","param":"bool $exclude_admin "},{"required":"yes","param":"bool $show_fullname "},{"required":"yes","param":"bool $hide_empty "},{"required":"yes","param":"string $feed "},{"required":"yes","param":"string $feed_image "}],"desc":"","returns":"unknown "},"wp_get_post_cats":{"params":[{"required":"yes","param":"int $blogid Not Used"},{"required":"yes","param":"int $post_ID "}],"desc":"","returns":"unknown "},"wp_set_post_cats":{"params":[{"required":"yes","param":"int $blogid Not used"},{"required":"yes","param":"int $post_ID "},{"required":"yes","param":"array $post_categories "}],"desc":"Sets the categories that the post id belongs to.","returns":"unknown "},"get_archives":{"params":[{"required":"yes","param":"string $type "},{"required":"yes","param":"string $limit "},{"required":"yes","param":"string $format "},{"required":"yes","param":"string $before "},{"required":"yes","param":"string $after "},{"required":"yes","param":"bool $show_post_count "}],"desc":"","returns":"unknown "},"get_author_link":{"params":[{"required":"no","param":"bool $echo Optional."},{"required":"yes","param":"int $author_id Required."},{"required":"no","param":"string $author_nicename Optional."}],"desc":"Returns or Prints link to the author's posts.","returns":"string|null "},"link_pages":{"params":[{"required":"yes","param":"string $before "},{"required":"yes","param":"string $after "},{"required":"yes","param":"string $next_or_number "},{"required":"yes","param":"string $nextpagelink "},{"required":"yes","param":"string $previouspagelink "},{"required":"yes","param":"string $pagelink "},{"required":"yes","param":"string $more_file "}],"desc":"Print list of pages based on arguments.","returns":"string "},"get_settings":{"params":[{"required":"yes","param":"string $option "}],"desc":"Get value based on option.","returns":"string "},"permalink_link":{"params":[],"desc":"Print the permalink of the current post in the loop.","returns":""},"permalink_single_rss":{"params":[{"required":"yes","param":"string $deprecated "}],"desc":"Print the permalink to the RSS feed.","returns":""},"wp_get_links":{"params":[{"required":"yes","param":"string $args a query string"}],"desc":"Gets the links associated with category.","returns":"null|string "},"get_links":{"params":[{"required":"yes","param":"int $category The category to use. If no category supplied uses all"},{"required":"yes","param":"string $before the html to output before the link"},{"required":"yes","param":"string $after the html to output after the link"},{"required":"yes","param":"string $between the html to output between the link/image and its description. Not used if no image or show_images == true"},{"required":"yes","param":"bool $show_images whether to show images (if defined)."},{"required":"yes","param":"string $orderby the order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"bool $show_description whether to show the description if show_images=false/not defined."},{"required":"yes","param":"bool $show_rating show rating stars/chars"},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."},{"required":"yes","param":"int $show_updated whether to show last updated timestamp"},{"required":"yes","param":"bool $echo whether to echo the results, or return them instead"}],"desc":"Gets the links associated with category by id.","returns":"null|string "},"get_links_list":{"params":[{"required":"yes","param":"string $order Sort link categories by 'name' or 'id'"}],"desc":"Output entire list of links by category.","returns":""},"links_popup_script":{"params":[{"required":"yes","param":"string $text the text of the link"},{"required":"yes","param":"int $width the width of the popup window"},{"required":"yes","param":"int $height the height of the popup window"},{"required":"yes","param":"string $file the page to open in the popup window"},{"required":"yes","param":"bool $count the number of links in the db"}],"desc":"Show the link to the links popup and the number of links.","returns":""},"get_linkrating":{"params":[{"required":"yes","param":"object $link "}],"desc":"","returns":"unknown "},"get_linkcatname":{"params":[{"required":"yes","param":"int $id The category to get. If no category supplied uses 0"}],"desc":"Gets the name of category by id.","returns":"string "},"comments_rss_link":{"params":[{"required":"yes","param":"string $link_text "}],"desc":"Print RSS comment feed link.","returns":""},"get_category_rss_link":{"params":[{"required":"yes","param":"bool $echo "},{"required":"yes","param":"int $cat_ID "}],"desc":"Print/Return link to category RSS2 feed.","returns":"string|null "},"get_author_rss_link":{"params":[{"required":"yes","param":"bool $echo "},{"required":"yes","param":"int $author_id "}],"desc":"Print/Return link to author RSS feed.","returns":"string|null "},"comments_rss":{"params":[],"desc":"Return link to the post RSS feed.","returns":"string "},"create_user":{"params":[{"required":"yes","param":"string $username The user's username."},{"required":"yes","param":"string $password The user's password."},{"required":"no","param":"string $email The user's email (optional)."}],"desc":"An alias of wp_create_user().","returns":"int The new user's ID."},"gzip_compression":{"params":[],"desc":"Unused function.","returns":""},"get_commentdata":{"params":[{"required":"yes","param":"int $comment_ID The ID of the comment"},{"required":"yes","param":"int $no_cache Whether to use the cache (cast to bool)"},{"required":"yes","param":"bool $include_unapproved Whether to include unapproved comments"}],"desc":"Retrieve an array of comment data about comment $comment_ID.","returns":"array The comment data"},"get_catname":{"params":[{"required":"yes","param":"int $cat_ID Category ID"}],"desc":"Retrieve the category name by the category ID.","returns":"string category name"},"get_category_children":{"params":[{"required":"yes","param":"int $id Category ID to retrieve children."},{"required":"no","param":"string $before Optional. Prepend before category term ID."},{"required":"no","param":"string $after Optional, default is empty string. Append after category term ID."},{"required":"no","param":"array $visited Optional. Category Term IDs that have already been added."}],"desc":"Retrieve category children list separated before and after the term IDs.","returns":"string "},"get_the_author_description":{"params":[],"desc":"Retrieve the description of the author of the current post.","returns":"string The author's description."},"the_author_description":{"params":[],"desc":"Display the description of the author of the current post.","returns":""},"get_the_author_login":{"params":[],"desc":"Retrieve the login name of the author of the current post.","returns":"string The author's login name (username)."},"the_author_login":{"params":[],"desc":"Display the login name of the author of the current post.","returns":""},"get_the_author_firstname":{"params":[],"desc":"Retrieve the first name of the author of the current post.","returns":"string The author's first name."},"the_author_firstname":{"params":[],"desc":"Display the first name of the author of the current post.","returns":""},"get_the_author_lastname":{"params":[],"desc":"Retrieve the last name of the author of the current post.","returns":"string The author's last name."},"the_author_lastname":{"params":[],"desc":"Display the last name of the author of the current post.","returns":""},"get_the_author_nickname":{"params":[],"desc":"Retrieve the nickname of the author of the current post.","returns":"string The author's nickname."},"the_author_nickname":{"params":[],"desc":"Display the nickname of the author of the current post.","returns":""},"get_the_author_email":{"params":[],"desc":"Retrieve the email of the author of the current post.","returns":"string The author's username."},"the_author_email":{"params":[],"desc":"Display the email of the author of the current post.","returns":""},"get_the_author_icq":{"params":[],"desc":"Retrieve the ICQ number of the author of the current post.","returns":"string The author's ICQ number."},"the_author_icq":{"params":[],"desc":"Display the ICQ number of the author of the current post.","returns":""},"get_the_author_yim":{"params":[],"desc":"Retrieve the Yahoo! IM name of the author of the current post.","returns":"string The author's Yahoo! IM name."},"the_author_yim":{"params":[],"desc":"Display the Yahoo! IM name of the author of the current post.","returns":""},"get_the_author_msn":{"params":[],"desc":"Retrieve the MSN address of the author of the current post.","returns":"string The author's MSN address."},"the_author_msn":{"params":[],"desc":"Display the MSN address of the author of the current post.","returns":""},"get_the_author_aim":{"params":[],"desc":"Retrieve the AIM address of the author of the current post.","returns":"string The author's AIM address."},"the_author_aim":{"params":[],"desc":"Display the AIM address of the author of the current post.","returns":""},"get_author_name":{"params":[{"required":"yes","param":"int $auth_id The ID of the author."}],"desc":"Retrieve the specified author's preferred display name.","returns":"string The author's display name."},"get_the_author_url":{"params":[],"desc":"Retrieve the URL to the home page of the author of the current post.","returns":"string The URL to the author's page."},"the_author_url":{"params":[],"desc":"Display the URL to the home page of the author of the current post.","returns":""},"get_the_author_ID":{"params":[],"desc":"Retrieve the ID of the author of the current post.","returns":"int The author's ID."},"the_author_ID":{"params":[],"desc":"Display the ID of the author of the current post.","returns":""},"the_content_rss":{"params":[{"required":"no","param":"string $more_link_text Optional. Text to display when more content is available but not displayed."},{"required":"no","param":"int|bool $stripteaser Optional. Default is 0."},{"required":"no","param":"string $more_file Optional."},{"required":"no","param":"int $cut Optional. Amount of words to keep for the content."},{"required":"no","param":"int $encode_html Optional. How to encode the content."}],"desc":"Display the post content for the feed.","returns":""},"make_url_footnote":{"params":[{"required":"yes","param":"string $content Content to get links"}],"desc":"Strip HTML and put links at the bottom of stripped content.","returns":"string HTML stripped out of content with links at the bottom."},"_c":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieve translated string with vertical bar context","returns":"string Translated context string without pipe"},"translate_with_context":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"yes","param":"string $domain Domain to retrieve the translated text"}],"desc":"Translates $text like translate(), but assumes that the text contains a context after its last vertical bar.","returns":"string Translated text"},"_nc":{"params":[],"desc":"A version of _n(), which supports contexts.","returns":""},"__ngettext":{"params":[],"desc":"Retrieve the plural or single form based on the amount.","returns":""},"__ngettext_noop":{"params":[],"desc":"Register plural strings in POT file, but don't translate them.","returns":""},"get_alloptions":{"params":[],"desc":"Retrieve all autoload options, or all options if no autoloaded ones exist.","returns":"array List of all options."},"get_the_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default is false. Whether to use full size image."},{"required":"no","param":"array $max_dims Optional. Max image dimensions."},{"required":"no","param":"bool $permalink Optional, default is false. Whether to include permalink to image."}],"desc":"Retrieve HTML content of attachment image with link.","returns":"string "},"get_attachment_icon_src":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default to false. Whether to have full image."}],"desc":"Retrieve icon URL and Path.","returns":"array Icon URL and full path to file, respectively."},"get_attachment_icon":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default to false. Whether to have full size image."},{"required":"no","param":"array $max_dims Optional. Dimensions of image."}],"desc":"Retrieve HTML content of icon attachment image element.","returns":"string HTML content."},"get_attachment_innerHTML":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default to false. Whether to have full size image."},{"required":"no","param":"array $max_dims Optional. Dimensions of image."}],"desc":"Retrieve HTML content of image element.","returns":"string "},"get_link":{"params":[{"required":"yes","param":"int $bookmark_id ID of link"},{"required":"yes","param":"string $output OBJECT, ARRAY_N, or ARRAY_A"}],"desc":"Retrieve bookmark data based on ID.","returns":"object|array "},"sanitize_url":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"yes","param":"array $protocols An array of acceptable protocols."}],"desc":"Performs esc_url() for database or redirect usage.","returns":"string The cleaned URL."},"clean_url":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"no","param":"array $protocols Optional. An array of acceptable protocols."},{"required":"no","param":"string $context Optional. How the URL will be used. Default is 'display'."}],"desc":"Checks and cleans a URL.","returns":"string The cleaned $url after the 'clean_url' filter is applied."},"js_escape":{"params":[{"required":"yes","param":"string $text The text to be escaped."}],"desc":"Escape single quotes, specialchar double quotes, and fix line endings.","returns":"string Escaped text."},"wp_specialchars":{"params":[],"desc":"Escaping for HTML blocks.","returns":""},"attribute_escape":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for HTML attributes.","returns":"string "},"register_sidebar_widget":{"params":[{"required":"yes","param":"string|int $name Widget ID."},{"required":"yes","param":"callback $output_callback Run when widget is called."},{"required":"yes","param":"string $classname Classname widget option."},{"required":"yes","param":"mixed $params,... Widget parameters."}],"desc":"Register widget for sidebar with backwards compatibility.","returns":""},"unregister_sidebar_widget":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Alias of {@link wp_unregister_sidebar_widget()}.","returns":""},"register_widget_control":{"params":[{"required":"yes","param":"int|string $name Sidebar ID."},{"required":"yes","param":"callback $control_callback Widget control callback to display and process form."},{"required":"yes","param":"int $width Widget width."},{"required":"yes","param":"int $height Widget height."}],"desc":"Registers widget control callback for customizing options.","returns":""},"unregister_widget_control":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Alias of {@link wp_unregister_widget_control()}.","returns":""},"delete_usermeta":{"params":[{"required":"yes","param":"int $user_id User ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."}],"desc":"Remove user meta data.","returns":"bool True deletion completed and false if user_id is not a number."},"get_usermeta":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"no","param":"string $meta_key Optional. Metadata key."}],"desc":"Retrieve user metadata.","returns":"mixed "},"update_usermeta":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."}],"desc":"Update metadata of user.","returns":"bool True on successful update, false on failure."},"get_users_of_blog":{"params":[{"required":"yes","param":"int $id Blog ID."}],"desc":"Get users for the blog.","returns":"array List of users that are part of that Blog ID"},"automatic_feed_links":{"params":[{"required":"no","param":"boolean $add Optional, default is true. Add or remove links. Defaults to true."}],"desc":"Enable/disable automatic general feed link outputting.","returns":""},"get_profile":{"params":[],"desc":"Retrieve user data based on field.","returns":""},"get_usernumposts":{"params":[],"desc":"Number of posts user has written.","returns":""},"funky_javascript_callback":{"params":[{"required":"yes","param":"array $matches Single Match"}],"desc":"Callback used to change %uXXXX to &#YYY; syntax","returns":"string An HTML entity"},"funky_javascript_fix":{"params":[{"required":"yes","param":"string $text Text to be made safe."}],"desc":"Fixes javascript bugs in browsers.","returns":"string Fixed text."},"is_taxonomy":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"}],"desc":"Checks that the taxonomy name exists.","returns":"bool Whether the taxonomy exists."},"is_term":{"params":[{"required":"yes","param":"int|string $term The term to check"},{"required":"yes","param":"string $taxonomy The taxonomy name to use"},{"required":"yes","param":"int $parent ID of parent term under which to confine the exists search."}],"desc":"Check if Term exists.","returns":"mixed Get the term id or Term Object, if exists."},"is_plugin_page":{"params":[],"desc":"Is the current admin page generated by a plugin?","returns":"bool "},"update_category_cache":{"params":[],"desc":"Update the categories cache.","returns":"bool Always return True"},"wp_timezone_supported":{"params":[],"desc":"Check for PHP timezone support","returns":"bool "},"the_editor":{"params":[{"required":"yes","param":"string $content Textarea content."},{"required":"no","param":"string $id Optional, default is 'content'. HTML ID attribute value."},{"required":"no","param":"string $prev_id Optional, not used"},{"required":"no","param":"bool $media_buttons Optional, default is true. Whether to display media buttons."},{"required":"no","param":"int $tab_index Optional, not used"}],"desc":"Display editor: TinyMCE, HTML, or both.","returns":""},"get_user_metavalues":{"params":[{"required":"yes","param":"array $ids User ID numbers list."}],"desc":"Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users","returns":"array of arrays. The array is indexed by user_id, containing $metavalues object arrays."},"sanitize_user_object":{"params":[{"required":"yes","param":"object|array $user The User Object or Array"},{"required":"no","param":"string $context Optional, default is 'display'. How to sanitize user fields."}],"desc":"Sanitize every user field.","returns":"object|array The now sanitized User Object or Array (will be the same type as $user)"},"get_boundary_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"string $excluded_categories Optional. Excluded categories IDs."},{"required":"no","param":"bool $start Optional, default is true. Whether to display link to first or last post."}],"desc":"Get boundary post relational link.","returns":"string "},"start_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"string $excluded_categories Optional. Excluded categories IDs."}],"desc":"Display relational link for the first post.","returns":""},"get_index_rel_link":{"params":[],"desc":"Get site index relational link.","returns":"string "},"index_rel_link":{"params":[],"desc":"Display relational link for the site index.","returns":""},"get_parent_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."}],"desc":"Get parent post relational link.","returns":"string "},"parent_post_rel_link":{"params":[],"desc":"Display relational link for parent item","returns":""},"wp_admin_bar_dashboard_view_site_menu":{"params":[],"desc":"Add the "Dashboard"/"Visit Site" menu.","returns":""},"is_blog_user":{"params":[{"required":"yes","param":"int $blog_id Blog ID"}],"desc":"Checks if the current user belong to a given blog.","returns":"bool True if the current users belong to $blog_id, false if not."},"stripos":{"params":[],"desc":"","returns":""},"wp_print_styles":{"params":[{"required":"yes","param":"array|bool $handles Styles to be printed. An empty array prints the queue, an array with one string prints that style, and an array of strings prints those styles."}],"desc":"Display styles that are in the queue or part of $handles.","returns":"bool True on success, false on failure."},"wp_add_inline_style":{"params":[],"desc":"Adds extra CSS.","returns":""},"wp_register_style":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."},{"required":"yes","param":"string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'."},{"required":"yes","param":"array $deps Array of handles of any stylesheet that this stylesheet depends on. (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies."},{"required":"yes","param":"string|bool $ver String specifying the stylesheet version number. Set to NULL to disable. Used to ensure that the correct version is sent to the client regardless of caching."},{"required":"yes","param":"string $media The media for which this stylesheet has been defined."}],"desc":"Register CSS style file.","returns":""},"wp_deregister_style":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."}],"desc":"Remove a registered CSS file.","returns":""},"wp_enqueue_style":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."},{"required":"yes","param":"string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'."},{"required":"yes","param":"array $deps Array of handles (names) of any stylesheet that this stylesheet depends on. (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies."},{"required":"yes","param":"string|bool $ver String specifying the stylesheet version number, if it has one. This parameter is used to ensure that the correct version is sent to the client regardless of caching, and so should be included if a version number is available and makes sense for the stylesheet."},{"required":"yes","param":"string $media The media for which this stylesheet has been defined."}],"desc":"Enqueue a CSS style file.","returns":""},"wp_dequeue_style":{"params":[],"desc":"Remove an enqueued style.","returns":""},"wp_style_is":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."},{"required":"yes","param":"string $list Values are 'registered', 'done', 'queue' and 'to_do'."}],"desc":"Check whether style has been added to WordPress Styles.","returns":"bool True on success, false on failure."},"redirect_canonical":{"params":[{"required":"no","param":"string $requested_url Optional. The URL that was requested, used to figure if redirect is needed."},{"required":"no","param":"bool $do_redirect Optional. Redirect to the new URL."}],"desc":"Redirects incoming links to the proper URL based on the site url.","returns":"null|false|string Null, if redirect not needed. False, if redirect not needed or the string of the URL"},"redirect_guess_404_permalink":{"params":[],"desc":"Attempts to guess correct post based on query vars.","returns":"bool|string Returns False, if it can't find post, returns correct location on success."},"wp_get_nav_menu_object":{"params":[{"required":"yes","param":"string $menu Menu id, slug or name"}],"desc":"Returns a navigation menu object.","returns":"mixed false if $menu param isn't supplied or term does not exist, menu object if successful."},"is_nav_menu":{"params":[{"required":"yes","param":"int|string $menu The menu to check (id, slug, or name)"}],"desc":"Check if the given ID is a navigation menu.","returns":"bool Whether the menu exists."},"register_nav_menus":{"params":[{"required":"yes","param":"array $locations Associative array of menu location identifiers (like a slug) and descriptive text."}],"desc":"Register navigation menus for a theme.","returns":""},"unregister_nav_menu":{"params":[{"required":"yes","param":"array $location the menu location identifier"}],"desc":"Unregisters a navigation menu for a theme.","returns":"bool True on success, false on failure."},"register_nav_menu":{"params":[{"required":"yes","param":"string $location Menu location identifier, like a slug."},{"required":"yes","param":"string $description Menu location descriptive text."}],"desc":"Register a navigation menu for a theme.","returns":""},"get_registered_nav_menus":{"params":[],"desc":"Returns an array of all registered navigation menus in a theme","returns":"array "},"get_nav_menu_locations":{"params":[],"desc":"Returns an array with the registered navigation menu locations and the menu assigned to it","returns":"array "},"has_nav_menu":{"params":[{"required":"yes","param":"string $location Menu location identifier."}],"desc":"Whether a registered nav menu location has a menu assigned to it.","returns":"bool Whether location has a menu."},"is_nav_menu_item":{"params":[{"required":"yes","param":"int $menu_item_id The ID of the potential nav menu item."}],"desc":"Determine whether the given ID is a nav menu item.","returns":"bool Whether the given ID is that of a nav menu item."},"wp_create_nav_menu":{"params":[{"required":"yes","param":"string $menu_name Menu Name"}],"desc":"Create a Navigation Menu.","returns":"mixed Menu object on success|WP_Error on failure"},"wp_delete_nav_menu":{"params":[{"required":"yes","param":"string $menu name|id|slug"}],"desc":"Delete a Navigation Menu.","returns":"mixed Menu object on success|WP_Error on failure"},"wp_update_nav_menu_object":{"params":[{"required":"yes","param":"int $menu_id The ID of the menu or "0" to create a new menu."},{"required":"yes","param":"array $menu_data The array of menu data."}],"desc":"Save the properties of a menu or create a new menu with those properties.","returns":"int|error object The menu's ID or WP_Error object."},"wp_update_nav_menu_item":{"params":[{"required":"yes","param":"int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan."},{"required":"yes","param":"int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item."},{"required":"yes","param":"array $menu_item_data The menu item's data."}],"desc":"Save the properties of a menu item or create a new one.","returns":"int The menu item's database ID or WP_Error object on failure."},"wp_get_nav_menus":{"params":[{"required":"yes","param":"array $args Array of arguments passed on to get_terms()."}],"desc":"Returns all navigation menu objects.","returns":"array menu objects"},"_sort_nav_menu_items":{"params":[{"required":"yes","param":"object $a The first object to compare"},{"required":"yes","param":"object $b The second object to compare"}],"desc":"Sort menu items by the desired key.","returns":"int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b."},"_is_valid_nav_menu_item":{"params":[{"required":"yes","param":"object $menu_item The menu item to check"}],"desc":"Returns if a menu item is valid. Bug #13958","returns":"bool false if invalid, else true."},"wp_get_nav_menu_items":{"params":[{"required":"yes","param":"string $menu menu name, id, or slug"},{"required":"yes","param":"string $args "}],"desc":"Returns all menu items of a navigation menu.","returns":"mixed $items array of menu items, else false."},"wp_setup_nav_menu_item":{"params":[{"required":"yes","param":"object $menu_item The menu item to modify."}],"desc":"Decorates a menu item object with the shared navigation menu item properties.","returns":"object $menu_item The menu item with standard menu item properties."},"wp_get_associated_nav_menu_items":{"params":[{"required":"yes","param":"int $object_id The ID of the original object."},{"required":"yes","param":"string $object_type The type of object, such as "taxonomy" or "post_type.""}],"desc":"Get the menu items associated with a particular object.","returns":"array The array of menu item IDs; empty array if none;"},"_wp_delete_post_menu_item":{"params":[{"required":"yes","param":"int $object_id The ID of the original object being trashed."}],"desc":"Callback for handling a menu item when its original object is deleted.","returns":""},"_wp_delete_tax_menu_item":{"params":[{"required":"yes","param":"int $object_id The ID of the original object being trashed."}],"desc":"Callback for handling a menu item when its original object is deleted.","returns":""},"_wp_auto_add_pages_to_menu":{"params":[{"required":"yes","param":"string $new_status The new status of the post object."},{"required":"yes","param":"string $old_status The old status of the post object."},{"required":"yes","param":"object $post The post object being transitioned from one status to another."}],"desc":"Automatically add newly published page objects to menus with that as an option.","returns":"void "},"wp_unregister_GLOBALS":{"params":[],"desc":"Turn register globals off.","returns":"null Will return null if register_globals PHP directive was disabled"},"wp_fix_server_vars":{"params":[],"desc":"Fix $_SERVER variables for various setups.","returns":""},"wp_check_php_mysql_versions":{"params":[],"desc":"Check for the required PHP version, and the MySQL extension or a database drop-in.","returns":""},"wp_favicon_request":{"params":[],"desc":"Don't load all of WordPress when handling a favicon.ico request.","returns":""},"wp_maintenance":{"params":[],"desc":"Dies with a maintenance message when conditions are met.","returns":""},"timer_start":{"params":[],"desc":"PHP 4 standard microtime start capture.","returns":"bool Always returns true."},"timer_stop":{"params":[{"required":"yes","param":"int $display Use '0' or null to not echo anything and 1 to echo the total time"},{"required":"yes","param":"int $precision The amount of digits from the right of the decimal to display. Default is 3."}],"desc":"Return and/or display the time from the page start to when function is called.","returns":"float The "second.microsecond" finished time calculation"},"wp_debug_mode":{"params":[],"desc":"Sets PHP error handling and handles WordPress debug mode.","returns":""},"wp_set_lang_dir":{"params":[],"desc":"Sets the location of the language directory.","returns":""},"require_wp_db":{"params":[],"desc":"Load the correct database class file.","returns":""},"wp_set_wpdb_vars":{"params":[],"desc":"Sets the database table prefix and the format specifiers for database table columns.","returns":""},"wp_start_object_cache":{"params":[],"desc":"Starts the WordPress object cache.","returns":""},"wp_not_installed":{"params":[],"desc":"Redirects to the installer if WordPress is not installed.","returns":""},"wp_get_mu_plugins":{"params":[],"desc":"Returns array of must-use plugin files to be included in global scope.","returns":"array Files to include"},"wp_get_active_and_valid_plugins":{"params":[],"desc":"Returns array of plugin files to be included in global scope.","returns":"array Files to include"},"wp_set_internal_encoding":{"params":[],"desc":"Sets internal encoding using mb_internal_encoding().","returns":""},"wp_magic_quotes":{"params":[],"desc":"Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER.","returns":""},"shutdown_action_hook":{"params":[],"desc":"Runs just before PHP shuts down execution.","returns":""},"wp_clone":{"params":[{"required":"yes","param":"object $object The object to clone"}],"desc":"Copy an object.","returns":"object The cloned object"},"is_admin":{"params":[],"desc":"Whether the current request is for a network or blog admin page","returns":"bool True if inside WordPress administration pages."},"is_blog_admin":{"params":[],"desc":"Whether the current request is for a blog admin screen /wp-admin/","returns":"bool True if inside WordPress network administration pages."},"is_network_admin":{"params":[],"desc":"Whether the current request is for a network admin screen /wp-admin/network/","returns":"bool True if inside WordPress network administration pages."},"is_user_admin":{"params":[],"desc":"Whether the current request is for a user admin screen /wp-admin/user/","returns":"bool True if inside WordPress user administration pages."},"is_multisite":{"params":[],"desc":"Whether Multisite support is enabled","returns":"bool True if multisite is enabled, false otherwise."},"wp_schedule_single_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Schedules a hook to run only once.","returns":""},"wp_schedule_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $recurrence How often the event should recur."},{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Schedule a periodic event.","returns":"bool|null False on failure, null when complete with scheduling event."},"wp_reschedule_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $recurrence How often the event should recur."},{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Reschedule a recurring event.","returns":"bool|null False on failure. Null when event is rescheduled."},"wp_unschedule_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $hook Action hook, the execution of which will be unscheduled."},{"required":"yes","param":"array $args Arguments to pass to the hook's callback function. Although not passed to a callback function, these arguments are used to uniquely identify the scheduled event, so they should be the same as those used when originally scheduling the event."}],"desc":"Unschedule a previously scheduled cron job.","returns":""},"wp_clear_scheduled_hook":{"params":[{"required":"yes","param":"string $hook Action hook, the execution of which will be unscheduled."},{"required":"no","param":"array $args Optional. Arguments that were to be pass to the hook's callback function."}],"desc":"Unschedule all cron jobs attached to a specific hook.","returns":""},"wp_next_scheduled":{"params":[{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Retrieve the next timestamp for a cron event.","returns":"bool|int The UNIX timestamp of the next time the scheduled event will occur."},"spawn_cron":{"params":[],"desc":"Send request to run cron through HTTP request that doesn't halt page loading.","returns":"null Cron could not be spawned, because it is not needed to run."},"wp_cron":{"params":[],"desc":"Run scheduled callbacks or spawn cron for all scheduled events.","returns":"null When doesn't need to run Cron."},"wp_get_schedules":{"params":[],"desc":"Retrieve supported and filtered Cron recurrences.","returns":"array "},"wp_get_schedule":{"params":[{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Retrieve Cron schedule for hook with arguments.","returns":"string|bool False, if no schedule. Schedule on success."},"_get_cron_array":{"params":[],"desc":"Retrieve cron info array option.","returns":"array CRON info array."},"_set_cron_array":{"params":[{"required":"yes","param":"array $cron Cron info array from {@link _get_cron_array()}."}],"desc":"Updates the CRON option with the new CRON array.","returns":""},"_upgrade_cron_array":{"params":[{"required":"yes","param":"array $cron Cron info array from {@link _get_cron_array()}."}],"desc":"Upgrade a Cron info array.","returns":"array An upgraded Cron info array."},"_wp_oembed_get_object":{"params":[],"desc":"Returns the initialized {@link WP_oEmbed} object","returns":"WP_oEmbed object."},"get_locale":{"params":[],"desc":"Gets the current locale.","returns":"string The locale of the blog or from the 'locale' hook."},"translate":{"params":[{"required":"yes","param":"string $text Text to translate."},{"required":"yes","param":"string $domain Domain to retrieve the translated text."}],"desc":"Retrieves the translation of $text. If there is no translation, or the domain isn't loaded, the original text is returned.","returns":"string Translated text"},"before_last_bar":{"params":[],"desc":"","returns":""},"translate_with_gettext_context":{"params":[],"desc":"","returns":""},"__":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieves the translation of $text. If there is no translation, or the domain isn't loaded, the original text is returned.","returns":"string Translated text"},"esc_attr__":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieves the translation of $text and escapes it for safe use in an attribute.","returns":"string Translated text"},"esc_html__":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieves the translation of $text and escapes it for safe use in HTML output.","returns":"string Translated text"},"_e":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays the returned translated text from translate().","returns":""},"esc_attr_e":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays translated text that has been escaped for safe use in an attribute.","returns":""},"esc_html_e":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays translated text that has been escaped for safe use in HTML output.","returns":""},"_x":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"yes","param":"string $context Context information for the translators"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieve translated string with gettext context","returns":"string Translated context string without pipe"},"_ex":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"yes","param":"string $context Context information for the translators"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays translated string with gettext context","returns":"string Translated context string without pipe"},"esc_attr_x":{"params":[],"desc":"","returns":""},"esc_html_x":{"params":[],"desc":"","returns":""},"_n":{"params":[{"required":"yes","param":"string $single The text that will be used if $number is 1"},{"required":"yes","param":"string $plural The text that will be used if $number is not 1"},{"required":"yes","param":"int $number The number to compare against to use either $single or $plural"},{"required":"no","param":"string $domain Optional. The domain identifier the text should be retrieved in"}],"desc":"Retrieve the plural or single form based on the amount.","returns":"string Either $single or $plural translated text"},"_nx":{"params":[],"desc":"A hybrid of _n() and _x(). It supports contexts and plurals.","returns":""},"_n_noop":{"params":[{"required":"yes","param":"string $singular Single form to be i18ned"},{"required":"yes","param":"string $plural Plural form to be i18ned"}],"desc":"Register plural strings in POT file, but don't translate them.","returns":"array array($singular, $plural)"},"_nx_noop":{"params":[],"desc":"Register plural strings with context in POT file, but don't translate them.","returns":""},"translate_nooped_plural":{"params":[{"required":"yes","param":"array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()"},{"required":"yes","param":"int $count Number of objects"},{"required":"no","param":"string $domain Optional. The domain identifier the text should be retrieved in"}],"desc":"Translate the result of _n_noop() or _nx_noop()","returns":""},"load_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"},{"required":"yes","param":"string $mofile Path to the .mo file"}],"desc":"Loads a MO file into the domain $domain.","returns":"bool True on success, false on failure"},"unload_textdomain":{"params":[{"required":"yes","param":"string $domain Textdomain to be unloaded"}],"desc":"Unloads translations for a domain","returns":"bool Whether textdomain was unloaded"},"load_default_textdomain":{"params":[],"desc":"Loads default translated strings based on locale.","returns":""},"load_plugin_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"},{"required":"no","param":"string $abs_rel_path Optional. Relative path to ABSPATH of a folder, where the .mo file resides. Deprecated, but still functional until 2.7"},{"required":"no","param":"string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precedence over $abs_rel_path"}],"desc":"Loads the plugin's translated strings.","returns":""},"load_muplugin_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"},{"required":"yes","param":"string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which the MO file resides. Defaults to empty string."}],"desc":"Load the translated strings for a plugin residing in the mu-plugins dir.","returns":""},"load_theme_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"}],"desc":"Loads the theme's translated strings.","returns":""},"load_child_theme_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"}],"desc":"Loads the child themes translated strings.","returns":""},"get_translations_for_domain":{"params":[{"required":"yes","param":"string $domain "}],"desc":"Returns the Translations instance for a domain. If there isn't one, returns empty Translations instance.","returns":"object A Translation instance"},"is_textdomain_loaded":{"params":[{"required":"yes","param":"string $domain "}],"desc":"Whether there are translations for the domain","returns":"bool Whether there are translations"},"translate_user_role":{"params":[],"desc":"Translates role name. Since the role names are in the database and not in the source there are dummy gettext calls to get them into the POT file and this function properly translates them back.","returns":""},"get_available_languages":{"params":[{"required":"yes","param":"string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR."}],"desc":"Get all available languages based on the presence of *.mo files in a given directory. The default directory is WP_LANG_DIR.","returns":"array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names."},"add_filter":{"params":[{"required":"yes","param":"string $tag The name of the filter to hook the $function_to_add to."},{"required":"yes","param":"callback $function_to_add The name of the function to be called when the filter is applied."},{"required":"no","param":"int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accept (default 1)."}],"desc":"Hooks a function or method to a specific filter action.","returns":"boolean true"},"has_filter":{"params":[{"required":"yes","param":"string $tag The name of the filter hook."},{"required":"no","param":"callback $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached."}],"desc":"Check if any filter has been registered for a hook.","returns":"int|boolean Optionally returns the priority on that hook for the specified function."},"apply_filters":{"params":[{"required":"yes","param":"string $tag The name of the filter hook."},{"required":"yes","param":"mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on."},{"required":"yes","param":"mixed $var,... Additional variables passed to the functions hooked to <tt>$tag</tt>."}],"desc":"Call the functions added to a filter hook.","returns":"mixed The filtered value after all hooked functions are applied to it."},"apply_filters_ref_array":{"params":[{"required":"yes","param":"string $tag The name of the filter hook."},{"required":"yes","param":"array $args The arguments supplied to the functions hooked to <tt>$tag</tt>"}],"desc":"Execute functions hooked on a specific filter hook, specifying arguments in an array.","returns":"mixed The filtered value after all hooked functions are applied to it."},"remove_filter":{"params":[{"required":"yes","param":"string $tag The filter hook to which the function to be removed is hooked."},{"required":"yes","param":"callback $function_to_remove The name of the function which should be removed."},{"required":"no","param":"int $priority optional. The priority of the function (default: 10)."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accepts (default: 1)."}],"desc":"Removes a function from a specified filter hook.","returns":"boolean Whether the function existed before it was removed."},"remove_all_filters":{"params":[{"required":"yes","param":"string $tag The filter to remove hooks from."},{"required":"yes","param":"int $priority The priority number to remove."}],"desc":"Remove all of the hooks from a filter.","returns":"bool True when finished."},"current_filter":{"params":[],"desc":"Retrieve the name of the current filter or action.","returns":"string Hook name of the current filter or action."},"add_action":{"params":[{"required":"yes","param":"string $tag The name of the action to which the $function_to_add is hooked."},{"required":"yes","param":"callback $function_to_add The name of the function you wish to be called."},{"required":"no","param":"int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accept (default 1)."}],"desc":"Hooks a function on to a specific action.","returns":""},"do_action":{"params":[{"required":"yes","param":"string $tag The name of the action to be executed."},{"required":"no","param":"mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the action."}],"desc":"Execute functions hooked on a specific action hook.","returns":"null Will return null if $tag does not exist in $wp_filter array"},"did_action":{"params":[{"required":"yes","param":"string $tag The name of the action hook."}],"desc":"Retrieve the number of times an action is fired.","returns":"int The number of times action hook <tt>$tag</tt> is fired"},"do_action_ref_array":{"params":[{"required":"yes","param":"string $tag The name of the action to be executed."},{"required":"yes","param":"array $args The arguments supplied to the functions hooked to <tt>$tag</tt>"}],"desc":"Execute functions hooked on a specific action hook, specifying arguments in an array.","returns":"null Will return null if $tag does not exist in $wp_filter array"},"has_action":{"params":[{"required":"yes","param":"string $tag The name of the action hook."},{"required":"no","param":"callback $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached."}],"desc":"Check if any action has been registered for a hook.","returns":"int|boolean Optionally returns the priority on that hook for the specified function."},"remove_action":{"params":[{"required":"yes","param":"string $tag The action hook to which the function to be removed is hooked."},{"required":"yes","param":"callback $function_to_remove The name of the function which should be removed."},{"required":"no","param":"int $priority optional The priority of the function (default: 10)."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accepts (default: 1)."}],"desc":"Removes a function from a specified action hook.","returns":"boolean Whether the function is removed."},"remove_all_actions":{"params":[{"required":"yes","param":"string $tag The action to remove hooks from."},{"required":"yes","param":"int $priority The priority number to remove them from."}],"desc":"Remove all of the hooks from an action.","returns":"bool True when finished."},"plugin_basename":{"params":[{"required":"yes","param":"string $file The filename of plugin."}],"desc":"Gets the basename of a plugin.","returns":"string The name of a plugin."},"plugin_dir_path":{"params":[{"required":"yes","param":"string $file The filename of the plugin (__FILE__)"}],"desc":"Gets the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in","returns":"string the filesystem path of the directory that contains the plugin"},"plugin_dir_url":{"params":[{"required":"yes","param":"string $file The filename of the plugin (__FILE__)"}],"desc":"Gets the URL directory path (with trailing slash) for the plugin __FILE__ passed in","returns":"string the URL path of the directory that contains the plugin"},"register_activation_hook":{"params":[{"required":"yes","param":"string $file The filename of the plugin including the path."},{"required":"yes","param":"callback $function the function hooked to the 'activate_PLUGIN' action."}],"desc":"Set the activation hook for a plugin.","returns":""},"register_deactivation_hook":{"params":[{"required":"yes","param":"string $file The filename of the plugin including the path."},{"required":"yes","param":"callback $function the function hooked to the 'activate_PLUGIN' action."}],"desc":"Set the deactivation hook for a plugin.","returns":""},"register_uninstall_hook":{"params":[{"required":"yes","param":"string $file "},{"required":"yes","param":"callback $callback The callback to run when the hook is called. Must be a static method or function."}],"desc":"Set the uninstallation hook for a plugin.","returns":""},"_wp_call_all_hook":{"params":[{"required":"yes","param":"array $args The collected parameters from the hook that was called."},{"required":"no","param":"string $hook Optional. The hook name that was used to call the 'all' hook."}],"desc":"Calls the 'all' hook, which will process the functions hooked into it.","returns":""},"_wp_filter_build_unique_id":{"params":[{"required":"yes","param":"string $tag Used in counting how many hooks were applied"},{"required":"yes","param":"callback $function Used for creating unique id"},{"required":"yes","param":"int|bool $priority Used in counting how many hooks were applied. If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise."}],"desc":"Build Unique ID for storage and retrieval.","returns":"string|bool Unique ID for usage as array key or false if $priority === false and $function is an object reference, and it does not already have a unique id."},"generate_random_password":{"params":[],"desc":"","returns":""},"is_site_admin":{"params":[],"desc":"Determine if user is a site admin.","returns":""},"graceful_fail":{"params":[],"desc":"","returns":""},"get_user_details":{"params":[],"desc":"","returns":""},"clear_global_post_cache":{"params":[],"desc":"","returns":""},"is_main_blog":{"params":[],"desc":"","returns":""},"validate_email":{"params":[],"desc":"","returns":""},"get_blog_list":{"params":[],"desc":"","returns":""},"get_most_active_blogs":{"params":[],"desc":"","returns":""},"wpmu_admin_do_redirect":{"params":[{"required":"yes","param":"string $url "}],"desc":"Redirect a user based on $_GET or $_POST arguments.","returns":""},"wpmu_admin_redirect_add_updated_param":{"params":[{"required":"yes","param":"string $url "}],"desc":"Adds an 'updated=true' argument to a URL.","returns":"string "},"has_post_thumbnail":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Check if post has an image attached.","returns":"bool Whether post has an image attached."},"get_post_thumbnail_id":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Retrieve Post Thumbnail ID.","returns":"int "},"the_post_thumbnail":{"params":[{"required":"no","param":"int $size Optional. Image size. Defaults to 'post-thumbnail', which theme sets using set_post_thumbnail_size( $width, $height, $crop_flag );."},{"required":"no","param":"string|array $attr Optional. Query string or array of attributes."}],"desc":"Display Post Thumbnail.","returns":""},"update_post_thumbnail_cache":{"params":[],"desc":"Update cache for thumbnails in the current loop","returns":""},"get_the_post_thumbnail":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"no","param":"string $size Optional. Image size. Defaults to 'thumbnail'."},{"required":"no","param":"string|array $attr Optional. Query string or array of attributes."}],"desc":"Retrieve Post Thumbnail.","returns":""},"wp_version_check":{"params":[],"desc":"Check WordPress version against the newest version.","returns":"mixed Returns null if update is unsupported. Returns false if check is too soon."},"wp_update_plugins":{"params":[],"desc":"Check plugin versions against the latest versions hosted on WordPress.org.","returns":"mixed Returns null if update is unsupported. Returns false if check is too soon."},"wp_update_themes":{"params":[],"desc":"Check theme versions against the latest versions hosted on WordPress.org.","returns":"mixed Returns null if update is unsupported. Returns false if check is too soon."},"wp_get_update_data":{"params":[],"desc":"","returns":""},"_maybe_update_core":{"params":[],"desc":"","returns":""},"_maybe_update_plugins":{"params":[],"desc":"Check the last time plugins were run before checking plugin versions.","returns":""},"_maybe_update_themes":{"params":[],"desc":"Check themes versions only after a duration of time.","returns":""},"wp_schedule_update_checks":{"params":[],"desc":"Schedule core, theme, and plugin update checks.","returns":""},"_wp_admin_bar_init":{"params":[],"desc":"Instantiate the admin bar object and set it up as a global for access elsewhere.","returns":"bool Whether the admin bar was successfully initialized."},"wp_admin_bar_render":{"params":[],"desc":"Render the admin bar to the page based on the $wp_admin_bar->menu member var.","returns":""},"wp_admin_bar_wp_menu":{"params":[],"desc":"Add the WordPress logo menu.","returns":""},"wp_admin_bar_my_account_item":{"params":[],"desc":"Add the "My Account" item.","returns":""},"wp_admin_bar_my_account_menu":{"params":[],"desc":"Add the "My Account" submenu items.","returns":""},"wp_admin_bar_site_menu":{"params":[],"desc":"Add the "Site Name" menu.","returns":""},"wp_admin_bar_my_sites_menu":{"params":[],"desc":"Add the "My Sites/[Site Name]" menu and all submenus.","returns":""},"wp_admin_bar_shortlink_menu":{"params":[],"desc":"Provide a shortlink.","returns":""},"wp_admin_bar_edit_menu":{"params":[],"desc":"Provide an edit link for posts and terms.","returns":""},"wp_admin_bar_new_content_menu":{"params":[],"desc":"Add "Add New" menu.","returns":""},"wp_admin_bar_comments_menu":{"params":[],"desc":"Add edit comments link with awaiting moderation count bubble.","returns":""},"wp_admin_bar_appearance_menu":{"params":[],"desc":"Add appearance submenu items to the "Site Name" menu.","returns":""},"wp_admin_bar_updates_menu":{"params":[],"desc":"Provide an update link if theme/plugin/core updates are available.","returns":""},"wp_admin_bar_search_menu":{"params":[],"desc":"Add search form.","returns":""},"wp_admin_bar_add_secondary_groups":{"params":[],"desc":"Add secondary menus.","returns":""},"wp_admin_bar_header":{"params":[],"desc":"Style and scripts for the admin bar.","returns":""},"_admin_bar_bump_cb":{"params":[],"desc":"Default admin bar callback.","returns":""},"show_admin_bar":{"params":[{"required":"yes","param":"bool $show Whether to allow the admin bar to show."}],"desc":"Set the display status of the admin bar.","returns":"void "},"is_admin_bar_showing":{"params":[],"desc":"Determine whether the admin bar should be showing.","returns":"bool Whether the admin bar should be showing."},"_get_admin_bar_pref":{"params":[{"required":"yes","param":"string $context Context of this preference check. Defaults to 'front'. The 'admin' preference is no longer used."},{"required":"no","param":"int $user Optional. ID of the user to check, defaults to 0 for current user."}],"desc":"Retrieve the admin bar display preference of a user.","returns":"bool Whether the admin bar should be showing for this user."},"map_meta_cap":{"params":[{"required":"yes","param":"string $cap Capability name."},{"required":"yes","param":"int $user_id User ID."}],"desc":"Map meta capabilities to primitive capabilities.","returns":"array Actual capabilities for meta capability."},"current_user_can":{"params":[{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether current user has capability or role.","returns":"bool "},"current_user_can_for_blog":{"params":[{"required":"yes","param":"int $blog_id Blog ID"},{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether current user has a capability or role for a given blog.","returns":"bool "},"author_can":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."},{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether author of supplied post has capability or role.","returns":"bool "},"user_can":{"params":[{"required":"yes","param":"int|object $user User ID or object."},{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether a particular user has capability or role.","returns":"bool "},"get_role":{"params":[{"required":"yes","param":"string $role Role name."}],"desc":"Retrieve role object.","returns":"object "},"add_role":{"params":[{"required":"yes","param":"string $role Role name."},{"required":"yes","param":"string $display_name Display name for role."},{"required":"yes","param":"array $capabilities List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );"}],"desc":"Add role, if it does not exist.","returns":"null|WP_Role WP_Role object if role is added, null if already exists."},"remove_role":{"params":[{"required":"yes","param":"string $role Role name."}],"desc":"Remove role, if it exists.","returns":"null "},"get_super_admins":{"params":[],"desc":"Retrieve a list of super admins.","returns":"array List of super admin logins"},"is_super_admin":{"params":[{"required":"no","param":"int $user_id (Optional) The ID of a user. Defaults to the current user."}],"desc":"Determine if user is a site admin.","returns":"bool True if the user is a site admin."},"the_ID":{"params":[],"desc":"Display the ID of the current item in the WordPress Loop.","returns":""},"get_the_ID":{"params":[],"desc":"Retrieve the ID of the current item in the WordPress Loop.","returns":"int "},"the_title":{"params":[{"required":"no","param":"string $before Optional. Content to prepend to the title."},{"required":"no","param":"string $after Optional. Content to append to the title."},{"required":"no","param":"bool $echo Optional, default to true.Whether to display or return."}],"desc":"Display or retrieve the current post title with optional content.","returns":"null|string Null on no title. String if $echo parameter is false."},"the_title_attribute":{"params":[{"required":"no","param":"string|array $args Optional. Override the defaults."}],"desc":"Sanitize the current title when retrieving or displaying.","returns":"string|null Null on failure or display. String when echo is false."},"get_the_title":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Retrieve post title.","returns":"string "},"the_guid":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Display the Post Global Unique Identifier (guid).","returns":""},"get_the_guid":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Retrieve the Post Global Unique Identifier (guid).","returns":"string "},"the_content":{"params":[{"required":"no","param":"string $more_link_text Optional. Content for when there is more text."},{"required":"no","param":"bool $stripteaser Optional. Strip teaser content before the more text. Default is false."}],"desc":"Display the post content.","returns":""},"get_the_content":{"params":[{"required":"no","param":"string $more_link_text Optional. Content for when there is more text."},{"required":"no","param":"bool $stripteaser Optional. Strip teaser content before the more text. Default is false."}],"desc":"Retrieve the post content.","returns":"string "},"_convert_urlencoded_to_entities":{"params":[{"required":"yes","param":"array $match Match array from preg_replace_callback"}],"desc":"Preview fix for javascript bug with foreign languages","returns":""},"the_excerpt":{"params":[],"desc":"Display the post excerpt.","returns":""},"get_the_excerpt":{"params":[{"required":"yes","param":"mixed $deprecated Not used."}],"desc":"Retrieve the post excerpt.","returns":"string "},"has_excerpt":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Whether post has excerpt.","returns":"bool "},"post_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."},{"required":"no","param":"int $post_id An optional post ID."}],"desc":"Display the classes for the post div.","returns":""},"get_post_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."},{"required":"no","param":"int $post_id An optional post ID."}],"desc":"Retrieve the classes for the post div as an array.","returns":"array Array of classes."},"body_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."}],"desc":"Display the classes for the body element.","returns":""},"get_body_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."}],"desc":"Retrieve the classes for the body element as an array.","returns":"array Array of classes."},"post_password_required":{"params":[{"required":"no","param":"int|object $post An optional post. Global $post used if not provided."}],"desc":"Whether post requires password and correct password has been provided.","returns":"bool false if a password is not required or the correct password cookie is present, true otherwise."},"sticky_class":{"params":[{"required":"no","param":"int $post_id An optional post ID."}],"desc":"Display "sticky" CSS class, if a post is sticky.","returns":""},"wp_link_pages":{"params":[{"required":"no","param":"string|array $args Optional. Overwrite the defaults."}],"desc":"The formatted output of a list of pages.","returns":"string Formatted output in HTML."},"_wp_link_page":{"params":[{"required":"yes","param":"int $i Page number."}],"desc":"Helper function for wp_link_pages().","returns":"string Link."},"post_custom":{"params":[{"required":"yes","param":"string $key Meta data key name."}],"desc":"Retrieve post custom meta data field.","returns":"bool|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist."},"the_meta":{"params":[],"desc":"Display list of post custom fields.","returns":""},"wp_dropdown_pages":{"params":[{"required":"no","param":"array|string $args Optional. Override default arguments."}],"desc":"Retrieve or display list of pages as a dropdown (select list).","returns":"string HTML content, if not displaying."},"wp_list_pages":{"params":[{"required":"no","param":"array|string $args Optional. Override default arguments."}],"desc":"Retrieve or display list of pages in list (li) format.","returns":"string HTML content, if not displaying."},"wp_page_menu":{"params":[{"required":"yes","param":"array|string $args "}],"desc":"Display or retrieve list of pages with optional home link.","returns":""},"walk_page_tree":{"params":[],"desc":"Retrieve HTML list content for page list.","returns":""},"walk_page_dropdown_tree":{"params":[],"desc":"Retrieve HTML dropdown (select) content for page list.","returns":""},"the_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default is false. Whether to use full size."},{"required":"yes","param":"bool $deprecated Deprecated. Not used."},{"required":"no","param":"bool $permalink Optional, default is false. Whether to include permalink."}],"desc":"Display an attachment page link using an image or icon.","returns":""},"wp_get_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"string $size Optional, default is 'thumbnail'. Size of image, either array or string."},{"required":"no","param":"bool $permalink Optional, default is false. Whether to add permalink to image."},{"required":"no","param":"bool $icon Optional, default is false. Whether to include icon."},{"required":"no","param":"string $text Optional, default is false. If string, then will be link text."}],"desc":"Retrieve an attachment page link using an image or icon, if possible.","returns":"string HTML content."},"prepend_attachment":{"params":[{"required":"yes","param":"string $content "}],"desc":"Wrap attachment in <<p>> element before content.","returns":"string "},"get_the_password_form":{"params":[],"desc":"Retrieve protected post password form content.","returns":"string HTML content for password form for password protected post."},"is_page_template":{"params":[{"required":"yes","param":"string $template The specific template name if specific matching is required."}],"desc":"Whether currently in a page template.","returns":"bool False on failure, true if success."},"wp_post_revision_title":{"params":[{"required":"yes","param":"int|object $revision Revision ID or revision object."},{"required":"no","param":"bool $link Optional, default is true. Link to revisions's page?"}],"desc":"Retrieve formatted date timestamp of a revision (linked to that revisions's page).","returns":"string i18n formatted datetimestamp or localized 'Current Revision'."},"wp_list_post_revisions":{"params":[{"required":"yes","param":"int|object $post_id Post ID or post object."},{"required":"yes","param":"string|array $args See description {@link wp_parse_args()}."}],"desc":"Display list of a post's revisions.","returns":"null "},"get_bookmark":{"params":[{"required":"yes","param":"mixed $bookmark "},{"required":"no","param":"string $output Optional. Either OBJECT, ARRAY_N, or ARRAY_A constant"},{"required":"no","param":"string $filter Optional, default is 'raw'."}],"desc":"Retrieve Bookmark data","returns":"array|object Type returned depends on $output value."},"get_bookmark_field":{"params":[{"required":"yes","param":"string $field The name of the data field to return"},{"required":"yes","param":"int $bookmark The bookmark ID to get field"},{"required":"no","param":"string $context Optional. The context of how the field will be used."}],"desc":"Retrieve single bookmark data item or field.","returns":"string "},"get_bookmarks":{"params":[{"required":"yes","param":"string|array $args List of arguments to overwrite the defaults"}],"desc":"Retrieves the list of bookmarks","returns":"array List of bookmark row objects"},"sanitize_bookmark":{"params":[{"required":"yes","param":"object|array $bookmark Bookmark row"},{"required":"no","param":"string $context Optional, default is 'display'. How to filter the fields"}],"desc":"Sanitizes all bookmark fields","returns":"object|array Same type as $bookmark but with fields sanitized."},"sanitize_bookmark_field":{"params":[{"required":"yes","param":"string $field The bookmark field"},{"required":"yes","param":"mixed $value The bookmark field value"},{"required":"yes","param":"int $bookmark_id Bookmark ID"},{"required":"yes","param":"string $context How to filter the field value. Either 'raw', 'edit', 'attribute', 'js', 'db', or 'display'"}],"desc":"Sanitizes a bookmark field","returns":"mixed The filtered value"},"clean_bookmark_cache":{"params":[],"desc":"Deletes bookmark cache","returns":""},"register_widget":{"params":[{"required":"yes","param":"string $widget_class The name of a class that extends WP_Widget"}],"desc":"Register a widget","returns":""},"unregister_widget":{"params":[{"required":"yes","param":"string $widget_class The name of a class that extends WP_Widget"}],"desc":"Unregister a widget","returns":""},"register_sidebars":{"params":[{"required":"yes","param":"int $number Number of sidebars to create."},{"required":"yes","param":"string|array $args Builds Sidebar based off of 'name' and 'id' values."}],"desc":"Creates multiple sidebars.","returns":""},"register_sidebar":{"params":[{"required":"yes","param":"string|array $args Builds Sidebar based off of 'name' and 'id' values"}],"desc":"Builds the definition for a single sidebar and returns the ID.","returns":"string The sidebar id that was added."},"unregister_sidebar":{"params":[{"required":"yes","param":"string $name The ID of the sidebar when it was added."}],"desc":"Removes a sidebar from the list.","returns":""},"wp_register_sidebar_widget":{"params":[{"required":"yes","param":"int|string $id Widget ID."},{"required":"yes","param":"string $name Widget display title."},{"required":"yes","param":"callback $output_callback Run when widget is called."},{"required":"no","param":"array|string $options Optional. Widget Options."},{"required":"yes","param":"mixed $params,... Widget parameters to add to widget."}],"desc":"Register widget for use in sidebars.","returns":"null Will return if $output_callback is empty after removing widget."},"wp_widget_description":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Retrieve description for widget.","returns":"string Widget description, if available. Null on failure to retrieve description."},"wp_sidebar_description":{"params":[{"required":"yes","param":"int|string $id sidebar ID."}],"desc":"Retrieve description for a sidebar.","returns":"string Sidebar description, if available. Null on failure to retrieve description."},"wp_unregister_sidebar_widget":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Remove widget from sidebar.","returns":""},"wp_register_widget_control":{"params":[{"required":"yes","param":"int|string $id Sidebar ID."},{"required":"yes","param":"string $name Sidebar display name."},{"required":"yes","param":"callback $control_callback Run when sidebar is displayed."},{"required":"no","param":"array|string $options Optional. Widget options. See above long description."},{"required":"no","param":"mixed $params,... Optional. Additional parameters to add to widget."}],"desc":"Registers widget control callback for customizing options.","returns":""},"_register_widget_update_callback":{"params":[],"desc":"","returns":""},"_register_widget_form_callback":{"params":[],"desc":"","returns":""},"wp_unregister_widget_control":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Remove control callback for widget.","returns":""},"dynamic_sidebar":{"params":[{"required":"no","param":"int|string $index Optional, default is 1. Name or ID of dynamic sidebar."}],"desc":"Display dynamic sidebar.","returns":"bool True, if widget sidebar was found and called. False if not found or not called."},"is_active_widget":{"params":[{"required":"no","param":"string $callback Optional, Widget callback to check."},{"required":"no","param":"int $widget_id Optional, but needed for checking. Widget ID."},{"required":"no","param":"string $id_base Optional, the base ID of a widget created by extending WP_Widget."},{"required":"no","param":"bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'."}],"desc":"Whether widget is displayed on the front-end.","returns":"mixed false if widget is not active or id of sidebar in which the widget is active."},"is_dynamic_sidebar":{"params":[],"desc":"Whether the dynamic sidebar is enabled and used by theme.","returns":"bool True, if using widgets. False, if not using widgets."},"is_active_sidebar":{"params":[{"required":"yes","param":"mixed $index Sidebar name, id or number to check."}],"desc":"Whether a sidebar is in use.","returns":"bool true if the sidebar is in use, false otherwise."},"wp_get_sidebars_widgets":{"params":[{"required":"yes","param":"bool $deprecated Not used (deprecated)."}],"desc":"Retrieve full list of sidebars and their widgets.","returns":"array Upgraded list of widgets to version 3 array format when called from the admin."},"wp_set_sidebars_widgets":{"params":[{"required":"yes","param":"array $sidebars_widgets Sidebar widgets and their settings."}],"desc":"Set the sidebar widget option to update sidebars.","returns":""},"wp_get_widget_defaults":{"params":[],"desc":"Retrieve default registered sidebars list.","returns":"array "},"wp_convert_widget_settings":{"params":[],"desc":"Convert the widget settings from single to multi-widget format.","returns":"array "},"the_widget":{"params":[{"required":"yes","param":"string $widget the widget's PHP class name (see default-widgets.php)"},{"required":"yes","param":"array $instance the widget's instance settings"},{"required":"yes","param":"array $args the widget's sidebar args"}],"desc":"Output an arbitrary widget as a template tag","returns":"void "},"_get_widget_id_base":{"params":[],"desc":"Private","returns":""},"_wp_sidebars_changed":{"params":[],"desc":"Handle sidebars config after theme change","returns":""},"retrieve_widgets":{"params":[],"desc":"","returns":""},"wp_nav_menu":{"params":[{"required":"yes","param":"array $args Arguments"}],"desc":"Displays a navigation menu.","returns":""},"_wp_menu_item_classes_by_context":{"params":[{"required":"yes","param":"array $menu_items The current menu item objects to which to add the class property information."}],"desc":"Add the class property classes for the current context, if applicable.","returns":""},"walk_nav_menu_tree":{"params":[],"desc":"Retrieve the HTML list content for nav menu items.","returns":""},"_nav_menu_item_id_use_once":{"params":[],"desc":"Prevents a menu item ID from being used more than once.","returns":""},"wp_default_scripts":{"params":[{"required":"yes","param":"object $scripts WP_Scripts object."}],"desc":"Register all WordPress scripts.","returns":""},"wp_default_styles":{"params":[{"required":"yes","param":"object $styles "}],"desc":"Assign default styles to $styles object.","returns":""},"wp_prototype_before_jquery":{"params":[{"required":"yes","param":"array $js_array JavaScript scripts array"}],"desc":"Reorder JavaScript scripts array to place prototype before jQuery.","returns":"array Reordered array, if needed."},"wp_just_in_time_script_localization":{"params":[],"desc":"Load localized data on print rather than initialization.","returns":""},"wp_style_loader_src":{"params":[{"required":"yes","param":"string $src Source URL."},{"required":"yes","param":"string $handle Either 'colors' or 'colors-rtl'."}],"desc":"Administration Screen CSS for changing the styles.","returns":"string URL path to CSS stylesheet for Administration Screens."},"print_head_scripts":{"params":[],"desc":"Prints the script queue in the HTML head on admin pages.","returns":""},"print_footer_scripts":{"params":[],"desc":"Prints the scripts that were queued for the footer or too late for the HTML head.","returns":""},"_print_scripts":{"params":[],"desc":"","returns":""},"wp_print_head_scripts":{"params":[],"desc":"Prints the script queue in the HTML head on the front end.","returns":""},"_wp_footer_scripts":{"params":[],"desc":"Private, for use in *_footer_scripts hooks","returns":""},"wp_print_footer_scripts":{"params":[],"desc":"Hooks to print the scripts and styles in the footer.","returns":""},"wp_enqueue_scripts":{"params":[],"desc":"Wrapper for do_action('wp_enqueue_scripts')","returns":""},"print_admin_styles":{"params":[],"desc":"Prints the styles queue in the HTML head on admin pages.","returns":""},"print_late_styles":{"params":[],"desc":"Prints the styles that were queued too late for the HTML head.","returns":""},"_print_styles":{"params":[],"desc":"","returns":""},"script_concat_settings":{"params":[],"desc":"Determine the concatenation and compression settings for scripts and styles.","returns":""},"getRequestParam":{"params":[{"required":"yes","param":"String $name Name of parameter to get."},{"required":"yes","param":"String $default_value Default value to return if value not found."}],"desc":"Returns an request value by name without magic quoting.","returns":"String request value by name without magic quoting or default value."},"getLogger":{"params":[],"desc":"","returns":""},"debug":{"params":[],"desc":"","returns":""},"info":{"params":[],"desc":"","returns":""},"error":{"params":[],"desc":"","returns":""},"warn":{"params":[],"desc":"","returns":""},"fatal":{"params":[],"desc":"","returns":""},"mce_escape":{"params":[],"desc":"","returns":""},"get_file":{"params":[],"desc":"","returns":""},"wp_signon":{"params":[{"required":"no","param":"array $credentials Optional. User info in order to sign on."},{"required":"no","param":"bool $secure_cookie Optional. Whether to use secure cookie."}],"desc":"Authenticate user with remember capability.","returns":"object Either WP_Error on failure, or WP_User on success."},"wp_authenticate_username_password":{"params":[],"desc":"","returns":""},"wp_authenticate_cookie":{"params":[],"desc":"Authenticate the user using the WordPress auth cookie.","returns":""},"count_user_posts":{"params":[{"required":"yes","param":"int $userid User ID."}],"desc":"Number of posts user has written.","returns":"int Amount of posts user has written."},"count_many_users_posts":{"params":[{"required":"yes","param":"array $user_ids Array of user IDs."},{"required":"no","param":"string|array $post_type Optional. Post type to check. Defaults to post."}],"desc":"Number of posts written by a list of users.","returns":"array Amount of posts each user has written."},"user_pass_ok":{"params":[{"required":"yes","param":"string $user_login User name."},{"required":"yes","param":"string $user_pass User password."}],"desc":"Check that the user login name and password is correct.","returns":"bool False if does not authenticate, true if username and password authenticates."},"get_current_user_id":{"params":[],"desc":"Get the current user's ID","returns":"int The current user's ID"},"get_user_option":{"params":[{"required":"yes","param":"string $option User option name."},{"required":"no","param":"int $user Optional. User ID."},{"required":"yes","param":"bool $deprecated Use get_option() to check for an option in the options table."}],"desc":"Retrieve user option that can be either per Site or per Network.","returns":"mixed "},"update_user_option":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"string $option_name User option name."},{"required":"yes","param":"mixed $newvalue User option value."},{"required":"no","param":"bool $global Optional. Whether option name is global or blog specific. Default false (blog specific)."}],"desc":"Update user option with global blog capability.","returns":"unknown "},"delete_user_option":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"string $option_name User option name."},{"required":"no","param":"bool $global Optional. Whether option name is global or blog specific. Default false (blog specific)."}],"desc":"Delete user option with global blog capability.","returns":"unknown "},"get_users":{"params":[{"required":"no","param":"array $args Optional."}],"desc":"Retrieve list of users matching criteria.","returns":"array List of users."},"get_blogs_of_user":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"bool $all Whether to retrieve all blogs, or only blogs that are not marked as deleted, archived, or spam."}],"desc":"Get the blogs a user belongs to.","returns":"array A list of the user's blogs. False if the user was not found or an empty array if the user has no blogs."},"is_user_member_of_blog":{"params":[{"required":"yes","param":"int $user_id The unique ID of the user"},{"required":"no","param":"int $blog Optional. If no blog_id is provided, current site is used"}],"desc":"Find out whether a user is a member of a given blog.","returns":"bool "},"add_user_meta":{"params":[{"required":"yes","param":"int $user_id Post ID."},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"bool $unique Optional, default is false. Whether the same key should not be added."}],"desc":"Add meta data field to a user.","returns":"bool False for failure. True for success."},"delete_user_meta":{"params":[{"required":"yes","param":"int $user_id user ID"},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"no","param":"mixed $meta_value Optional. Metadata value."}],"desc":"Remove metadata matching criteria from a user.","returns":"bool False for failure. True for success."},"get_user_meta":{"params":[{"required":"yes","param":"int $user_id Post ID."},{"required":"yes","param":"string $key The meta key to retrieve."},{"required":"yes","param":"bool $single Whether to return a single value."}],"desc":"Retrieve user meta field for a user.","returns":"mixed Will be an array if $single is false. Will be value of meta data field if $single is true."},"update_user_meta":{"params":[{"required":"yes","param":"int $user_id Post ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"mixed $prev_value Optional. Previous value to check before removing."}],"desc":"Update user meta field based on user ID.","returns":"bool False on failure, true if success."},"count_users":{"params":[{"required":"yes","param":"string $strategy 'time' or 'memory'"}],"desc":"Count number of users who have each of the user roles.","returns":"array Includes a grand total and an array of counts indexed by role strings."},"setup_userdata":{"params":[{"required":"no","param":"int $for_user_id Optional. User ID to set up global data."}],"desc":"Set up global user vars.","returns":""},"wp_dropdown_users":{"params":[{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Create dropdown HTML content of users.","returns":"string|null Null on display. String of HTML content on retrieve."},"sanitize_user_field":{"params":[{"required":"yes","param":"string $field The user Object field name."},{"required":"yes","param":"mixed $value The user Object value."},{"required":"yes","param":"int $user_id user ID."},{"required":"yes","param":"string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display', 'attribute' and 'js'."}],"desc":"Sanitize user field based on context.","returns":"mixed Sanitized value."},"update_user_caches":{"params":[{"required":"yes","param":"object $user User object to be cached"}],"desc":"Update all user caches","returns":""},"clean_user_cache":{"params":[{"required":"yes","param":"int $id User ID"}],"desc":"Clean all user caches","returns":""},"username_exists":{"params":[{"required":"yes","param":"string $username Username."}],"desc":"Checks whether the given username exists.","returns":"null|int The user's ID on success, and null on failure."},"email_exists":{"params":[{"required":"yes","param":"string $email Email."}],"desc":"Checks whether the given email exists.","returns":"bool|int The user's ID on success, and false on failure."},"validate_username":{"params":[{"required":"yes","param":"string $username Username."}],"desc":"Checks whether an username is valid.","returns":"bool Whether username given is valid"},"wp_insert_user":{"params":[{"required":"yes","param":"array $userdata An array of user data."}],"desc":"Insert an user into the database.","returns":"int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created."},"wp_update_user":{"params":[{"required":"yes","param":"array $userdata An array of user data."}],"desc":"Update an user in the database.","returns":"int The updated user's ID."},"wp_create_user":{"params":[{"required":"yes","param":"string $username The user's username."},{"required":"yes","param":"string $password The user's password."},{"required":"no","param":"string $email The user's email (optional)."}],"desc":"A simpler way of inserting an user into the database.","returns":"int The new user's ID."},"_get_additional_user_keys":{"params":[{"required":"yes","param":"object $user WP_User instance"}],"desc":"Return a list of meta keys that wp_insert_user() is supposed to set.","returns":"array "},"_wp_get_user_contactmethods":{"params":[{"required":"no","param":"object $user User data object (optional)"}],"desc":"Set up the default contact methods","returns":"array $user_contactmethods Array of contact methods and their labels."},"get_category_link":{"params":[{"required":"yes","param":"int|object $category Category ID or object."}],"desc":"Retrieve category link URL.","returns":"string Link on success, empty string if category does not exist."},"get_category_parents":{"params":[{"required":"yes","param":"int $id Category ID."},{"required":"no","param":"bool $link Optional, default is false. Whether to format with link."},{"required":"no","param":"string $separator Optional, default is '/'. How to separate categories."},{"required":"no","param":"bool $nicename Optional, default is false. Whether to use nice name for display."},{"required":"no","param":"array $visited Optional. Already linked to categories to prevent duplicates."}],"desc":"Retrieve category parents with separator.","returns":"string "},"get_the_category":{"params":[{"required":"no","param":"int $id Optional, default to current post ID. The post ID."}],"desc":"Retrieve post categories.","returns":"array "},"_usort_terms_by_name":{"params":[{"required":"yes","param":"object $a "},{"required":"yes","param":"object $b "}],"desc":"Sort categories by name.","returns":"int "},"_usort_terms_by_ID":{"params":[{"required":"yes","param":"object $a "},{"required":"yes","param":"object $b "}],"desc":"Sort categories by ID.","returns":"int "},"get_the_category_by_ID":{"params":[{"required":"yes","param":"int $cat_ID Category ID."}],"desc":"Retrieve category name based on category ID.","returns":"string Category name."},"get_the_category_list":{"params":[{"required":"no","param":"string $separator Optional, default is empty string. Separator for between the categories."},{"required":"no","param":"string $parents Optional. How to display the parents."},{"required":"no","param":"int $post_id Optional. Post ID to retrieve categories."}],"desc":"Retrieve category list in either HTML list or custom format.","returns":"string "},"in_category":{"params":[{"required":"yes","param":"int|string|array $category Category ID, name or slug, or array of said."},{"required":"no","param":"int|object $_post Optional. Post to check instead of the current post. (since 2.7.0)"}],"desc":"Check if the current post in within any of the given categories.","returns":"bool True if the current post is in any of the given categories."},"the_category":{"params":[{"required":"no","param":"string $separator Optional, default is empty string. Separator for between the categories."},{"required":"no","param":"string $parents Optional. How to display the parents."},{"required":"no","param":"int $post_id Optional. Post ID to retrieve categories."}],"desc":"Display the category list for the post.","returns":""},"category_description":{"params":[{"required":"no","param":"int $category Optional. Category ID. Will use global category ID by default."}],"desc":"Retrieve category description.","returns":"string Category description, available."},"wp_dropdown_categories":{"params":[{"required":"no","param":"string|array $args Optional. Override default arguments."}],"desc":"Display or retrieve the HTML dropdown list of categories.","returns":"string HTML content only if 'echo' argument is 0."},"wp_list_categories":{"params":[{"required":"no","param":"string|array $args Optional. Override default arguments."}],"desc":"Display or retrieve the HTML list of categories.","returns":"string HTML content only if 'echo' argument is 0."},"wp_tag_cloud":{"params":[{"required":"no","param":"array|string $args Optional. Override default arguments."}],"desc":"Display tag cloud.","returns":"array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument."},"default_topic_count_text":{"params":[{"required":"yes","param":"integer $count number of posts with that tag"}],"desc":"Default text for tooltip for tag links","returns":"string text for the tooltip of a tag link."},"default_topic_count_scale":{"params":[{"required":"yes","param":"integer $count number of posts with that tag"}],"desc":"Default topic count scaling for tag links","returns":"integer scaled count"},"wp_generate_tag_cloud":{"params":[{"required":"yes","param":"array $tags List of tags."},{"required":"no","param":"string|array $args Optional, override default arguments."}],"desc":"Generates a tag cloud (heatmap) from provided data.","returns":"string "},"_wp_object_name_sort_cb":{"params":[],"desc":"Callback for comparing objects based on name","returns":""},"_wp_object_count_sort_cb":{"params":[],"desc":"Callback for comparing objects based on count","returns":""},"walk_category_tree":{"params":[],"desc":"Retrieve HTML list content for category list.","returns":""},"walk_category_dropdown_tree":{"params":[],"desc":"Retrieve HTML dropdown (select) content for category list.","returns":""},"get_tag_link":{"params":[{"required":"yes","param":"int|object $tag Tag ID or object."}],"desc":"Retrieve the link to the tag.","returns":"string Link on success, empty string if tag does not exist."},"get_the_tags":{"params":[{"required":"yes","param":"int $id Post ID."}],"desc":"Retrieve the tags for a post.","returns":"array "},"get_the_tag_list":{"params":[{"required":"no","param":"string $before Optional. Before tags."},{"required":"no","param":"string $sep Optional. Between tags."},{"required":"no","param":"string $after Optional. After tags."}],"desc":"Retrieve the tags for a post formatted as a string.","returns":"string "},"the_tags":{"params":[{"required":"no","param":"string $before Optional. Before list."},{"required":"no","param":"string $sep Optional. Separate items using this."},{"required":"no","param":"string $after Optional. After list."}],"desc":"Retrieve the tags for a post.","returns":"string "},"tag_description":{"params":[{"required":"no","param":"int $tag Optional. Tag ID. Will use global tag ID by default."}],"desc":"Retrieve tag description.","returns":"string Tag description, available."},"term_description":{"params":[{"required":"no","param":"int $term Optional. Term ID. Will use global term ID by default."}],"desc":"Retrieve term description.","returns":"string Term description, available."},"get_the_terms":{"params":[{"required":"no","param":"int $id Post ID. Is not optional."},{"required":"yes","param":"string $taxonomy Taxonomy name."}],"desc":"Retrieve the terms of the taxonomy that are attached to the post.","returns":"array|bool False on failure. Array of term objects on success."},"get_the_term_list":{"params":[{"required":"yes","param":"int $id Post ID."},{"required":"yes","param":"string $taxonomy Taxonomy name."},{"required":"no","param":"string $before Optional. Before list."},{"required":"no","param":"string $sep Optional. Separate items using this."},{"required":"no","param":"string $after Optional. After list."}],"desc":"Retrieve a post's terms as a list with specified format.","returns":"string "},"the_terms":{"params":[{"required":"yes","param":"int $id Post ID."},{"required":"yes","param":"string $taxonomy Taxonomy name."},{"required":"no","param":"string $before Optional. Before list."},{"required":"no","param":"string $sep Optional. Separate items using this."},{"required":"no","param":"string $after Optional. After list."}],"desc":"Display the terms in a list.","returns":"null|bool False on WordPress error. Returns null when displaying."},"has_category":{"params":[{"required":"no","param":"string|int|array $tag Optional. The category name/term_id/slug or array of them to check for."},{"required":"no","param":"int|object $post Optional. Post to check instead of the current post."}],"desc":"Check if the current post has any of given category.","returns":"bool True if the current post has any of the given categories (or any category, if no category specified)."},"has_tag":{"params":[{"required":"no","param":"string|int|array $tag Optional. The tag name/term_id/slug or array of them to check for."},{"required":"no","param":"int|object $post Optional. Post to check instead of the current post. (since 2.7.0)"}],"desc":"Check if the current post has any of given tags.","returns":"bool True if the current post has any of the given tags (or any tag, if no tag specified)."},"has_term":{"params":[{"required":"no","param":"string|int|array $term Optional. The term name/term_id/slug or array of them to check for."},{"required":"yes","param":"string $taxonomy Taxonomy name"},{"required":"no","param":"int|object $post Optional. Post to check instead of the current post."}],"desc":"Check if the current post has any of given terms.","returns":"bool True if the current post has any of the given tags (or any tag, if no tag specified)."}}' );
\ No newline at end of file
+
+var autocomplete_wordpress = jQuery.parseJSON( '{"_wp_menu_output":{"params":[{"required":"yes","param":"array $menu "},{"required":"yes","param":"array $submenu "},{"required":"yes","param":"bool $submenu_as_parent "}],"desc":"Display menu.","returns":""},"display_header":{"params":[],"desc":"Display install header.","returns":""},"get_bloginfo":{"params":[{"required":"yes","param":"string $show Blog info to retrieve."},{"required":"yes","param":"string $filter How to filter what is retrieved."}],"desc":"Retrieve information about the blog.","returns":"string Mostly string values, might be empty."},"wp_nav_menu_max_depth":{"params":[],"desc":"","returns":""},"comment_footer_die":{"params":[{"required":"yes","param":"string $msg Error Message. Assumed to contain HTML and be sanitized."}],"desc":"Display error message at bottom of comments.","returns":""},"press_it":{"params":[],"desc":"Press It form handler.","returns":"int Post ID"},"get_images_from_uri":{"params":[{"required":"yes","param":"string $uri "}],"desc":"Retrieve all image URLs from given URI.","returns":"string "},"press_this_media_buttons":{"params":[],"desc":"","returns":""},"add_js":{"params":[],"desc":"Display JavaScript on the page.","returns":""},"export_date_options":{"params":[],"desc":"","returns":""},"__":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieves the translation of $text. If there is no translation, or the domain isn't loaded, the original text is returned.","returns":"string Translated text"},"_x":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"yes","param":"string $context Context information for the translators"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieve translated string with gettext context","returns":"string Translated context string without pipe"},"add_filter":{"params":[{"required":"yes","param":"string $tag The name of the filter to hook the $function_to_add to."},{"required":"yes","param":"callback $function_to_add The name of the function to be called when the filter is applied."},{"required":"no","param":"int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accept (default 1)."}],"desc":"Hooks a function or method to a specific filter action.","returns":"boolean true"},"esc_attr":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for HTML attributes.","returns":"string "},"apply_filters":{"params":[{"required":"yes","param":"string $tag The name of the filter hook."},{"required":"yes","param":"mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on."},{"required":"yes","param":"mixed $var,... Additional variables passed to the functions hooked to <tt>$tag</tt>."}],"desc":"Call the functions added to a filter hook.","returns":"mixed The filtered value after all hooked functions are applied to it."},"get_option":{"params":[{"required":"yes","param":"string $option Name of option to retrieve. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $default Optional. Default value to return if the option does not exist."}],"desc":"Retrieve option value based on name of option.","returns":"mixed Value set for the option."},"is_lighttpd_before_150":{"params":[],"desc":"Is the server running earlier than 1.5.0 version of lighttpd?","returns":"bool Whether the server is running lighttpd < 1.5.0"},"add_action":{"params":[{"required":"yes","param":"string $tag The name of the action to which the $function_to_add is hooked."},{"required":"yes","param":"callback $function_to_add The name of the function you wish to be called."},{"required":"no","param":"int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accept (default 1)."}],"desc":"Hooks a function on to a specific action.","returns":""},"do_action_ref_array":{"params":[{"required":"yes","param":"string $tag The name of the action to be executed."},{"required":"yes","param":"array $args The arguments supplied to the functions hooked to <tt>$tag</tt>"}],"desc":"Execute functions hooked on a specific action hook, specifying arguments in an array.","returns":"null Will return null if $tag does not exist in $wp_filter array"},"is_admin":{"params":[],"desc":"Whether the current request is for a network or blog admin page","returns":"bool True if inside WordPress administration pages."},"site_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the site url."},{"required":"no","param":"string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'."}],"desc":"Retrieve the site url for the current site.","returns":"string Site url link with optional path appended."},"admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for the current site.","returns":"string Admin url link with optional path appended."},"wp_guess_url":{"params":[],"desc":"Guess the URL for the site.","returns":"string "},"get_file":{"params":[],"desc":"","returns":""},"wp_category_checklist":{"params":[{"required":"yes","param":"unknown_type $post_id "},{"required":"yes","param":"unknown_type $descendants_and_self "},{"required":"yes","param":"unknown_type $selected_cats "},{"required":"yes","param":"unknown_type $popular_cats "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_terms_checklist":{"params":[{"required":"yes","param":"int $post_id "},{"required":"yes","param":"array $args "}],"desc":"Taxonomy independent version of wp_category_checklist","returns":""},"wp_popular_terms_checklist":{"params":[{"required":"yes","param":"unknown_type $taxonomy "},{"required":"yes","param":"unknown_type $default "},{"required":"yes","param":"unknown_type $number "},{"required":"yes","param":"unknown_type $echo "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_link_category_checklist":{"params":[{"required":"yes","param":"unknown_type $link_id "}],"desc":"{@internal Missing Short Description}}","returns":""},"get_inline_data":{"params":[{"required":"yes","param":"unknown_type $post "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_comment_reply":{"params":[{"required":"yes","param":"unknown_type $position "},{"required":"yes","param":"unknown_type $checkbox "},{"required":"yes","param":"unknown_type $mode "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_comment_trashnotice":{"params":[],"desc":"Output 'undo move to trash' text for comments","returns":""},"list_meta":{"params":[{"required":"yes","param":"unknown_type $meta "}],"desc":"{@internal Missing Short Description}}","returns":""},"_list_meta_row":{"params":[{"required":"yes","param":"unknown_type $entry "},{"required":"yes","param":"unknown_type $count "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"meta_form":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"touch_time":{"params":[{"required":"yes","param":"unknown_type $edit "},{"required":"yes","param":"unknown_type $for_post "},{"required":"yes","param":"unknown_type $tab_index "},{"required":"yes","param":"unknown_type $multi "}],"desc":"{@internal Missing Short Description}}","returns":""},"page_template_dropdown":{"params":[{"required":"yes","param":"unknown_type $default "}],"desc":"{@internal Missing Short Description}}","returns":""},"parent_dropdown":{"params":[{"required":"yes","param":"unknown_type $default "},{"required":"yes","param":"unknown_type $parent "},{"required":"yes","param":"unknown_type $level "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"the_attachment_links":{"params":[{"required":"yes","param":"unknown_type $id "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_dropdown_roles":{"params":[{"required":"yes","param":"string $selected slug for the role that should be already selected"}],"desc":"Print out <option> html elements for role selectors","returns":""},"wp_convert_hr_to_bytes":{"params":[{"required":"yes","param":"unknown_type $size "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_convert_bytes_to_hr":{"params":[{"required":"yes","param":"unknown_type $bytes "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_max_upload_size":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_import_upload_form":{"params":[{"required":"yes","param":"string $action The action attribute for the form."}],"desc":"Outputs the form used by the importers to accept the data to be imported","returns":""},"add_meta_box":{"params":[{"required":"yes","param":"string $id String for use in the 'id' attribute of tags."},{"required":"yes","param":"string $title Title of the meta box."},{"required":"yes","param":"string $callback Function that fills the box with the desired content. The function should echo its output."},{"required":"no","param":"string|object $screen Optional. The screen on which to show the box (post, page, link). Defaults to current screen."},{"required":"no","param":"string $context Optional. The context within the page where the boxes should show ('normal', 'advanced')."},{"required":"no","param":"string $priority Optional. The priority within the context where the boxes should show ('high', 'low')."}],"desc":"Add a meta box to an edit form.","returns":""},"do_meta_boxes":{"params":[{"required":"yes","param":"string|object $screen Screen identifier"},{"required":"yes","param":"string $context box context"},{"required":"yes","param":"mixed $object gets passed to the box callback function as first parameter"}],"desc":"Meta-Box template function","returns":"int number of meta_boxes"},"remove_meta_box":{"params":[{"required":"yes","param":"string $id String for use in the 'id' attribute of tags."},{"required":"yes","param":"string|object $screen The screen on which to show the box (post, page, link)."},{"required":"yes","param":"string $context The context within the page where the boxes should show ('normal', 'advanced')."}],"desc":"Remove a meta box from an edit form.","returns":""},"add_settings_section":{"params":[{"required":"yes","param":"string $id Slug-name to identify the section. Used in the 'id' attribute of tags."},{"required":"yes","param":"string $title Formatted title of the section. Shown as the heading for the section."},{"required":"yes","param":"string $callback Function that echos out any content at the top of the section (between heading and fields)."},{"required":"yes","param":"string $page The slug-name of the settings page on which to show the section. Built-in pages include 'general', 'reading', 'writing', 'discussion', 'media', etc. Create your own using add_options_page();"}],"desc":"Add a new section to a settings page.","returns":""},"add_settings_field":{"params":[{"required":"yes","param":"string $id Slug-name to identify the field. Used in the 'id' attribute of tags."},{"required":"yes","param":"string $title Formatted title of the field. Shown as the label for the field during output."},{"required":"yes","param":"string $callback Function that fills the field with the desired form inputs. The function should echo its output."},{"required":"yes","param":"string $page The slug-name of the settings page on which to show the section (general, reading, writing, ...)."},{"required":"yes","param":"string $section The slug-name of the section of the settings page in which to show the box (default, ...)."},{"required":"yes","param":"array $args Additional arguments"}],"desc":"Add a new field to a section of a settings page","returns":""},"do_settings_sections":{"params":[{"required":"yes","param":"string $page The slug name of the page whos settings sections you want to output"}],"desc":"Prints out all settings sections added to a particular settings page","returns":""},"do_settings_fields":{"params":[{"required":"yes","param":"string $page Slug title of the admin page who's settings fields you want to show."},{"required":"yes","param":"section $section Slug title of the settings section who's fields you want to show."}],"desc":"Print out the settings fields for a particular settings section","returns":""},"add_settings_error":{"params":[{"required":"yes","param":"string $setting Slug title of the setting to which this error applies"},{"required":"yes","param":"string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output."},{"required":"yes","param":"string $message The formatted message text to display to the user (will be shown inside styled <div> and <p>)"},{"required":"yes","param":"string $type The type of message it is, controls HTML class. Use 'error' or 'updated'."}],"desc":"Register a settings error to be displayed to the user","returns":""},"get_settings_errors":{"params":[{"required":"no","param":"string $setting Optional slug title of a specific setting who's errors you want."},{"required":"yes","param":"boolean $sanitize Whether to re-sanitize the setting value before returning errors."}],"desc":"Fetch settings errors registered by add_settings_error()","returns":"array Array of settings errors"},"settings_errors":{"params":[{"required":"no","param":"string $setting Optional slug title of a specific setting who's errors you want."},{"required":"yes","param":"boolean $sanitize Whether to re-sanitize the setting value before returning errors."},{"required":"yes","param":"boolean $hide_on_update If set to true errors will not be shown if the settings page has already been submitted."}],"desc":"Display settings errors registered by add_settings_error()","returns":""},"find_posts_div":{"params":[{"required":"yes","param":"unknown_type $found_action "}],"desc":"{@internal Missing Short Description}}","returns":""},"the_post_password":{"params":[],"desc":"Display the post password.","returns":""},"_draft_or_post_title":{"params":[{"required":"yes","param":"int $post_id The post id. If not supplied the global $post is used."}],"desc":"Get the post title.","returns":"string The post title if set"},"_admin_search_query":{"params":[],"desc":"Display the search query.","returns":""},"iframe_header":{"params":[{"required":"yes","param":"string $title Title of the Iframe page."},{"required":"yes","param":"bool $limit_styles Limit styles to colour-related styles only (unless others are enqueued)."}],"desc":"Generic Iframe header for use with Thickbox","returns":""},"iframe_footer":{"params":[],"desc":"Generic Iframe footer for use with Thickbox","returns":""},"_post_states":{"params":[],"desc":"","returns":""},"_media_states":{"params":[],"desc":"","returns":""},"compression_test":{"params":[],"desc":"Test support for compressing JavaScript from PHP","returns":""},"submit_button":{"params":[{"required":"yes","param":"string $text The text of the button (defaults to 'Save Changes')"},{"required":"yes","param":"string $type The type of button. One of: primary, secondary, delete"},{"required":"yes","param":"string $name The HTML name of the submit button. Defaults to "submit". If no id attribute is given in $other_attributes below, $name will be used as the button's id."},{"required":"yes","param":"bool $wrap True if the output button should be wrapped in a paragraph tag, false otherwise. Defaults to true"},{"required":"yes","param":"array|string $other_attributes Other attributes that should be output with the button, mapping attributes to their values, such as array( 'tabindex' => '1' ). These attributes will be output as attribute="value", such as tabindex="1". Defaults to no other attributes. Other attributes can also be provided as a string such as 'tabindex="1"', though the array format is typically cleaner."}],"desc":"Echos a submit button, with provided text and appropriate class","returns":""},"get_submit_button":{"params":[{"required":"yes","param":"string $text The text of the button (defaults to 'Save Changes')"},{"required":"yes","param":"string $type The type of button. One of: primary, secondary, delete"},{"required":"yes","param":"string $name The HTML name of the submit button. Defaults to "submit". If no id attribute is given in $other_attributes below, $name will be used as the button's id."},{"required":"yes","param":"bool $wrap True if the output button should be wrapped in a paragraph tag, false otherwise. Defaults to true"},{"required":"yes","param":"array|string $other_attributes Other attributes that should be output with the button, mapping attributes to their values, such as array( 'tabindex' => '1' ). These attributes will be output as attribute="value", such as tabindex="1". Defaults to no other attributes. Other attributes can also be provided as a string such as 'tabindex="1"', though the array format is typically cleaner."}],"desc":"Returns a submit button, with provided text and appropriate class","returns":""},"_wp_admin_html_begin":{"params":[],"desc":"","returns":""},"convert_to_screen":{"params":[{"required":"yes","param":"string $hook_name The hook name (also known as the hook suffix) used to determine the screen."}],"desc":"Convert a screen string to a screen object","returns":"WP_Screen Screen object."},"check_upload_size":{"params":[{"required":"yes","param":"array $file $_FILES array for a given file."}],"desc":"Determine if uploaded file exceeds space quota.","returns":"array $_FILES array with 'error' key set if file exceeds quota. 'error' is empty otherwise."},"wpmu_delete_blog":{"params":[{"required":"yes","param":"int $blog_id Blog ID"},{"required":"yes","param":"bool $drop True if blog's table should be dropped. Default is false."}],"desc":"Delete a blog","returns":"void "},"wpmu_delete_user":{"params":[],"desc":"","returns":""},"wpmu_get_blog_allowedthemes":{"params":[],"desc":"","returns":""},"update_option_new_admin_email":{"params":[],"desc":"","returns":""},"send_confirmation_on_profile_email":{"params":[],"desc":"","returns":""},"new_user_email_admin_notice":{"params":[],"desc":"","returns":""},"get_site_allowed_themes":{"params":[],"desc":"","returns":""},"is_upload_space_available":{"params":[],"desc":"Determines if there is any upload space left in the current blog's quota.","returns":"bool True if space is available, false otherwise."},"upload_size_limit_filter":{"params":[],"desc":"","returns":"int of upload size limit in bytes"},"get_upload_space_available":{"params":[],"desc":"Determines if there is any upload space left in the current blog's quota.","returns":"int of upload space available in bytes"},"get_space_allowed":{"params":[],"desc":"Returns the upload quota for the current blog.","returns":"int Quota"},"display_space_usage":{"params":[],"desc":"","returns":""},"upload_space_setting":{"params":[],"desc":"","returns":""},"update_user_status":{"params":[],"desc":"","returns":""},"refresh_user_details":{"params":[],"desc":"","returns":""},"format_code_lang":{"params":[],"desc":"","returns":""},"sync_category_tag_slugs":{"params":[],"desc":"","returns":""},"_access_denied_splash":{"params":[],"desc":"","returns":""},"check_import_new_users":{"params":[],"desc":"","returns":""},"mu_dropdown_languages":{"params":[],"desc":"","returns":""},"secret_salt_warning":{"params":[],"desc":"","returns":""},"site_admin_notice":{"params":[],"desc":"","returns":""},"avoid_blog_page_permalink_collision":{"params":[],"desc":"","returns":""},"choose_primary_blog":{"params":[],"desc":"","returns":""},"ms_deprecated_blogs_file":{"params":[],"desc":"","returns":""},"grant_super_admin":{"params":[{"required":"yes","param":"int $user_id "}],"desc":"Grants super admin privileges.","returns":""},"revoke_super_admin":{"params":[{"required":"yes","param":"int $user_id "}],"desc":"Revokes super admin privileges.","returns":""},"can_edit_network":{"params":[{"required":"yes","param":"integer $site_id The network/site id to check."}],"desc":"Whether or not we can edit this network from this page","returns":""},"_thickbox_path_admin_subfolder":{"params":[],"desc":"Thickbox image paths for Network Admin.","returns":""},"wp_is_large_network":{"params":[{"required":"yes","param":"string $using 'sites or 'users'. Default is 'sites'."}],"desc":"Whether or not we have a large network.","returns":"bool True if the network meets the criteria for large. False otherwise."},"comment_exists":{"params":[{"required":"yes","param":"string $comment_author Author of the comment"},{"required":"yes","param":"string $comment_date Date of the comment"}],"desc":"{@internal Missing Short Description}}","returns":"mixed Comment ID on success."},"edit_comment":{"params":[],"desc":"Update a comment with values provided in $_POST.","returns":""},"get_comment_to_edit":{"params":[{"required":"yes","param":"int $id ID of comment to retrieve"}],"desc":"{@internal Missing Short Description}}","returns":"bool|object Comment if found. False on failure."},"get_pending_comments_num":{"params":[{"required":"yes","param":"int|array $post_id Either a single Post ID or an array of Post IDs"}],"desc":"Get the number of pending comments on a post or posts","returns":"int|array Either a single Posts pending comments as an int or an array of ints keyed on the Post IDs"},"floated_admin_avatar":{"params":[{"required":"yes","param":"string $name User name."}],"desc":"Add avatars to relevant places in admin, or try to.","returns":"string Avatar with Admin name."},"enqueue_comment_hotkeys_js":{"params":[],"desc":"","returns":""},"PclZipUtilPathReduction":{"params":[],"desc":"","returns":""},"PclZipUtilPathInclusion":{"params":[],"desc":"","returns":""},"PclZipUtilCopyBlock":{"params":[],"desc":"","returns":""},"PclZipUtilRename":{"params":[],"desc":"","returns":""},"PclZipUtilOptionText":{"params":[],"desc":"","returns":""},"PclZipUtilTranslateWinPath":{"params":[],"desc":"","returns":""},"current_theme_info":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"delete_theme":{"params":[{"required":"yes","param":"string $template Template directory of the theme to delete"},{"required":"yes","param":"string $redirect Redirect to page when complete."}],"desc":"Remove a theme","returns":"mixed "},"get_broken_themes":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_allowed_themes":{"params":[],"desc":"Get the allowed themes for the current blog.","returns":"array $themes Array of allowed themes."},"get_page_templates":{"params":[],"desc":"Get the Page Templates available in this theme","returns":"array Key is the template name, value is the filename of the template"},"_get_template_edit_filename":{"params":[{"required":"yes","param":"string $fullpath Full path to the theme file"},{"required":"yes","param":"string $containingfolder Path of the theme parent folder"}],"desc":"Tidies a filename for url display by the theme editor.","returns":"string "},"theme_update_available":{"params":[{"required":"yes","param":"object $theme Theme data object."}],"desc":"Check if there is an update for a theme available.","returns":"bool False if no valid info was passed."},"get_theme_feature_list":{"params":[],"desc":"Retrieve list of WordPress theme features (aka theme tags)","returns":"array Array of features keyed by category with translations keyed by slug."},"themes_api":{"params":[{"required":"yes","param":"string $action "},{"required":"no","param":"array|object $args Optional. Arguments to serialize for the Theme Info API."}],"desc":"Retrieve theme installer pages from WordPress Themes API.","returns":"mixed "},"export_wp":{"params":[{"required":"yes","param":"array $args Filters defining what should be included in the export"}],"desc":"Generates the WXR export file for download","returns":""},"get_column_headers":{"params":[{"required":"yes","param":"string|WP_Screen $screen The screen you want the headers for"}],"desc":"Get the column headers for a screen","returns":"array Containing the headers in the format id => UI String"},"get_hidden_columns":{"params":[{"required":"yes","param":"string|WP_Screen $screen The screen you want the hidden columns for"}],"desc":"Get a list of hidden columns.","returns":"array "},"meta_box_prefs":{"params":[{"required":"yes","param":"string|WP_Screen $screen "}],"desc":"Prints the meta box preferences for screen meta.","returns":""},"get_hidden_meta_boxes":{"params":[{"required":"yes","param":"string|WP_Screen $screen Screen identifier"}],"desc":"Get Hidden Meta Boxes","returns":"array Hidden Meta Boxes"},"add_screen_option":{"params":[{"required":"yes","param":"string $option An option name."},{"required":"yes","param":"mixed $args Option-dependent arguments."}],"desc":"Register and configure an admin screen option","returns":"void "},"screen_icon":{"params":[{"required":"no","param":"string|WP_Screen $screen Optional. Accepts a screen object (and defaults to the current screen object) which it uses to determine an icon HTML ID. Or, if a string is provided, it is used to form the icon HTML ID."}],"desc":"Displays a screen icon.","returns":""},"get_screen_icon":{"params":[{"required":"no","param":"string|WP_Screen $screen Optional. Accepts a screen object (and defaults to the current screen object) which it uses to determine an icon HTML ID. Or, if a string is provided, it is used to form the icon HTML ID."}],"desc":"Gets a screen icon.","returns":"string HTML for the screen icon."},"get_current_screen":{"params":[],"desc":"Get the current screen object","returns":"object Current screen object"},"set_current_screen":{"params":[{"required":"no","param":"mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen, or an existing screen object."}],"desc":"Set the current screen object","returns":""},"wp_create_thumbnail":{"params":[{"required":"yes","param":"mixed $file Filename of the original image, Or attachment id."},{"required":"yes","param":"int $max_side Maximum length of a single side for the thumbnail."},{"required":"yes","param":"mixed $deprecated Never used."}],"desc":"Create a thumbnail from an Image given a maximum side size.","returns":"string Thumbnail path on success, Error string on failure."},"wp_crop_image":{"params":[{"required":"yes","param":"string|int $src_file The source file or Attachment ID."},{"required":"yes","param":"int $src_x The start x position to crop from."},{"required":"yes","param":"int $src_y The start y position to crop from."},{"required":"yes","param":"int $src_w The width to crop."},{"required":"yes","param":"int $src_h The height to crop."},{"required":"yes","param":"int $dst_w The destination width."},{"required":"yes","param":"int $dst_h The destination height."},{"required":"no","param":"int $src_abs Optional. If the source crop points are absolute."},{"required":"no","param":"string $dst_file Optional. The destination file to write to."}],"desc":"Crop an Image to a given size.","returns":"string|WP_Error|false New filepath on success, WP_Error or false on failure."},"wp_generate_attachment_metadata":{"params":[{"required":"yes","param":"int $attachment_id Attachment Id to process."},{"required":"yes","param":"string $file Filepath of the Attached image."}],"desc":"Generate post thumbnail attachment meta data.","returns":"mixed Metadata for attachment."},"get_udims":{"params":[{"required":"yes","param":"int $width Current width of the image"},{"required":"yes","param":"int $height Current height of the image"}],"desc":"Calculated the new dimensions for a downsampled image.","returns":"mixed Array(height,width) of shrunk dimensions."},"wp_exif_frac2dec":{"params":[{"required":"yes","param":"string $str "}],"desc":"Convert a fraction string to a decimal.","returns":"int|float "},"wp_exif_date2ts":{"params":[{"required":"yes","param":"string $str "}],"desc":"Convert the exif date format to a unix timestamp.","returns":"int "},"wp_read_image_metadata":{"params":[{"required":"yes","param":"string $file "}],"desc":"Get extended image metadata, exif or iptc as available.","returns":"bool|array False on failure. Image metadata array on success."},"file_is_valid_image":{"params":[{"required":"yes","param":"string $path File path to test if valid image."}],"desc":"Validate that file is an image.","returns":"bool True if valid image, false if not valid image."},"file_is_displayable_image":{"params":[{"required":"yes","param":"string $path File path to test."}],"desc":"Validate that file is suitable for displaying within a web page.","returns":"bool True if suitable, false if not suitable."},"get_manifest":{"params":[],"desc":"Retrieve list of all cacheable WP files","returns":""},"post_submit_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display post submit form fields.","returns":""},"post_format_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display post format form elements.","returns":""},"post_tags_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display post tags form fields.","returns":""},"post_categories_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display post categories form fields.","returns":""},"post_excerpt_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display post excerpt form fields.","returns":""},"post_trackback_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display trackback links form fields.","returns":""},"post_custom_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display custom fields form fields.","returns":""},"post_comment_status_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display comments status form fields.","returns":""},"post_comment_meta_box_thead":{"params":[{"required":"yes","param":"array $result table header rows"}],"desc":"Display comments for post table header","returns":"array "},"post_comment_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display comments for post.","returns":""},"post_slug_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display slug form fields.","returns":""},"post_author_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display form field with list of authors.","returns":""},"post_revisions_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display list of revisions.","returns":""},"page_attributes_meta_box":{"params":[{"required":"yes","param":"object $post "}],"desc":"Display page attributes form fields.","returns":""},"link_submit_meta_box":{"params":[{"required":"yes","param":"object $link "}],"desc":"Display link create form fields.","returns":""},"link_categories_meta_box":{"params":[{"required":"yes","param":"object $link "}],"desc":"Display link categories form fields.","returns":""},"link_target_meta_box":{"params":[{"required":"yes","param":"object $link "}],"desc":"Display form fields for changing link target.","returns":""},"xfn_check":{"params":[{"required":"yes","param":"string $class "},{"required":"yes","param":"string $value "},{"required":"yes","param":"mixed $deprecated Never used."}],"desc":"Display checked checkboxes attribute for xfn microformat options.","returns":""},"link_xfn_meta_box":{"params":[{"required":"yes","param":"object $link "}],"desc":"Display xfn form fields.","returns":""},"link_advanced_meta_box":{"params":[{"required":"yes","param":"object $link "}],"desc":"Display advanced link options form fields.","returns":""},"post_thumbnail_meta_box":{"params":[],"desc":"Display post thumbnail meta box.","returns":""},"got_mod_rewrite":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"extract_from_markers":{"params":[{"required":"yes","param":"unknown_type $filename "},{"required":"yes","param":"unknown_type $marker "}],"desc":"{@internal Missing Short Description}}","returns":"array An array of strings from a file (.htaccess ) from between BEGIN and END markers."},"insert_with_markers":{"params":[{"required":"yes","param":"unknown_type $filename "},{"required":"yes","param":"unknown_type $marker "},{"required":"yes","param":"unknown_type $insertion "}],"desc":"{@internal Missing Short Description}}","returns":"bool True on write success, false on failure."},"save_mod_rewrite_rules":{"params":[],"desc":"Updates the htaccess file with the current rules if it is writable.","returns":""},"iis7_save_url_rewrite_rules":{"params":[],"desc":"Updates the IIS web.config file with the current rules if it is writable.","returns":"bool True if web.config was updated successfully"},"update_recently_edited":{"params":[{"required":"yes","param":"unknown_type $file "}],"desc":"{@internal Missing Short Description}}","returns":""},"update_home_siteurl":{"params":[{"required":"yes","param":"unknown_type $old_value "},{"required":"yes","param":"unknown_type $value "}],"desc":"If siteurl or home changed, flush rewrite rules.","returns":""},"url_shorten":{"params":[{"required":"yes","param":"string $url "}],"desc":"Shorten an URL, to be used as link text","returns":"string "},"wp_reset_vars":{"params":[{"required":"yes","param":"array $vars An array of globals to reset."}],"desc":"Resets global variables based on $_GET and $_POST","returns":""},"show_message":{"params":[{"required":"yes","param":"unknown_type $message "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_doc_link_parse":{"params":[],"desc":"","returns":""},"set_screen_options":{"params":[],"desc":"Saves option for number of rows when listing posts, pages, comments, etc.","returns":""},"iis7_rewrite_rule_exists":{"params":[{"required":"yes","param":"string $filename The file path to the configuration file"}],"desc":"Check if rewrite rule for WordPress already exists in the IIS 7 configuration file","returns":"bool "},"iis7_delete_rewrite_rule":{"params":[{"required":"yes","param":"string $filename Name of the configuration file"}],"desc":"Delete WordPress rewrite rule from web.config file if it exists there","returns":"bool "},"iis7_add_rewrite_rule":{"params":[{"required":"yes","param":"string $filename The file path to the configuration file"},{"required":"yes","param":"string $rewrite_rule The XML fragment with URL Rewrite rule"}],"desc":"Add WordPress rewrite rule to the IIS 7 configuration file.","returns":"bool "},"saveDomDocument":{"params":[{"required":"yes","param":"DOMDocument $doc "},{"required":"yes","param":"string $filename "}],"desc":"Saves the XML document into a file","returns":""},"win_is_writable":{"params":[{"required":"yes","param":"string $path "}],"desc":"Workaround for Windows bug in is_writable() function","returns":"bool "},"admin_color_scheme_picker":{"params":[],"desc":"Display the default admin color scheme picker (Used in user-edit.php)","returns":""},"_ipad_meta":{"params":[],"desc":"","returns":""},"media_upload_tabs":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"update_gallery_tab":{"params":[{"required":"yes","param":"unknown_type $tabs "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"the_media_upload_tabs":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"get_image_send_to_editor":{"params":[{"required":"yes","param":"unknown_type $id "},{"required":"yes","param":"unknown_type $alt "},{"required":"yes","param":"unknown_type $title "},{"required":"yes","param":"unknown_type $align "},{"required":"yes","param":"unknown_type $url "},{"required":"yes","param":"unknown_type $rel "},{"required":"yes","param":"unknown_type $size "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"image_add_caption":{"params":[{"required":"yes","param":"unknown_type $html "},{"required":"yes","param":"unknown_type $id "},{"required":"yes","param":"unknown_type $alt "},{"required":"yes","param":"unknown_type $title "},{"required":"yes","param":"unknown_type $align "},{"required":"yes","param":"unknown_type $url "},{"required":"yes","param":"unknown_type $size "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"media_send_to_editor":{"params":[{"required":"yes","param":"unknown_type $html "}],"desc":"{@internal Missing Short Description}}","returns":""},"media_handle_upload":{"params":[{"required":"yes","param":"string $file_id Index into the {@link $_FILES} array of the upload"},{"required":"yes","param":"int $post_id The post ID the media is associated with"},{"required":"yes","param":"array $post_data allows you to overwrite some of the attachment"},{"required":"yes","param":"array $overrides allows you to override the {@link wp_handle_upload()} behavior"}],"desc":"{@internal Missing Short Description}}","returns":"int the ID of the attachment"},"media_handle_sideload":{"params":[{"required":"yes","param":"array $file_array Array similar to a {@link $_FILES} upload array"},{"required":"yes","param":"int $post_id The post ID the media is associated with"},{"required":"yes","param":"string $desc Description of the sideloaded file"},{"required":"yes","param":"array $post_data allows you to overwrite some of the attachment"}],"desc":"This handles a sideloaded file in the same way as an uploaded file is handled by {@link media_handle_upload()}","returns":"int|object The ID of the attachment or a WP_Error on failure"},"wp_iframe":{"params":[{"required":"yes","param":"unknown_type $content_func "}],"desc":"{@internal Missing Short Description}}","returns":""},"media_buttons":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"_media_button":{"params":[],"desc":"","returns":""},"get_upload_iframe_src":{"params":[],"desc":"","returns":""},"media_upload_form_handler":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_media_upload_handler":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"media_sideload_image":{"params":[{"required":"yes","param":"string $file The URL of the image to download"},{"required":"yes","param":"int $post_id The post ID the media is to be associated with"},{"required":"no","param":"string $desc Optional. Description of the image"}],"desc":"Download an image from the specified URL and attach it to a post.","returns":"string|WP_Error Populated HTML img tag on success"},"media_upload_gallery":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"media_upload_library":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"image_align_input_fields":{"params":[{"required":"yes","param":"unknown_type $post "},{"required":"yes","param":"unknown_type $checked "}],"desc":"Retrieve HTML for the image alignment radio buttons with the specified one checked.","returns":"unknown "},"image_size_input_fields":{"params":[{"required":"yes","param":"unknown_type $post "},{"required":"yes","param":"unknown_type $check "}],"desc":"Retrieve HTML for the size radio buttons with the specified one checked.","returns":"unknown "},"image_link_input_fields":{"params":[{"required":"yes","param":"unknown_type $post "},{"required":"yes","param":"unknown_type $url_type "}],"desc":"Retrieve HTML for the Link URL buttons with the default link type as specified.","returns":"unknown "},"image_attachment_fields_to_edit":{"params":[{"required":"yes","param":"unknown_type $form_fields "},{"required":"yes","param":"unknown_type $post "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"media_single_attachment_fields_to_edit":{"params":[{"required":"yes","param":"unknown_type $form_fields "},{"required":"yes","param":"unknown_type $post "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"media_post_single_attachment_fields_to_edit":{"params":[{"required":"yes","param":"unknown_type $form_fields "},{"required":"yes","param":"unknown_type $post "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"image_attachment_fields_to_save":{"params":[{"required":"yes","param":"unknown_type $post "},{"required":"yes","param":"unknown_type $attachment "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"image_media_send_to_editor":{"params":[{"required":"yes","param":"unknown_type $html "},{"required":"yes","param":"unknown_type $attachment_id "},{"required":"yes","param":"unknown_type $attachment "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_attachment_fields_to_edit":{"params":[{"required":"yes","param":"unknown_type $post "},{"required":"yes","param":"unknown_type $errors "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_media_items":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"yes","param":"array $errors Errors for attachment, if any."}],"desc":"Retrieve HTML for media items of post gallery.","returns":"string "},"get_media_item":{"params":[{"required":"yes","param":"int $attachment_id Attachment ID for modification."},{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Retrieve HTML form for modifying the image attachment.","returns":"string HTML form for attachment."},"media_upload_header":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_form":{"params":[{"required":"yes","param":"unknown_type $errors "}],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_type_form":{"params":[{"required":"yes","param":"unknown_type $type "},{"required":"yes","param":"unknown_type $errors "},{"required":"yes","param":"unknown_type $id "}],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_type_url_form":{"params":[{"required":"yes","param":"unknown_type $type "},{"required":"yes","param":"unknown_type $errors "},{"required":"yes","param":"unknown_type $id "}],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_gallery_form":{"params":[{"required":"yes","param":"unknown_type $errors "}],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_library_form":{"params":[{"required":"yes","param":"unknown_type $errors "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_media_insert_url_form":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"_insert_into_post_button":{"params":[],"desc":"","returns":""},"media_upload_flash_bypass":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_html_bypass":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"media_upload_text_after":{"params":[],"desc":"","returns":""},"media_upload_max_image_resize":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"plugins_api":{"params":[{"required":"yes","param":"string $action "},{"required":"no","param":"array|object $args Optional. Arguments to serialize for the Plugin Info API."}],"desc":"Retrieve plugin installer pages from WordPress Plugins API.","returns":"object plugins_api response object on success, WP_Error on failure."},"install_popular_tags":{"params":[{"required":"yes","param":"array $args "}],"desc":"Retrieve popular WordPress plugin tags.","returns":"array "},"install_dashboard":{"params":[],"desc":"","returns":""},"install_search_form":{"params":[],"desc":"Display search form for searching plugins.","returns":""},"install_plugins_upload":{"params":[{"required":"yes","param":"string $page "}],"desc":"Upload from zip","returns":""},"display_plugins_table":{"params":[],"desc":"Display plugin content based on plugin list.","returns":""},"install_plugin_install_status":{"params":[],"desc":"Determine the status we can perform on a plugin.","returns":""},"install_plugin_information":{"params":[],"desc":"Display plugin information in dialog box form.","returns":""},"wp_dashboard_setup":{"params":[],"desc":"Registers dashboard widgets.","returns":""},"wp_add_dashboard_widget":{"params":[],"desc":"","returns":""},"_wp_dashboard_control_callback":{"params":[],"desc":"","returns":""},"wp_dashboard":{"params":[],"desc":"Displays the dashboard.","returns":""},"wp_dashboard_right_now":{"params":[],"desc":"","returns":""},"wp_network_dashboard_right_now":{"params":[],"desc":"","returns":""},"wp_dashboard_quick_press":{"params":[],"desc":"","returns":""},"wp_dashboard_recent_drafts":{"params":[],"desc":"","returns":""},"wp_dashboard_recent_comments":{"params":[],"desc":"Display recent comments dashboard widget content.","returns":""},"_wp_dashboard_recent_comments_row":{"params":[],"desc":"","returns":""},"wp_dashboard_recent_comments_control":{"params":[],"desc":"The recent comments dashboard widget control.","returns":""},"wp_dashboard_incoming_links":{"params":[],"desc":"","returns":""},"wp_dashboard_incoming_links_output":{"params":[],"desc":"Display incoming links dashboard widget content.","returns":""},"wp_dashboard_incoming_links_control":{"params":[],"desc":"","returns":""},"wp_dashboard_primary":{"params":[],"desc":"","returns":""},"wp_dashboard_primary_control":{"params":[],"desc":"","returns":""},"wp_dashboard_rss_output":{"params":[{"required":"yes","param":"string $widget_id "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_dashboard_secondary":{"params":[],"desc":"","returns":""},"wp_dashboard_secondary_control":{"params":[],"desc":"","returns":""},"wp_dashboard_secondary_output":{"params":[],"desc":"Display secondary dashboard RSS widget feed.","returns":"unknown "},"wp_dashboard_plugins":{"params":[],"desc":"","returns":""},"wp_dashboard_plugins_output":{"params":[],"desc":"Display plugins most popular, newest plugins, and recently updated widget text.","returns":""},"wp_dashboard_cached_rss_widget":{"params":[{"required":"yes","param":"string $widget_id "},{"required":"yes","param":"callback $callback "},{"required":"yes","param":"array $check_urls RSS feeds"}],"desc":"Checks to see if all of the feed url in $check_urls are cached.","returns":"bool False on failure. True on success."},"wp_dashboard_trigger_widget_control":{"params":[{"required":"yes","param":"int $widget_control_id Registered Widget ID."}],"desc":"Calls widget control callback.","returns":""},"wp_dashboard_rss_control":{"params":[{"required":"yes","param":"string $widget_id "},{"required":"yes","param":"array $form_inputs "}],"desc":"The RSS dashboard widget control.","returns":""},"wp_dashboard_quota":{"params":[],"desc":"","returns":""},"wp_dashboard_browser_nag":{"params":[],"desc":"","returns":""},"dashboard_browser_nag_class":{"params":[],"desc":"","returns":""},"wp_check_browser_version":{"params":[],"desc":"Check if the user needs a browser update","returns":"array|bool False on failure, array of browser data on success."},"wp_dashboard_empty":{"params":[],"desc":"Empty function usable by plugins to output empty dashboard widget (to be populated later by JS).","returns":""},"wp_welcome_panel":{"params":[],"desc":"Displays a welcome panel to introduce users to WordPress.","returns":""},"install_themes_feature_list":{"params":[],"desc":"Retrieve list of WordPress theme features (aka theme tags)","returns":"array "},"install_theme_search_form":{"params":[],"desc":"Display search form for searching themes.","returns":""},"install_themes_dashboard":{"params":[],"desc":"Display tags filter for themes.","returns":""},"install_themes_upload":{"params":[],"desc":"","returns":""},"display_theme":{"params":[],"desc":"","returns":""},"display_themes":{"params":[],"desc":"Display theme content based on theme list.","returns":""},"install_theme_information":{"params":[],"desc":"Display theme information in dialog box form.","returns":""},"get_cli_args":{"params":[{"required":"yes","param":"string $param "},{"required":"yes","param":"bool $required "}],"desc":"Returns value of command line params.","returns":"mixed "},"_wp_translate_postdata":{"params":[{"required":"yes","param":"bool $update Are we updating a pre-existing post?"},{"required":"yes","param":"array $post_data Array of post data. Defaults to the contents of $_POST."}],"desc":"Rename $_POST data from form names to DB post columns.","returns":"object|bool WP_Error on failure, true on success."},"edit_post":{"params":[{"required":"no","param":"array $post_data Optional."}],"desc":"Update an existing post with values provided in $_POST.","returns":"int Post ID."},"bulk_edit_posts":{"params":[{"required":"no","param":"array $post_data Optional, the array of post data to process if not provided will use $_POST superglobal."}],"desc":"Process the post data for the bulk editing of posts.","returns":"array "},"get_default_post_to_edit":{"params":[{"required":"yes","param":"string $post_type A post type string, defaults to 'post'."}],"desc":"Default post information to use when populating the "Write Post" form.","returns":"object stdClass object containing all the default post data as attributes"},"get_default_page_to_edit":{"params":[],"desc":"Get the default page information to use.","returns":"object stdClass object containing all the default post data as attributes"},"get_post_to_edit":{"params":[{"required":"yes","param":"unknown_type $id "}],"desc":"Get an existing post and format it for editing.","returns":"unknown "},"post_exists":{"params":[{"required":"yes","param":"string $title Post title"},{"required":"no","param":"string $content Optional post content"},{"required":"no","param":"string $date Optional post date"}],"desc":"Determine if a post exists based on title, content, and date","returns":"int Post ID if post exists, 0 otherwise."},"wp_write_post":{"params":[],"desc":"Creates a new post from the "Write Post" form using $_POST information.","returns":"unknown "},"write_post":{"params":[],"desc":"Calls wp_write_post() and handles the errors.","returns":"unknown "},"add_meta":{"params":[{"required":"yes","param":"unknown_type $post_ID "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"delete_meta":{"params":[{"required":"yes","param":"unknown_type $mid "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_meta_keys":{"params":[],"desc":"Get a list of previously defined keys.","returns":"unknown "},"get_post_meta_by_id":{"params":[{"required":"yes","param":"unknown_type $mid "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"has_meta":{"params":[{"required":"yes","param":"unknown_type $postid "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"update_meta":{"params":[{"required":"yes","param":"unknown_type $meta_id "},{"required":"yes","param":"unknown_type $meta_key Expect Slashed"},{"required":"yes","param":"unknown_type $meta_value Expect Slashed"}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"_fix_attachment_links":{"params":[{"required":"yes","param":"unknown_type $post_ID "}],"desc":"Replace hrefs of attachment anchors with up-to-date permalinks.","returns":"unknown "},"_fix_attachment_links_replace_cb":{"params":[],"desc":"","returns":""},"_relocate_children":{"params":[{"required":"yes","param":"unknown_type $old_ID "},{"required":"yes","param":"unknown_type $new_ID "}],"desc":"Move child posts to a new parent.","returns":"unknown "},"get_available_post_statuses":{"params":[{"required":"yes","param":"string $type The post_type you want the statuses for"}],"desc":"Get all the possible statuses for a post_type","returns":"array As array of all the statuses for the supplied post type"},"wp_edit_posts_query":{"params":[{"required":"yes","param":"array|bool $q Array of query variables to use to build the query or false to use $_GET superglobal."}],"desc":"Run the wp query to fetch the posts for listing on the edit posts page","returns":"array "},"get_post_mime_types":{"params":[],"desc":"Get default post mime types","returns":"array "},"get_available_post_mime_types":{"params":[{"required":"yes","param":"unknown_type $type "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_edit_attachments_query":{"params":[{"required":"yes","param":"unknown_type $q "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"_edit_attachments_query_helper":{"params":[],"desc":"","returns":""},"postbox_classes":{"params":[{"required":"yes","param":"unknown_type $id "},{"required":"yes","param":"unknown_type $page "}],"desc":"Returns the list of classes to be used by a metabox","returns":"unknown "},"get_sample_permalink":{"params":[{"required":"yes","param":"int|object $id Post ID or post object."},{"required":"no","param":"string $title (optional) Title"},{"required":"no","param":"string $name (optional) Name"}],"desc":"{@internal Missing Short Description}}","returns":"array With two entries of type string"},"get_sample_permalink_html":{"params":[{"required":"yes","param":"int|object $id Post ID or post object."},{"required":"no","param":"string $new_title (optional) New title"},{"required":"no","param":"string $new_slug (optional) New slug"}],"desc":"sample permalink html","returns":"string intended to be used for the inplace editor of the permalink post slug on in the post (and page?) editor."},"_wp_post_thumbnail_html":{"params":[{"required":"yes","param":"int $thumbnail_id ID of the attachment used for thumbnail"}],"desc":"Output HTML for the post thumbnail meta-box.","returns":"string html"},"wp_check_post_lock":{"params":[{"required":"yes","param":"int $post_id ID of the post to check for editing"}],"desc":"Check to see if the post is currently being edited by another user.","returns":"bool|int False: not locked or locked by current user. Int: user ID of user with lock."},"wp_set_post_lock":{"params":[{"required":"yes","param":"int $post_id ID of the post to being edited"}],"desc":"Mark the post as currently being edited by the current user","returns":"bool|array Returns false if the post doesn't exist of there is no current user, or an array of the lock time and the user ID."},"_admin_notice_post_locked":{"params":[],"desc":"Outputs the notice message to say that someone else is editing this post at the moment.","returns":"none "},"wp_create_post_autosave":{"params":[],"desc":"Creates autosave data for the specified post from $_POST data.","returns":"unknown "},"post_preview":{"params":[],"desc":"Save draft or manually autosave for showing preview.","returns":"str URL to redirect to show the preview"},"category_exists":{"params":[{"required":"yes","param":"unknown_type $cat_name "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_category_to_edit":{"params":[{"required":"yes","param":"unknown_type $id "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_create_category":{"params":[{"required":"yes","param":"unknown_type $cat_name "},{"required":"yes","param":"unknown_type $parent "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_create_categories":{"params":[{"required":"yes","param":"unknown_type $categories "},{"required":"yes","param":"unknown_type $post_id "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_insert_category":{"params":[{"required":"yes","param":"mixed $catarr See defaults below. Set 'cat_ID' to a non-zero value to update an existing category. The 'taxonomy' key was added in 3.0.0."},{"required":"no","param":"bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values."}],"desc":"Updates an existing Category or creates a new Category.","returns":"int|object The ID number of the new or updated Category on success. Zero or a WP_Error on failure, depending on param $wp_error."},"wp_update_category":{"params":[{"required":"no","param":"array $catarr The 'cat_ID' value is required. All other keys are optional."}],"desc":"Aliases wp_insert_category() with minimal args.","returns":"int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure."},"tag_exists":{"params":[{"required":"yes","param":"unknown_type $tag_name "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_create_tag":{"params":[{"required":"yes","param":"unknown_type $tag_name "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_tags_to_edit":{"params":[{"required":"yes","param":"unknown_type $post_id "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"get_terms_to_edit":{"params":[{"required":"yes","param":"unknown_type $post_id "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"wp_create_term":{"params":[{"required":"yes","param":"unknown_type $tag_name "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"tinymce_include":{"params":[],"desc":"","returns":""},"documentation_link":{"params":[],"desc":"Unused Admin function.","returns":""},"wp_shrink_dimensions":{"params":[{"required":"yes","param":"int $width Current width of the image"},{"required":"yes","param":"int $height Current height of the image"},{"required":"yes","param":"int $wmax Maximum wanted width"},{"required":"yes","param":"int $hmax Maximum wanted height"}],"desc":"Calculates the new dimensions for a downsampled image.","returns":"mixed Array(height,width) of shrunk dimensions."},"dropdown_categories":{"params":[{"required":"yes","param":"unknown_type $default "},{"required":"yes","param":"unknown_type $parent "},{"required":"yes","param":"unknown_type $popular_ids "}],"desc":"{@internal Missing Short Description}}","returns":""},"dropdown_link_categories":{"params":[{"required":"yes","param":"unknown_type $default "}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_dropdown_cats":{"params":[{"required":"yes","param":"unknown_type $currentcat "},{"required":"yes","param":"unknown_type $currentparent "},{"required":"yes","param":"unknown_type $parent "},{"required":"yes","param":"unknown_type $level "},{"required":"yes","param":"unknown_type $categories "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"add_option_update_handler":{"params":[{"required":"yes","param":"string $option_group A settings group name. Should correspond to a whitelisted option key name. Default whitelisted option key names include "general," "discussion," and "reading," among others."},{"required":"yes","param":"string $option_name The name of an option to sanitize and save."},{"required":"yes","param":"unknown_type $sanitize_callback A callback function that sanitizes the option's value."}],"desc":"Register a setting and its sanitization callback","returns":"unknown "},"remove_option_update_handler":{"params":[{"required":"yes","param":"unknown_type $option_group "},{"required":"yes","param":"unknown_type $option_name "},{"required":"yes","param":"unknown_type $sanitize_callback "}],"desc":"Unregister a setting","returns":"unknown "},"codepress_get_lang":{"params":[{"required":"yes","param":"string $filename "}],"desc":"Determines the language to use for CodePress syntax highlighting.","returns":""},"codepress_footer_js":{"params":[],"desc":"Adds Javascript required to make CodePress work on the theme/plugin editors.","returns":""},"use_codepress":{"params":[],"desc":"Determine whether to use CodePress.","returns":""},"get_author_user_ids":{"params":[],"desc":"","returns":"array List of user IDs."},"get_editable_authors":{"params":[{"required":"yes","param":"int $user_id User ID."}],"desc":"","returns":"array|bool List of editable authors. False if no editable users."},"get_editable_user_ids":{"params":[{"required":"yes","param":"int $user_id User ID."},{"required":"no","param":"bool $exclude_zeros Optional, default is true. Whether to exclude zeros."}],"desc":"","returns":"unknown "},"get_nonauthor_user_ids":{"params":[],"desc":"","returns":""},"get_others_unpublished_posts":{"params":[{"required":"yes","param":"int $user_id User ID to not retrieve posts from."},{"required":"no","param":"string $type Optional, defaults to 'any'. Post type to retrieve, can be 'draft' or 'pending'."}],"desc":"Retrieve editable posts from other users.","returns":"array List of posts from others."},"get_others_drafts":{"params":[{"required":"yes","param":"int $user_id User ID."}],"desc":"Retrieve drafts from other users.","returns":"array List of drafts from other users."},"get_others_pending":{"params":[{"required":"yes","param":"int $user_id User ID."}],"desc":"Retrieve pending review posts from other users.","returns":"array List of posts with pending review post type from other users."},"wp_dashboard_quick_press_output":{"params":[],"desc":"Output the QuickPress dashboard widget.","returns":""},"wp_tiny_mce":{"params":[],"desc":"","returns":""},"wp_preload_dialogs":{"params":[],"desc":"","returns":""},"wp_print_editor_js":{"params":[],"desc":"","returns":""},"wp_quicktags":{"params":[],"desc":"","returns":""},"screen_layout":{"params":[],"desc":"Returns the screen layout options.","returns":""},"screen_options":{"params":[],"desc":"Returns the screen's per-page options.","returns":""},"screen_meta":{"params":[],"desc":"Renders the screen's help.","returns":""},"favorite_actions":{"params":[],"desc":"Favorite actions were deprecated in version 3.2. Use the admin bar instead.","returns":""},"media_upload_image":{"params":[],"desc":"","returns":""},"media_upload_audio":{"params":[],"desc":"","returns":""},"media_upload_video":{"params":[],"desc":"","returns":""},"media_upload_file":{"params":[],"desc":"","returns":""},"type_url_form_image":{"params":[],"desc":"","returns":""},"type_url_form_audio":{"params":[],"desc":"","returns":""},"type_url_form_video":{"params":[],"desc":"","returns":""},"type_url_form_file":{"params":[],"desc":"","returns":""},"add_contextual_help":{"params":[{"required":"yes","param":"string $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions."},{"required":"yes","param":"string $help The content of an 'Overview' help tab."}],"desc":"Add contextual help text for a page.","returns":""},"wp_get_db_schema":{"params":[{"required":"no","param":"string $scope Optional. The tables for which to retrieve SQL. Can be all, global, ms_global, or blog tables. Defaults to all."},{"required":"no","param":"int $blog_id Optional. The blog ID for which to retrieve SQL. Default is the current blog ID."}],"desc":"Retrieve the SQL for creating database tables.","returns":"string The SQL needed to create the requested tables."},"populate_options":{"params":[],"desc":"Create WordPress options and set the default values.","returns":""},"populate_roles":{"params":[],"desc":"Execute WordPress role creation for the various WordPress versions.","returns":""},"populate_roles_160":{"params":[],"desc":"Create the roles for WordPress 2.0","returns":""},"populate_roles_210":{"params":[],"desc":"Create and modify WordPress roles for WordPress 2.1.","returns":""},"populate_roles_230":{"params":[],"desc":"Create and modify WordPress roles for WordPress 2.3.","returns":""},"populate_roles_250":{"params":[],"desc":"Create and modify WordPress roles for WordPress 2.5.","returns":""},"populate_roles_260":{"params":[],"desc":"Create and modify WordPress roles for WordPress 2.6.","returns":""},"populate_roles_270":{"params":[],"desc":"Create and modify WordPress roles for WordPress 2.7.","returns":""},"populate_roles_280":{"params":[],"desc":"Create and modify WordPress roles for WordPress 2.8.","returns":""},"populate_roles_300":{"params":[],"desc":"Create and modify WordPress roles for WordPress 3.0.","returns":""},"install_network":{"params":[],"desc":"","returns":""},"populate_network":{"params":[{"required":"yes","param":"int $network_id id of network to populate"}],"desc":"populate network settings","returns":"bool|WP_Error True on success, or WP_Error on warning (with the install otherwise successful, so the error code must be checked) or failure."},"_get_list_table":{"params":[{"required":"yes","param":"string $class The type of the list table, which is the class name."}],"desc":"Fetch an instance of a WP_List_Table class.","returns":"object|bool Object on success, false if the class does not exist."},"register_column_headers":{"params":[{"required":"yes","param":"string $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions."},{"required":"yes","param":"array $columns An array of columns with column IDs as the keys and translated column names as the values"}],"desc":"Register column headers for a particular screen.","returns":""},"print_column_headers":{"params":[],"desc":"Prints column headers for a particular screen.","returns":""},"update_core":{"params":[{"required":"yes","param":"string $from New release unzipped path."},{"required":"yes","param":"string $to Path to old WordPress installation."}],"desc":"Upgrade the core of WordPress.","returns":"WP_Error|null WP_Error on failure, null on success."},"_copy_dir":{"params":[{"required":"yes","param":"string $from source directory"},{"required":"yes","param":"string $to destination directory"},{"required":"yes","param":"array $skip_list a list of files/folders to skip copying"}],"desc":"Copies a directory from one location to another via the WordPress Filesystem Abstraction.","returns":"mixed WP_Error on failure, True on success."},"_redirect_to_about_wordpress":{"params":[],"desc":"Redirect to the About WordPress page after a successful upgrade.","returns":""},"wp_image_editor":{"params":[],"desc":"WordPress Image Editor","returns":""},"load_image_to_edit":{"params":[],"desc":"","returns":""},"wp_stream_image":{"params":[],"desc":"","returns":""},"wp_save_image_file":{"params":[],"desc":"","returns":""},"_image_get_preview_ratio":{"params":[],"desc":"","returns":""},"_rotate_image_resource":{"params":[],"desc":"","returns":""},"_flip_image_resource":{"params":[],"desc":"","returns":""},"_crop_image_resource":{"params":[],"desc":"","returns":""},"image_edit_apply_changes":{"params":[],"desc":"","returns":""},"stream_preview_image":{"params":[],"desc":"","returns":""},"wp_restore_image":{"params":[],"desc":"","returns":""},"wp_save_image":{"params":[],"desc":"","returns":""},"_wp_ajax_menu_quick_search":{"params":[{"required":"yes","param":"array $request The unsanitized request values."}],"desc":"Prints the appropriate response to a menu quick search.","returns":""},"wp_nav_menu_setup":{"params":[],"desc":"Register nav menu metaboxes and advanced menu items","returns":""},"wp_initial_nav_menu_meta_boxes":{"params":[],"desc":"Limit the amount of meta boxes to just links, pages and cats for first time users.","returns":""},"wp_nav_menu_post_type_meta_boxes":{"params":[],"desc":"Creates metaboxes for any post type menu item.","returns":""},"wp_nav_menu_taxonomy_meta_boxes":{"params":[],"desc":"Creates metaboxes for any taxonomy menu item.","returns":""},"wp_nav_menu_locations_meta_box":{"params":[],"desc":"Displays a metabox for the nav menu theme locations.","returns":""},"wp_nav_menu_item_link_meta_box":{"params":[],"desc":"Displays a metabox for the custom links menu item.","returns":""},"wp_nav_menu_item_post_type_meta_box":{"params":[{"required":"yes","param":"string $object Not used."},{"required":"yes","param":"string $post_type The post type object."}],"desc":"Displays a metabox for a post type menu item.","returns":""},"wp_nav_menu_item_taxonomy_meta_box":{"params":[{"required":"yes","param":"string $object Not used."},{"required":"yes","param":"string $taxonomy The taxonomy object."}],"desc":"Displays a metabox for a taxonomy menu item.","returns":""},"wp_save_nav_menu_items":{"params":[{"required":"yes","param":"int $menu_id The menu ID for which to save this item. $menu_id of 0 makes a draft, orphaned menu item."},{"required":"yes","param":"array $menu_data The unsanitized posted menu item data."}],"desc":"Save posted nav menu item data.","returns":"array The database IDs of the items saved"},"_wp_nav_menu_meta_box_object":{"params":[{"required":"yes","param":"object $object The post type or taxonomy meta-object."}],"desc":"Adds custom arguments to some of the meta box object types.","returns":"object The post type of taxonomy object."},"wp_get_nav_menu_to_edit":{"params":[{"required":"yes","param":"string $menu_id The ID of the menu to format."}],"desc":"Returns the menu formatted to edit.","returns":"string|WP_Error $output The menu formatted to edit or error object on failure."},"wp_nav_menu_manage_columns":{"params":[],"desc":"Returns the columns for the nav menus page.","returns":"string|WP_Error $output The menu formatted to edit or error object on failure."},"_wp_delete_orphaned_draft_menu_items":{"params":[],"desc":"Deletes orphaned draft menu items","returns":""},"get_importers":{"params":[],"desc":"Retrieve list of importers.","returns":"array "},"register_importer":{"params":[{"required":"yes","param":"string $id Importer tag. Used to uniquely identify importer."},{"required":"yes","param":"string $name Importer name and title."},{"required":"yes","param":"string $description Importer description."},{"required":"yes","param":"callback $callback Callback to run."}],"desc":"Register importer for WordPress.","returns":"WP_Error Returns WP_Error when $callback is WP_Error."},"wp_import_cleanup":{"params":[{"required":"yes","param":"string $id Importer ID."}],"desc":"Cleanup importer.","returns":""},"wp_import_handle_upload":{"params":[],"desc":"Handle importer uploading and add attachment.","returns":"array Uploaded file's details on success, error message on failure"},"get_plugin_data":{"params":[{"required":"yes","param":"string $plugin_file Path to the plugin file"},{"required":"yes","param":"bool $markup If the returned data should have HTML markup applied"},{"required":"yes","param":"bool $translate If the returned data should be translated"}],"desc":"Parse the plugin contents to retrieve plugin's metadata.","returns":"array See above for description."},"_get_plugin_data_markup_translate":{"params":[],"desc":"","returns":""},"get_plugin_files":{"params":[{"required":"yes","param":"string $plugin Plugin ID"}],"desc":"Get a list of a plugin's files.","returns":"array List of files relative to the plugin root."},"get_plugins":{"params":[{"required":"no","param":"string $plugin_folder Optional. Relative path to single plugin folder."}],"desc":"Check the plugins directory and retrieve all plugin files with plugin data.","returns":"array Key is the plugin file path and the value is an array of the plugin data."},"get_mu_plugins":{"params":[],"desc":"Check the mu-plugins directory and retrieve all mu-plugin files with any plugin data.","returns":"array Key is the mu-plugin file path and the value is an array of the mu-plugin data."},"_sort_uname_callback":{"params":[],"desc":"Callback to sort array by a 'Name' key.","returns":""},"get_dropins":{"params":[],"desc":"Check the wp-content directory and retrieve all drop-ins with any plugin data.","returns":"array Key is the file path and the value is an array of the plugin data."},"_get_dropins":{"params":[],"desc":"Returns drop-ins that WordPress uses.","returns":"array Key is file name. The value is an array, with the first value the purpose of the drop-in and the second value the name of the constant that must be true for the drop-in to be used, or true if no constant is required."},"is_plugin_active":{"params":[{"required":"yes","param":"string $plugin Base plugin path from plugins directory."}],"desc":"Check whether the plugin is active by checking the active_plugins list.","returns":"bool True, if in the active plugins list. False, not in the list."},"is_plugin_inactive":{"params":[{"required":"yes","param":"string $plugin Base plugin path from plugins directory."}],"desc":"Check whether the plugin is inactive.","returns":"bool True if inactive. False if active."},"is_plugin_active_for_network":{"params":[{"required":"yes","param":"string $plugin Base plugin path from plugins directory."}],"desc":"Check whether the plugin is active for the entire network.","returns":"bool True, if active for the network, otherwise false."},"is_network_only_plugin":{"params":[{"required":"yes","param":"string $plugin Plugin to check"}],"desc":"Checks for "Network: true" in the plugin header to see if this should be activated only as a network wide plugin. The plugin would also work when Multisite is not enabled.","returns":"bool True if plugin is network only, false otherwise."},"activate_plugin":{"params":[{"required":"yes","param":"string $plugin Plugin path to main plugin file with plugin data."},{"required":"no","param":"string $redirect Optional. URL to redirect to."},{"required":"yes","param":"bool $network_wide Whether to enable the plugin for all sites in the network or just the current site. Multisite only. Default is false."},{"required":"no","param":"bool $silent Prevent calling activation hooks. Optional, default is false."}],"desc":"Attempts activation of plugin in a "sandbox" and redirects on success.","returns":"WP_Error|null WP_Error on invalid file or null on success."},"deactivate_plugins":{"params":[{"required":"yes","param":"string|array $plugins Single plugin or list of plugins to deactivate."},{"required":"yes","param":"bool $silent Prevent calling deactivation hooks. Default is false."}],"desc":"Deactivate a single plugin or multiple plugins.","returns":""},"activate_plugins":{"params":[{"required":"yes","param":"string|array $plugins "},{"required":"yes","param":"string $redirect Redirect to page after successful activation."},{"required":"yes","param":"bool $network_wide Whether to enable the plugin for all sites in the network."},{"required":"yes","param":"bool $silent Prevent calling activation hooks. Default is false."}],"desc":"Activate multiple plugins.","returns":"bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation."},"delete_plugins":{"params":[{"required":"yes","param":"array $plugins List of plugin"},{"required":"yes","param":"string $redirect Redirect to page when complete."}],"desc":"Remove directory and files of a plugin for a single or list of plugin(s).","returns":"mixed "},"validate_active_plugins":{"params":[],"desc":"Validate active plugins","returns":"array invalid plugins, plugin as key, error as value"},"validate_plugin":{"params":[{"required":"yes","param":"string $plugin Plugin Path"}],"desc":"Validate the plugin path.","returns":"WP_Error|int 0 on success, WP_Error on failure."},"is_uninstallable_plugin":{"params":[{"required":"yes","param":"string $plugin Plugin path to check."}],"desc":"Whether the plugin can be uninstalled.","returns":"bool Whether plugin can be uninstalled."},"uninstall_plugin":{"params":[{"required":"yes","param":"string $plugin Relative plugin path from Plugin Directory."}],"desc":"Uninstall a single plugin.","returns":""},"add_menu_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."},{"required":"yes","param":"string $icon_url The url to the icon to be used for this menu"},{"required":"yes","param":"int $position The position in the menu order this one should appear"}],"desc":"Add a top level menu page","returns":"string The resulting page's hook_suffix"},"add_object_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."},{"required":"yes","param":"string $icon_url The url to the icon to be used for this menu"}],"desc":"Add a top level menu page in the 'objects' section","returns":"string The resulting page's hook_suffix"},"add_utility_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."},{"required":"yes","param":"string $icon_url The url to the icon to be used for this menu"}],"desc":"Add a top level menu page in the 'utility' section","returns":"string The resulting page's hook_suffix"},"add_submenu_page":{"params":[{"required":"yes","param":"string $parent_slug The slug name for the parent menu (or the file name of a standard WordPress admin page)"},{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add a sub menu page","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_management_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the tools main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_options_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the options main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_theme_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the themes main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_plugins_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the plugins main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_users_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the Users/Profile main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_dashboard_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the Dashboard main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_posts_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the posts main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_media_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the media main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_links_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the links main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_pages_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the pages main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"add_comments_page":{"params":[{"required":"yes","param":"string $page_title The text to be displayed in the title tags of the page when the menu is selected"},{"required":"yes","param":"string $menu_title The text to be used for the menu"},{"required":"yes","param":"string $capability The capability required for this menu to be displayed to the user."},{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"callback $function The function to be called to output the content for this page."}],"desc":"Add sub menu page to the comments main menu.","returns":"string|bool The resulting page's hook_suffix, or false if the user does not have the capability required."},"remove_menu_page":{"params":[{"required":"yes","param":"string $menu_slug The slug of the menu"}],"desc":"Remove a top level admin menu","returns":"array|bool The removed menu on success, False if not found"},"remove_submenu_page":{"params":[{"required":"yes","param":"string $menu_slug The slug for the parent menu"},{"required":"yes","param":"string $submenu_slug The slug of the submenu"}],"desc":"Remove an admin submenu","returns":"array|bool The removed submenu on success, False if not found"},"menu_page_url":{"params":[{"required":"yes","param":"string $menu_slug The slug name to refer to this menu by (should be unique for this menu)"},{"required":"yes","param":"bool $echo Whether or not to echo the url - default is true"}],"desc":"Get the url to access a particular menu page based on the slug it was registered with.","returns":"string the url"},"get_admin_page_parent":{"params":[],"desc":"","returns":""},"get_admin_page_title":{"params":[],"desc":"","returns":""},"get_plugin_page_hook":{"params":[],"desc":"","returns":""},"get_plugin_page_hookname":{"params":[],"desc":"","returns":""},"user_can_access_admin_page":{"params":[],"desc":"","returns":""},"register_setting":{"params":[{"required":"yes","param":"string $option_group A settings group name. Should correspond to a whitelisted option key name. Default whitelisted option key names include "general," "discussion," and "reading," among others."},{"required":"yes","param":"string $option_name The name of an option to sanitize and save."},{"required":"yes","param":"unknown_type $sanitize_callback A callback function that sanitizes the option's value."}],"desc":"Register a setting and its sanitization callback","returns":"unknown "},"unregister_setting":{"params":[{"required":"yes","param":"unknown_type $option_group "},{"required":"yes","param":"unknown_type $option_name "},{"required":"yes","param":"unknown_type $sanitize_callback "}],"desc":"Unregister a setting","returns":"unknown "},"option_update_filter":{"params":[{"required":"yes","param":"unknown_type $options "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"add_option_whitelist":{"params":[{"required":"yes","param":"unknown_type $new_options "},{"required":"yes","param":"unknown_type $options "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"remove_option_whitelist":{"params":[{"required":"yes","param":"unknown_type $del_options "},{"required":"yes","param":"unknown_type $options "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"settings_fields":{"params":[{"required":"yes","param":"string $option_group A settings group name. This should match the group name used in register_setting()."}],"desc":"Output nonce, action, and option_page fields for a settings page.","returns":""},"wpmu_menu":{"params":[],"desc":"","returns":""},"wpmu_checkAvailableSpace":{"params":[],"desc":"Determines if the available space defined by the admin has been exceeded by the user.","returns":""},"mu_options":{"params":[],"desc":"","returns":""},"activate_sitewide_plugin":{"params":[],"desc":"","returns":""},"deactivate_sitewide_plugin":{"params":[],"desc":"","returns":""},"is_wpmu_sitewide_plugin":{"params":[],"desc":"","returns":""},"get_preferred_from_update_core":{"params":[],"desc":"Selects the first update version from the update_core option","returns":"object the response from the API"},"get_core_updates":{"params":[{"required":"yes","param":"array $options Set $options'dismissed' to true to show dismissed upgrades too, set $options'available' to false to skip not-dismissed updates."}],"desc":"Get available core updates","returns":"array Array of the update objects"},"dismiss_core_update":{"params":[],"desc":"","returns":""},"undismiss_core_update":{"params":[],"desc":"","returns":""},"find_core_update":{"params":[],"desc":"","returns":""},"core_update_footer":{"params":[],"desc":"","returns":""},"update_nag":{"params":[],"desc":"","returns":""},"update_right_now_message":{"params":[],"desc":"","returns":""},"get_plugin_updates":{"params":[],"desc":"","returns":""},"wp_plugin_update_rows":{"params":[],"desc":"","returns":""},"wp_plugin_update_row":{"params":[],"desc":"","returns":""},"wp_update_plugin":{"params":[],"desc":"","returns":""},"get_theme_updates":{"params":[],"desc":"","returns":""},"wp_update_theme":{"params":[],"desc":"","returns":""},"wp_theme_update_rows":{"params":[],"desc":"","returns":""},"wp_theme_update_row":{"params":[],"desc":"","returns":""},"wp_update_core":{"params":[],"desc":"","returns":""},"maintenance_nag":{"params":[],"desc":"","returns":""},"add_link":{"params":[],"desc":"Add a link to using values provided in $_POST.","returns":"int|WP_Error Value 0 or WP_Error on failure. The link ID on success."},"edit_link":{"params":[{"required":"no","param":"int $link_id Optional. ID of the link to edit."}],"desc":"Update or insert a link using values provided in $_POST.","returns":"int|WP_Error Value 0 or WP_Error on failure. The link ID on success."},"get_default_link_to_edit":{"params":[],"desc":"Retrieve the default link for editing.","returns":"object Default link"},"wp_delete_link":{"params":[{"required":"yes","param":"int $link_id ID of the link to delete"}],"desc":"Delete link specified from database","returns":"bool True"},"wp_get_link_cats":{"params":[{"required":"yes","param":"int $link_id Link ID to look up"}],"desc":"Retrieves the link categories associated with the link specified.","returns":"array The requested link's categories"},"get_link_to_edit":{"params":[{"required":"yes","param":"int $link_id ID of link to retrieve"}],"desc":"Retrieve link data based on ID.","returns":"object Link for editing"},"wp_insert_link":{"params":[{"required":"yes","param":"array $linkdata Elements that make up the link to insert."},{"required":"no","param":"bool $wp_error Optional. If true return WP_Error object on failure."}],"desc":"This function inserts/updates links into/in the database.","returns":"int|WP_Error Value 0 or WP_Error on failure. The link ID on success."},"wp_set_link_cats":{"params":[{"required":"yes","param":"int $link_id ID of link to update"},{"required":"yes","param":"array $link_categories Array of categories to"}],"desc":"Update link with the specified link categories.","returns":""},"wp_update_link":{"params":[{"required":"yes","param":"array $linkdata Link data to update."}],"desc":"Update a link in the database.","returns":"int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success."},"get_file_description":{"params":[{"required":"yes","param":"string $file Filesystem path or filename"}],"desc":"Get the description for standard WordPress theme files and other various standard WordPress files","returns":"string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist"},"get_home_path":{"params":[],"desc":"Get the absolute filesystem path to the root of the WordPress installation","returns":"string Full filesystem path to the root of the WordPress installation"},"get_real_file_to_edit":{"params":[{"required":"yes","param":"string $file filesystem path relative to the WordPress install directory or to the wp-content directory"}],"desc":"Get the real file system path to a file to edit within the admin","returns":"string full file system path to edit"},"list_files":{"params":[{"required":"yes","param":"string $folder Full path to folder"},{"required":"no","param":"int $levels (optional) Levels of folders to follow, Default: 100 (PHP Loop limit)."}],"desc":"Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.","returns":"bool|array False on failure, Else array of files"},"wp_tempnam":{"params":[{"required":"no","param":"string $filename (optional) Filename to base the Unique file off"},{"required":"no","param":"string $dir (optional) Directory to store the file in"}],"desc":"Returns a filename of a Temporary unique file.","returns":"string a writable filename"},"validate_file_to_edit":{"params":[{"required":"yes","param":"string $file file the users is attempting to edit"},{"required":"yes","param":"array $allowed_files Array of allowed files to edit, $file must match an entry exactly"}],"desc":"Make sure that the file that was requested to edit, is allowed to be edited","returns":"null "},"wp_handle_upload":{"params":[{"required":"yes","param":"array $file Reference to a single element of $_FILES. Call the function once for each uploaded file."},{"required":"no","param":"array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE )."}],"desc":"Handle PHP uploads in WordPress, sanitizing file names, checking extensions for mime type, and moving the file to the appropriate directory within the uploads directory.","returns":"array On success, returns an associative array of file attributes. On failure, returns $overrides'upload_error_handler'(&$file, $message ) or array( 'error'=>$message )."},"wp_handle_sideload":{"params":[{"required":"yes","param":"array $file an array similar to that of a PHP $_FILES POST array"},{"required":"no","param":"array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE )."}],"desc":"Handle sideloads, which is the process of retrieving a media item from another server instead of a traditional media upload.  This process involves sanitizing the filename, checking extensions for mime type, and moving the file to the appropriate directory within the uploads directory.","returns":"array On success, returns an associative array of file attributes. On failure, returns $overrides'upload_error_handler'(&$file, $message ) or array( 'error'=>$message )."},"download_url":{"params":[{"required":"yes","param":"string $url the URL of the file to download"},{"required":"yes","param":"int $timeout The timeout for the request to download the file default 300 seconds"}],"desc":"Downloads a url to a local temporary file using the WordPress HTTP Class.","returns":"mixed WP_Error on failure, string Filename on success."},"unzip_file":{"params":[{"required":"yes","param":"string $file Full path and filename of zip archive"},{"required":"yes","param":"string $to Full path on the filesystem to extract archive to"}],"desc":"Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction.","returns":"mixed WP_Error on failure, True on success"},"_unzip_file_ziparchive":{"params":[{"required":"yes","param":"string $file Full path and filename of zip archive"},{"required":"yes","param":"string $to Full path on the filesystem to extract archive to"},{"required":"yes","param":"array $needed_dirs A partial list of required folders needed to be created."}],"desc":"This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the ZipArchive class.","returns":"mixed WP_Error on failure, True on success"},"_unzip_file_pclzip":{"params":[{"required":"yes","param":"string $file Full path and filename of zip archive"},{"required":"yes","param":"string $to Full path on the filesystem to extract archive to"},{"required":"yes","param":"array $needed_dirs A partial list of required folders needed to be created."}],"desc":"This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the PclZip library.","returns":"mixed WP_Error on failure, True on success"},"copy_dir":{"params":[{"required":"yes","param":"string $from source directory"},{"required":"yes","param":"string $to destination directory"},{"required":"yes","param":"array $skip_list a list of files/folders to skip copying"}],"desc":"Copies a directory from one location to another via the WordPress Filesystem Abstraction.","returns":"mixed WP_Error on failure, True on success."},"WP_Filesystem":{"params":[{"required":"no","param":"array $args (optional) Connection args, These are passed directly to the WP_Filesystem_*() classes."},{"required":"no","param":"string $context (optional) Context for get_filesystem_method(), See function declaration for more information."}],"desc":"Initialises and connects the WordPress Filesystem Abstraction classes.","returns":"boolean false on failure, true on success"},"get_filesystem_method":{"params":[{"required":"yes","param":"array $args Connection details."},{"required":"yes","param":"string $context Full path to the directory that is tested for being writable."}],"desc":"Determines which Filesystem Method to use.","returns":"string The transport to use, see description for valid return values."},"request_filesystem_credentials":{"params":[{"required":"yes","param":"string $form_post the URL to post the form to"},{"required":"yes","param":"string $type the chosen Filesystem method in use"},{"required":"yes","param":"boolean $error if the current request has failed to connect"},{"required":"yes","param":"string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method()"},{"required":"yes","param":"string $extra_fields Extra POST fields which should be checked for to be included in the post."}],"desc":"Displays a form to the user to request for their FTP/SSH details in order to  connect to the filesystem.","returns":"boolean False on failure. True on success."},"wp_install":{"params":[{"required":"yes","param":"string $blog_title Blog title."},{"required":"yes","param":"string $user_name User's username."},{"required":"yes","param":"string $user_email User's email."},{"required":"yes","param":"bool $public Whether blog is public."},{"required":"no","param":"null $deprecated Optional. Not used."},{"required":"no","param":"string $user_password Optional. User's chosen password. Will default to a random password."}],"desc":"Installs the blog","returns":"array Array keys 'url', 'user_id', 'password', 'password_message'."},"wp_install_defaults":{"params":[{"required":"yes","param":"int $user_id User ID."}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_new_blog_notification":{"params":[{"required":"yes","param":"string $blog_title Blog title."},{"required":"yes","param":"string $blog_url Blog url."},{"required":"yes","param":"int $user_id User ID."},{"required":"yes","param":"string $password User's Password."}],"desc":"{@internal Missing Short Description}}","returns":""},"wp_upgrade":{"params":[],"desc":"Run WordPress Upgrade functions.","returns":"null "},"upgrade_all":{"params":[],"desc":"Functions to be called in install and upgrade scripts.","returns":""},"upgrade_100":{"params":[],"desc":"Execute changes made in WordPress 1.0.","returns":""},"upgrade_101":{"params":[],"desc":"Execute changes made in WordPress 1.0.1.","returns":""},"upgrade_110":{"params":[],"desc":"Execute changes made in WordPress 1.2.","returns":""},"upgrade_130":{"params":[],"desc":"Execute changes made in WordPress 1.5.","returns":""},"upgrade_160":{"params":[],"desc":"Execute changes made in WordPress 2.0.","returns":""},"upgrade_210":{"params":[],"desc":"Execute changes made in WordPress 2.1.","returns":""},"upgrade_230":{"params":[],"desc":"Execute changes made in WordPress 2.3.","returns":""},"upgrade_230_options_table":{"params":[],"desc":"Remove old options from the database.","returns":""},"upgrade_230_old_tables":{"params":[],"desc":"Remove old categories, link2cat, and post2cat database tables.","returns":""},"upgrade_old_slugs":{"params":[],"desc":"Upgrade old slugs made in version 2.2.","returns":""},"upgrade_250":{"params":[],"desc":"Execute changes made in WordPress 2.5.0.","returns":""},"upgrade_252":{"params":[],"desc":"Execute changes made in WordPress 2.5.2.","returns":""},"upgrade_260":{"params":[],"desc":"Execute changes made in WordPress 2.6.","returns":""},"upgrade_270":{"params":[],"desc":"Execute changes made in WordPress 2.7.","returns":""},"upgrade_280":{"params":[],"desc":"Execute changes made in WordPress 2.8.","returns":""},"upgrade_290":{"params":[],"desc":"Execute changes made in WordPress 2.9.","returns":""},"upgrade_300":{"params":[],"desc":"Execute changes made in WordPress 3.0.","returns":""},"upgrade_330":{"params":[],"desc":"Execute changes made in WordPress 3.3.","returns":""},"upgrade_network":{"params":[],"desc":"Execute network level changes","returns":""},"maybe_create_table":{"params":[{"required":"yes","param":"string $table_name Database table name."},{"required":"yes","param":"string $create_ddl Create database table SQL."}],"desc":"Create database table, if it doesn't already exist.","returns":"bool False on error, true if already exists or success."},"drop_index":{"params":[{"required":"yes","param":"string $table Database table name."},{"required":"yes","param":"string $index Index name to drop."}],"desc":"{@internal Missing Short Description}}","returns":"bool True, when finished."},"add_clean_index":{"params":[{"required":"yes","param":"string $table Database table name."},{"required":"yes","param":"string $index Database table index column."}],"desc":"{@internal Missing Short Description}}","returns":"bool True, when done with execution."},"maybe_add_column":{"params":[{"required":"yes","param":"string $table_name Database table name"},{"required":"yes","param":"string $column_name Table column name"},{"required":"yes","param":"string $create_ddl SQL to add column to table."}],"desc":"Add column to database table, if column doesn't already exist in table.","returns":"bool False on failure. True, if already exists or was successful."},"get_alloptions_110":{"params":[],"desc":"Retrieve all options as it was for 1.2.","returns":"array List of options."},"__get_option":{"params":[{"required":"yes","param":"string $setting Option name."}],"desc":"Version of get_option that is private to install/upgrade.","returns":"mixed "},"deslash":{"params":[{"required":"yes","param":"string $content "}],"desc":"{@internal Missing Short Description}}","returns":"string "},"dbDelta":{"params":[{"required":"yes","param":"unknown_type $queries "},{"required":"yes","param":"unknown_type $execute "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"make_db_current":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"make_db_current_silent":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"make_site_theme_from_oldschool":{"params":[{"required":"yes","param":"unknown_type $theme_name "},{"required":"yes","param":"unknown_type $template "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"make_site_theme_from_default":{"params":[{"required":"yes","param":"unknown_type $theme_name "},{"required":"yes","param":"unknown_type $template "}],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"make_site_theme":{"params":[],"desc":"{@internal Missing Short Description}}","returns":"unknown "},"translate_level_to_role":{"params":[{"required":"yes","param":"int $level User level."}],"desc":"Translate user level to user role name.","returns":"string User role name."},"wp_check_mysql_version":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"maybe_disable_automattic_widgets":{"params":[],"desc":"{@internal Missing Short Description}}","returns":""},"pre_schema_upgrade":{"params":[],"desc":"Runs before the schema is upgraded.","returns":""},"install_global_terms":{"params":[],"desc":"","returns":""},"add_cssclass":{"params":[],"desc":"","returns":""},"add_menu_classes":{"params":[],"desc":"","returns":""},"sort_menu":{"params":[],"desc":"","returns":""},"wp_list_widgets":{"params":[],"desc":"Display list of the available widgets.","returns":""},"_sort_name_callback":{"params":[],"desc":"Callback to sort array by a 'name' key.","returns":""},"wp_list_widget_controls":{"params":[{"required":"yes","param":"string $sidebar id slug of the sidebar"}],"desc":"Show the widgets and their settings for a sidebar.","returns":""},"wp_list_widget_controls_dynamic_sidebar":{"params":[{"required":"yes","param":"array $params "}],"desc":"{@internal Missing Short Description}}","returns":"array "},"next_widget_id_number":{"params":[],"desc":"","returns":""},"wp_widget_control":{"params":[{"required":"yes","param":"array $sidebar_args "}],"desc":"Meta widget used to display the control form for a widget.","returns":"array "},"add_user":{"params":[{"required":"no","param":"int $user_id Optional. User ID."}],"desc":"Creates a new user from the "Users" form using $_POST information.","returns":"null|WP_Error|int Null when adding user, WP_Error or User ID integer when no parameters."},"edit_user":{"params":[{"required":"no","param":"int $user_id Optional. User ID."}],"desc":"Edit user settings based on contents of $_POST","returns":"int user id of the updated user"},"get_editable_roles":{"params":[],"desc":"Fetch a filtered list of user roles that the current user is allowed to edit.","returns":"unknown "},"get_user_to_edit":{"params":[{"required":"yes","param":"int $user_id User ID."}],"desc":"Retrieve user data and filter it.","returns":"object WP_User object with user data."},"get_users_drafts":{"params":[{"required":"yes","param":"int $user_id User ID."}],"desc":"Retrieve the user's drafts.","returns":"array "},"wp_delete_user":{"params":[{"required":"yes","param":"int $id User ID."},{"required":"no","param":"int $reassign Optional. Reassign posts and links to new User ID."}],"desc":"Remove user and optionally reassign posts and links to another user.","returns":"bool True when finished."},"wp_revoke_user":{"params":[{"required":"yes","param":"int $id User ID."}],"desc":"Remove all capabilities from user.","returns":""},"default_password_nag_handler":{"params":[],"desc":"","returns":""},"default_password_nag_edit_user":{"params":[],"desc":"","returns":""},"default_password_nag":{"params":[],"desc":"","returns":""},"startElement":{"params":[{"required":"yes","param":"mixed $parser XML Parser resource."},{"required":"yes","param":"string $tagName XML element name."},{"required":"yes","param":"array $attrs XML element attributes."}],"desc":"XML callback function for the start of a new XML tag.","returns":""},"endElement":{"params":[{"required":"yes","param":"mixed $parser XML Parser resource."},{"required":"yes","param":"string $tagName XML tag name."}],"desc":"XML callback function that is called at the end of a XML tag.","returns":""},"_wp_ajax_delete_comment_response":{"params":[{"required":"yes","param":"int $comment_id "}],"desc":"Sends back current comment total and new page links if they need to be updated.","returns":"die "},"_wp_ajax_add_hierarchical_term":{"params":[],"desc":"","returns":""},"redirect_post":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Redirect to previous page.","returns":""},"admin_created_user_email":{"params":[],"desc":"","returns":""},"admin_created_user_subject":{"params":[],"desc":"","returns":""},"use_ssl_preference":{"params":[{"required":"yes","param":"object $user User data object"}],"desc":"Optional SSL preference that can be turned on by hooking to the 'personal_options' action.","returns":""},"list_core_update":{"params":[],"desc":"","returns":""},"dismissed_updates":{"params":[],"desc":"","returns":""},"core_upgrade_preamble":{"params":[],"desc":"Display upgrade WordPress for downloading latest or upgrading automatically form.","returns":"null "},"list_plugin_updates":{"params":[],"desc":"","returns":""},"list_theme_updates":{"params":[],"desc":"","returns":""},"do_core_upgrade":{"params":[],"desc":"Upgrade WordPress core display.","returns":"null "},"do_dismiss_core_update":{"params":[],"desc":"","returns":""},"do_undismiss_core_update":{"params":[],"desc":"","returns":""},"no_update_actions":{"params":[],"desc":"","returns":""},"plugin_sandbox_scrape":{"params":[],"desc":"","returns":""},"home_url":{"params":[{"required":"no","param":"string $path (optional) Path relative to the home url."},{"required":"no","param":"string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'."}],"desc":"Retrieve the home url for the current site.","returns":"string Home url link with optional path appended."},"includes_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the includes url."}],"desc":"Retrieve the url to the includes directory.","returns":"string Includes url link with optional path appended."},"json_encode":{"params":[],"desc":"","returns":""},"display_setup_form":{"params":[],"desc":"Display installer setup form.","returns":""},"wp_credits":{"params":[],"desc":"","returns":""},"_wp_credits_add_profile_link":{"params":[],"desc":"","returns":""},"_wp_credits_build_object_link":{"params":[],"desc":"","returns":""},"network_domain_check":{"params":[],"desc":"Check for an existing network.","returns":"Whether a network exists."},"allow_subdomain_install":{"params":[],"desc":"Allow subdomain install","returns":"bool Whether subdomain install is allowed"},"allow_subdirectory_install":{"params":[],"desc":"Allow subdirectory install","returns":"bool Whether subdirectory install is allowed"},"get_clean_basedomain":{"params":[],"desc":"Get base domain of network.","returns":"string Base domain."},"network_step1":{"params":[],"desc":"Prints step 1 for Network installation process.","returns":""},"network_step2":{"params":[],"desc":"Prints step 2 for Network installation process.","returns":""},"_add_themes_utility_last":{"params":[],"desc":"","returns":""},"wp_widgets_access_body_class":{"params":[],"desc":"","returns":""},"maybe_drop_column":{"params":[{"required":"yes","param":"string $table_name Table name"},{"required":"yes","param":"string $column_name Column name"},{"required":"yes","param":"string $drop_ddl SQL statement to drop column."}],"desc":"Drop column from database table, if it exists.","returns":"bool False on failure, true on success or doesn't exist."},"check_column":{"params":[{"required":"yes","param":"string $table_name Table name"},{"required":"yes","param":"string $col_name Column name"},{"required":"yes","param":"string $col_type Column type"},{"required":"no","param":"bool $is_null Optional. Check is null."},{"required":"no","param":"mixed $key Optional. Key info."},{"required":"no","param":"mixed $default Optional. Default value."},{"required":"no","param":"mixed $extra Optional. Extra value."}],"desc":"Check column matches criteria.","returns":"bool True, if matches. False, if not matching."},"dvortr":{"params":[],"desc":"","returns":""},"confirm_delete_users":{"params":[],"desc":"","returns":""},"add_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key"},{"required":"yes","param":"string $meta_value Metadata value"},{"required":"no","param":"bool $unique Optional, default is false. Whether the specified metadata key should be unique for the object. If true, and the object already has a value for the specified metadata key, no change will be made"}],"desc":"Add metadata for the specified object.","returns":"bool The meta ID on successful update, false on failure."},"update_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key"},{"required":"yes","param":"string $meta_value Metadata value"},{"required":"no","param":"string $prev_value Optional. If specified, only update existing metadata entries with the specified value. Otherwise, update all entries."}],"desc":"Update metadata for the specified object.  If no value already exists for the specified object ID and metadata key, the metadata will be added.","returns":"bool True on successful update, false on failure."},"delete_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key"},{"required":"no","param":"string $meta_value Optional. Metadata value. If specified, only delete metadata entries with this value. Otherwise, delete all entries with the specified meta_key."},{"required":"no","param":"bool $delete_all Optional, default is false. If true, delete matching metadata entries for all objects, ignoring the specified object_id. Otherwise, only delete matching metadata entries for the specified object_id."}],"desc":"Delete metadata for the specified object.","returns":"bool True on successful delete, false on failure."},"get_metadata":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"no","param":"string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for the specified object."},{"required":"no","param":"bool $single Optional, default is false. If true, return only the first value of the specified meta_key. This parameter has no effect if meta_key is not specified."}],"desc":"Retrieve metadata for the specified object.","returns":"string|array Single metadata value, or array of values"},"metadata_exists":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $object_id ID of the object metadata is for"},{"required":"yes","param":"string $meta_key Metadata key."}],"desc":"Determine if a meta key is set for a given object","returns":"boolean true of the key is set, false if not."},"get_metadata_by_mid":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $meta_id ID for a specific meta row"}],"desc":"Get meta data by meta ID","returns":"object Meta object or false."},"update_metadata_by_mid":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $meta_id ID for a specific meta row"},{"required":"yes","param":"string $meta_value Metadata value"},{"required":"no","param":"string $meta_key Optional, you can provide a meta key to update it"}],"desc":"Update meta data by meta ID","returns":"bool True on successful update, false on failure."},"delete_metadata_by_mid":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int $meta_id ID for a specific meta row"}],"desc":"Delete meta data by meta ID","returns":"bool True on successful delete, false on failure."},"update_meta_cache":{"params":[{"required":"yes","param":"string $meta_type Type of object metadata is for (e.g., comment, post, or user)"},{"required":"yes","param":"int|array $object_ids array or comma delimited list of object IDs to update cache for"}],"desc":"Update the metadata cache for the specified objects.","returns":"mixed Metadata cache for the specified objects, or false on failure."},"get_meta_sql":{"params":[{"required":"yes","param":"array $meta_query A meta query"},{"required":"yes","param":"string $type Type of meta"},{"required":"yes","param":"string $primary_table "},{"required":"yes","param":"string $primary_id_column "},{"required":"no","param":"object $context (optional) The main query object"}],"desc":"Given a meta query, generates SQL clauses to be appended to a main query","returns":"array( 'join' => $join_sql, 'where' => $where_sql )"},"_get_meta_table":{"params":[{"required":"yes","param":"string $type Type of object to get metadata table for (e.g., comment, post, or user)"}],"desc":"Retrieve the name of the metadata table for the specified object type.","returns":"mixed Metadata table name, or false if no metadata table exists"},"is_protected_meta":{"params":[{"required":"yes","param":"string $meta_key Meta key"}],"desc":"Determine whether a meta key is protected","returns":"bool True if the key is protected, false otherwise."},"sanitize_meta":{"params":[{"required":"yes","param":"string $meta_key Meta key"},{"required":"yes","param":"mixed $meta_value Meta value to sanitize"},{"required":"yes","param":"string $meta_type Type of meta"}],"desc":"Sanitize meta value","returns":"mixed Sanitized $meta_value"},"register_meta":{"params":[{"required":"yes","param":"string $meta_type Type of meta"},{"required":"yes","param":"string $meta_key Meta key"},{"required":"yes","param":"string|array $sanitize_callback A function or method to call when sanitizing the value of $meta_key."},{"required":"no","param":"string|array $auth_callback Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks."},{"required":"yes","param":"array $args Arguments"}],"desc":"Register meta key","returns":""},"add_rewrite_rule":{"params":[{"required":"yes","param":"string $regex Regular Expression to match request against."},{"required":"yes","param":"string $redirect Page to redirect to."},{"required":"no","param":"string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'."}],"desc":"Add a straight rewrite rule.","returns":""},"add_rewrite_tag":{"params":[{"required":"yes","param":"string $tagname "},{"required":"yes","param":"string $regex "}],"desc":"Add a new tag (like %postname%).","returns":""},"add_permastruct":{"params":[{"required":"yes","param":"string $name Name for permalink structure."},{"required":"yes","param":"string $struct Permalink structure."},{"required":"yes","param":"bool $with_front Prepend front base to permalink structure."}],"desc":"Add permalink structure.","returns":""},"add_feed":{"params":[{"required":"yes","param":"string $feedname "},{"required":"yes","param":"callback $function Callback to run on feed display."}],"desc":"Add a new feed type like /atom1/.","returns":"string Feed action name."},"flush_rewrite_rules":{"params":[{"required":"yes","param":"bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules transient (soft flush). Default is true (hard)."}],"desc":"Remove rewrite rules and then recreate rewrite rules.","returns":""},"add_rewrite_endpoint":{"params":[{"required":"yes","param":"unknown_type $name "},{"required":"yes","param":"unknown_type $places "}],"desc":"Add an endpoint, like /trackback/.","returns":""},"_wp_filter_taxonomy_base":{"params":[{"required":"yes","param":"string $base The taxonomy base that we're going to filter"}],"desc":"Filter the URL base for taxonomies.","returns":"string "},"url_to_postid":{"params":[{"required":"yes","param":"string $url Permalink to check."}],"desc":"Examine a url and try to determine the post ID it represents.","returns":"int Post ID, or 0 on failure."},"fetch_rss":{"params":[{"required":"yes","param":"string $url URL to retrieve feed"}],"desc":"Build Magpie object based on RSS from URL.","returns":"bool|MagpieRSS false on failure or MagpieRSS object on success."},"_fetch_remote_file":{"params":[{"required":"yes","param":"string $url URL to retrieve"},{"required":"no","param":"array $headers Optional. Headers to send to the URL."}],"desc":"Retrieve URL headers and content using WP HTTP Request API.","returns":"Snoopy style response"},"_response_to_rss":{"params":[{"required":"yes","param":"unknown_type $resp "}],"desc":"Retrieve","returns":"unknown "},"init":{"params":[],"desc":"Set up constants with default values, unless user overrides.","returns":""},"is_info":{"params":[],"desc":"","returns":""},"is_success":{"params":[],"desc":"","returns":""},"is_redirect":{"params":[],"desc":"","returns":""},"is_error":{"params":[],"desc":"","returns":""},"is_client_error":{"params":[],"desc":"","returns":""},"is_server_error":{"params":[],"desc":"","returns":""},"parse_w3cdtf":{"params":[],"desc":"","returns":""},"wp_rss":{"params":[{"required":"yes","param":"string $url URL of feed to display. Will not auto sense feed URL."},{"required":"no","param":"int $num_items Optional. Number of items to display, default is all."}],"desc":"Display all RSS items in a HTML ordered list.","returns":""},"get_rss":{"params":[{"required":"yes","param":"string $url URL of feed to display. Will not auto sense feed URL."},{"required":"no","param":"int $num_items Optional. Number of items to display, default is all."}],"desc":"Display RSS items in HTML list items.","returns":"bool False on failure."},"get_bloginfo_rss":{"params":[{"required":"yes","param":"string $show See get_bloginfo() for possible values."}],"desc":"RSS container for the bloginfo function.","returns":"string "},"bloginfo_rss":{"params":[{"required":"yes","param":"string $show See get_bloginfo() for possible values."}],"desc":"Display RSS container for the bloginfo function.","returns":""},"get_default_feed":{"params":[],"desc":"Retrieve the default feed.","returns":"string Default feed, or for example 'rss2', 'atom', etc."},"get_wp_title_rss":{"params":[{"required":"no","param":"string $sep Optional.How to separate the title. See wp_title() for more info."}],"desc":"Retrieve the blog title for the feed title.","returns":"string Error message on failure or blog title on success."},"wp_title_rss":{"params":[{"required":"no","param":"string $sep Optional."}],"desc":"Display the blog title for display of the feed title.","returns":""},"get_the_title_rss":{"params":[],"desc":"Retrieve the current post title for the feed.","returns":"string Current post title."},"the_title_rss":{"params":[],"desc":"Display the post title in the feed.","returns":""},"get_the_content_feed":{"params":[{"required":"yes","param":"string $feed_type The type of feed. rss2 | atom | rss | rdf"}],"desc":"Retrieve the post content for feeds.","returns":""},"the_content_feed":{"params":[{"required":"yes","param":"string $feed_type The type of feed. rss2 | atom | rss | rdf"}],"desc":"Display the post content for feeds.","returns":""},"the_excerpt_rss":{"params":[],"desc":"Display the post excerpt for the feed.","returns":""},"the_permalink_rss":{"params":[],"desc":"Display the permalink to the post for use in feeds.","returns":""},"comments_link_feed":{"params":[],"desc":"Outputs the link to the comments for the current post in an xml safe way","returns":"none "},"comment_guid":{"params":[{"required":"no","param":"int|object $comment_id Optional comment object or id. Defaults to global comment object."}],"desc":"Display the feed GUID for the current comment.","returns":""},"get_comment_guid":{"params":[{"required":"no","param":"int|object $comment_id Optional comment object or id. Defaults to global comment object."}],"desc":"Retrieve the feed GUID for the current comment.","returns":"bool|string false on failure or guid for comment on success."},"comment_link":{"params":[],"desc":"Display the link to the comments.","returns":""},"get_comment_author_rss":{"params":[],"desc":"Retrieve the current comment author for use in the feeds.","returns":"string Comment Author"},"comment_author_rss":{"params":[],"desc":"Display the current comment author in the feed.","returns":""},"comment_text_rss":{"params":[],"desc":"Display the current comment content for use in the feeds.","returns":""},"get_the_category_rss":{"params":[{"required":"no","param":"string $type Optional, default is the type returned by get_default_feed()."}],"desc":"Retrieve all of the post categories, formatted for use in feeds.","returns":"string All of the post categories for displaying in the feed."},"the_category_rss":{"params":[{"required":"no","param":"string $type Optional, default is the type returned by get_default_feed()."}],"desc":"Display the post categories in the feed.","returns":""},"html_type_rss":{"params":[],"desc":"Display the HTML type based on the blog setting.","returns":""},"rss_enclosure":{"params":[],"desc":"Display the rss enclosure for the current post.","returns":""},"atom_enclosure":{"params":[],"desc":"Display the atom enclosure for the current post.","returns":""},"prep_atom_text_construct":{"params":[{"required":"yes","param":"string $data Input string"}],"desc":"Determine the type of a string of data with the data formatted.","returns":"array array(type, value)"},"self_link":{"params":[],"desc":"Display the link for the currently displayed feed in a XSS safe way.","returns":""},"feed_content_type":{"params":[],"desc":"Return the content type for specified feed type.","returns":""},"fetch_feed":{"params":[{"required":"yes","param":"string $url URL to retrieve feed"}],"desc":"Build SimplePie object based on RSS or Atom feed from URL.","returns":"WP_Error|SimplePie WP_Error object on failure or SimplePie object on success"},"is_rtl":{"params":[],"desc":"Checks if current locale is RTL.","returns":"bool Whether locale is RTL."},"is_subdomain_install":{"params":[],"desc":"Whether a subdomain configuration is enabled.","returns":"bool True if subdomain configuration is enabled, false otherwise."},"wp_get_active_network_plugins":{"params":[],"desc":"Returns array of network plugin files to be included in global scope.","returns":"array Files to include"},"ms_site_check":{"params":[],"desc":"Checks status of current blog.","returns":"bool|string Returns true on success, or drop-in file to include."},"get_current_site_name":{"params":[],"desc":"Sets current site name.","returns":"object $current_site object with site_name"},"wpmu_current_site":{"params":[],"desc":"Sets current_site object.","returns":"object $current_site object"},"ms_not_installed":{"params":[],"desc":"Displays a failure message.","returns":""},"_walk_bookmarks":{"params":[{"required":"yes","param":"array $bookmarks List of bookmarks to traverse"},{"required":"no","param":"string|array $args Optional. Overwrite the defaults."}],"desc":"The formatted output of a list of bookmarks.","returns":"string Formatted output in HTML"},"wp_list_bookmarks":{"params":[{"required":"no","param":"string|array $args Optional. Overwrite the defaults of the function"}],"desc":"Retrieve or echo all of the bookmarks.","returns":"string|null Will only return if echo option is set to not echo. Default is not return anything."},"check_comment":{"params":[{"required":"yes","param":"string $author Comment Author's name"},{"required":"yes","param":"string $email Comment Author's email"},{"required":"yes","param":"string $url Comment Author's URL"},{"required":"yes","param":"string $comment Comment contents"},{"required":"yes","param":"string $user_ip Comment Author's IP address"},{"required":"yes","param":"string $user_agent Comment Author's User Agent"},{"required":"yes","param":"string $comment_type Comment type, either user submitted comment, trackback, or pingback"}],"desc":"Checks whether a comment passes internal checks to be allowed to add.","returns":"bool Whether the checks passed (true) and the comments should be displayed or set to moderated"},"get_approved_comments":{"params":[{"required":"yes","param":"int $post_id The ID of the post"}],"desc":"Retrieve the approved comments for post $post_id.","returns":"array $comments The approved comments"},"get_comment":{"params":[{"required":"yes","param":"object|string|int $comment Comment to retrieve."},{"required":"no","param":"string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants."}],"desc":"Retrieves comment data given a comment ID or comment object.","returns":"object|array|null Depends on $output value."},"get_comments":{"params":[{"required":"no","param":"mixed $args Optional. Array or string of options to override defaults."}],"desc":"Retrieve a list of comments.","returns":"array List of comments."},"get_comment_statuses":{"params":[],"desc":"Retrieve all of the WordPress supported comment statuses.","returns":"array List of comment statuses."},"get_lastcommentmodified":{"params":[{"required":"yes","param":"string $timezone Which timezone to use in reference to 'gmt', 'blog', or 'server' locations."}],"desc":"The date the last comment was modified.","returns":"string Last comment modified date."},"get_comment_count":{"params":[{"required":"no","param":"int $post_id Optional. Comment amount in post if > 0, else total comments blog wide."}],"desc":"The amount of comments in a post or total comments.","returns":"array The amount of spam, approved, awaiting moderation, and total comments."},"add_comment_meta":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"bool $unique Optional, default is false. Whether the same key should not be added."}],"desc":"Add meta data field to a comment.","returns":"bool False for failure. True for success."},"delete_comment_meta":{"params":[{"required":"yes","param":"int $comment_id comment ID"},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"no","param":"mixed $meta_value Optional. Metadata value."}],"desc":"Remove metadata matching criteria from a comment.","returns":"bool False for failure. True for success."},"get_comment_meta":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $key The meta key to retrieve."},{"required":"yes","param":"bool $single Whether to return a single value."}],"desc":"Retrieve comment meta field for a comment.","returns":"mixed Will be an array if $single is false. Will be value of meta data field if $single is true."},"update_comment_meta":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"mixed $prev_value Optional. Previous value to check before removing."}],"desc":"Update comment meta field based on comment ID.","returns":"bool False on failure, true if success."},"sanitize_comment_cookies":{"params":[],"desc":"Sanitizes the cookies sent to the user already.","returns":""},"wp_allow_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment"}],"desc":"Validates whether this comment is allowed to be made.","returns":"mixed Signifies the approval status (0|1|'spam')"},"check_comment_flood_db":{"params":[{"required":"yes","param":"string $ip Comment IP."},{"required":"yes","param":"string $email Comment author email address."},{"required":"yes","param":"string $date MySQL time string."}],"desc":"Check whether comment flooding is occurring.","returns":""},"separate_comments":{"params":[{"required":"yes","param":"array $comments Array of comments"}],"desc":"Separates an array of comments into an array keyed by comment_type.","returns":"array Array of comments keyed by comment_type."},"get_comment_pages_count":{"params":[{"required":"no","param":"array $comments Optional array of comment objects. Defaults to $wp_query->comments"},{"required":"no","param":"int $per_page Optional comments per page."},{"required":"no","param":"boolean $threaded Optional control over flat or threaded comments."}],"desc":"Calculate the total number of comment pages.","returns":"int Number of comment pages."},"get_page_of_comment":{"params":[{"required":"yes","param":"int $comment_ID Comment ID."},{"required":"no","param":"array $args Optional args."}],"desc":"Calculate what page number a comment will appear on for comment paging.","returns":"int|null Comment page number or null on error."},"wp_blacklist_check":{"params":[{"required":"yes","param":"string $author The author of the comment"},{"required":"yes","param":"string $email The email of the comment"},{"required":"yes","param":"string $url The url used in the comment"},{"required":"yes","param":"string $comment The comment content"},{"required":"yes","param":"string $user_ip The comment author IP address"},{"required":"yes","param":"string $user_agent The author's browser user agent"}],"desc":"Does comment contain blacklisted characters or words.","returns":"bool True if comment contains blacklisted content, false if comment does not"},"wp_count_comments":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Retrieve total comments for blog or single post.","returns":"object Comment stats."},"wp_delete_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID"},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Default is false."}],"desc":"Trashes or deletes a comment.","returns":"bool False if delete comment query failure, true on success."},"wp_trash_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Moves a comment to the Trash","returns":"mixed False on failure"},"wp_untrash_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Removes a comment from the Trash","returns":"mixed False on failure"},"wp_spam_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Marks a comment as Spam","returns":"mixed False on failure"},"wp_unspam_comment":{"params":[{"required":"yes","param":"int $comment_id Comment ID."}],"desc":"Removes a comment from the Spam","returns":"mixed False on failure"},"wp_get_comment_status":{"params":[{"required":"yes","param":"int $comment_id Comment ID"}],"desc":"The status of a comment by ID.","returns":"string|bool Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure."},"wp_transition_comment_status":{"params":[{"required":"yes","param":"string $new_status New comment status."},{"required":"yes","param":"string $old_status Previous comment status."},{"required":"yes","param":"object $comment Comment data."}],"desc":"Call hooks for when a comment status transition occurs.","returns":""},"wp_get_current_commenter":{"params":[],"desc":"Get current commenter's name, email, and URL.","returns":"array Comment author, email, url respectively."},"wp_insert_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment."}],"desc":"Inserts a comment to the database.","returns":"int The new comment's ID."},"wp_filter_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment."}],"desc":"Filters and sanitizes comment data.","returns":"array Parsed comment information."},"wp_throttle_comment_flood":{"params":[{"required":"yes","param":"bool $block Whether plugin has already blocked comment."},{"required":"yes","param":"int $time_lastcomment Timestamp for last comment."},{"required":"yes","param":"int $time_newcomment Timestamp for new comment."}],"desc":"Whether comment should be blocked because of comment flood.","returns":"bool Whether comment should be blocked."},"wp_new_comment":{"params":[{"required":"yes","param":"array $commentdata Contains information on the comment."}],"desc":"Adds a new comment to the database.","returns":"int The ID of the comment after adding."},"wp_set_comment_status":{"params":[{"required":"yes","param":"int $comment_id Comment ID."},{"required":"yes","param":"string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'delete'."},{"required":"yes","param":"bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false."}],"desc":"Sets the status of a comment.","returns":"bool False on failure or deletion and true on success."},"wp_update_comment":{"params":[{"required":"yes","param":"array $commentarr Contains information on the comment."}],"desc":"Updates an existing comment in the database.","returns":"int Comment was updated if value is 1, or was not updated if value is 0."},"wp_defer_comment_counting":{"params":[{"required":"yes","param":"bool $defer "}],"desc":"Whether to defer comment counting.","returns":"unknown "},"wp_update_comment_count":{"params":[{"required":"yes","param":"int $post_id Post ID"},{"required":"yes","param":"bool $do_deferred Whether to process previously deferred post comment counts"}],"desc":"Updates the comment count for post(s).","returns":"bool True on success, false on failure"},"wp_update_comment_count_now":{"params":[{"required":"yes","param":"int $post_id Post ID"}],"desc":"Updates the comment count for the post.","returns":"bool False on '0' $post_id or if post with ID does not exist. True on success."},"discover_pingback_server_uri":{"params":[{"required":"yes","param":"string $url URL to ping."},{"required":"yes","param":"int $deprecated Not Used."}],"desc":"Finds a pingback server URI based on the given URL.","returns":"bool|string False on failure, string containing URI on success."},"do_all_pings":{"params":[],"desc":"Perform all pingbacks, enclosures, trackbacks, and send to pingback services.","returns":""},"do_trackbacks":{"params":[{"required":"yes","param":"int $post_id Post ID to do trackbacks on."}],"desc":"Perform trackbacks.","returns":""},"generic_ping":{"params":[{"required":"yes","param":"int $post_id Post ID. Not actually used."}],"desc":"Sends pings to all of the ping site services.","returns":"int Same as Post ID from parameter"},"pingback":{"params":[{"required":"yes","param":"string $content Post content to check for links."},{"required":"yes","param":"int $post_ID Post ID."}],"desc":"Pings back the links found in a post.","returns":""},"privacy_ping_filter":{"params":[{"required":"yes","param":"mixed $sites Will return if blog is public, will not return if not public."}],"desc":"Check whether blog is public before returning sites.","returns":"mixed Empty string if blog is not public, returns $sites, if site is public."},"trackback":{"params":[{"required":"yes","param":"string $trackback_url URL to send trackbacks."},{"required":"yes","param":"string $title Title of post."},{"required":"yes","param":"string $excerpt Excerpt of post."},{"required":"yes","param":"int $ID Post ID."}],"desc":"Send a Trackback.","returns":"mixed Database query from update."},"weblog_ping":{"params":[{"required":"yes","param":"string $server Host of blog to connect to."},{"required":"yes","param":"string $path Path to send the ping."}],"desc":"Send a pingback.","returns":""},"clean_comment_cache":{"params":[{"required":"yes","param":"int|array $ids Comment ID or array of comment IDs to remove from cache"}],"desc":"Removes comment ID from the comment cache.","returns":""},"update_comment_cache":{"params":[{"required":"yes","param":"array $comments Array of comment row objects"}],"desc":"Updates the comment cache of given comments.","returns":""},"_close_comments_for_old_posts":{"params":[{"required":"yes","param":"object $posts Post data object."},{"required":"yes","param":"object $query Query object."}],"desc":"Close comments on old posts on the fly, without any extra DB queries.  Hooked to the_posts.","returns":"object "},"_close_comments_for_old_post":{"params":[{"required":"yes","param":"bool $open Comments open or closed"},{"required":"yes","param":"int $post_id Post ID"}],"desc":"Close comments on an old post.  Hooked to comments_open and pings_open.","returns":"bool $open"},"get_query_var":{"params":[{"required":"yes","param":"string $var The variable key to retrieve."}],"desc":"Retrieve variable in the WP_Query class.","returns":"mixed "},"get_queried_object":{"params":[],"desc":"Retrieve the currently-queried object.  Wrapper for $wp_query->get_queried_object()","returns":"object "},"get_queried_object_id":{"params":[],"desc":"Retrieve ID of the current queried object. Wrapper for $wp_query->get_queried_object_id()","returns":"int "},"set_query_var":{"params":[{"required":"yes","param":"string $var Query variable key."},{"required":"yes","param":"mixed $value "}],"desc":"Set query variable.","returns":"null "},"query_posts":{"params":[{"required":"yes","param":"string $query "}],"desc":"Set up The Loop with query parameters.","returns":"array List of posts"},"wp_reset_query":{"params":[],"desc":"Destroy the previous query and set up a new query.","returns":""},"wp_reset_postdata":{"params":[],"desc":"After looping through a separate query, this function restores the $post global to the current post in the main query","returns":""},"is_archive":{"params":[],"desc":"Is the query for an archive page?","returns":"bool "},"is_post_type_archive":{"params":[{"required":"no","param":"mixed $post_types Optional. Post type or array of posts types to check against."}],"desc":"Is the query for a post type archive page?","returns":"bool "},"is_attachment":{"params":[],"desc":"Is the query for an attachment page?","returns":"bool "},"is_author":{"params":[{"required":"no","param":"mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames"}],"desc":"Is the query for an author archive page?","returns":"bool "},"is_category":{"params":[{"required":"no","param":"mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs."}],"desc":"Is the query for a category archive page?","returns":"bool "},"is_tag":{"params":[{"required":"no","param":"mixed $slug Optional. Tag slug or array of slugs."}],"desc":"Is the query for a tag archive page?","returns":"bool "},"is_tax":{"params":[{"required":"no","param":"mixed $taxonomy Optional. Taxonomy slug or slugs."},{"required":"no","param":"mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs."}],"desc":"Is the query for a taxonomy archive page?","returns":"bool "},"is_comments_popup":{"params":[],"desc":"Whether the current URL is within the comments popup window.","returns":"bool "},"is_date":{"params":[],"desc":"Is the query for a date archive?","returns":"bool "},"is_day":{"params":[],"desc":"Is the query for a day archive?","returns":"bool "},"is_feed":{"params":[{"required":"no","param":"string|array $feeds Optional feed types to check."}],"desc":"Is the query for a feed?","returns":"bool "},"is_comment_feed":{"params":[],"desc":"Is the query for a comments feed?","returns":"bool "},"is_front_page":{"params":[],"desc":"Is the query for the front page of the site?","returns":"bool True, if front of site."},"is_home":{"params":[],"desc":"Is the query for the blog homepage?","returns":"bool True if blog view homepage."},"is_month":{"params":[],"desc":"Is the query for a month archive?","returns":"bool "},"is_page":{"params":[{"required":"yes","param":"mixed $page Page ID, title, slug, or array of such."}],"desc":"Is the query for a single page?","returns":"bool "},"is_paged":{"params":[],"desc":"Is the query for paged result and not for the first page?","returns":"bool "},"is_preview":{"params":[],"desc":"Is the query for a post or page preview?","returns":"bool "},"is_robots":{"params":[],"desc":"Is the query for the robots file?","returns":"bool "},"is_search":{"params":[],"desc":"Is the query for a search?","returns":"bool "},"is_single":{"params":[{"required":"yes","param":"mixed $post Post ID, title, slug, or array of such."}],"desc":"Is the query for a single post?","returns":"bool "},"is_singular":{"params":[{"required":"no","param":"mixed $post_types Optional. Post Type or array of Post Types"}],"desc":"Is the query for a single post of any post type (post, attachment, page, ... )?","returns":"bool "},"is_time":{"params":[],"desc":"Is the query for a specific time?","returns":"bool "},"is_trackback":{"params":[],"desc":"Is the query for a trackback endpoint call?","returns":"bool "},"is_year":{"params":[],"desc":"Is the query for a specific year?","returns":"bool "},"is_404":{"params":[],"desc":"Is the query a 404 (returns no results)?","returns":"bool "},"is_main_query":{"params":[],"desc":"Is the query the main query?","returns":"bool "},"have_posts":{"params":[],"desc":"Whether current WordPress query has results to loop over.","returns":"bool "},"in_the_loop":{"params":[],"desc":"Whether the caller is in the Loop.","returns":"bool True if caller is within loop, false if loop hasn't started or ended."},"rewind_posts":{"params":[],"desc":"Rewind the loop posts.","returns":"null "},"the_post":{"params":[],"desc":"Iterate the post index in the loop.","returns":""},"have_comments":{"params":[],"desc":"Whether there are comments to loop over.","returns":"bool "},"the_comment":{"params":[],"desc":"Iterate comment index in the comment loop.","returns":"object "},"wp_old_slug_redirect":{"params":[],"desc":"Redirect old slugs to the correct permalink.","returns":"null If no link is found, null is returned."},"setup_postdata":{"params":[{"required":"yes","param":"object $post Post data."}],"desc":"Set up global post data.","returns":"bool True when finished."},"is_child_theme":{"params":[],"desc":"Whether a child theme is in use.","returns":"bool true if a child theme is in use, false otherwise."},"get_stylesheet":{"params":[],"desc":"Retrieve name of the current stylesheet.","returns":"string Stylesheet name."},"get_stylesheet_directory":{"params":[],"desc":"Retrieve stylesheet directory path for current theme.","returns":"string Path to current theme directory."},"get_stylesheet_directory_uri":{"params":[],"desc":"Retrieve stylesheet directory URI.","returns":"string "},"get_stylesheet_uri":{"params":[],"desc":"Retrieve URI of current theme stylesheet.","returns":"string "},"get_locale_stylesheet_uri":{"params":[],"desc":"Retrieve localized stylesheet URI.","returns":"string "},"get_template":{"params":[],"desc":"Retrieve name of the current theme.","returns":"string Template name."},"get_template_directory":{"params":[],"desc":"Retrieve current theme directory.","returns":"string Template directory path."},"get_template_directory_uri":{"params":[],"desc":"Retrieve theme directory URI.","returns":"string Template directory URI."},"get_theme_data":{"params":[{"required":"yes","param":"string $theme_file Theme file path."}],"desc":"Retrieve theme data from parsed theme file.","returns":"array Theme data."},"get_themes":{"params":[],"desc":"Retrieve list of themes with theme data in theme directory.","returns":"array Theme list with theme data."},"get_theme_roots":{"params":[],"desc":"Retrieve theme roots.","returns":"array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root."},"get_theme":{"params":[{"required":"yes","param":"string $theme Theme name."}],"desc":"Retrieve theme data.","returns":"array|null Null, if theme name does not exist. Theme data, if exists."},"get_current_theme":{"params":[],"desc":"Retrieve current theme display name.","returns":"string "},"register_theme_directory":{"params":[{"required":"yes","param":"string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR"}],"desc":"Register a directory that contains themes.","returns":"bool "},"search_theme_directories":{"params":[],"desc":"Search all registered theme directories for complete and valid themes.","returns":"array Valid themes found"},"get_theme_root":{"params":[{"required":"yes","param":"string $stylesheet_or_template The stylesheet or template name of the theme"}],"desc":"Retrieve path to themes directory.","returns":"string Theme path."},"get_theme_root_uri":{"params":[{"required":"yes","param":"string $stylesheet_or_template The stylesheet or template name of the theme"}],"desc":"Retrieve URI for themes directory.","returns":"string Themes URI."},"get_raw_theme_root":{"params":[{"required":"yes","param":"string $stylesheet_or_template The stylesheet or template name of the theme"}],"desc":"Get the raw theme root relative to the content directory with no filters applied.","returns":"string Theme root"},"get_query_template":{"params":[{"required":"yes","param":"string $type Filename without extension."},{"required":"no","param":"array $templates An optional list of template candidates"}],"desc":"Retrieve path to a template","returns":"string Full path to file."},"get_index_template":{"params":[],"desc":"Retrieve path of index template in current or parent template.","returns":"string "},"get_404_template":{"params":[],"desc":"Retrieve path of 404 template in current or parent template.","returns":"string "},"get_archive_template":{"params":[],"desc":"Retrieve path of archive template in current or parent template.","returns":"string "},"get_author_template":{"params":[],"desc":"Retrieve path of author template in current or parent template.","returns":"string "},"get_category_template":{"params":[],"desc":"Retrieve path of category template in current or parent template.","returns":"string "},"get_tag_template":{"params":[],"desc":"Retrieve path of tag template in current or parent template.","returns":"string "},"get_taxonomy_template":{"params":[],"desc":"Retrieve path of taxonomy template in current or parent template.","returns":"string "},"get_date_template":{"params":[],"desc":"Retrieve path of date template in current or parent template.","returns":"string "},"get_home_template":{"params":[],"desc":"Retrieve path of home template in current or parent template.","returns":"string "},"get_front_page_template":{"params":[],"desc":"Retrieve path of front-page template in current or parent template.","returns":"string "},"get_page_template":{"params":[],"desc":"Retrieve path of page template in current or parent template.","returns":"string "},"get_paged_template":{"params":[],"desc":"Retrieve path of paged template in current or parent template.","returns":"string "},"get_search_template":{"params":[],"desc":"Retrieve path of search template in current or parent template.","returns":"string "},"get_single_template":{"params":[],"desc":"Retrieve path of single template in current or parent template.","returns":"string "},"get_attachment_template":{"params":[],"desc":"Retrieve path of attachment template in current or parent template.","returns":"string "},"get_comments_popup_template":{"params":[],"desc":"Retrieve path of comment popup template in current or parent template.","returns":"string "},"locate_template":{"params":[{"required":"yes","param":"string|array $template_names Template file(s) to search for, in order."},{"required":"yes","param":"bool $load If true the template file will be loaded if it is found."},{"required":"yes","param":"bool $require_once Whether to require_once or require. Default true. Has no effect if $load is false."}],"desc":"Retrieve the name of the highest priority template file that exists.","returns":"string The template filename if one is located."},"load_template":{"params":[{"required":"yes","param":"string $_template_file Path to template file."},{"required":"yes","param":"bool $require_once Whether to require_once or require. Default true."}],"desc":"Require the template file with WordPress environment.","returns":""},"locale_stylesheet":{"params":[],"desc":"Display localized stylesheet link element.","returns":""},"preview_theme":{"params":[],"desc":"Start preview theme output buffer.","returns":""},"_preview_theme_template_filter":{"params":[],"desc":"Private function to modify the current template when previewing a theme","returns":"string "},"_preview_theme_stylesheet_filter":{"params":[],"desc":"Private function to modify the current stylesheet when previewing a theme","returns":"string "},"preview_theme_ob_filter":{"params":[{"required":"yes","param":"string $content "}],"desc":"Callback function for ob_start() to capture all links in the theme.","returns":"string "},"preview_theme_ob_filter_callback":{"params":[{"required":"yes","param":"array $matches "}],"desc":"Manipulates preview theme links in order to control and maintain location.","returns":"string "},"switch_theme":{"params":[{"required":"yes","param":"string $template Template name"},{"required":"yes","param":"string $stylesheet Stylesheet name."}],"desc":"Switches current theme to new template and stylesheet names.","returns":""},"validate_current_theme":{"params":[],"desc":"Checks that current theme files 'index.php' and 'style.css' exists.","returns":"bool "},"get_theme_mods":{"params":[],"desc":"Retrieve all theme modifications.","returns":"array Theme modifications."},"get_theme_mod":{"params":[{"required":"yes","param":"string $name Theme modification name."},{"required":"yes","param":"bool|string $default "}],"desc":"Retrieve theme modification value for the current theme.","returns":"string "},"set_theme_mod":{"params":[{"required":"yes","param":"string $name Theme modification name."},{"required":"yes","param":"string $value theme modification value."}],"desc":"Update theme modification value for the current theme.","returns":""},"remove_theme_mod":{"params":[{"required":"yes","param":"string $name Theme modification name."}],"desc":"Remove theme modification name from current theme list.","returns":"null "},"remove_theme_mods":{"params":[],"desc":"Remove theme modifications option for current theme.","returns":""},"get_header_textcolor":{"params":[],"desc":"Retrieve text color for custom header.","returns":"string "},"header_textcolor":{"params":[],"desc":"Display text color for custom header.","returns":""},"get_header_image":{"params":[],"desc":"Retrieve header image for custom header.","returns":"string "},"get_random_header_image":{"params":[],"desc":"Get random header image from registered images in theme.","returns":"string Path to header image"},"is_random_header_image":{"params":[{"required":"yes","param":"string $type The random pool to use. any|default|uploaded"}],"desc":"Check if random header image is in use.","returns":"boolean "},"header_image":{"params":[],"desc":"Display header image path.","returns":""},"get_uploaded_header_images":{"params":[],"desc":"Get the header images uploaded for the current theme.","returns":"array "},"add_custom_image_header":{"params":[{"required":"yes","param":"callback $header_callback Call on 'wp_head' action."},{"required":"yes","param":"callback $admin_header_callback Call on custom header administration screen."},{"required":"no","param":"callback $admin_image_div_callback Output a custom header image div on the custom header administration screen. Optional."}],"desc":"Add callbacks for image header display.","returns":""},"remove_custom_image_header":{"params":[],"desc":"Remove image header support.","returns":"bool Whether support was removed."},"register_default_headers":{"params":[{"required":"yes","param":"array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys."}],"desc":"Register a selection of default headers to be displayed by the custom header admin UI.","returns":""},"unregister_default_headers":{"params":[{"required":"yes","param":"string|array $header The header string id (key of array) to remove, or an array thereof."}],"desc":"Unregister default headers.","returns":"True on success, false on failure."},"get_background_image":{"params":[],"desc":"Retrieve background image for custom background.","returns":"string "},"background_image":{"params":[],"desc":"Display background image path.","returns":""},"get_background_color":{"params":[],"desc":"Retrieve value for custom background color.","returns":"string "},"background_color":{"params":[],"desc":"Display background color value.","returns":""},"add_custom_background":{"params":[{"required":"yes","param":"callback $header_callback Call on 'wp_head' action."},{"required":"yes","param":"callback $admin_header_callback Call on custom background administration screen."},{"required":"no","param":"callback $admin_image_div_callback Output a custom background image div on the custom background administration screen. Optional."}],"desc":"Add callbacks for background image display.","returns":""},"remove_custom_background":{"params":[],"desc":"Remove custom background support.","returns":"bool Whether support was removed."},"_custom_background_cb":{"params":[],"desc":"Default custom background callback.","returns":""},"add_editor_style":{"params":[{"required":"no","param":"mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root. Defaults to 'editor-style.css'"}],"desc":"Add callback for custom TinyMCE editor stylesheets.","returns":""},"remove_editor_styles":{"params":[],"desc":"Removes all visual editor stylesheets.","returns":"bool True on success, false if there were no stylesheets to remove."},"add_theme_support":{"params":[{"required":"yes","param":"string $feature the feature being added"}],"desc":"Allows a theme to register its support of a certain feature","returns":""},"get_theme_support":{"params":[{"required":"yes","param":"string $feature the feature to check"}],"desc":"Gets the theme support arguments passed when registering that support","returns":"array The array of extra arguments"},"remove_theme_support":{"params":[{"required":"yes","param":"string $feature the feature being added"}],"desc":"Allows a theme to de-register its support of a certain feature","returns":"bool Whether feature was removed."},"_remove_theme_support":{"params":[],"desc":"Do not use. Removes theme support internally, ignorant of the blacklist.","returns":""},"current_theme_supports":{"params":[{"required":"yes","param":"string $feature the feature being checked"}],"desc":"Checks a theme's support for a given feature","returns":"boolean "},"require_if_theme_supports":{"params":[{"required":"yes","param":"string $feature the feature being checked"},{"required":"yes","param":"string $include the file containing the functions that implement the feature"}],"desc":"Checks a theme's support for a given feature before loading the functions which implement it.","returns":""},"_delete_attachment_theme_mod":{"params":[{"required":"yes","param":"int $id the attachment id"}],"desc":"Checks an attachment being deleted to see if it's a header or background image.","returns":""},"check_theme_switched":{"params":[],"desc":"Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load","returns":""},"set_current_user":{"params":[{"required":"yes","param":"int|null $id User ID."},{"required":"no","param":"string $name Optional. The user's username"}],"desc":"Changes the current user by ID or name.","returns":"object returns wp_set_current_user()"},"get_userdatabylogin":{"params":[{"required":"yes","param":"string $user_login User's username"}],"desc":"Retrieve user info by login name.","returns":"bool|object False on failure, User DB row object"},"get_user_by_email":{"params":[{"required":"yes","param":"string $email User's email address"}],"desc":"Retrieve user info by email.","returns":"bool|object False on failure, User DB row object"},"wp_setcookie":{"params":[{"required":"yes","param":"string $username The user's username"},{"required":"no","param":"string $password Optional. The user's password"},{"required":"no","param":"bool $already_md5 Optional. Whether the password has already been through MD5"},{"required":"no","param":"string $home Optional. Will be used instead of COOKIEPATH if set"},{"required":"no","param":"string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set"},{"required":"no","param":"bool $remember Optional. Remember that the user is logged in"}],"desc":"Sets a cookie for a user who just logged in. This function is deprecated.","returns":""},"wp_clearcookie":{"params":[],"desc":"Clears the authentication cookie, logging the user out. This function is deprecated.","returns":""},"wp_get_cookie_login":{"params":[],"desc":"Gets the user cookie login. This function is deprecated.","returns":"bool Always returns false"},"wp_login":{"params":[{"required":"yes","param":"string $username User's username"},{"required":"yes","param":"string $password User's password"},{"required":"yes","param":"bool $deprecated Not used"}],"desc":"Checks a users login information and logs them in if it checks out. This function is deprecated.","returns":"bool False on login failure, true on successful check"},"wp_set_current_user":{"params":[{"required":"yes","param":"int $id User ID"},{"required":"yes","param":"string $name User's username"}],"desc":"Changes the current user by ID or name.","returns":"WP_User Current user User object"},"wp_get_current_user":{"params":[],"desc":"Retrieve the current user object.","returns":"WP_User Current user WP_User object"},"get_currentuserinfo":{"params":[],"desc":"Populate global variables with information about the currently logged in user.","returns":"bool|null False on XMLRPC Request and invalid auth cookie. Null when current user set"},"get_userdata":{"params":[{"required":"yes","param":"int $user_id User ID"}],"desc":"Retrieve user info by user ID.","returns":"bool|object False on failure, WP_User object on success"},"get_user_by":{"params":[{"required":"yes","param":"string $field The field to retrieve the user with. id | slug | email | login"},{"required":"yes","param":"int|string $value A value for $field. A user ID, slug, email address, or login name."}],"desc":"Retrieve user info by a given field","returns":"bool|object False on failure, WP_User object on success"},"cache_users":{"params":[{"required":"yes","param":"array $user_ids User ID numbers list"}],"desc":"Retrieve info for user lists to prevent multiple queries by get_userdata()","returns":""},"wp_mail":{"params":[{"required":"yes","param":"string|array $to Array or comma-separated list of email addresses to send message."},{"required":"yes","param":"string $subject Email subject"},{"required":"yes","param":"string $message Message contents"},{"required":"no","param":"string|array $headers Optional. Additional headers."},{"required":"no","param":"string|array $attachments Optional. Files to attach."}],"desc":"Send mail, similar to PHP's mail","returns":"bool Whether the email contents were sent successfully."},"wp_authenticate":{"params":[{"required":"yes","param":"string $username User's username"},{"required":"yes","param":"string $password User's password"}],"desc":"Checks a user's login information and logs them in if it checks out.","returns":"WP_Error|WP_User WP_User object if login successful, otherwise WP_Error object."},"wp_logout":{"params":[],"desc":"Log the current user out.","returns":""},"wp_validate_auth_cookie":{"params":[{"required":"no","param":"string $cookie Optional. If used, will validate contents instead of cookie's"},{"required":"no","param":"string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in"}],"desc":"Validates authentication cookie.","returns":"bool|int False if invalid cookie, User ID if valid."},"wp_generate_auth_cookie":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"int $expiration Cookie expiration in seconds"},{"required":"no","param":"string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in"}],"desc":"Generate authentication cookie contents.","returns":"string Authentication cookie contents"},"wp_parse_auth_cookie":{"params":[{"required":"yes","param":"string $cookie "},{"required":"no","param":"string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in"}],"desc":"Parse a cookie into its components","returns":"array Authentication cookie components"},"wp_set_auth_cookie":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"bool $remember Whether to remember the user"}],"desc":"Sets the authentication cookies based User ID.","returns":""},"wp_clear_auth_cookie":{"params":[],"desc":"Removes all of the cookies associated with authentication.","returns":""},"is_user_logged_in":{"params":[],"desc":"Checks if the current visitor is a logged in user.","returns":"bool True if user is logged in, false if not logged in."},"auth_redirect":{"params":[],"desc":"Checks if a user is logged in, if not it redirects them to the login page.","returns":""},"check_admin_referer":{"params":[{"required":"yes","param":"string $action Action nonce"},{"required":"yes","param":"string $query_arg where to look for nonce in $_REQUEST (since 2.5)"}],"desc":"Makes sure that a user was referred from another admin page.","returns":""},"check_ajax_referer":{"params":[{"required":"yes","param":"string $action Action nonce"},{"required":"yes","param":"string $query_arg where to look for nonce in $_REQUEST (since 2.5)"}],"desc":"Verifies the AJAX request to prevent processing requests external of the blog.","returns":""},"wp_redirect":{"params":[{"required":"yes","param":"string $location The path to redirect to"},{"required":"yes","param":"int $status Status code to use"}],"desc":"Redirects to another page.","returns":"bool False if $location is not set"},"wp_sanitize_redirect":{"params":[],"desc":"Sanitizes a URL for use in a redirect.","returns":"string redirect-sanitized URL"},"wp_safe_redirect":{"params":[],"desc":"Performs a safe (local) redirect, using wp_redirect().","returns":"void Does not return anything"},"wp_validate_redirect":{"params":[{"required":"yes","param":"string $location The redirect to validate"},{"required":"yes","param":"string $default The value to return is $location is not allowed"}],"desc":"Validates a URL for use in a redirect.","returns":"string redirect-sanitized URL"},"wp_notify_postauthor":{"params":[{"required":"yes","param":"int $comment_id Comment ID"},{"required":"no","param":"string $comment_type Optional. The comment type either 'comment' (default), 'trackback', or 'pingback'"}],"desc":"Notify an author of a comment/trackback/pingback to one of their posts.","returns":"bool False if user email does not exist. True on completion."},"wp_notify_moderator":{"params":[{"required":"yes","param":"int $comment_id Comment ID"}],"desc":"Notifies the moderator of the blog about a new comment that is awaiting approval.","returns":"bool Always returns true"},"wp_password_change_notification":{"params":[{"required":"yes","param":"object $user User Object"}],"desc":"Notify the blog admin of a user changing password, normally via email.","returns":""},"wp_new_user_notification":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"no","param":"string $plaintext_pass Optional. The user's plaintext password"}],"desc":"Notify the blog admin of a new user, normally via email.","returns":""},"wp_nonce_tick":{"params":[],"desc":"Get the time-dependent variable for nonce creation.","returns":"int "},"wp_verify_nonce":{"params":[{"required":"yes","param":"string $nonce Nonce that was used in the form to verify"},{"required":"yes","param":"string|int $action Should give context to what is taking place and be the same when nonce was created."}],"desc":"Verify that correct nonce was used with time limit.","returns":"bool Whether the nonce check passed or failed."},"wp_create_nonce":{"params":[{"required":"yes","param":"string|int $action Scalar value to add context to the nonce."}],"desc":"Creates a random, one time use token.","returns":"string The one use form token"},"wp_salt":{"params":[{"required":"yes","param":"string $scheme Authentication scheme"}],"desc":"Get salt to add to hashes to help prevent attacks.","returns":"string Salt value"},"wp_hash":{"params":[{"required":"yes","param":"string $data Plain text to hash"}],"desc":"Get hash of given string.","returns":"string Hash of $data"},"wp_hash_password":{"params":[{"required":"yes","param":"string $password Plain text user password to hash"}],"desc":"Create a hash (encrypt) of a plain text password.","returns":"string The hash string of the password"},"wp_check_password":{"params":[{"required":"yes","param":"string $password Plaintext user's password"},{"required":"yes","param":"string $hash Hash of the user's password to check against."}],"desc":"Checks the plaintext password against the encrypted Password.","returns":"bool False, if the $password does not match the hashed password"},"wp_generate_password":{"params":[{"required":"yes","param":"int $length The length of password to generate"},{"required":"yes","param":"bool $special_chars Whether to include standard special characters. Default true."},{"required":"yes","param":"bool $extra_special_chars Whether to include other special characters. Used when generating secret keys and salts. Default false."}],"desc":"Generates a random password drawn from the defined set of characters.","returns":"string The random password"},"wp_rand":{"params":[{"required":"no","param":"int $min Lower limit for the generated number (optional, default is 0)"},{"required":"no","param":"int $max Upper limit for the generated number (optional, default is 4294967295)"}],"desc":"Generates a random number","returns":"int A random number between min and max"},"wp_set_password":{"params":[{"required":"yes","param":"string $password The plaintext new user password"},{"required":"yes","param":"int $user_id User ID"}],"desc":"Updates the user's password with a new encrypted one.","returns":""},"get_avatar":{"params":[{"required":"yes","param":"int|string|object $id_or_email A user ID, email address, or comment object"},{"required":"yes","param":"int $size Size of the avatar image"},{"required":"yes","param":"string $default URL to a default image to use if no avatar is available"},{"required":"yes","param":"string $alt Alternate text to use in image tag. Defaults to blank"}],"desc":"Retrieve the avatar for a user who provided a user ID or email address.","returns":"string <img> tag for the user's avatar"},"wp_text_diff":{"params":[{"required":"yes","param":"string $left_string "old" (left) version of string"},{"required":"yes","param":"string $right_string "new" (right) version of string"},{"required":"no","param":"string|array $args Optional. Change 'title', 'title_left', and 'title_right' defaults."}],"desc":"Displays a human readable HTML representation of the difference between two strings.","returns":"string Empty string if strings are equivalent or HTML with differences."},"get_comment_author":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to retrieve the author. Optional."}],"desc":"Retrieve the author of the current comment.","returns":"string The comment author"},"comment_author":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author. Optional."}],"desc":"Displays the author of the current comment.","returns":""},"get_comment_author_email":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's email. Optional."}],"desc":"Retrieve the email of the author of the current comment.","returns":"string The current comment author's email"},"comment_author_email":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's email. Optional."}],"desc":"Display the email of the author of the current global $comment.","returns":""},"comment_author_email_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Display the html email link to the author of the current comment.","returns":""},"get_comment_author_email_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Return the html email link to the author of the current comment.","returns":""},"get_comment_author_link":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's link. Optional."}],"desc":"Retrieve the html link to the url of the author of the current comment.","returns":"string Comment Author name or HTML link for author's URL"},"comment_author_link":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's link. Optional."}],"desc":"Display the html link to the url of the author of the current comment.","returns":""},"get_comment_author_IP":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's IP address. Optional."}],"desc":"Retrieve the IP address of the author of the current comment.","returns":"string The comment author's IP address."},"comment_author_IP":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's IP address. Optional."}],"desc":"Display the IP address of the author of the current comment.","returns":""},"get_comment_author_url":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the author's URL. Optional."}],"desc":"Retrieve the url of the author of the current comment.","returns":"string "},"comment_author_url":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the author's URL. Optional."}],"desc":"Display the url of the author of the current comment.","returns":""},"get_comment_author_url_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Retrieves the HTML link of the url of the author of the current comment.","returns":"string The HTML link between the $before and $after parameters"},"comment_author_url_link":{"params":[{"required":"yes","param":"string $linktext The text to display instead of the comment author's email address"},{"required":"yes","param":"string $before The text or HTML to display before the email link."},{"required":"yes","param":"string $after The text or HTML to display after the email link."}],"desc":"Displays the HTML link of the url of the author of the current comment.","returns":""},"comment_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list"},{"required":"no","param":"int $comment_id An optional comment ID"},{"required":"no","param":"int $post_id An optional post ID"},{"required":"yes","param":"bool $echo Whether comment_class should echo or return"}],"desc":"Generates semantic classes for each comment element","returns":""},"get_comment_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list"},{"required":"no","param":"int $comment_id An optional comment ID"},{"required":"no","param":"int $post_id An optional post ID"}],"desc":"Returns the classes for the comment div as an array","returns":"array Array of classes"},"get_comment_date":{"params":[{"required":"yes","param":"string $d The format of the date (defaults to user's config)"},{"required":"no","param":"int $comment_ID The ID of the comment for which to get the date. Optional."}],"desc":"Retrieve the comment date of the current comment.","returns":"string The comment's date"},"comment_date":{"params":[{"required":"yes","param":"string $d The format of the date (defaults to user's config)"},{"required":"no","param":"int $comment_ID The ID of the comment for which to print the date. Optional."}],"desc":"Display the comment date of the current comment.","returns":""},"get_comment_excerpt":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the excerpt. Optional."}],"desc":"Retrieve the excerpt of the current comment.","returns":"string The maybe truncated comment with 20 words or less"},"comment_excerpt":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the excerpt. Optional."}],"desc":"Display the excerpt of the current comment.","returns":""},"get_comment_ID":{"params":[],"desc":"Retrieve the comment id of the current comment.","returns":"int The comment ID"},"comment_ID":{"params":[],"desc":"Displays the comment id of the current comment.","returns":""},"get_comment_link":{"params":[{"required":"yes","param":"object|string|int $comment Comment to retrieve."},{"required":"no","param":"array $args Optional args."}],"desc":"Retrieve the link to a given comment.","returns":"string The permalink to the given comment."},"get_comments_link":{"params":[{"required":"no","param":"int $post_id Optional post id"}],"desc":"Retrieves the link to the current post comments.","returns":"string The link to the comments"},"comments_link":{"params":[{"required":"yes","param":"string $deprecated Not Used"},{"required":"yes","param":"bool $deprecated_2 Not Used"}],"desc":"Displays the link to the current post comments.","returns":""},"get_comments_number":{"params":[{"required":"yes","param":"int $post_id The Post ID"}],"desc":"Retrieve the amount of comments a post has.","returns":"int The number of comments a post has"},"comments_number":{"params":[{"required":"yes","param":"string $zero Text for no comments"},{"required":"yes","param":"string $one Text for one comment"},{"required":"yes","param":"string $more Text for more than one comment"},{"required":"yes","param":"string $deprecated Not used."}],"desc":"Display the language string for the number of comments the current post has.","returns":""},"get_comment_text":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the text. Optional."}],"desc":"Retrieve the text of the current comment.","returns":"string The comment content"},"comment_text":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to print the text. Optional."}],"desc":"Displays the text of the current comment.","returns":""},"get_comment_time":{"params":[{"required":"no","param":"string $d Optional. The format of the time (defaults to user's config)"},{"required":"yes","param":"bool $gmt Whether to use the GMT date"},{"required":"yes","param":"bool $translate Whether to translate the time (for use in feeds)"}],"desc":"Retrieve the comment time of the current comment.","returns":"string The formatted time"},"comment_time":{"params":[{"required":"no","param":"string $d Optional. The format of the time (defaults to user's config)"}],"desc":"Display the comment time of the current comment.","returns":""},"get_comment_type":{"params":[{"required":"no","param":"int $comment_ID The ID of the comment for which to get the type. Optional."}],"desc":"Retrieve the comment type of the current comment.","returns":"string The comment type"},"comment_type":{"params":[{"required":"yes","param":"string $commenttxt The string to display for comment type"},{"required":"yes","param":"string $trackbacktxt The string to display for trackback type"},{"required":"yes","param":"string $pingbacktxt The string to display for pingback type"}],"desc":"Display the comment type of the current comment.","returns":""},"get_trackback_url":{"params":[],"desc":"Retrieve The current post's trackback URL.","returns":"string The trackback URL after being filtered"},"trackback_url":{"params":[{"required":"yes","param":"bool $deprecated_echo Remove backwards compat in 2.5"}],"desc":"Displays the current post's trackback URL.","returns":"void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead."},"trackback_rdf":{"params":[{"required":"yes","param":"int $deprecated Not used (Was $timezone = 0)"}],"desc":"Generates and displays the RDF for the trackback information of current post.","returns":""},"comments_open":{"params":[{"required":"no","param":"int $post_id An optional post ID to check instead of the current post."}],"desc":"Whether the current post is open for comments.","returns":"bool True if the comments are open"},"pings_open":{"params":[{"required":"no","param":"int $post_id An optional post ID to check instead of the current post."}],"desc":"Whether the current post is open for pings.","returns":"bool True if pings are accepted"},"wp_comment_form_unfiltered_html_nonce":{"params":[],"desc":"Displays form token for unfiltered comments.","returns":""},"comments_template":{"params":[{"required":"no","param":"string $file Optional, default '/comments.php'. The file to load"},{"required":"no","param":"bool $separate_comments Optional, whether to separate the comments by comment type. Default is false."}],"desc":"Loads the comment template specified in $file.","returns":"null Returns null if no comments appear"},"comments_popup_script":{"params":[{"required":"no","param":"int $width Optional. The width of the popup window"},{"required":"no","param":"int $height Optional. The height of the popup window"},{"required":"no","param":"string $file Optional. Sets the location of the popup window"}],"desc":"Displays the JS popup script to show a comment.","returns":""},"comments_popup_link":{"params":[{"required":"yes","param":"string $zero The string to display when no comments"},{"required":"yes","param":"string $one The string to display when only one comment is available"},{"required":"yes","param":"string $more The string to display when there are more than one comment"},{"required":"yes","param":"string $css_class The CSS class to use for comments"},{"required":"yes","param":"string $none The string to display when comments have been turned off"}],"desc":"Displays the link to the comments popup window for the current post ID.","returns":"null Returns null on single posts and pages."},"get_comment_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int $comment Optional. Comment being replied to."},{"required":"no","param":"int $post Optional. Post that the comment is going to be displayed on."}],"desc":"Retrieve HTML content for reply to comment link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"comment_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int $comment Optional. Comment being replied to."},{"required":"no","param":"int $post Optional. Post that the comment is going to be displayed on."}],"desc":"Displays the HTML content for reply to comment link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"get_post_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int|object $post Optional. Post that the comment is going to be displayed on. Defaults to current post."}],"desc":"Retrieve HTML content for reply to post link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"post_reply_link":{"params":[{"required":"no","param":"array $args Optional. Override default options."},{"required":"no","param":"int|object $post Optional. Post that the comment is going to be displayed on."}],"desc":"Displays the HTML content for reply to post link.","returns":"string|bool|null Link to show comment form, if successful. False, if comments are closed."},"get_cancel_comment_reply_link":{"params":[{"required":"no","param":"string $text Optional. Text to display for cancel reply link."}],"desc":"Retrieve HTML content for cancel comment reply link.","returns":""},"cancel_comment_reply_link":{"params":[{"required":"no","param":"string $text Optional. Text to display for cancel reply link."}],"desc":"Display HTML content for cancel comment reply link.","returns":""},"get_comment_id_fields":{"params":[],"desc":"Retrieve hidden input HTML for replying to comments.","returns":"string Hidden input HTML for replying to comments"},"comment_id_fields":{"params":[],"desc":"Output hidden input HTML for replying to comments.","returns":""},"comment_form_title":{"params":[{"required":"no","param":"string $noreplytext Optional. Text to display when not replying to a comment."},{"required":"no","param":"string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to."},{"required":"no","param":"string $linktoparent Optional. Boolean to control making the author's name a link to their comment."}],"desc":"Display text based on comment reply status. Only affects users with Javascript disabled.","returns":""},"wp_list_comments":{"params":[{"required":"yes","param":"string|array $args Formatting options"},{"required":"no","param":"array $comments Optional array of comment objects. Defaults to $wp_query->comments"}],"desc":"List comments","returns":""},"comment_form":{"params":[{"required":"yes","param":"array $args Options for strings, fields etc in the form"},{"required":"yes","param":"mixed $post_id Post ID to generate the form for, uses the current post if null"}],"desc":"Outputs a complete commenting form for use within a template.","returns":"void "},"is_wp_error":{"params":[{"required":"yes","param":"mixed $thing Check if unknown variable is WordPress Error object."}],"desc":"Check whether variable is a WordPress Error.","returns":"bool True, if WP_Error. False, if not WP_Error."},"image_constrain_size_for_editor":{"params":[{"required":"yes","param":"int $width Width of the image"},{"required":"yes","param":"int $height Height of the image"},{"required":"yes","param":"string|array $size Size of what the result image should be."}],"desc":"Scale down the default size of an image.","returns":"array Width and height of what the result image should resize to."},"image_hwstring":{"params":[{"required":"no","param":"int|string $width Optional. Width attribute value."},{"required":"no","param":"int|string $height Optional. Height attribute value."}],"desc":"Retrieve width and height attributes using given width and height values.","returns":"string HTML attributes for width and, or height."},"image_downsize":{"params":[{"required":"yes","param":"int $id Attachment ID for image."},{"required":"no","param":"array|string $size Optional, default is 'medium'. Size of image, either array or string."}],"desc":"Scale an image to fit a particular size (such as 'thumb' or 'medium').","returns":"bool|array False on failure, array on success."},"add_image_size":{"params":[],"desc":"Registers a new image size","returns":""},"set_post_thumbnail_size":{"params":[],"desc":"Registers an image size for the post thumbnail","returns":""},"get_image_tag":{"params":[{"required":"yes","param":"int $id Attachment ID."},{"required":"yes","param":"string $alt Image Description for the alt attribute."},{"required":"yes","param":"string $title Image Description for the title attribute."},{"required":"yes","param":"string $align Part of the class name for aligning the image."},{"required":"no","param":"string $size Optional. Default is 'medium'."}],"desc":"An <img src /> tag for an image attachment, scaling it down if requested.","returns":"string HTML IMG element for given image attachment"},"wp_load_image":{"params":[{"required":"yes","param":"string $file Filename of the image to load."}],"desc":"Load an image from a string, if PHP supports it.","returns":"resource The resulting image resource on success, Error string on failure."},"wp_constrain_dimensions":{"params":[{"required":"yes","param":"int $current_width Current width of the image."},{"required":"yes","param":"int $current_height Current height of the image."},{"required":"no","param":"int $max_width Optional. Maximum wanted width."},{"required":"no","param":"int $max_height Optional. Maximum wanted height."}],"desc":"Calculates the new dimensions for a downsampled image.","returns":"array First item is the width, the second item is the height."},"image_resize_dimensions":{"params":[{"required":"yes","param":"int $orig_w Original width."},{"required":"yes","param":"int $orig_h Original height."},{"required":"yes","param":"int $dest_w New width."},{"required":"yes","param":"int $dest_h New height."},{"required":"no","param":"bool $crop Optional, default is false. Whether to crop image or resize."}],"desc":"Retrieve calculated resized dimensions for use in imagecopyresampled().","returns":"bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function."},"image_resize":{"params":[{"required":"yes","param":"string $file Image file path."},{"required":"yes","param":"int $max_w Maximum width to resize to."},{"required":"yes","param":"int $max_h Maximum height to resize to."},{"required":"no","param":"bool $crop Optional. Whether to crop image or resize."},{"required":"no","param":"string $suffix Optional. File suffix."},{"required":"no","param":"string $dest_path Optional. New image file path."},{"required":"no","param":"int $jpeg_quality Optional, default is 90. Image quality percentage."}],"desc":"Scale down an image to fit a particular size and save a new copy of the image.","returns":"mixed WP_Error on failure. String with new destination path."},"image_make_intermediate_size":{"params":[{"required":"yes","param":"string $file File path."},{"required":"yes","param":"int $width Image width."},{"required":"yes","param":"int $height Image height."},{"required":"no","param":"bool $crop Optional, default is false. Whether to crop image to specified height and width or resize."}],"desc":"Resize an image to make a thumbnail or intermediate size.","returns":"bool|array False, if no image was created. Metadata array on success."},"image_get_intermediate_size":{"params":[{"required":"yes","param":"int $post_id Attachment ID for image."},{"required":"no","param":"array|string $size Optional, default is 'thumbnail'. Size of image, either array or string."}],"desc":"Retrieve the image's intermediate size (resized) path, width, and height.","returns":"bool|array False on failure or array of file path, width, and height on success."},"get_intermediate_image_sizes":{"params":[],"desc":"Get the available image sizes","returns":"array Returns a filtered array of image size strings"},"wp_get_attachment_image_src":{"params":[{"required":"yes","param":"int $attachment_id Image attachment ID."},{"required":"no","param":"string $size Optional, default is 'thumbnail'."},{"required":"no","param":"bool $icon Optional, default is false. Whether it is an icon."}],"desc":"Retrieve an image to represent an attachment.","returns":"bool|array Returns an array (url, width, height), or false, if no image is available."},"wp_get_attachment_image":{"params":[{"required":"yes","param":"int $attachment_id Image attachment ID."},{"required":"no","param":"string $size Optional, default is 'thumbnail'."},{"required":"no","param":"bool $icon Optional, default is false. Whether it is an icon."}],"desc":"Get an HTML img element representing an image attachment","returns":"string HTML img element or empty string on failure."},"_wp_post_thumbnail_class_filter":{"params":[{"required":"yes","param":"array $attr Attributes including src, class, alt, title"}],"desc":"Adds a 'wp-post-image' class to post thumbnails Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to dynamically add/remove itself so as to only filter post thumbnails","returns":"array "},"_wp_post_thumbnail_class_filter_add":{"params":[],"desc":"Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter","returns":""},"_wp_post_thumbnail_class_filter_remove":{"params":[],"desc":"Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter","returns":""},"img_caption_shortcode":{"params":[{"required":"yes","param":"array $attr Attributes attributed to the shortcode."},{"required":"no","param":"string $content Optional. Shortcode content."}],"desc":"The Caption shortcode.","returns":"string "},"gallery_shortcode":{"params":[{"required":"yes","param":"array $attr Attributes of the shortcode."}],"desc":"The Gallery shortcode.","returns":"string HTML content to display gallery."},"previous_image_link":{"params":[{"required":"no","param":"string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;"},{"required":"no","param":"string $text Optional, default is false. If included, link will reflect $text variable."}],"desc":"Display previous image link that has the same post parent.","returns":"string HTML content."},"next_image_link":{"params":[{"required":"no","param":"string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;"},{"required":"no","param":"string $text Optional, default is false. If included, link will reflect $text variable."}],"desc":"Display next image link that has the same post parent.","returns":"string HTML content."},"adjacent_image_link":{"params":[{"required":"no","param":"bool $prev Optional. Default is true to display previous link, false for next."}],"desc":"Display next or previous image link that has the same post parent.","returns":""},"get_attachment_taxonomies":{"params":[{"required":"yes","param":"int|array|object $attachment Attachment ID, Attachment data array, or Attachment data object."}],"desc":"Retrieve taxonomies attached to the attachment.","returns":"array Empty array on failure. List of taxonomies on success."},"gd_edit_image_support":{"params":[{"required":"yes","param":"string $mime_type "}],"desc":"Check if the installed version of GD supports particular image type","returns":"bool "},"wp_imagecreatetruecolor":{"params":[{"required":"yes","param":"int $width Image width"},{"required":"yes","param":"int $height Image height"}],"desc":"Create new GD image resource with transparency support","returns":"image resource"},"wp_embed_register_handler":{"params":[],"desc":"Register an embed handler. This function should probably only be used for sites that do not support oEmbed.","returns":""},"wp_embed_unregister_handler":{"params":[],"desc":"Unregister a previously registered embed handler.","returns":""},"wp_embed_defaults":{"params":[],"desc":"Create default array of embed parameters.","returns":"array Default embed parameters."},"wp_expand_dimensions":{"params":[{"required":"yes","param":"int $example_width The width of an example embed."},{"required":"yes","param":"int $example_height The height of an example embed."},{"required":"yes","param":"int $max_width The maximum allowed width."},{"required":"yes","param":"int $max_height The maximum allowed height."}],"desc":"Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.","returns":"array The maximum possible width and height based on the example ratio."},"wp_oembed_get":{"params":[{"required":"yes","param":"string $url The URL that should be embedded."},{"required":"yes","param":"array $args Additional arguments and parameters."}],"desc":"Attempts to fetch the embed HTML for a provided URL using oEmbed.","returns":"string The original URL on failure or the embed HTML on success."},"wp_oembed_add_provider":{"params":[{"required":"yes","param":"string $format The format of URL that this provider can handle. You can use asterisks as wildcards."},{"required":"yes","param":"string $provider The URL to the oEmbed provider."},{"required":"yes","param":"boolean $regex Whether the $format parameter is in a regex format."}],"desc":"Adds a URL format and oEmbed provider URL pair.","returns":""},"wp_maybe_load_embeds":{"params":[],"desc":"Determines if default embed handlers should be loaded.","returns":""},"wp_embed_handler_googlevideo":{"params":[{"required":"yes","param":"array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}."},{"required":"yes","param":"array $attr Embed attributes."},{"required":"yes","param":"string $url The original URL that was matched by the regex."},{"required":"yes","param":"array $rawattr The original unmodified attributes."}],"desc":"The Google Video embed handler callback. Google Video does not support oEmbed.","returns":"string The embed HTML."},"wp_cache_add":{"params":[{"required":"yes","param":"int|string $key The cache key to use for retrieval later"},{"required":"yes","param":"mixed $data The data to add to the cache store"},{"required":"yes","param":"string $group The group to add the cache to"},{"required":"yes","param":"int $expire When the cache data should be expired"}],"desc":"Adds data to the cache, if the cache key doesn't already exist.","returns":"unknown "},"wp_cache_close":{"params":[],"desc":"Closes the cache.","returns":"bool Always returns True"},"wp_cache_decr":{"params":[{"required":"yes","param":"int|string $key The cache key to increment"},{"required":"yes","param":"int $offset The amount by which to decrement the item's value. Default is 1."},{"required":"yes","param":"string $group The group the key is in."}],"desc":"Decrement numeric cache item's value","returns":"false|int False on failure, the item's new value on success."},"wp_cache_delete":{"params":[{"required":"yes","param":"int|string $key What the contents in the cache are called"},{"required":"yes","param":"string $group Where the cache contents are grouped"}],"desc":"Removes the cache contents matching key and group.","returns":"bool True on successful removal, false on failure"},"wp_cache_flush":{"params":[],"desc":"Removes all cache items.","returns":"bool Always returns true"},"wp_cache_get":{"params":[{"required":"yes","param":"int|string $key What the contents in the cache are called"},{"required":"yes","param":"string $group Where the cache contents are grouped"},{"required":"yes","param":"bool $force Whether to force an update of the local cache from the persistent cache (default is false)"}],"desc":"Retrieves the cache contents from the cache by key and group.","returns":"bool|mixed False on failure to retrieve contents or the cache contents on success"},"wp_cache_incr":{"params":[{"required":"yes","param":"int|string $key The cache key to increment"},{"required":"yes","param":"int $offset The amount by which to increment the item's value. Default is 1."},{"required":"yes","param":"string $group The group the key is in."}],"desc":"Increment numeric cache item's value","returns":"false|int False on failure, the item's new value on success."},"wp_cache_init":{"params":[],"desc":"Sets up Object Cache Global and assigns it.","returns":""},"wp_cache_replace":{"params":[{"required":"yes","param":"int|string $key What to call the contents in the cache"},{"required":"yes","param":"mixed $data The contents to store in the cache"},{"required":"yes","param":"string $group Where to group the cache contents"},{"required":"yes","param":"int $expire When to expire the cache contents"}],"desc":"Replaces the contents of the cache with new data.","returns":"bool False if cache key and group already exist, true on success"},"wp_cache_set":{"params":[{"required":"yes","param":"int|string $key What to call the contents in the cache"},{"required":"yes","param":"mixed $data The contents to store in the cache"},{"required":"yes","param":"string $group Where to group the cache contents"},{"required":"yes","param":"int $expire When to expire the cache contents"}],"desc":"Saves the data to the cache.","returns":"bool False if cache key and group already exist, true on success"},"wp_cache_add_global_groups":{"params":[{"required":"yes","param":"string|array $groups A group or an array of groups to add"}],"desc":"Adds a group or set of groups to the list of global groups.","returns":""},"wp_cache_add_non_persistent_groups":{"params":[{"required":"yes","param":"string|array $groups A group or an array of groups to add"}],"desc":"Adds a group or set of groups to the list of non-persistent groups.","returns":""},"wp_cache_reset":{"params":[],"desc":"Reset internal cache keys and structures.  If the cache backend uses global blog or site IDs as part of its cache keys, this function instructs the backend to reset those keys and perform any cleanup since blog or site IDs have changed since cache init.","returns":""},"wp_initial_constants":{"params":[],"desc":"Defines initial WordPress constants","returns":""},"wp_plugin_directory_constants":{"params":[],"desc":"Defines plugin directory WordPress constants","returns":""},"wp_cookie_constants":{"params":[],"desc":"Defines cookie related WordPress constants","returns":""},"wp_ssl_constants":{"params":[],"desc":"Defines cookie related WordPress constants","returns":""},"wp_functionality_constants":{"params":[],"desc":"Defines functionality related WordPress constants","returns":""},"wp_templating_constants":{"params":[],"desc":"Defines templating related WordPress constants","returns":""},"_":{"params":[],"desc":"","returns":""},"mb_substr":{"params":[],"desc":"","returns":""},"_mb_substr":{"params":[],"desc":"","returns":""},"hash_hmac":{"params":[],"desc":"","returns":""},"_hash_hmac":{"params":[],"desc":"","returns":""},"json_decode":{"params":[],"desc":"","returns":""},"_json_decode_object_helper":{"params":[],"desc":"","returns":""},"wp_widget_rss_output":{"params":[{"required":"yes","param":"string|array|object $rss RSS url."},{"required":"yes","param":"array $args Widget arguments."}],"desc":"Display the RSS entries in a list.","returns":""},"wp_widget_rss_form":{"params":[{"required":"yes","param":"array|string $args Values for input fields."},{"required":"yes","param":"array $inputs Override default display options."}],"desc":"Display RSS widget options form.","returns":""},"wp_widget_rss_process":{"params":[{"required":"yes","param":"array $widget_rss RSS widget feed data. Expects unescaped data."},{"required":"no","param":"bool $check_feed Optional, default is true. Whether to check feed for errors."}],"desc":"Process RSS feed widget data and optionally retrieve feed items.","returns":"array "},"wp_widgets_init":{"params":[],"desc":"Register all of the default WordPress widgets on startup.","returns":""},"get_all_category_ids":{"params":[],"desc":"Retrieves all category IDs.","returns":"object List of all of the category IDs."},"get_categories":{"params":[{"required":"no","param":"string|array $args Optional. Change the defaults retrieving categories."}],"desc":"Retrieve list of category objects.","returns":"array List of categories."},"get_category":{"params":[{"required":"yes","param":"int|object $category Category ID or Category row object"},{"required":"no","param":"string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional. Default is raw or no WordPress defined filter will applied."}],"desc":"Retrieves category data given a category ID or category object.","returns":"mixed Category data in type defined by $output parameter."},"get_category_by_path":{"params":[{"required":"yes","param":"string $category_path URL containing category slugs."},{"required":"no","param":"bool $full_match Optional. Whether full path should be matched."},{"required":"no","param":"string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N"}],"desc":"Retrieve category based on URL containing the category slug.","returns":"null|object|array Null on failure. Type is based on $output value."},"get_category_by_slug":{"params":[{"required":"yes","param":"string $slug The category slug."}],"desc":"Retrieve category object by category slug.","returns":"object Category data object"},"get_cat_ID":{"params":[{"required":"no","param":"string $cat_name Optional. Default is 'General' and can be any category name."}],"desc":"Retrieve the ID of a category from its name.","returns":"int 0, if failure and ID of category on success."},"get_cat_name":{"params":[{"required":"yes","param":"int $cat_id Category ID"}],"desc":"Retrieve the name of a category from its ID.","returns":"string Category name, or an empty string if category doesn't exist."},"cat_is_ancestor_of":{"params":[{"required":"yes","param":"int|object $cat1 ID or object to check if this is the parent category."},{"required":"yes","param":"int|object $cat2 The child category."}],"desc":"Check if a category is an ancestor of another category.","returns":"bool Whether $cat2 is child of $cat1"},"sanitize_category":{"params":[{"required":"yes","param":"object|array $category Category data"},{"required":"no","param":"string $context Optional. Default is 'display'."}],"desc":"Sanitizes category data based on context.","returns":"object|array Same type as $category with sanitized data for safe use."},"sanitize_category_field":{"params":[{"required":"yes","param":"string $field Category key to sanitize"},{"required":"yes","param":"mixed $value Category value to sanitize"},{"required":"yes","param":"int $cat_id Category ID"},{"required":"yes","param":"string $context What filter to use, 'raw', 'display', etc."}],"desc":"Sanitizes data in single category key field.","returns":"mixed Same type as $value after $value has been sanitized."},"get_tags":{"params":[{"required":"yes","param":"string|array $args Tag arguments to use when retrieving tags."}],"desc":"Retrieves all post tags.","returns":"array List of tags."},"get_tag":{"params":[{"required":"yes","param":"int|object $tag "},{"required":"no","param":"string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional. Default is raw or no WordPress defined filter will applied."}],"desc":"Retrieve post tag by tag ID or tag object.","returns":"object|array Return type based on $output value."},"clean_category_cache":{"params":[{"required":"yes","param":"int $id Category ID"}],"desc":"Remove the category cache data based on ID.","returns":""},"_make_cat_compat":{"params":[{"required":"yes","param":"array|object $category Category Row object or array"}],"desc":"Update category structure to old pre 2.3 from new taxonomy structure.","returns":""},"_wp_http_get_object":{"params":[],"desc":"Returns the initialized WP_Http Object","returns":"WP_Http HTTP Transport object."},"wp_remote_request":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_get":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request using the GET method.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_post":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request using the POST method.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_head":{"params":[{"required":"yes","param":"string $url Site URL to retrieve."},{"required":"no","param":"array $args Optional. Override the defaults."}],"desc":"Retrieve the raw response from the HTTP request using the HEAD method.","returns":"WP_Error|array The response or WP_Error on failure."},"wp_remote_retrieve_headers":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the headers from the raw response.","returns":"array The headers of the response. Empty array if incorrect parameter given."},"wp_remote_retrieve_header":{"params":[{"required":"yes","param":"array $response "},{"required":"yes","param":"string $header Header name to retrieve value from."}],"desc":"Retrieve a single header by name from the raw response.","returns":"string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist."},"wp_remote_retrieve_response_code":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the response code from the raw response.","returns":"string the response code. Empty string on incorrect parameter given."},"wp_remote_retrieve_response_message":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the response message from the raw response.","returns":"string The response message. Empty string on incorrect parameter given."},"wp_remote_retrieve_body":{"params":[{"required":"yes","param":"array $response HTTP response."}],"desc":"Retrieve only the body from the raw response.","returns":"string The body of the response. Empty string if no body or incorrect parameter given."},"wp_http_supports":{"params":[{"required":"yes","param":"array $capabilities Array of capabilities to test or a wp_remote_request() $args array."},{"required":"no","param":"string $url Optional. If given, will check if the URL requires SSL and adds that requirement to the capabilities array."}],"desc":"Determines if there is an HTTP Transport that can process this request.","returns":"bool "},"wptexturize":{"params":[{"required":"yes","param":"string $text The text to be formatted"}],"desc":"Replaces common plain text characters into formatted entities","returns":"string The string replaced with html entities"},"_wptexturize_pushpop_element":{"params":[{"required":"yes","param":"string $text Text to check. First character is assumed to be $opening"},{"required":"yes","param":"array $stack Array used as stack of opened tag elements"},{"required":"yes","param":"string $disabled_elements Tags to match against formatted as regexp sub-expression"},{"required":"yes","param":"string $opening Tag opening character, assumed to be 1 character long"},{"required":"yes","param":"string $opening Tag closing character"}],"desc":"Search for disabled element tags. Push element to stack on tag open and pop on tag close. Assumes first character of $text is tag opening.","returns":"object "},"clean_pre":{"params":[{"required":"yes","param":"array|string $matches The array or string"}],"desc":"Accepts matches array from preg_replace_callback in wpautop() or a string.","returns":"string The pre block without paragraph/line-break conversion."},"wpautop":{"params":[{"required":"yes","param":"string $pee The text which has to be formatted."},{"required":"no","param":"int|bool $br Optional. If set, this will convert all remaining line-breaks after paragraphing. Default true."}],"desc":"Replaces double line-breaks with paragraph elements.","returns":"string Text which has been converted into correct paragraph tags."},"_autop_newline_preservation_helper":{"params":[{"required":"yes","param":"array $matches preg_replace_callback matches array"}],"desc":"Newline preservation help function for wpautop","returns":""},"shortcode_unautop":{"params":[{"required":"yes","param":"string $pee The content."}],"desc":"Don't auto-p wrap shortcodes that stand alone","returns":"string The filtered content."},"seems_utf8":{"params":[{"required":"yes","param":"string $str The string to be checked"}],"desc":"Checks to see if a string is utf8 encoded.","returns":"bool True if $str fits a UTF-8 model, false otherwise."},"_wp_specialchars":{"params":[{"required":"yes","param":"string $string The text which is to be encoded."},{"required":"no","param":"mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES."},{"required":"no","param":"string $charset Optional. The character encoding of the string. Default is false."},{"required":"no","param":"boolean $double_encode Optional. Whether to encode existing html entities. Default is false."}],"desc":"Converts a number of special characters into their HTML entities.","returns":"string The encoded text with HTML entities."},"wp_specialchars_decode":{"params":[{"required":"yes","param":"string $string The text which is to be decoded."},{"required":"no","param":"mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old _wp_specialchars() values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES."}],"desc":"Converts a number of HTML entities into their special characters.","returns":"string The decoded text without HTML entities."},"wp_check_invalid_utf8":{"params":[{"required":"yes","param":"string $string The text which is to be checked."},{"required":"no","param":"boolean $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false."}],"desc":"Checks for invalid UTF8 in a string.","returns":"string The checked text."},"utf8_uri_encode":{"params":[{"required":"yes","param":"string $utf8_string "},{"required":"yes","param":"int $length Max length of the string"}],"desc":"Encode the Unicode values to be used in the URI.","returns":"string String with Unicode encoded for URI."},"remove_accents":{"params":[{"required":"yes","param":"string $string Text that might have accent characters"}],"desc":"Converts all accent characters to ASCII characters.","returns":"string Filtered string with replaced "nice" characters."},"sanitize_file_name":{"params":[{"required":"yes","param":"string $filename The filename to be sanitized"}],"desc":"Sanitizes a filename replacing whitespace with dashes","returns":"string The sanitized filename"},"sanitize_user":{"params":[{"required":"yes","param":"string $username The username to be sanitized."},{"required":"yes","param":"bool $strict If set limits $username to specific characters. Default false."}],"desc":"Sanitize username stripping out unsafe characters.","returns":"string The sanitized username, after passing through filters."},"sanitize_key":{"params":[{"required":"yes","param":"string $key String key"}],"desc":"Sanitize a string key.","returns":"string Sanitized key"},"sanitize_title":{"params":[{"required":"yes","param":"string $title The string to be sanitized."},{"required":"no","param":"string $fallback_title Optional. A title to use if $title is empty."},{"required":"no","param":"string $context Optional. The operation for which the string is sanitized"}],"desc":"Sanitizes title or use fallback title.","returns":"string The sanitized string."},"sanitize_title_for_query":{"params":[],"desc":"","returns":""},"sanitize_title_with_dashes":{"params":[{"required":"yes","param":"string $title The title to be sanitized."},{"required":"no","param":"string $raw_title Optional. Not used."},{"required":"no","param":"string $context Optional. The operation for which the string is sanitized."}],"desc":"Sanitizes title, replacing whitespace and a few other characters with dashes.","returns":"string The sanitized title."},"sanitize_sql_orderby":{"params":[{"required":"yes","param":"string $orderby Order by string to be checked."}],"desc":"Ensures a string is a valid SQL order by clause.","returns":"string|false Returns the order by clause if it is a match, false otherwise."},"sanitize_html_class":{"params":[{"required":"yes","param":"string $class The classname to be sanitized"},{"required":"no","param":"string $fallback Optional. The value to return if the sanitization end's up as an empty string. Defaults to an empty string."}],"desc":"Santizes a html classname to ensure it only contains valid characters","returns":"string The sanitized value"},"convert_chars":{"params":[{"required":"yes","param":"string $content String of characters to be converted."},{"required":"yes","param":"string $deprecated Not used."}],"desc":"Converts a number of characters from a string.","returns":"string Converted string."},"balanceTags":{"params":[{"required":"yes","param":"string $text Text to be balanced"},{"required":"yes","param":"bool $force Forces balancing, ignoring the value of the option. Default false."}],"desc":"Will only balance the tags if forced to and the option is set to balance tags.","returns":"string Balanced text"},"force_balance_tags":{"params":[{"required":"yes","param":"string $text Text to be balanced."}],"desc":"Balances tags of string using a modified stack.","returns":"string Balanced text."},"format_to_edit":{"params":[{"required":"yes","param":"string $content The text about to be edited."},{"required":"yes","param":"bool $richedit Whether the $content should pass through htmlspecialchars(). Default false."}],"desc":"Acts on text which is about to be edited.","returns":"string The text after the filter (and possibly htmlspecialchars()) has been run."},"format_to_post":{"params":[{"required":"yes","param":"string $content The text to pass through the filter."}],"desc":"Holder for the 'format_to_post' filter.","returns":"string Text returned from the 'format_to_post' filter."},"zeroise":{"params":[{"required":"yes","param":"mixed $number Number to append zeros to if not greater than threshold."},{"required":"yes","param":"int $threshold Digit places number needs to be to not have zeros added."}],"desc":"Add leading zeros when necessary.","returns":"string Adds leading zeros to number if needed."},"backslashit":{"params":[{"required":"yes","param":"string $string Value to which backslashes will be added."}],"desc":"Adds backslashes before letters and before a number at the start of a string.","returns":"string String with backslashes inserted."},"trailingslashit":{"params":[{"required":"yes","param":"string $string What to add the trailing slash to."}],"desc":"Appends a trailing slash.","returns":"string String with trailing slash added."},"untrailingslashit":{"params":[{"required":"yes","param":"string $string What to remove the trailing slash from."}],"desc":"Removes trailing slash if it exists.","returns":"string String without the trailing slash."},"addslashes_gpc":{"params":[{"required":"yes","param":"string $gpc The string returned from HTTP request data."}],"desc":"Adds slashes to escape strings.","returns":"string Returns a string escaped with slashes."},"stripslashes_deep":{"params":[{"required":"yes","param":"array|string $value The array or string to be stripped."}],"desc":"Navigates through an array and removes slashes from the values.","returns":"array|string Stripped array (or string in the callback)."},"urlencode_deep":{"params":[{"required":"yes","param":"array|string $value The array or string to be encoded."}],"desc":"Navigates through an array and encodes the values to be used in a URL.","returns":"array|string $value The encoded array (or string from the callback)."},"antispambot":{"params":[{"required":"yes","param":"string $emailaddy Email address."},{"required":"no","param":"int $mailto Optional. Range from 0 to 1. Used for encoding."}],"desc":"Converts email addresses characters to HTML entities to block spam bots.","returns":"string Converted email address."},"_make_url_clickable_cb":{"params":[{"required":"yes","param":"array $matches Single Regex Match."}],"desc":"Callback to convert URI match to HTML A element.","returns":"string HTML A element with URI address."},"_make_web_ftp_clickable_cb":{"params":[{"required":"yes","param":"array $matches Single Regex Match."}],"desc":"Callback to convert URL match to HTML A element.","returns":"string HTML A element with URL address."},"_make_email_clickable_cb":{"params":[{"required":"yes","param":"array $matches Single Regex Match."}],"desc":"Callback to convert email address match to HTML A element.","returns":"string HTML A element with email address."},"make_clickable":{"params":[{"required":"yes","param":"string $text Content to convert URIs."}],"desc":"Convert plaintext URI to HTML links.","returns":"string Content with converted URIs."},"_split_str_by_whitespace":{"params":[{"required":"yes","param":"string $string The string to split"},{"required":"yes","param":"int $goal The desired chunk length."}],"desc":"Breaks a string into chunks by splitting at whitespace characters.","returns":"array Numeric array of chunks."},"wp_rel_nofollow":{"params":[{"required":"yes","param":"string $text Content that may contain HTML A elements."}],"desc":"Adds rel nofollow string to all HTML A elements in content.","returns":"string Converted content."},"wp_rel_nofollow_callback":{"params":[{"required":"yes","param":"array $matches Single Match"}],"desc":"Callback to used to add rel=nofollow string to HTML A element.","returns":"string HTML A Element with rel nofollow."},"translate_smiley":{"params":[{"required":"yes","param":"string $smiley Smiley code to convert to image."}],"desc":"Convert one smiley code to the icon graphic file equivalent.","returns":"string Image string for smiley."},"convert_smilies":{"params":[{"required":"yes","param":"string $text Content to convert smilies from text."}],"desc":"Convert text equivalent of smilies to images.","returns":"string Converted content with text smilies replaced with images."},"is_email":{"params":[{"required":"yes","param":"string $email Email address to verify."},{"required":"yes","param":"boolean $deprecated Deprecated."}],"desc":"Verifies that an email is valid.","returns":"string|bool Either false or the valid email address."},"wp_iso_descrambler":{"params":[{"required":"yes","param":"string $string Subject line"}],"desc":"Convert to ASCII from email subjects.","returns":"string Converted string to ASCII"},"_wp_iso_convert":{"params":[{"required":"yes","param":"array $match the preg_replace_callback matches array"}],"desc":"Helper function to convert hex encoded chars to ascii","returns":""},"get_gmt_from_date":{"params":[{"required":"yes","param":"string $string The date to be converted."},{"required":"yes","param":"string $format The format string for the returned date (default is Y-m-d H:i:s)"}],"desc":"Returns a date in the GMT equivalent.","returns":"string GMT version of the date provided."},"get_date_from_gmt":{"params":[{"required":"yes","param":"string $string The date to be converted."},{"required":"yes","param":"string $format The format string for the returned date (default is Y-m-d H:i:s)"}],"desc":"Converts a GMT date into the correct format for the blog.","returns":"string Formatted date relative to the GMT offset."},"iso8601_timezone_to_offset":{"params":[{"required":"yes","param":"string $timezone Either 'Z' for 0 offset or '\u00b1hhmm'."}],"desc":"Computes an offset in seconds from an iso8601 timezone.","returns":"int|float The offset in seconds."},"iso8601_to_datetime":{"params":[{"required":"yes","param":"string $date_string Date and time in ISO 8601 format {@link http://en.wikipedia.org/wiki/ISO_8601}."},{"required":"no","param":"string $timezone Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'."}],"desc":"Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].","returns":"string The date and time in MySQL DateTime format - Y-m-d H:i:s."},"popuplinks":{"params":[{"required":"yes","param":"string $text Content to replace links to open in a new window."}],"desc":"Adds a element attributes to open links in new windows.","returns":"string Content that has filtered links."},"sanitize_email":{"params":[{"required":"yes","param":"string $email Email address to filter."}],"desc":"Strips out all characters that are not allowable in an email.","returns":"string Filtered email address."},"human_time_diff":{"params":[{"required":"yes","param":"int $from Unix timestamp from which the difference begins."},{"required":"no","param":"int $to Optional. Unix timestamp to end the time difference. Default becomes time() if not set."}],"desc":"Determines the difference between two timestamps.","returns":"string Human readable time difference."},"wp_trim_excerpt":{"params":[{"required":"no","param":"string $text Optional. The excerpt. If set to empty, an excerpt is generated."}],"desc":"Generates an excerpt from the content, if needed.","returns":"string The excerpt."},"wp_trim_words":{"params":[{"required":"yes","param":"string $text Text to trim."},{"required":"yes","param":"int $num_words Number of words. Default 55."},{"required":"yes","param":"string $more What to append if $text needs to be trimmed. Default '…'."}],"desc":"Trims text to a certain number of words.","returns":"string Trimmed text."},"ent2ncr":{"params":[{"required":"yes","param":"string $text The text within which entities will be converted."}],"desc":"Converts named entities into numbered entities.","returns":"string Text with converted entities."},"wp_richedit_pre":{"params":[{"required":"yes","param":"string $text The text to be formatted."}],"desc":"Formats text for the rich text editor.","returns":"string The formatted text after filter is applied."},"wp_htmledit_pre":{"params":[{"required":"yes","param":"string $output The text to be formatted."}],"desc":"Formats text for the HTML editor.","returns":"string Formatted text after filter applied."},"_deep_replace":{"params":[{"required":"yes","param":"string|array $search "},{"required":"yes","param":"string $subject "}],"desc":"Perform a deep string replace operation to ensure the values in $search are no longer present","returns":"string The processed string"},"esc_sql":{"params":[{"required":"yes","param":"string $sql Unescaped SQL data"}],"desc":"Escapes data for use in a MySQL query","returns":"string The cleaned $sql"},"esc_url":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"no","param":"array $protocols Optional. An array of acceptable protocols. Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn' if not set."},{"required":"yes","param":"string $_context Private. Use esc_url_raw() for database usage."}],"desc":"Checks and cleans a URL.","returns":"string The cleaned $url after the 'clean_url' filter is applied."},"esc_url_raw":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"yes","param":"array $protocols An array of acceptable protocols."}],"desc":"Performs esc_url() for database usage.","returns":"string The cleaned URL."},"htmlentities2":{"params":[{"required":"yes","param":"string $myHTML The text to be converted."}],"desc":"Convert entities, while preserving already-encoded entities.","returns":"string Converted text."},"esc_js":{"params":[{"required":"yes","param":"string $text The text to be escaped."}],"desc":"Escape single quotes, htmlspecialchar " < > &, and fix line endings.","returns":"string Escaped text."},"esc_html":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for HTML blocks.","returns":"string "},"esc_textarea":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for textarea values.","returns":"string "},"tag_escape":{"params":[{"required":"yes","param":"string $tag_name "}],"desc":"Escape a HTML tag name.","returns":"string "},"like_escape":{"params":[{"required":"yes","param":"string $text The text to be escaped."}],"desc":"Escapes text for SQL LIKE special characters % and _.","returns":"string text, safe for inclusion in LIKE query."},"wp_make_link_relative":{"params":[{"required":"yes","param":"string $link Full URL path."}],"desc":"Convert full URL paths to absolute paths.","returns":"string Absolute path."},"sanitize_option":{"params":[{"required":"yes","param":"string $option The name of the option."},{"required":"yes","param":"string $value The unsanitised value."}],"desc":"Sanitises various option values based on the nature of the option.","returns":"string Sanitized value."},"wp_parse_str":{"params":[{"required":"yes","param":"string $string The string to be parsed."},{"required":"yes","param":"array $array Variables will be stored in this array."}],"desc":"Parses a string into variables to be stored in an array.","returns":""},"wp_pre_kses_less_than":{"params":[{"required":"yes","param":"string $text Text to be converted."}],"desc":"Convert lone less than signs.","returns":"string Converted text."},"wp_pre_kses_less_than_callback":{"params":[{"required":"yes","param":"array $matches Populated by matches to preg_replace."}],"desc":"Callback function used by preg_replace.","returns":"string The text returned after esc_html if needed."},"wp_sprintf":{"params":[{"required":"yes","param":"string $pattern The string which formatted args are inserted."},{"required":"yes","param":"mixed $args,... Arguments to be formatted into the $pattern string."}],"desc":"WordPress implementation of PHP sprintf() with filters.","returns":"string The formatted string."},"wp_sprintf_l":{"params":[{"required":"yes","param":"string $pattern Content containing '%l' at the beginning."},{"required":"yes","param":"array $args List items to prepend to the content and replace '%l'."}],"desc":"Localize list items before the rest of the content.","returns":"string Localized list items and rest of the content."},"wp_html_excerpt":{"params":[{"required":"yes","param":"integer $str String to get the excerpt from."},{"required":"yes","param":"integer $count Maximum number of characters to take."}],"desc":"Safely extracts not more than the first $count characters from html string.","returns":"string The excerpt."},"links_add_base_url":{"params":[{"required":"yes","param":"string $content String to search for links in."},{"required":"yes","param":"string $base The base URL to prefix to links."},{"required":"yes","param":"array $attrs The attributes which should be processed."}],"desc":"Add a Base url to relative links in passed content.","returns":"string The processed content."},"_links_add_base":{"params":[{"required":"yes","param":"string $m The matched link."}],"desc":"Callback to add a base url to relative links in passed content.","returns":"string The processed link."},"links_add_target":{"params":[{"required":"yes","param":"string $content String to search for links in."},{"required":"yes","param":"string $target The Target to add to the links."},{"required":"yes","param":"array $tags An array of tags to apply to."}],"desc":"Adds a Target attribute to all links in passed content.","returns":"string The processed content."},"_links_add_target":{"params":[{"required":"yes","param":"string $m The matched link."}],"desc":"Callback to add a target attribute to all links in passed content.","returns":"string The processed link."},"normalize_whitespace":{"params":[],"desc":"","returns":""},"wp_strip_all_tags":{"params":[{"required":"yes","param":"string $string String containing HTML tags"},{"required":"no","param":"bool $remove_breaks optional Whether to remove left over line breaks and white space chars"}],"desc":"Properly strip all HTML tags including script and style","returns":"string The processed string."},"sanitize_text_field":{"params":[{"required":"yes","param":"string $str "}],"desc":"Sanitize a string from user input or from the db","returns":"string "},"wp_basename":{"params":[{"required":"yes","param":"string $path A path."},{"required":"yes","param":"string $suffix If the filename ends in suffix this will also be cut off."}],"desc":"i18n friendly version of basename()","returns":"string "},"capital_P_dangit":{"params":[],"desc":"Forever eliminate "Wordpress" from the planet (or at least the little bit we can influence).","returns":""},"sanitize_mime_type":{"params":[{"required":"yes","param":"string $mime_type Mime type"}],"desc":"Sanitize a mime type","returns":"string Sanitized mime type"},"wp_kses":{"params":[{"required":"yes","param":"string $string Content to filter through kses"},{"required":"yes","param":"array $allowed_html List of allowed HTML elements"},{"required":"no","param":"array $allowed_protocols Optional. Allowed protocol in links."}],"desc":"Filters content and keeps only allowable HTML elements.","returns":"string Filtered content with only allowed HTML elements"},"wp_kses_hook":{"params":[{"required":"yes","param":"string $string Content to filter through kses"},{"required":"yes","param":"array $allowed_html List of allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocol in links"}],"desc":"You add any kses hooks here.","returns":"string Filtered content through 'pre_kses' hook"},"wp_kses_version":{"params":[],"desc":"This function returns kses' version number.","returns":"string KSES Version Number"},"wp_kses_split":{"params":[{"required":"yes","param":"string $string Content to filter"},{"required":"yes","param":"array $allowed_html Allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Searches for HTML tags, no matter how malformed.","returns":"string Content with fixed HTML tags"},"_wp_kses_split_callback":{"params":[],"desc":"Callback for wp_kses_split.","returns":""},"wp_kses_split2":{"params":[{"required":"yes","param":"string $string Content to filter"},{"required":"yes","param":"array $allowed_html Allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Callback for wp_kses_split for fixing malformed HTML tags.","returns":"string Fixed HTML element"},"wp_kses_attr":{"params":[{"required":"yes","param":"string $element HTML element/tag"},{"required":"yes","param":"string $attr HTML attributes from HTML element to closing HTML element tag"},{"required":"yes","param":"array $allowed_html Allowed HTML elements"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Removes all attributes, if none are allowed for this element.","returns":"string Sanitized HTML element"},"wp_kses_hair":{"params":[{"required":"yes","param":"string $attr Attribute list from HTML element to closing HTML element tag"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Builds an attribute list from string containing attributes.","returns":"array List of attributes after parsing"},"wp_kses_check_attr_val":{"params":[{"required":"yes","param":"string $value Attribute value"},{"required":"yes","param":"string $vless Whether the value is valueless. Use 'y' or 'n'"},{"required":"yes","param":"string $checkname What $checkvalue is checking for."},{"required":"yes","param":"mixed $checkvalue What constraint the value should pass"}],"desc":"Performs different checks for attribute values.","returns":"bool Whether check passes"},"wp_kses_bad_protocol":{"params":[{"required":"yes","param":"string $string Content to filter bad protocols from"},{"required":"yes","param":"array $allowed_protocols Allowed protocols to keep"}],"desc":"Sanitize string from bad protocols.","returns":"string Filtered content"},"wp_kses_no_null":{"params":[{"required":"yes","param":"string $string "}],"desc":"Removes any NULL characters in $string.","returns":"string "},"wp_kses_stripslashes":{"params":[{"required":"yes","param":"string $string String to strip slashes"}],"desc":"Strips slashes from in front of quotes.","returns":"string Fixed string with quoted slashes"},"wp_kses_array_lc":{"params":[{"required":"yes","param":"array $inarray Unfiltered array"}],"desc":"Goes through an array and changes the keys to all lower case.","returns":"array Fixed array with all lowercase keys"},"wp_kses_js_entities":{"params":[{"required":"yes","param":"string $string "}],"desc":"Removes the HTML JavaScript entities found in early versions of Netscape 4.","returns":"string "},"wp_kses_html_error":{"params":[{"required":"yes","param":"string $string "}],"desc":"Handles parsing errors in wp_kses_hair().","returns":"string "},"wp_kses_bad_protocol_once":{"params":[{"required":"yes","param":"string $string Content to check for bad protocols"},{"required":"yes","param":"string $allowed_protocols Allowed protocols"}],"desc":"Sanitizes content from bad protocols and other characters.","returns":"string Sanitized content"},"wp_kses_bad_protocol_once2":{"params":[{"required":"yes","param":"string $string URI scheme to check against the whitelist"},{"required":"yes","param":"string $allowed_protocols Allowed protocols"}],"desc":"Callback for wp_kses_bad_protocol_once() regular expression.","returns":"string Sanitized content"},"wp_kses_normalize_entities":{"params":[{"required":"yes","param":"string $string Content to normalize entities"}],"desc":"Converts and fixes HTML entities.","returns":"string Content with normalized entities"},"wp_kses_named_entities":{"params":[{"required":"yes","param":"array $matches preg_replace_callback() matches array"}],"desc":"Callback for wp_kses_normalize_entities() regular expression.","returns":"string Correctly encoded entity"},"wp_kses_normalize_entities2":{"params":[{"required":"yes","param":"array $matches preg_replace_callback() matches array"}],"desc":"Callback for wp_kses_normalize_entities() regular expression.","returns":"string Correctly encoded entity"},"wp_kses_normalize_entities3":{"params":[{"required":"yes","param":"array $matches preg_replace_callback() matches array"}],"desc":"Callback for wp_kses_normalize_entities() for regular expression.","returns":"string Correctly encoded entity"},"valid_unicode":{"params":[{"required":"yes","param":"int $i Unicode value"}],"desc":"Helper function to determine if a Unicode value is valid.","returns":"bool True if the value was a valid Unicode number"},"wp_kses_decode_entities":{"params":[{"required":"yes","param":"string $string Content to change entities"}],"desc":"Convert all entities to their character counterparts.","returns":"string Content after decoded entities"},"_wp_kses_decode_entities_chr":{"params":[{"required":"yes","param":"array $match preg match"}],"desc":"Regex callback for wp_kses_decode_entities()","returns":"string "},"_wp_kses_decode_entities_chr_hexdec":{"params":[{"required":"yes","param":"array $match preg match"}],"desc":"Regex callback for wp_kses_decode_entities()","returns":"string "},"wp_filter_kses":{"params":[{"required":"yes","param":"string $data Content to filter, expected to be escaped with slashes"}],"desc":"Sanitize content with allowed HTML Kses rules.","returns":"string Filtered content"},"wp_kses_data":{"params":[{"required":"yes","param":"string $data Content to filter, expected to not be escaped"}],"desc":"Sanitize content with allowed HTML Kses rules.","returns":"string Filtered content"},"wp_filter_post_kses":{"params":[{"required":"yes","param":"string $data Post content to filter, expected to be escaped with slashes"}],"desc":"Sanitize content for allowed HTML tags for post content.","returns":"string Filtered post content with allowed HTML tags and attributes intact."},"wp_kses_post":{"params":[{"required":"yes","param":"string $data Post content to filter"}],"desc":"Sanitize content for allowed HTML tags for post content.","returns":"string Filtered post content with allowed HTML tags and attributes intact."},"wp_filter_nohtml_kses":{"params":[{"required":"yes","param":"string $data Content to strip all HTML from"}],"desc":"Strips all of the HTML in the content.","returns":"string Filtered content without any HTML"},"kses_init_filters":{"params":[],"desc":"Adds all Kses input form content filters.","returns":""},"kses_remove_filters":{"params":[],"desc":"Removes all Kses input form content filters.","returns":""},"kses_init":{"params":[],"desc":"Sets up most of the Kses filters for input form content.","returns":""},"safecss_filter_attr":{"params":[],"desc":"Inline CSS filter","returns":""},"create_initial_post_types":{"params":[],"desc":"Creates the initial post types when 'init' action is fired.","returns":""},"get_attached_file":{"params":[{"required":"yes","param":"int $attachment_id Attachment ID."},{"required":"yes","param":"bool $unfiltered Whether to apply filters."}],"desc":"Retrieve attached file path based on attachment ID.","returns":"string The file path to the attached file."},"update_attached_file":{"params":[{"required":"yes","param":"int $attachment_id Attachment ID"},{"required":"yes","param":"string $file File path for the attachment"}],"desc":"Update attachment file path based on attachment ID.","returns":"bool False on failure, true on success."},"_wp_relative_upload_path":{"params":[{"required":"yes","param":"string $path Full path to the file"}],"desc":"Return relative path to an uploaded file.","returns":"string relative path on success, unchanged path on failure."},"get_children":{"params":[{"required":"no","param":"mixed $args Optional. User defined arguments for replacing the defaults."},{"required":"no","param":"string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N."}],"desc":"Retrieve all children of the post parent ID.","returns":"array|bool False on failure and the type will be determined by $output parameter."},"get_extended":{"params":[{"required":"yes","param":"string $post Post content."}],"desc":"Get extended entry info (<!--more-->).","returns":"array Post before ('main') and after ('extended')."},"get_post":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."},{"required":"no","param":"string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N."},{"required":"no","param":"string $filter Optional, default is raw."}],"desc":"Retrieves post data given a post ID or post object.","returns":"mixed Post data"},"get_post_ancestors":{"params":[{"required":"yes","param":"int|object $post Post ID or post object"}],"desc":"Retrieve ancestors of a post.","returns":"array Ancestor IDs or empty array if none are found."},"get_post_field":{"params":[{"required":"yes","param":"string $field Post field name"},{"required":"yes","param":"id $post Post ID"},{"required":"no","param":"string $context Optional. How to filter the field. Default is display."}],"desc":"Retrieve data from a post field based on Post ID.","returns":"WP_Error|string Value in post field or WP_Error on failure"},"get_post_mime_type":{"params":[{"required":"no","param":"int $ID Optional. Post ID."}],"desc":"Retrieve the mime type of an attachment based on the ID.","returns":"bool|string False on failure or returns the mime type"},"get_post_format":{"params":[{"required":"yes","param":"int|object $post A post"}],"desc":"Retrieve the format slug for a post","returns":"mixed The format if successful. False if no format is set. WP_Error if errors."},"has_post_format":{"params":[{"required":"yes","param":"string $format The format to check for"},{"required":"yes","param":"object|id $post The post to check. If not supplied, defaults to the current post if used in the loop."}],"desc":"Check if a post has a particular format","returns":"bool True if the post has the format, false otherwise."},"set_post_format":{"params":[{"required":"yes","param":"int|object $post The post for which to assign a format"},{"required":"yes","param":"string $format A format to assign. Use an empty string or array to remove all formats from the post."}],"desc":"Assign a format to a post","returns":"mixed WP_Error on error. Array of affected term IDs on success."},"get_post_status":{"params":[{"required":"yes","param":"int $ID Post ID"}],"desc":"Retrieve the post status based on the Post ID.","returns":"string|bool Post status or false on failure."},"get_post_statuses":{"params":[],"desc":"Retrieve all of the WordPress supported post statuses.","returns":"array List of post statuses."},"get_page_statuses":{"params":[],"desc":"Retrieve all of the WordPress support page statuses.","returns":"array List of page statuses."},"register_post_status":{"params":[{"required":"yes","param":"string $post_status Name of the post status."},{"required":"yes","param":"array|string $args See above description."}],"desc":"Register a post type. Do not use before init.","returns":""},"get_post_status_object":{"params":[{"required":"yes","param":"string $post_status The name of a registered post status"}],"desc":"Retrieve a post status object by name","returns":"object A post status object"},"get_post_stati":{"params":[{"required":"yes","param":"array|string $args An array of key => value arguments to match against the post status objects."},{"required":"yes","param":"string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default."},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."}],"desc":"Get a list of all registered post status objects.","returns":"array A list of post type names or objects"},"is_post_type_hierarchical":{"params":[{"required":"yes","param":"string $post_type Post type name"}],"desc":"Whether the post type is hierarchical.","returns":"bool Whether post type is hierarchical."},"post_type_exists":{"params":[{"required":"yes","param":"string $post_type Post type name"}],"desc":"Checks if a post type is registered.","returns":"bool Whether post type is registered."},"get_post_type":{"params":[{"required":"no","param":"mixed $the_post Optional. Post object or post ID."}],"desc":"Retrieve the post type of the current post or of a given post.","returns":"bool|string post type or false on failure."},"get_post_type_object":{"params":[{"required":"yes","param":"string $post_type The name of a registered post type"}],"desc":"Retrieve a post type object by name","returns":"object A post type object"},"get_post_types":{"params":[{"required":"yes","param":"array|string $args An array of key => value arguments to match against the post type objects."},{"required":"yes","param":"string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default."},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."}],"desc":"Get a list of all registered post type objects.","returns":"array A list of post type names or objects"},"register_post_type":{"params":[{"required":"yes","param":"string $post_type Name of the post type."},{"required":"yes","param":"array|string $args See above description."}],"desc":"Register a post type. Do not use before init.","returns":"object|WP_Error the registered post type object, or an error object"},"get_post_type_capabilities":{"params":[{"required":"yes","param":"object $args Post type registration arguments"}],"desc":"Builds an object with all post type capabilities out of a post type object","returns":"object object with all the capabilities as member variables"},"_post_type_meta_capabilities":{"params":[],"desc":"Stores or returns a list of post type meta caps for map_meta_cap().","returns":""},"get_post_type_labels":{"params":[{"required":"yes","param":"object $post_type_object "}],"desc":"Builds an object with all post type labels out of a post type object","returns":"object object with all the labels as member variables"},"_get_custom_object_labels":{"params":[],"desc":"Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object","returns":""},"_add_post_type_submenus":{"params":[],"desc":"Adds submenus for post types.","returns":""},"add_post_type_support":{"params":[{"required":"yes","param":"string $post_type The post type for which to add the feature"},{"required":"yes","param":"string|array $feature the feature being added, can be an array of feature strings or a single string"}],"desc":"Register support of certain features for a post type.","returns":""},"remove_post_type_support":{"params":[{"required":"yes","param":"string $post_type The post type for which to remove the feature"},{"required":"yes","param":"string $feature The feature being removed"}],"desc":"Remove support for a feature from a post type.","returns":""},"post_type_supports":{"params":[{"required":"yes","param":"string $post_type The post type being checked"},{"required":"yes","param":"string $feature the feature being checked"}],"desc":"Checks a post type's support for a given feature","returns":"boolean "},"set_post_type":{"params":[{"required":"no","param":"int $post_id Post ID to change post type. Not actually optional."},{"required":"no","param":"string $post_type Optional, default is post. Supported values are 'post' or 'page' to name a few."}],"desc":"Updates the post type for the post ID.","returns":"int Amount of rows changed. Should be 1 for success and 0 for failure."},"get_posts":{"params":[{"required":"no","param":"array $args Optional. Overrides defaults."}],"desc":"Retrieve list of latest posts or posts matching criteria.","returns":"array List of posts."},"add_post_meta":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"bool $unique Optional, default is false. Whether the same key should not be added."}],"desc":"Add meta data field to a post.","returns":"bool False for failure. True for success."},"delete_post_meta":{"params":[{"required":"yes","param":"int $post_id post ID"},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"no","param":"mixed $meta_value Optional. Metadata value."}],"desc":"Remove metadata matching criteria from a post.","returns":"bool False for failure. True for success."},"get_post_meta":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $key The meta key to retrieve."},{"required":"yes","param":"bool $single Whether to return a single value."}],"desc":"Retrieve post meta field for a post.","returns":"mixed Will be an array if $single is false. Will be value of meta data field if $single is true."},"update_post_meta":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"mixed $prev_value Optional. Previous value to check before removing."}],"desc":"Update post meta field based on post ID.","returns":"bool False on failure, true if success."},"delete_post_meta_by_key":{"params":[{"required":"yes","param":"string $post_meta_key Key to search for when deleting."}],"desc":"Delete everything from post meta matching meta key.","returns":"bool Whether the post meta key was deleted from the database"},"get_post_custom":{"params":[{"required":"yes","param":"int $post_id post ID"}],"desc":"Retrieve post meta fields, based on post ID.","returns":"array "},"get_post_custom_keys":{"params":[{"required":"yes","param":"int $post_id post ID"}],"desc":"Retrieve meta field names for a post.","returns":"array|null Either array of the keys, or null if keys could not be retrieved."},"get_post_custom_values":{"params":[{"required":"yes","param":"string $key Meta field key."},{"required":"yes","param":"int $post_id Post ID"}],"desc":"Retrieve values for a custom post field.","returns":"array Meta field values."},"is_sticky":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Check if post is sticky.","returns":"bool Whether post is sticky."},"sanitize_post":{"params":[{"required":"yes","param":"object|array $post The Post Object or Array"},{"required":"no","param":"string $context Optional, default is 'display'. How to sanitize post fields."}],"desc":"Sanitize every post field.","returns":"object|array The now sanitized Post Object or Array (will be the same type as $post)"},"sanitize_post_field":{"params":[{"required":"yes","param":"string $field The Post Object field name."},{"required":"yes","param":"mixed $value The Post Object value."},{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display', 'attribute' and 'js'."}],"desc":"Sanitize post field based on context.","returns":"mixed Sanitized value."},"stick_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Make a post sticky.","returns":""},"unstick_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Unstick a post.","returns":""},"wp_count_posts":{"params":[{"required":"no","param":"string $type Optional. Post type to retrieve count"},{"required":"no","param":"string $perm Optional. 'readable' or empty."}],"desc":"Count number of posts of a post type and is user has permissions to view.","returns":"object Number of posts for each status"},"wp_count_attachments":{"params":[{"required":"no","param":"string|array $mime_type Optional. Array or comma-separated list of MIME patterns."}],"desc":"Count number of attachments for the mime type(s).","returns":"array Number of posts for each mime type."},"wp_match_mime_types":{"params":[{"required":"yes","param":"string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or flash (same as *flash*)."},{"required":"yes","param":"string|array $real_mime_types post_mime_type values"}],"desc":"Check a MIME-Type against a list.","returns":"array array(wildcard=>array(real types))"},"wp_post_mime_type_where":{"params":[{"required":"yes","param":"string|array $post_mime_types List of mime types or comma separated string of mime types."},{"required":"no","param":"string $table_alias Optional. Specify a table alias, if needed."}],"desc":"Convert MIME types into SQL.","returns":"string The SQL AND clause for mime searching."},"wp_delete_post":{"params":[{"required":"yes","param":"int $postid Post ID."},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Defaults to false."}],"desc":"Trashes or deletes a post or page.","returns":"mixed False on failure"},"wp_trash_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Moves a post or page to the Trash","returns":"mixed False on failure"},"wp_untrash_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Restores a post or page from the Trash","returns":"mixed False on failure"},"wp_trash_post_comments":{"params":[{"required":"yes","param":"int $post Post ID or object."}],"desc":"Moves comments for a post to the trash","returns":"mixed False on failure"},"wp_untrash_post_comments":{"params":[{"required":"yes","param":"int $post Post ID or object."}],"desc":"Restore comments for a post from the trash","returns":"mixed False on failure"},"wp_get_post_categories":{"params":[{"required":"no","param":"int $post_id Optional. The Post ID."},{"required":"no","param":"array $args Optional. Overwrite the defaults."}],"desc":"Retrieve the list of categories for a post.","returns":"array "},"wp_get_post_tags":{"params":[{"required":"no","param":"int $post_id Optional. The Post ID"},{"required":"no","param":"array $args Optional. Overwrite the defaults"}],"desc":"Retrieve the tags for a post.","returns":"array List of post tags."},"wp_get_post_terms":{"params":[{"required":"no","param":"int $post_id Optional. The Post ID"},{"required":"yes","param":"string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag."},{"required":"no","param":"array $args Optional. Overwrite the defaults"}],"desc":"Retrieve the terms for a post.","returns":"array List of post tags."},"wp_get_recent_posts":{"params":[{"required":"yes","param":"string $deprecated Deprecated."},{"required":"no","param":"array $args Optional. Overrides defaults."},{"required":"no","param":"string $output Optional."}],"desc":"Retrieve number of recent posts.","returns":"unknown. "},"wp_get_single_post":{"params":[{"required":"yes","param":"int $postid Post ID."},{"required":"yes","param":"string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A."}],"desc":"Retrieve a single post, based on post ID.","returns":"object|array Post object or array holding post contents and information"},"wp_insert_post":{"params":[{"required":"yes","param":"array $postarr Elements that make up post to insert."},{"required":"no","param":"bool $wp_error Optional. Allow return of WP_Error on failure."}],"desc":"Insert a post.","returns":"int|WP_Error The value 0 or WP_Error on failure. The post ID on success."},"wp_update_post":{"params":[{"required":"yes","param":"array|object $postarr Post data. Arrays are expected to be escaped, objects are not."}],"desc":"Update a post with new post data.","returns":"int 0 on failure, Post ID on success."},"wp_publish_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Publish a post by transitioning the post status.","returns":"null "},"check_and_publish_future_post":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Publish future post and make sure post ID has future post status.","returns":"null Nothing is returned. Which can mean that no action is required or post was published."},"wp_unique_post_slug":{"params":[{"required":"yes","param":"string $slug the desired slug (post_name)"},{"required":"yes","param":"integer $post_ID "},{"required":"yes","param":"string $post_status no uniqueness checks are made if the post is still draft or pending"},{"required":"yes","param":"string $post_type "},{"required":"yes","param":"integer $post_parent "}],"desc":"Computes a unique slug for the post, when given the desired slug and some post details.","returns":"string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)"},"wp_add_post_tags":{"params":[{"required":"yes","param":"int $post_id Post ID"},{"required":"yes","param":"string $tags The tags to set for the post, separated by commas."}],"desc":"Adds tags to a post.","returns":"bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise"},"wp_set_post_tags":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $tags The tags to set for the post, separated by commas."},{"required":"yes","param":"bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags."}],"desc":"Set the tags for a post.","returns":"mixed Array of affected term IDs. WP_Error or false on failure."},"wp_set_post_terms":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $tags The tags to set for the post, separated by commas."},{"required":"yes","param":"bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags."}],"desc":"Set the terms for a post.","returns":"mixed Array of affected term IDs. WP_Error or false on failure."},"wp_set_post_categories":{"params":[{"required":"yes","param":"int $post_ID Post ID."},{"required":"no","param":"array $post_categories Optional. List of categories."}],"desc":"Set categories for a post.","returns":"bool|mixed "},"wp_transition_post_status":{"params":[{"required":"yes","param":"string $new_status Transition to this post status."},{"required":"yes","param":"string $old_status Previous post status."},{"required":"yes","param":"object $post Post data."}],"desc":"Transition the post status of a post.","returns":""},"add_ping":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"string $uri Ping URI."}],"desc":"Add a URL to those already pung.","returns":"int How many rows were updated."},"get_enclosed":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Retrieve enclosures already enclosed for a post.","returns":"array List of enclosures"},"get_pung":{"params":[{"required":"yes","param":"int $post_id Post ID."}],"desc":"Retrieve URLs already pinged for a post.","returns":"array "},"get_to_ping":{"params":[{"required":"yes","param":"int $post_id Post ID"}],"desc":"Retrieve URLs that need to be pinged.","returns":"array "},"trackback_url_list":{"params":[{"required":"yes","param":"string $tb_list Comma separated list of URLs"},{"required":"yes","param":"int $post_id Post ID"}],"desc":"Do trackbacks for a list of URLs.","returns":""},"get_all_page_ids":{"params":[],"desc":"Get a list of page IDs.","returns":"array List of page IDs."},"get_page":{"params":[{"required":"yes","param":"mixed $page Page object or page ID. Passed by reference."},{"required":"yes","param":"string $output What to output. OBJECT, ARRAY_A, or ARRAY_N."},{"required":"yes","param":"string $filter How the return value should be filtered."}],"desc":"Retrieves page data given a page ID or page object.","returns":"mixed Page data."},"get_page_by_path":{"params":[{"required":"yes","param":"string $page_path Page path"},{"required":"no","param":"string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT."},{"required":"no","param":"string $post_type Optional. Post type. Default page."}],"desc":"Retrieves a page given its path.","returns":"mixed Null when complete."},"get_page_by_title":{"params":[{"required":"yes","param":"string $page_title Page title"},{"required":"no","param":"string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT."},{"required":"no","param":"string $post_type Optional. Post type. Default page."}],"desc":"Retrieve a page given its title.","returns":"mixed "},"get_page_children":{"params":[{"required":"yes","param":"int $page_id Page ID."},{"required":"yes","param":"array $pages List of pages' objects."}],"desc":"Retrieve child pages from list of pages matching page ID.","returns":"array "},"get_page_hierarchy":{"params":[{"required":"yes","param":"array $pages Posts array."},{"required":"yes","param":"int $page_id Parent page ID."}],"desc":"Order the pages with children under parents in a flat list.","returns":"array A list arranged by hierarchy. Children immediately follow their parents."},"_page_traverse_name":{"params":[],"desc":"function to traverse and return all the nested children post names of a root page.","returns":""},"get_page_uri":{"params":[{"required":"yes","param":"mixed $page Page object or page ID."}],"desc":"Builds URI for a page.","returns":"string Page URI."},"get_pages":{"params":[{"required":"no","param":"mixed $args Optional. Array or string of options that overrides defaults."}],"desc":"Retrieve a list of pages.","returns":"array List of pages matching defaults or $args"},"is_local_attachment":{"params":[{"required":"yes","param":"string $url URL to check"}],"desc":"Check if the attachment URI is local one and is really an attachment.","returns":"bool True on success, false on failure."},"wp_insert_attachment":{"params":[{"required":"yes","param":"string|array $object Arguments to override defaults."},{"required":"no","param":"string $file Optional filename."},{"required":"yes","param":"int $parent Parent post ID."}],"desc":"Insert an attachment.","returns":"int Attachment ID."},"wp_delete_attachment":{"params":[{"required":"yes","param":"int $post_id Attachment ID."},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Defaults to false."}],"desc":"Trashes or deletes an attachment.","returns":"mixed False on failure. Post data on success."},"wp_get_attachment_metadata":{"params":[{"required":"yes","param":"int $post_id Attachment ID"},{"required":"no","param":"bool $unfiltered Optional, default is false. If true, filters are not run."}],"desc":"Retrieve attachment meta field for attachment ID.","returns":"string|bool Attachment meta field. False on failure."},"wp_update_attachment_metadata":{"params":[{"required":"yes","param":"int $post_id Attachment ID."},{"required":"yes","param":"array $data Attachment data."}],"desc":"Update metadata for an attachment.","returns":"int "},"wp_get_attachment_url":{"params":[{"required":"yes","param":"int $post_id Attachment ID."}],"desc":"Retrieve the URL for an attachment.","returns":"string "},"wp_get_attachment_thumb_file":{"params":[{"required":"yes","param":"int $post_id Attachment ID."}],"desc":"Retrieve thumbnail for an attachment.","returns":"mixed False on failure. Thumbnail file path on success."},"wp_get_attachment_thumb_url":{"params":[{"required":"yes","param":"int $post_id Attachment ID"}],"desc":"Retrieve URL for an attachment thumbnail.","returns":"string|bool False on failure. Thumbnail URL on success."},"wp_attachment_is_image":{"params":[{"required":"yes","param":"int $post_id Attachment ID"}],"desc":"Check if the attachment is an image.","returns":"bool "},"wp_mime_type_icon":{"params":[{"required":"yes","param":"string $mime MIME type"}],"desc":"Retrieve the icon for a MIME type.","returns":"string|bool "},"wp_check_for_changed_slugs":{"params":[{"required":"yes","param":"int $post_id Post ID."},{"required":"yes","param":"object $post The Post Object"},{"required":"yes","param":"object $post_before The Previous Post Object"}],"desc":"Checked for changed slugs for published post objects and save the old slug.","returns":"int Same as $post_id"},"get_private_posts_cap_sql":{"params":[{"required":"yes","param":"string $post_type currently only supports 'post' or 'page'."}],"desc":"Retrieve the private post SQL based on capability.","returns":"string SQL code that can be added to a where clause."},"get_posts_by_author_sql":{"params":[{"required":"yes","param":"string $post_type Post type."},{"required":"no","param":"bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term."},{"required":"no","param":"int $post_author Optional. Query posts having a single author ID."}],"desc":"Retrieve the post SQL based on capability, author, and type.","returns":"string SQL WHERE code that can be added to a query."},"get_lastpostdate":{"params":[{"required":"yes","param":"string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'."}],"desc":"Retrieve the date that the last post was published.","returns":"string The date of the last post."},"get_lastpostmodified":{"params":[{"required":"yes","param":"string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'."}],"desc":"Retrieve last post modified date depending on timezone.","returns":"string The date the post was last modified."},"_get_last_post_time":{"params":[{"required":"yes","param":"string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'."},{"required":"yes","param":"string $field Field to check. Can be 'date' or 'modified'."}],"desc":"Retrieve latest post date data based on timezone.","returns":"string The date."},"update_post_cache":{"params":[{"required":"yes","param":"array $posts Array of post objects"}],"desc":"Updates posts in cache.","returns":""},"clean_post_cache":{"params":[{"required":"yes","param":"int $id The Post ID in the cache to clean"}],"desc":"Will clean the post in the cache.","returns":""},"update_page_cache":{"params":[{"required":"yes","param":"array $pages list of page objects"}],"desc":"Alias of update_post_cache().","returns":""},"clean_page_cache":{"params":[{"required":"yes","param":"int $id Page ID to clean"}],"desc":"Will clean the page in the cache.","returns":""},"update_post_caches":{"params":[{"required":"yes","param":"array $posts Array of Post objects"},{"required":"yes","param":"string $post_type The post type of the posts in $posts. Default is 'post'."},{"required":"yes","param":"bool $update_term_cache Whether to update the term cache. Default is true."},{"required":"yes","param":"bool $update_meta_cache Whether to update the meta cache. Default is true."}],"desc":"Call major cache updating functions for list of Post objects.","returns":""},"update_postmeta_cache":{"params":[{"required":"yes","param":"array $post_ids List of post IDs."}],"desc":"Updates metadata cache for list of post IDs.","returns":"bool|array Returns false if there is nothing to update or an array of metadata."},"clean_attachment_cache":{"params":[{"required":"yes","param":"int $id The attachment ID in the cache to clean"},{"required":"no","param":"bool $clean_terms optional. Whether to clean terms cache"}],"desc":"Will clean the attachment in the cache.","returns":""},"_transition_post_status":{"params":[{"required":"yes","param":"string $new_status New post status"},{"required":"yes","param":"string $old_status Previous post status"},{"required":"yes","param":"object $post Object type containing the post information"}],"desc":"Hook for managing future post transitions to published.","returns":""},"_future_post_hook":{"params":[{"required":"yes","param":"int $deprecated Not used. Can be set to null. Never implemented. Not marked as deprecated with _deprecated_argument() as it conflicts with wp_transition_post_status() and the default filter for _future_post_hook()."},{"required":"yes","param":"object $post Object type containing the post information"}],"desc":"Hook used to schedule publication for a post marked for the future.","returns":""},"_publish_post_hook":{"params":[{"required":"yes","param":"int $post_id The ID in the database table of the post being published"}],"desc":"Hook to schedule pings and enclosures when a post is published.","returns":""},"_save_post_hook":{"params":[{"required":"yes","param":"int $post_id The ID in the database table for the $post"},{"required":"yes","param":"object $post Object type containing the post information"}],"desc":"Hook used to prevent page/post cache and rewrite rules from staying dirty.","returns":""},"_get_post_ancestors":{"params":[{"required":"yes","param":"object $_post Post data."}],"desc":"Retrieve post ancestors and append to post ancestors property.","returns":"null When nothing needs to be done."},"_wp_post_revision_fields":{"params":[{"required":"no","param":"array $post Optional a post array to be processed for insertion as a post revision."},{"required":"no","param":"bool $autosave optional Is the revision an autosave?"}],"desc":"Determines which fields of posts are to be saved in revisions.","returns":"array Post array ready to be inserted as a post revision or array of fields that can be versioned."},"wp_save_post_revision":{"params":[{"required":"yes","param":"int $post_id The ID of the post to save as a revision."}],"desc":"Saves an already existing post as a post revision.","returns":"mixed Null or 0 if error, new revision ID, if success."},"wp_get_post_autosave":{"params":[{"required":"yes","param":"int $post_id The post ID."}],"desc":"Retrieve the autosaved data of the specified post.","returns":"object|bool The autosaved data or false on failure or when no autosave exists."},"_wp_get_post_autosave_hack":{"params":[{"required":"yes","param":"object $query WP_Query object"}],"desc":"Internally used to hack WP_Query into submission.","returns":""},"wp_is_post_revision":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."}],"desc":"Determines if the specified post is a revision.","returns":"bool|int False if not a revision, ID of revision's parent otherwise."},"wp_is_post_autosave":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."}],"desc":"Determines if the specified post is an autosave.","returns":"bool|int False if not a revision, ID of autosave's parent otherwise"},"_wp_put_post_revision":{"params":[{"required":"yes","param":"int|object|array $post Post ID, post object OR post array."},{"required":"no","param":"bool $autosave Optional. Is the revision an autosave?"}],"desc":"Inserts post data into the posts table as a post revision.","returns":"mixed Null or 0 if error, new revision ID if success."},"wp_get_post_revision":{"params":[{"required":"yes","param":"int|object $post Post ID or post object"},{"required":"no","param":"string $output Optional. OBJECT, ARRAY_A, or ARRAY_N."},{"required":"no","param":"string $filter Optional sanitation filter. @see sanitize_post()"}],"desc":"Gets a post revision.","returns":"mixed Null if error or post object if success"},"wp_restore_post_revision":{"params":[{"required":"yes","param":"int|object $revision_id Revision ID or revision object."},{"required":"no","param":"array $fields Optional. What fields to restore from. Defaults to all."}],"desc":"Restores a post to the specified revision.","returns":"mixed Null if error, false if no fields to restore, (int) post ID if success."},"wp_delete_post_revision":{"params":[{"required":"yes","param":"int|object $revision_id Revision ID or revision object."}],"desc":"Deletes a revision.","returns":"mixed Null or WP_Error if error, deleted post if success."},"wp_get_post_revisions":{"params":[{"required":"yes","param":"int|object $post_id Post ID or post object"}],"desc":"Returns all revisions of specified post.","returns":"array empty if no revisions"},"_set_preview":{"params":[],"desc":"","returns":""},"_show_post_preview":{"params":[],"desc":"","returns":""},"wp_get_post_parent_id":{"params":[{"required":"yes","param":"int $post_id "}],"desc":"Returns the post's parent's post_ID","returns":"int|bool false on error"},"wp_check_post_hierarchy_for_loops":{"params":[{"required":"yes","param":"int $post_parent ID of the parent for the post we're checking."}],"desc":"Checks the given subset of the post hierarchy for hierarchy loops.","returns":"int The new post_parent for the post."},"get_post_format_strings":{"params":[],"desc":"Returns an array of post format slugs to their translated and pretty display versions","returns":"array The array of translations"},"get_post_format_slugs":{"params":[],"desc":"Retrieves an array of post format slugs.","returns":"array The array of post format slugs."},"get_post_format_string":{"params":[{"required":"yes","param":"string $slug A post format slug"}],"desc":"Returns a pretty, translated version of a post format slug","returns":"string The translated post format name"},"set_post_thumbnail":{"params":[{"required":"yes","param":"int|object $post Post ID or object where thumbnail should be attached."},{"required":"yes","param":"int $thumbnail_id Thumbnail to attach."}],"desc":"Sets a post thumbnail.","returns":"bool True on success, false on failure."},"delete_post_thumbnail":{"params":[{"required":"yes","param":"int|object $post Post ID or object where thumbnail should be removed from."}],"desc":"Removes a post thumbnail.","returns":"bool True on success, false on failure."},"get_post_format_link":{"params":[{"required":"yes","param":"string $format Post format"}],"desc":"Returns a link to a post format index.","returns":"string Link"},"_post_format_request":{"params":[],"desc":"Filters the request to allow for the format prefix.","returns":""},"_post_format_link":{"params":[],"desc":"Filters the post format term link to remove the format prefix.","returns":""},"_post_format_get_term":{"params":[],"desc":"Remove the post format prefix from the name property of the term object created by get_term().","returns":""},"_post_format_get_terms":{"params":[],"desc":"Remove the post format prefix from the name property of the term objects created by get_terms().","returns":""},"_post_format_wp_get_object_terms":{"params":[],"desc":"Remove the post format prefix from the name property of the term objects created by wp_get_object_terms().","returns":""},"_update_term_count_on_transition_post_status":{"params":[{"required":"yes","param":"string $new_status "},{"required":"yes","param":"string $old_status "},{"required":"yes","param":"object $post "}],"desc":"Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts.","returns":""},"wp_print_scripts":{"params":[],"desc":"Prints script tags in document head.","returns":""},"wp_register_script":{"params":[{"required":"yes","param":"string $handle Script name"},{"required":"yes","param":"string $src Script url"},{"required":"no","param":"array $deps (optional) Array of script names on which this script depends"},{"required":"no","param":"string|bool $ver (optional) Script version (used for cache busting), set to NULL to disable"},{"required":"no","param":"bool $in_footer (optional) Whether to enqueue the script before </head> or before </body>"}],"desc":"Register new Javascript file.","returns":"null "},"wp_localize_script":{"params":[{"required":"yes","param":"string $handle The script handle that was registered or used in script-loader"},{"required":"yes","param":"string $object_name Name for the created JS object. This is passed directly so it should be qualified JS variable /a-zA-Z0-9_+/"},{"required":"yes","param":"array $l10n Associative PHP array containing the translated strings. HTML entities will be converted and the array will be JSON encoded."}],"desc":"Wrapper for $wp_scripts->localize().","returns":"bool Whether the localization was added successfully."},"wp_deregister_script":{"params":[],"desc":"Remove a registered script.","returns":""},"wp_enqueue_script":{"params":[],"desc":"Enqueues script.","returns":""},"wp_dequeue_script":{"params":[],"desc":"Remove an enqueued script.","returns":""},"wp_script_is":{"params":[{"required":"yes","param":"string $handle Handle used to add script."},{"required":"no","param":"string $list Optional, defaults to 'queue'. Others values are 'registered', 'queue', 'done', 'to_do'"}],"desc":"Check whether script has been added to WordPress Scripts.","returns":"bool "},"wpmu_update_blogs_date":{"params":[],"desc":"Update the last_updated field for the current blog.","returns":""},"get_blogaddress_by_id":{"params":[{"required":"yes","param":"int $blog_id Blog ID"}],"desc":"Get a full blog URL, given a blog id.","returns":"string "},"get_blogaddress_by_name":{"params":[{"required":"yes","param":"string $blogname The (subdomain or directory) name"}],"desc":"Get a full blog URL, given a blog name.","returns":"string "},"get_blogaddress_by_domain":{"params":[{"required":"yes","param":"string $domain "},{"required":"yes","param":"string $path "}],"desc":"Get a full blog URL, given a domain and a path.","returns":"string "},"get_id_from_blogname":{"params":[{"required":"yes","param":"string $name "}],"desc":"Given a blog's (subdomain or directory) name, retrieve it's id.","returns":"int A blog id"},"get_blog_details":{"params":[{"required":"yes","param":"int|string|array $fields A blog ID, a blog name, or an array of fields to query against."},{"required":"yes","param":"bool $get_all Whether to retrieve all details or only the details in the blogs table. Default is true."}],"desc":"Retrieve the details for a blog from the blogs table and blog options.","returns":"object Blog details."},"refresh_blog_details":{"params":[{"required":"yes","param":"int $blog_id Blog ID"}],"desc":"Clear the blog details cache.","returns":""},"update_blog_details":{"params":[{"required":"yes","param":"int $blog_id Blog ID"},{"required":"yes","param":"array $details Array of details keyed by blogs table field names."}],"desc":"Update the details for a blog. Updates the blogs table for a given blog id.","returns":"bool True if update succeeds, false otherwise."},"get_blog_option":{"params":[{"required":"no","param":"int $blog_id Optional. Blog ID, can be null to refer to the current blog."},{"required":"yes","param":"string $setting Name of option to retrieve. Should already be SQL-escaped."},{"required":"no","param":"string $default (optional) Default value returned if option not found."}],"desc":"Retrieve option value based on setting name and blog_id.","returns":"mixed Value set for the option."},"add_blog_option":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $key The option key"},{"required":"yes","param":"mixed $value The option value"}],"desc":"Add an option for a particular blog.","returns":"bool True on success, false on failure."},"delete_blog_option":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $key The option key"}],"desc":"Delete an option for a particular blog.","returns":"bool True on success, false on failure."},"update_blog_option":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $key The option key"},{"required":"yes","param":"mixed $value The option value"}],"desc":"Update an option for a particular blog.","returns":"bool True on success, false on failrue."},"switch_to_blog":{"params":[{"required":"yes","param":"int $new_blog The id of the blog you want to switch to. Default: current blog"},{"required":"yes","param":"bool $validate Whether to check if $new_blog exists before proceeding"}],"desc":"Switch the current blog.","returns":"bool True on success, False if the validation failed"},"restore_current_blog":{"params":[],"desc":"Restore the current blog, after calling switch_to_blog()","returns":"bool True on success, False if we're already on the current blog"},"is_archived":{"params":[{"required":"yes","param":"int $id The blog id"}],"desc":"Check if a particular blog is archived.","returns":"string Whether the blog is archived or not"},"update_archived":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $archived The new status"}],"desc":"Update the 'archived' status of a particular blog.","returns":"string $archived"},"update_blog_status":{"params":[{"required":"yes","param":"int $blog_id BLog ID"},{"required":"yes","param":"string $pref A field name"},{"required":"yes","param":"string $value Value for $pref"}],"desc":"Update a blog details field.","returns":"string $value"},"get_blog_status":{"params":[{"required":"yes","param":"int $id The blog id"},{"required":"yes","param":"string $pref A field name"}],"desc":"Get a blog details field.","returns":"bool $value"},"get_last_updated":{"params":[{"required":"yes","param":"mixed $deprecated Not used"},{"required":"yes","param":"int $start The offset"},{"required":"yes","param":"int $quantity The maximum number of blogs to retrieve. Default is 40."}],"desc":"Get a list of most recently updated blogs.","returns":"array The list of blogs"},"_update_blog_date_on_post_publish":{"params":[{"required":"yes","param":"string $new_status The new post status"},{"required":"yes","param":"string $old_status The old post status"},{"required":"yes","param":"object $post Post object"}],"desc":"Handler for updating the blog date when a post is published or an already published post is changed.","returns":""},"get_header":{"params":[{"required":"yes","param":"string $name The name of the specialised header."}],"desc":"Load header template.","returns":""},"get_footer":{"params":[{"required":"yes","param":"string $name The name of the specialised footer."}],"desc":"Load footer template.","returns":""},"get_sidebar":{"params":[{"required":"yes","param":"string $name The name of the specialised sidebar."}],"desc":"Load sidebar template.","returns":""},"get_template_part":{"params":[{"required":"yes","param":"string $slug The slug name for the generic template."},{"required":"yes","param":"string $name The name of the specialised template."}],"desc":"Load a template part into a template","returns":""},"get_search_form":{"params":[{"required":"yes","param":"boolean $echo Default to echo and not return the form."}],"desc":"Display search form.","returns":""},"wp_loginout":{"params":[{"required":"no","param":"string $redirect Optional path to redirect to on login/logout."},{"required":"yes","param":"boolean $echo Default to echo and not return the link."}],"desc":"Display the Log In/Out link.","returns":""},"wp_logout_url":{"params":[{"required":"yes","param":"string $redirect Path to redirect to on logout."}],"desc":"Returns the Log Out URL.","returns":""},"wp_login_url":{"params":[{"required":"yes","param":"string $redirect Path to redirect to on login."},{"required":"yes","param":"bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false."}],"desc":"Returns the Log In URL.","returns":"string A log in url"},"wp_login_form":{"params":[{"required":"yes","param":"array $args Configuration options to modify the form output"}],"desc":"Provides a simple login form for use anywhere within WordPress. By default, it echoes the HTML immediately. Pass array('echo'=>false) to return the string instead.","returns":"Void, or string containing the form"},"wp_lostpassword_url":{"params":[{"required":"yes","param":"string $redirect Path to redirect to on login."}],"desc":"Returns the Lost Password URL.","returns":""},"wp_register":{"params":[{"required":"yes","param":"string $before Text to output before the link (defaults to <li>)."},{"required":"yes","param":"string $after Text to output after the link (defaults to </li>)."},{"required":"yes","param":"boolean $echo Default to echo and not return the link."}],"desc":"Display the Registration or Admin link.","returns":""},"wp_meta":{"params":[],"desc":"Theme container function for the 'wp_meta' action.","returns":""},"bloginfo":{"params":[{"required":"yes","param":"string $show What to display."}],"desc":"Display information about the blog.","returns":""},"get_current_blog_id":{"params":[],"desc":"Retrieve the current blog id","returns":"int Blog id"},"wp_title":{"params":[{"required":"no","param":"string $sep Optional, default is '»'. How to separate the various items within the page title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."},{"required":"no","param":"string $seplocation Optional. Direction to display title, 'right'."}],"desc":"Display or retrieve page title for all areas of blog.","returns":"string|null String on retrieve, null when displaying."},"single_post_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for post.","returns":"string|null Title when retrieving, null when displaying or failure."},"post_type_archive_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve title for a post type archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_cat_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for category archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_tag_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for tag post archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_term_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for taxonomy term archive.","returns":"string|null Title when retrieving, null when displaying or failure."},"single_month_title":{"params":[{"required":"no","param":"string $prefix Optional. What to display before the title."},{"required":"no","param":"bool $display Optional, default is true. Whether to display or retrieve title."}],"desc":"Display or retrieve page title for post archive based on date.","returns":"string|null Title when retrieving, null when displaying or failure."},"get_archives_link":{"params":[{"required":"yes","param":"string $url URL to archive."},{"required":"yes","param":"string $text Archive text description."},{"required":"no","param":"string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom."},{"required":"no","param":"string $before Optional."},{"required":"no","param":"string $after Optional."}],"desc":"Retrieve archive link content based on predefined or custom code.","returns":"string HTML link content for archive."},"wp_get_archives":{"params":[{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Display archive links based on type and format.","returns":""},"calendar_week_mod":{"params":[{"required":"yes","param":"int $num Number of day."}],"desc":"Get number of days since the start of the week.","returns":"int Days since the start of the week."},"get_calendar":{"params":[{"required":"no","param":"bool $initial Optional, default is true. Use initial calendar names."},{"required":"no","param":"bool $echo Optional, default is true. Set to false for return."}],"desc":"Display calendar with days that have posts as links.","returns":""},"delete_get_calendar_cache":{"params":[],"desc":"Purge the cached results of get_calendar.","returns":""},"allowed_tags":{"params":[],"desc":"Display all of the allowed tags in HTML format with attributes.","returns":"string HTML allowed tags entity encoded."},"the_date_xml":{"params":[],"desc":"Outputs the date in iso8601 format for xml files.","returns":""},"the_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format defaults to the date_format option if not specified."},{"required":"no","param":"string $before Optional. Output before the date."},{"required":"no","param":"string $after Optional. Output after the date."},{"required":"no","param":"bool $echo Optional, default is display. Whether to echo the date or return it."}],"desc":"Display or Retrieve the date the current $post was written (once per date)","returns":"string|null Null if displaying, string if retrieving."},"get_the_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format defaults to the date_format option if not specified."}],"desc":"Retrieve the date the current $post was written.","returns":"string|null Null if displaying, string if retrieving."},"the_modified_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format defaults to the date_format option if not specified."},{"required":"no","param":"string $before Optional. Output before the date."},{"required":"no","param":"string $after Optional. Output after the date."},{"required":"no","param":"bool $echo Optional, default is display. Whether to echo the date or return it."}],"desc":"Display the date on which the post was last modified.","returns":"string|null Null if displaying, string if retrieving."},"get_the_modified_date":{"params":[{"required":"no","param":"string $d Optional. PHP date format. Defaults to the "date_format" option"}],"desc":"Retrieve the date on which the post was last modified.","returns":"string "},"the_time":{"params":[{"required":"yes","param":"string $d Either 'G', 'U', or php date format."}],"desc":"Display the time at which the post was written.","returns":""},"get_the_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option."},{"required":"no","param":"int|object $post Optional post ID or object. Default is global $post object."}],"desc":"Retrieve the time at which the post was written.","returns":"string "},"get_post_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format."},{"required":"no","param":"bool $gmt Optional, default is false. Whether to return the gmt time."},{"required":"no","param":"int|object $post Optional post ID or object. Default is global $post object."},{"required":"yes","param":"bool $translate Whether to translate the time string"}],"desc":"Retrieve the time at which the post was written.","returns":"string "},"the_modified_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option."}],"desc":"Display the time at which the post was last modified.","returns":""},"get_the_modified_time":{"params":[{"required":"no","param":"string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option."}],"desc":"Retrieve the time at which the post was last modified.","returns":"string "},"get_post_modified_time":{"params":[{"required":"no","param":"string $d Optional, default is 'U'. Either 'G', 'U', or php date format."},{"required":"no","param":"bool $gmt Optional, default is false. Whether to return the gmt time."},{"required":"no","param":"int|object $post Optional, default is global post object. A post_id or post object"},{"required":"no","param":"bool $translate Optional, default is false. Whether to translate the result"}],"desc":"Retrieve the time at which the post was last modified.","returns":"string Returns timestamp"},"the_weekday":{"params":[],"desc":"Display the weekday on which the post was written.","returns":""},"the_weekday_date":{"params":[{"required":"no","param":"string $before Optional Output before the date."},{"required":"no","param":"string $after Optional Output after the date."}],"desc":"Display the weekday on which the post was written.","returns":""},"wp_head":{"params":[],"desc":"Fire the wp_head action","returns":""},"wp_footer":{"params":[],"desc":"Fire the wp_footer action","returns":""},"feed_links":{"params":[{"required":"no","param":"array $args Optional arguments."}],"desc":"Display the links to the general feeds.","returns":""},"feed_links_extra":{"params":[{"required":"no","param":"array $args Optional arguments."}],"desc":"Display the links to the extra feeds such as category feeds.","returns":""},"rsd_link":{"params":[],"desc":"Display the link to the Really Simple Discovery service endpoint.","returns":""},"wlwmanifest_link":{"params":[],"desc":"Display the link to the Windows Live Writer manifest file.","returns":""},"noindex":{"params":[],"desc":"Display a noindex meta tag if required by the blog configuration.","returns":""},"wp_no_robots":{"params":[],"desc":"Display a noindex meta tag.","returns":""},"rich_edit_exists":{"params":[],"desc":"Determine if TinyMCE is available.","returns":"bool Whether TinyMCE exists."},"user_can_richedit":{"params":[],"desc":"Whether the user should have a WYSIWIG editor.","returns":"bool "},"wp_default_editor":{"params":[],"desc":"Find out which editor should be displayed by default.","returns":"string Either 'tinymce', or 'html', or 'test'"},"wp_editor":{"params":[{"required":"yes","param":"string $content Initial content for the editor."},{"required":"yes","param":"string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /a-z+/."},{"required":"yes","param":"array $settings See _WP_Editors::editor()."}],"desc":"Renders an editor.","returns":""},"get_search_query":{"params":[{"required":"yes","param":"bool $escaped Whether the result is escaped. Default true. Only use when you are later escaping it. Do not use unescaped."}],"desc":"Retrieve the contents of the search WordPress query variable.","returns":"string "},"the_search_query":{"params":[],"desc":"Display the contents of the search query variable.","returns":""},"language_attributes":{"params":[{"required":"yes","param":"string $doctype The type of html document (xhtml|html)."}],"desc":"Display the language attributes for the html tag.","returns":""},"paginate_links":{"params":[{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Retrieve paginated link for archive post pages.","returns":"array|string String of page links or array of page links."},"wp_admin_css_color":{"params":[{"required":"yes","param":"string $key The unique key for this theme."},{"required":"yes","param":"string $name The name of the theme."},{"required":"yes","param":"string $url The url of the css file containing the colour scheme."},{"required":"no","param":"array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme."}],"desc":"Registers an admin colour scheme css file.","returns":""},"register_admin_color_schemes":{"params":[],"desc":"Registers the default Admin color schemes","returns":""},"wp_admin_css_uri":{"params":[{"required":"yes","param":"string $file file relative to wp-admin/ without its ".css" extension."}],"desc":"Display the URL of a WordPress admin CSS file.","returns":""},"wp_admin_css":{"params":[{"required":"no","param":"string $file Optional. Style handle name or file name (without ".css" extension) relative to wp-admin/. Defaults to 'wp-admin'."},{"required":"no","param":"bool $force_echo Optional. Force the stylesheet link to be printed rather than enqueued."}],"desc":"Enqueues or directly prints a stylesheet link to the specified CSS file.","returns":""},"add_thickbox":{"params":[],"desc":"Enqueues the default ThickBox js and css.","returns":""},"wp_generator":{"params":[],"desc":"Display the XHTML generator that is generated on the wp_head hook.","returns":""},"the_generator":{"params":[{"required":"yes","param":"string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export)."}],"desc":"Display the generator XML or Comment for RSS, ATOM, etc.","returns":""},"get_the_generator":{"params":[{"required":"yes","param":"string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export)."}],"desc":"Creates the generator XML or Comment for RSS, ATOM, etc.","returns":"string The HTML content for the generator."},"checked":{"params":[{"required":"yes","param":"mixed $checked One of the values to compare"},{"required":"yes","param":"mixed $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"}],"desc":"Outputs the html checked attribute.","returns":"string html attribute or empty string"},"selected":{"params":[{"required":"yes","param":"mixed $selected One of the values to compare"},{"required":"yes","param":"mixed $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"}],"desc":"Outputs the html selected attribute.","returns":"string html attribute or empty string"},"disabled":{"params":[{"required":"yes","param":"mixed $disabled One of the values to compare"},{"required":"yes","param":"mixed $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"}],"desc":"Outputs the html disabled attribute.","returns":"string html attribute or empty string"},"__checked_selected_helper":{"params":[{"required":"yes","param":"any $helper One of the values to compare"},{"required":"yes","param":"any $current (true) The other value to compare if not just true"},{"required":"yes","param":"bool $echo Whether to echo or just return the string"},{"required":"yes","param":"string $type The type of checked|selected|disabled we are doing"}],"desc":"Private helper function for checked, selected, and disabled.","returns":"string html attribute or empty string"},"add_shortcode":{"params":[{"required":"yes","param":"string $tag Shortcode tag to be searched in post content."},{"required":"yes","param":"callable $func Hook to run when shortcode is found."}],"desc":"Add hook for shortcode tag.","returns":""},"remove_shortcode":{"params":[{"required":"yes","param":"string $tag shortcode tag to remove hook for."}],"desc":"Removes hook for shortcode.","returns":""},"remove_all_shortcodes":{"params":[],"desc":"Clear all shortcodes.","returns":""},"do_shortcode":{"params":[{"required":"yes","param":"string $content Content to search for shortcodes"}],"desc":"Search content for shortcodes and filter shortcodes through their hooks.","returns":"string Content with shortcodes filtered out."},"get_shortcode_regex":{"params":[],"desc":"Retrieve the shortcode regular expression for searching.","returns":"string The shortcode search regular expression"},"do_shortcode_tag":{"params":[{"required":"yes","param":"array $m Regular expression match array"}],"desc":"Regular Expression callable for do_shortcode() for calling shortcode hook.","returns":"mixed False on failure."},"shortcode_parse_atts":{"params":[{"required":"yes","param":"string $text "}],"desc":"Retrieve all attributes from the shortcodes tag.","returns":"array List of attributes and their value."},"shortcode_atts":{"params":[{"required":"yes","param":"array $pairs Entire list of supported attributes and their defaults."},{"required":"yes","param":"array $atts User defined attributes in shortcode tag."}],"desc":"Combine user attributes with known attributes and fill in defaults when needed.","returns":"array Combined and filtered attribute list."},"strip_shortcodes":{"params":[{"required":"yes","param":"string $content Content to remove shortcode tags."}],"desc":"Remove all shortcode tags from the given content.","returns":"string Content without shortcode tags."},"strip_shortcode_tag":{"params":[],"desc":"","returns":""},"get_the_author":{"params":[{"required":"yes","param":"string $deprecated Deprecated."}],"desc":"Retrieve the author of the current post.","returns":"string The author's display name."},"the_author":{"params":[{"required":"yes","param":"string $deprecated Deprecated."},{"required":"yes","param":"string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it."}],"desc":"Display the name of the author of the current post.","returns":"string The author's display name, from get_the_author()."},"get_the_modified_author":{"params":[],"desc":"Retrieve the author who last edited the current post.","returns":"string The author's display name."},"the_modified_author":{"params":[],"desc":"Display the name of the author who last edited the current post.","returns":"string The author's display name, from get_the_modified_author()."},"get_the_author_meta":{"params":[{"required":"yes","param":"string $field selects the field of the users record."},{"required":"no","param":"int $user_id Optional. User ID."}],"desc":"Retrieve the requested data of the author of the current post.","returns":"string The author's field from the current author's DB object."},"the_author_meta":{"params":[{"required":"yes","param":"string $field selects the field of the users record."},{"required":"no","param":"int $user_id Optional. User ID."}],"desc":"Retrieve the requested data of the author of the current post.","returns":""},"get_the_author_link":{"params":[],"desc":"Retrieve either author's link or author's name.","returns":""},"the_author_link":{"params":[],"desc":"Display either author's link or author's name.","returns":""},"get_the_author_posts":{"params":[],"desc":"Retrieve the number of posts by the author of the current post.","returns":"int The number of posts by the author."},"the_author_posts":{"params":[],"desc":"Display the number of posts by the author of the current post.","returns":""},"the_author_posts_link":{"params":[{"required":"yes","param":"string $deprecated Deprecated."}],"desc":"Display an HTML link to the author page of the author of the current post.","returns":""},"get_author_posts_url":{"params":[],"desc":"Retrieve the URL to the author page for the user with the ID provided.","returns":"string The URL to the author's page."},"wp_list_authors":{"params":[{"required":"yes","param":"array $args The argument array."}],"desc":"List all the authors of the blog, with several options available.","returns":"null|string The output, if echo is set to false."},"is_multi_author":{"params":[],"desc":"Does this site have more than one author","returns":"bool Whether or not we have more than one author"},"__clear_multi_author_cache":{"params":[],"desc":"Helper function to clear the cache for number of authors.","returns":""},"the_permalink":{"params":[],"desc":"Display the permalink for the current post.","returns":""},"user_trailingslashit":{"params":[{"required":"yes","param":"string $string URL with or without a trailing slash."},{"required":"yes","param":"string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter."}],"desc":"Retrieve trailing slash string, if blog set for adding trailing slashes.","returns":"string "},"permalink_anchor":{"params":[{"required":"yes","param":"string $mode Permalink mode can be either 'title', 'id', or default, which is 'id'."}],"desc":"Display permalink anchor for current post.","returns":""},"get_permalink":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional, defaults to false. Whether to keep post name or page name."}],"desc":"Retrieve full permalink for current post or post ID.","returns":"string "},"get_post_permalink":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional, defaults to false. Whether to keep post name."},{"required":"no","param":"bool $sample Optional, defaults to false. Is it a sample permalink."}],"desc":"Retrieve the permalink for a post with a custom post type.","returns":"string "},"post_permalink":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"yes","param":"mixed $deprecated Not used."}],"desc":"Retrieve permalink from post ID.","returns":"string "},"get_page_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional, defaults to false. Whether to keep page name."},{"required":"no","param":"bool $sample Optional, defaults to false. Is it a sample permalink."}],"desc":"Retrieve the permalink for current page or page ID.","returns":"string "},"_get_page_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $leavename Optional. Leave name."},{"required":"no","param":"bool $sample Optional. Sample permalink."}],"desc":"Retrieve the page permalink.","returns":"string "},"get_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Retrieve permalink for attachment.","returns":"string "},"get_year_link":{"params":[{"required":"yes","param":"int|bool $year False for current year or year for permalink."}],"desc":"Retrieve the permalink for the year archives.","returns":"string "},"get_month_link":{"params":[{"required":"yes","param":"bool|int $year False for current year. Integer of year."},{"required":"yes","param":"bool|int $month False for current month. Integer of month."}],"desc":"Retrieve the permalink for the month archives with year.","returns":"string "},"get_day_link":{"params":[{"required":"yes","param":"bool|int $year False for current year. Integer of year."},{"required":"yes","param":"bool|int $month False for current month. Integer of month."},{"required":"yes","param":"bool|int $day False for current day. Integer of day."}],"desc":"Retrieve the permalink for the day archives with year and month.","returns":"string "},"the_feed_link":{"params":[{"required":"yes","param":"string $anchor The link's anchor text."},{"required":"no","param":"string $feed Optional, defaults to default feed. Feed type."}],"desc":"Display the permalink for the feed type.","returns":""},"get_feed_link":{"params":[{"required":"no","param":"string $feed Optional, defaults to default feed. Feed type."}],"desc":"Retrieve the permalink for the feed type.","returns":"string "},"get_post_comments_feed_link":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the permalink for the post comments feed.","returns":"string "},"post_comments_feed_link":{"params":[{"required":"yes","param":"string $link_text Descriptive text."},{"required":"no","param":"int $post_id Optional post ID. Default to current post."},{"required":"no","param":"string $feed Optional. Feed format."}],"desc":"Display the comment feed link for a post.","returns":"string Link to the comment feed for the current post."},"get_author_feed_link":{"params":[{"required":"yes","param":"int $author_id ID of an author."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the feed link for a given author.","returns":"string Link to the feed for the author specified by $author_id."},"get_category_feed_link":{"params":[{"required":"yes","param":"int $cat_id ID of a category."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the feed link for a category.","returns":"string Link to the feed for the category specified by $cat_id."},"get_term_feed_link":{"params":[{"required":"yes","param":"int $term_id ID of a category."},{"required":"no","param":"string $taxonomy Optional. Taxonomy of $term_id"},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the feed link for a term.","returns":"string Link to the feed for the term specified by $term_id and $taxonomy."},"get_tag_feed_link":{"params":[{"required":"yes","param":"int $tag_id Tag ID."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve permalink for feed of tag.","returns":"string "},"get_edit_tag_link":{"params":[{"required":"yes","param":"int $tag_id Tag ID"},{"required":"yes","param":"string $taxonomy Taxonomy"}],"desc":"Retrieve edit tag link.","returns":"string "},"edit_tag_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"yes","param":"int|object $tag Tag object or ID"}],"desc":"Display or retrieve edit tag link with formatting.","returns":"string HTML content."},"get_edit_term_link":{"params":[{"required":"yes","param":"int $term_id Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy"},{"required":"yes","param":"string $object_type The object type"}],"desc":"Retrieve edit term url.","returns":"string "},"edit_term_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"yes","param":"object $term Term object"}],"desc":"Display or retrieve edit term link with formatting.","returns":"string HTML content."},"get_search_link":{"params":[{"required":"no","param":"string $query Optional. The query string to use. If empty the current query is used."}],"desc":"Retrieve permalink for search.","returns":"string "},"get_search_feed_link":{"params":[{"required":"no","param":"string $search_query Optional. Search query."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the permalink for the feed of the search results.","returns":"string "},"get_search_comments_feed_link":{"params":[{"required":"no","param":"string $search_query Optional. Search query."},{"required":"no","param":"string $feed Optional. Feed type."}],"desc":"Retrieve the permalink for the comments feed of the search results.","returns":"string "},"get_post_type_archive_link":{"params":[{"required":"yes","param":"string $post_type Post type"}],"desc":"Retrieve the permalink for a post type archive.","returns":"string "},"get_post_type_archive_feed_link":{"params":[{"required":"yes","param":"string $post_type Post type"},{"required":"no","param":"string $feed Optional. Feed type"}],"desc":"Retrieve the permalink for a post type archive feed.","returns":"string "},"get_edit_post_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"string $context Optional, defaults to display. How to write the '&', defaults to '&'."}],"desc":"Retrieve edit posts link for post.","returns":"string "},"edit_post_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Display edit post link for post.","returns":""},"get_delete_post_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"yes","param":"string $deprecated Not used."},{"required":"yes","param":"bool $force_delete Whether to bypass trash and force deletion. Default is false."}],"desc":"Retrieve delete posts link for post.","returns":"string "},"get_edit_comment_link":{"params":[{"required":"no","param":"int $comment_id Optional. Comment ID."}],"desc":"Retrieve edit comment link.","returns":"string "},"edit_comment_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."}],"desc":"Display or retrieve edit comment link with formatting.","returns":"string|null HTML content, if $echo is set to false."},"get_edit_bookmark_link":{"params":[{"required":"no","param":"int $link Optional. Bookmark ID."}],"desc":"Display edit bookmark (literally a URL external to blog) link.","returns":"string "},"edit_bookmark_link":{"params":[{"required":"no","param":"string $link Optional. Anchor text."},{"required":"no","param":"string $before Optional. Display before edit link."},{"required":"no","param":"string $after Optional. Display after edit link."},{"required":"no","param":"int $bookmark Optional. Bookmark ID."}],"desc":"Display edit bookmark (literally a URL external to blog) link anchor content.","returns":""},"get_previous_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Retrieve previous post that is adjacent to current post.","returns":"mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists."},"get_next_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Retrieve next post that is adjacent to current post.","returns":"mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists."},"get_adjacent_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $previous Optional. Whether to retrieve previous post."}],"desc":"Retrieve adjacent post.","returns":"mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists."},"get_adjacent_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $previous Optional, default is true. Whether to display link to previous or next post."}],"desc":"Get adjacent post relational link.","returns":"string "},"adjacent_posts_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display relational links for the posts adjacent to the current post.","returns":""},"adjacent_posts_rel_link_wp_head":{"params":[],"desc":"Display relational links for the posts adjacent to the current post for single post pages.","returns":""},"next_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display relational link for the next post adjacent to the current post.","returns":""},"prev_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display relational link for the previous post adjacent to the current post.","returns":""},"get_boundary_post":{"params":[{"required":"no","param":"bool $in_same_cat Optional. Whether returned post should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $start Optional. Whether to retrieve first or last post."}],"desc":"Retrieve boundary post.","returns":"object "},"previous_post_link":{"params":[{"required":"no","param":"string $format Optional. Link anchor format."},{"required":"no","param":"string $link Optional. Link permalink format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display previous post link that is adjacent to the current post.","returns":""},"next_post_link":{"params":[{"required":"no","param":"string $format Optional. Link anchor format."},{"required":"no","param":"string $link Optional. Link permalink format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."}],"desc":"Display next post link that is adjacent to the current post.","returns":""},"adjacent_post_link":{"params":[{"required":"yes","param":"string $format Link anchor format."},{"required":"yes","param":"string $link Link permalink format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs."},{"required":"no","param":"bool $previous Optional, default is true. Whether to display link to previous or next post."}],"desc":"Display adjacent post link.","returns":""},"get_pagenum_link":{"params":[{"required":"no","param":"int $pagenum Optional. Page ID."}],"desc":"Retrieve links for page numbers.","returns":"string "},"get_next_posts_page_link":{"params":[{"required":"no","param":"int $max_page Optional. Max pages."}],"desc":"Retrieve next posts page link.","returns":"string "},"next_posts":{"params":[{"required":"no","param":"int $max_page Optional. Max pages."},{"required":"no","param":"boolean $echo Optional. Echo or return;"}],"desc":"Display or return the next posts page link.","returns":""},"get_next_posts_link":{"params":[{"required":"yes","param":"string $label Content for link text."},{"required":"no","param":"int $max_page Optional. Max pages."}],"desc":"Return the next posts page link.","returns":"string|null "},"next_posts_link":{"params":[{"required":"yes","param":"string $label Content for link text."},{"required":"no","param":"int $max_page Optional. Max pages."}],"desc":"Display the next posts page link.","returns":""},"get_previous_posts_page_link":{"params":[],"desc":"Retrieve previous posts page link.","returns":"string|null "},"previous_posts":{"params":[{"required":"no","param":"boolean $echo Optional. Echo or return;"}],"desc":"Display or return the previous posts page link.","returns":""},"get_previous_posts_link":{"params":[{"required":"no","param":"string $label Optional. Previous page link text."}],"desc":"Return the previous posts page link.","returns":"string|null "},"previous_posts_link":{"params":[{"required":"no","param":"string $label Optional. Previous page link text."}],"desc":"Display the previous posts page link.","returns":""},"get_posts_nav_link":{"params":[{"required":"no","param":"string|array $args Optional args."}],"desc":"Return post pages link navigation for previous and next pages.","returns":"string The posts link navigation."},"posts_nav_link":{"params":[{"required":"no","param":"string $sep Optional. Separator for posts navigation links."},{"required":"no","param":"string $prelabel Optional. Label for previous pages."},{"required":"no","param":"string $nxtlabel Optional Label for next pages."}],"desc":"Display post pages link navigation for previous and next pages.","returns":""},"get_comments_pagenum_link":{"params":[{"required":"no","param":"int $pagenum Optional. Page number."}],"desc":"Retrieve comments page number link.","returns":"string "},"get_next_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for link text."},{"required":"no","param":"int $max_page Optional. Max page."}],"desc":"Return the link to next comments page.","returns":"string|null "},"next_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for link text."},{"required":"no","param":"int $max_page Optional. Max page."}],"desc":"Display the link to next comments page.","returns":""},"get_previous_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for comments link text."}],"desc":"Return the previous comments page link.","returns":"string|null "},"previous_comments_link":{"params":[{"required":"no","param":"string $label Optional. Label for comments link text."}],"desc":"Display the previous comments page link.","returns":""},"paginate_comments_links":{"params":[{"required":"no","param":"string|array $args Optional args. See paginate_links()."}],"desc":"Create pagination links for the comments on the current post.","returns":"string Markup for pagination links."},"get_shortcut_link":{"params":[],"desc":"Retrieve shortcut link.","returns":"string "},"get_home_url":{"params":[{"required":"no","param":"int $blog_id (optional) Blog ID. Defaults to current blog."},{"required":"no","param":"string $path (optional) Path relative to the home url."},{"required":"no","param":"string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'."}],"desc":"Retrieve the home url for a given site.","returns":"string Home url link with optional path appended."},"get_site_url":{"params":[{"required":"no","param":"int $blog_id (optional) Blog ID. Defaults to current blog."},{"required":"no","param":"string $path Optional. Path relative to the site url."},{"required":"no","param":"string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'."}],"desc":"Retrieve the site url for a given site.","returns":"string Site url link with optional path appended."},"get_admin_url":{"params":[{"required":"no","param":"int $blog_id (optional) Blog ID. Defaults to current blog."},{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for a given site.","returns":"string Admin url link with optional path appended."},"content_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the content url."}],"desc":"Retrieve the url to the content directory.","returns":"string Content url link with optional path appended."},"plugins_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the plugins url."},{"required":"no","param":"string $plugin Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__"}],"desc":"Retrieve the url to the plugins directory or to a specific file within that directory.","returns":"string Plugins url link with optional path appended."},"network_site_url":{"params":[{"required":"no","param":"string $path Optional. Path relative to the site url."},{"required":"no","param":"string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'."}],"desc":"Retrieve the site url for the current network.","returns":"string Site url link with optional path appended."},"network_home_url":{"params":[{"required":"no","param":"string $path (optional) Path relative to the home url."},{"required":"no","param":"string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'."}],"desc":"Retrieve the home url for the current network.","returns":"string Home url link with optional path appended."},"network_admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for the network.","returns":"string Admin url link with optional path appended."},"user_admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for the current user.","returns":"string Admin url link with optional path appended."},"self_admin_url":{"params":[{"required":"no","param":"string $path Optional path relative to the admin url."},{"required":"yes","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."}],"desc":"Retrieve the url to the admin area for either the current blog or the network depending on context.","returns":"string Admin url link with optional path appended."},"get_dashboard_url":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"no","param":"string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins."},{"required":"yes","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."}],"desc":"Get the URL to the user's dashboard.","returns":"string Dashboard url link with optional path appended."},"get_edit_profile_url":{"params":[{"required":"yes","param":"int $user User ID"},{"required":"yes","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."}],"desc":"Get the URL to the user's profile editor.","returns":"string Dashboard url link with optional path appended."},"rel_canonical":{"params":[],"desc":"Output rel=canonical for singular queries.","returns":""},"wp_get_shortlink":{"params":[{"required":"yes","param":"int $id A post or blog id. Default is 0, which means the current post or blog."},{"required":"yes","param":"string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'."},{"required":"yes","param":"bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this."}],"desc":"Return a shortlink for a post, page, attachment, or blog.","returns":"string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled."},"wp_shortlink_wp_head":{"params":[],"desc":"Inject rel=shortlink into head if a shortlink is defined for the current page.","returns":""},"wp_shortlink_header":{"params":[],"desc":"Send a Link: rel=shortlink header if a shortlink is defined for the current page.","returns":""},"the_shortlink":{"params":[{"required":"no","param":"string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'"},{"required":"no","param":"string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title."},{"required":"no","param":"string $before Optional HTML to display before the link."},{"required":"no","param":"string $after Optional HTML to display after the link."}],"desc":"Display the Short Link for a Post","returns":""},"create_initial_taxonomies":{"params":[],"desc":"Creates the initial taxonomies when 'init' action is fired.","returns":""},"get_taxonomies":{"params":[{"required":"yes","param":"array $args An array of key => value arguments to match against the taxonomy objects."},{"required":"yes","param":"string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default."},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."}],"desc":"Get a list of registered taxonomy objects.","returns":"array A list of taxonomy names or objects"},"get_object_taxonomies":{"params":[{"required":"yes","param":"array|string|object $object Name of the type of taxonomy object, or an object (row from posts)"},{"required":"yes","param":"string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default."}],"desc":"Return all of the taxonomy names that are of $object_type.","returns":"array The names of all taxonomy of $object_type."},"get_taxonomy":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object to return"}],"desc":"Retrieves the taxonomy object of $taxonomy.","returns":"object|bool The Taxonomy Object or false if $taxonomy doesn't exist"},"taxonomy_exists":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"}],"desc":"Checks that the taxonomy name exists.","returns":"bool Whether the taxonomy exists."},"is_taxonomy_hierarchical":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"}],"desc":"Whether the taxonomy object is hierarchical.","returns":"bool Whether the taxonomy is hierarchical"},"register_taxonomy":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"},{"required":"yes","param":"array|string $object_type Name of the object type for the taxonomy object."},{"required":"yes","param":"array|string $args See above description for the two keys values."}],"desc":"Create or modify a taxonomy object. Do not use before init.","returns":""},"get_taxonomy_labels":{"params":[{"required":"yes","param":"object $tax Taxonomy object"}],"desc":"Builds an object with all taxonomy labels out of a taxonomy object","returns":"object object with all the labels as member variables"},"register_taxonomy_for_object_type":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"},{"required":"yes","param":"array|string $object_type Name of the object type"}],"desc":"Add an already registered taxonomy to an object type.","returns":"bool True if successful, false if not"},"get_objects_in_term":{"params":[{"required":"yes","param":"int|array $term_ids Term id or array of term ids of terms that will be used"},{"required":"yes","param":"string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names"},{"required":"yes","param":"array|string $args Change the order of the object_ids, either ASC or DESC"}],"desc":"Retrieve object_ids of valid taxonomy and term.","returns":"WP_Error|array If the taxonomy does not exist, then WP_Error will be returned. On success the array can be empty meaning that there are no $object_ids found or it will return the $object_ids found."},"get_tax_sql":{"params":[{"required":"yes","param":"array $tax_query A compact tax query"},{"required":"yes","param":"string $primary_table "},{"required":"yes","param":"string $primary_id_column "}],"desc":"Given a taxonomy query, generates SQL to be appended to a main query.","returns":"array "},"get_term":{"params":[{"required":"yes","param":"int|object $term If integer, will get from database. If object will apply filters and return $term."},{"required":"yes","param":"string $taxonomy Taxonomy name that $term is part of."},{"required":"yes","param":"string $output Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional, default is raw or no WordPress defined filter will applied."}],"desc":"Get all Term data from database by Term ID.","returns":"mixed|null|WP_Error Term Row from database. Will return null if $term is empty. If taxonomy does not exist then WP_Error will be returned."},"get_term_by":{"params":[{"required":"yes","param":"string $field Either 'slug', 'name', or 'id'"},{"required":"yes","param":"string|int $value Search for this term value"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"yes","param":"string $output Constant OBJECT, ARRAY_A, or ARRAY_N"},{"required":"no","param":"string $filter Optional, default is raw or no WordPress defined filter will applied."}],"desc":"Get all Term data from database by Term field and data.","returns":"mixed Term Row from database. Will return false if $taxonomy does not exist or $term was not found."},"get_term_children":{"params":[{"required":"yes","param":"string $term_id ID of Term to get children"},{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Merge all term children into a single array of their IDs.","returns":"array|WP_Error List of Term Objects. WP_Error returned if $taxonomy does not exist"},"get_term_field":{"params":[{"required":"yes","param":"string $field Term field to fetch"},{"required":"yes","param":"int $term Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"no","param":"string $context Optional, default is display. Look at sanitize_term_field() for available options."}],"desc":"Get sanitized Term field.","returns":"mixed Will return an empty string if $term is not an object or if $field is not set in $term."},"get_term_to_edit":{"params":[{"required":"yes","param":"int|object $id Term ID or Object"},{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Sanitizes Term for editing.","returns":"mixed|null|WP_Error Will return empty string if $term is not an object."},"get_terms":{"params":[{"required":"yes","param":"string|array $taxonomies Taxonomy name or list of Taxonomy names"},{"required":"yes","param":"string|array $args The values of what to search for when returning terms"}],"desc":"Retrieve the terms in a given taxonomy or list of taxonomies.","returns":"array|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies do not exist."},"term_exists":{"params":[{"required":"yes","param":"int|string $term The term to check"},{"required":"yes","param":"string $taxonomy The taxonomy name to use"},{"required":"yes","param":"int $parent ID of parent term under which to confine the exists search."}],"desc":"Check if Term exists.","returns":"mixed Get the term id or Term Object, if exists."},"sanitize_term":{"params":[{"required":"yes","param":"array|object $term The term to check"},{"required":"yes","param":"string $taxonomy The taxonomy name to use"},{"required":"yes","param":"string $context Default is 'display'."}],"desc":"Sanitize Term all fields.","returns":"array|object Term with all fields sanitized"},"sanitize_term_field":{"params":[{"required":"yes","param":"string $field Term field to sanitize"},{"required":"yes","param":"string $value Search for this term value"},{"required":"yes","param":"int $term_id Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"yes","param":"string $context Either edit, db, display, attribute, or js."}],"desc":"Cleanse the field value in the term based on the context.","returns":"mixed sanitized field"},"wp_count_terms":{"params":[{"required":"yes","param":"string $taxonomy Taxonomy name"},{"required":"yes","param":"array|string $args Overwrite defaults. See get_terms()"}],"desc":"Count how many terms are in Taxonomy.","returns":"int How many terms are in $taxonomy"},"wp_delete_object_term_relationships":{"params":[{"required":"yes","param":"int $object_id The term Object Id that refers to the term"},{"required":"yes","param":"string|array $taxonomies List of Taxonomy Names or single Taxonomy name."}],"desc":"Will unlink the object from the taxonomy or taxonomies.","returns":""},"wp_delete_term":{"params":[{"required":"yes","param":"int $term Term ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"},{"required":"no","param":"array|string $args Optional. Change 'default' term id and override found term ids."}],"desc":"Removes a term from the database.","returns":"bool|WP_Error Returns false if not term; true if completes delete action."},"wp_delete_category":{"params":[{"required":"yes","param":"int $cat_ID "}],"desc":"Deletes one existing category.","returns":"mixed Returns true if completes delete action; false if term doesn't exist; Zero on attempted deletion of default Category; WP_Error object is also a possibility."},"wp_get_object_terms":{"params":[{"required":"yes","param":"int|array $object_ids The ID(s) of the object(s) to retrieve."},{"required":"yes","param":"string|array $taxonomies The taxonomies to retrieve terms from."},{"required":"yes","param":"array|string $args Change what is returned"}],"desc":"Retrieves the terms associated with the given object(s), in the supplied taxonomies.","returns":"array|WP_Error The requested term data or empty array if no terms found. WP_Error if $taxonomy does not exist."},"wp_insert_term":{"params":[{"required":"yes","param":"string $term The term to add or update."},{"required":"yes","param":"string $taxonomy The taxonomy to which to add the term"},{"required":"yes","param":"array|string $args Change the values of the inserted term"}],"desc":"Adds a new term to the database. Optionally marks it as an alias of an existing term.","returns":"array|WP_Error The Term ID and Term Taxonomy ID"},"wp_set_object_terms":{"params":[{"required":"yes","param":"int $object_id The object to relate to."},{"required":"yes","param":"array|int|string $terms The slug or id of the term, will replace all existing related terms in this taxonomy."},{"required":"yes","param":"array|string $taxonomy The context in which to relate the term to the object."},{"required":"yes","param":"bool $append If false will delete difference of terms."}],"desc":"Create Term and Taxonomy Relationships.","returns":"array|WP_Error Affected Term IDs"},"wp_unique_term_slug":{"params":[{"required":"yes","param":"string $slug The string that will be tried for a unique slug"},{"required":"yes","param":"object $term The term object that the $slug will belong too"}],"desc":"Will make slug unique, if it isn't already.","returns":"string Will return a true unique slug."},"wp_update_term":{"params":[{"required":"yes","param":"int $term_id The ID of the term"},{"required":"yes","param":"string $taxonomy The context in which to relate the term to the object."},{"required":"yes","param":"array|string $args Overwrite term field values"}],"desc":"Update term based on arguments provided.","returns":"array|WP_Error Returns Term ID and Taxonomy Term ID"},"wp_defer_term_counting":{"params":[{"required":"no","param":"bool $defer Optional. Enable if true, disable if false."}],"desc":"Enable or disable term counting.","returns":"bool Whether term counting is enabled or disabled."},"wp_update_term_count":{"params":[{"required":"yes","param":"int|array $terms The term_taxonomy_id of the terms"},{"required":"yes","param":"string $taxonomy The context of the term."}],"desc":"Updates the amount of terms in taxonomy.","returns":"bool If no terms will return false, and if successful will return true."},"wp_update_term_count_now":{"params":[{"required":"yes","param":"array $terms The term_taxonomy_id of terms to update."},{"required":"yes","param":"string $taxonomy The context of the term."}],"desc":"Perform term count update immediately.","returns":"bool Always true when complete."},"clean_object_term_cache":{"params":[{"required":"yes","param":"int|array $object_ids Single or list of term object ID(s)"},{"required":"yes","param":"array|string $object_type The taxonomy object type"}],"desc":"Removes the taxonomy relationship to terms from the cache.","returns":""},"clean_term_cache":{"params":[{"required":"yes","param":"int|array $ids Single or list of Term IDs"},{"required":"yes","param":"string $taxonomy Can be empty and will assume tt_ids, else will use for context."},{"required":"yes","param":"bool $clean_taxonomy Whether to clean taxonomy wide caches (true), or just individual term object caches (false). Default is true."}],"desc":"Will remove all of the term ids from the cache.","returns":""},"get_object_term_cache":{"params":[{"required":"yes","param":"int|array $id Term object ID"},{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Retrieves the taxonomy relationship to the term object id.","returns":"bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id."},"update_object_term_cache":{"params":[{"required":"yes","param":"string|array $object_ids Single or list of term object ID(s)"},{"required":"yes","param":"array|string $object_type The taxonomy object type"}],"desc":"Updates the cache for Term ID(s).","returns":"null|bool Null value is given with empty $object_ids. False if"},"update_term_cache":{"params":[{"required":"yes","param":"array $terms List of Term objects to change"},{"required":"no","param":"string $taxonomy Optional. Update Term to this taxonomy in cache"}],"desc":"Updates Terms to Taxonomy in cache.","returns":""},"_get_term_hierarchy":{"params":[{"required":"yes","param":"string $taxonomy Taxonomy Name"}],"desc":"Retrieves children of taxonomy as Term IDs.","returns":"array Empty if $taxonomy isn't hierarchical or returns children as Term IDs."},"_get_term_children":{"params":[{"required":"yes","param":"int $term_id The ancestor term: all returned terms should be descendants of $term_id."},{"required":"yes","param":"array $terms The set of terms---either an array of term objects or term IDs---from which those that are descendants of $term_id will be chosen."},{"required":"yes","param":"string $taxonomy The taxonomy which determines the hierarchy of the terms."}],"desc":"Get the subset of $terms that are descendants of $term_id.","returns":"array The subset of $terms that are descendants of $term_id."},"_pad_term_counts":{"params":[{"required":"yes","param":"array $terms List of Term IDs"},{"required":"yes","param":"string $taxonomy Term Context"}],"desc":"Add count of children to parent count.","returns":"null Will break from function if conditions are not met."},"_update_post_term_count":{"params":[{"required":"yes","param":"array $terms List of Term taxonomy IDs"},{"required":"yes","param":"object $taxonomy Current taxonomy object of terms"}],"desc":"Will update term count based on object types of the current taxonomy.","returns":""},"_update_generic_term_count":{"params":[{"required":"yes","param":"array $terms List of Term taxonomy IDs"},{"required":"yes","param":"object $taxonomy Current taxonomy object of terms"}],"desc":"Will update term count based on number of objects.","returns":""},"get_term_link":{"params":[{"required":"yes","param":"object|int|string $term "},{"required":"no","param":"string $taxonomy (optional if $term is object)"}],"desc":"Generates a permalink for a taxonomy term archive.","returns":"string|WP_Error HTML link to taxonomy term archive on success, WP_Error if term does not exist."},"the_taxonomies":{"params":[{"required":"yes","param":"array $args Override the defaults."}],"desc":"Display the taxonomies of a post with available options.","returns":""},"get_the_taxonomies":{"params":[{"required":"no","param":"int $post Optional. Post ID or will use Global Post ID (in loop)."},{"required":"yes","param":"array $args Override the defaults."}],"desc":"Retrieve all taxonomies associated with a post.","returns":"array "},"get_post_taxonomies":{"params":[{"required":"no","param":"int $post Optional. Post ID"}],"desc":"Retrieve all taxonomies of a post with just the names.","returns":"array "},"is_object_in_term":{"params":[{"required":"yes","param":"int $object_id ID of the object (post ID, link ID, ...)"},{"required":"yes","param":"string $taxonomy Single taxonomy name"},{"required":"no","param":"int|string|array $terms Optional. Term term_id, name, slug or array of said"}],"desc":"Determine if the given object is associated with any of the given terms.","returns":"bool|WP_Error. WP_Error on input error."},"is_object_in_taxonomy":{"params":[{"required":"yes","param":"string $object_type Object type string"},{"required":"yes","param":"string $taxonomy Single taxonomy name"}],"desc":"Determine if the given object type is associated with the given taxonomy.","returns":"bool True if object is associated with the taxonomy, otherwise false."},"get_ancestors":{"params":[{"required":"yes","param":"int $object_id The ID of the object"},{"required":"yes","param":"string $object_type The type of object for which we'll be retrieving ancestors."}],"desc":"Get an array of ancestor IDs for a given object.","returns":"array of ancestors from lowest to highest in the hierarchy."},"wp_get_term_taxonomy_parent_id":{"params":[{"required":"yes","param":"int $term_id "},{"required":"yes","param":"string $taxonomy "}],"desc":"Returns the term's parent's term_ID","returns":"int|bool false on error"},"wp_check_term_hierarchy_for_loops":{"params":[{"required":"yes","param":"int $parent term_id of the parent for the term we're checking."},{"required":"yes","param":"int $term_id The term we're checking."},{"required":"yes","param":"string $taxonomy The taxonomy of the term we're checking."}],"desc":"Checks the given subset of the term hierarchy for hierarchy loops.","returns":"int The new parent for the term."},"mysql2date":{"params":[{"required":"yes","param":"string $dateformatstring Either 'G', 'U', or php date format."},{"required":"yes","param":"string $mysqlstring Time from mysql DATETIME field."},{"required":"no","param":"bool $translate Optional. Default is true. Will switch format to locale."}],"desc":"Converts MySQL DATETIME field to user specified date format.","returns":"string Date formatted by $dateformatstring or locale (if available)."},"current_time":{"params":[{"required":"yes","param":"string $type Either 'mysql' or 'timestamp'."},{"required":"no","param":"int|bool $gmt Optional. Whether to use GMT timezone. Default is false."}],"desc":"Retrieve the current time based on specified type.","returns":"int|string String if $type is 'gmt', int if $type is 'timestamp'."},"date_i18n":{"params":[{"required":"yes","param":"string $dateformatstring Format to display the date."},{"required":"no","param":"int $unixtimestamp Optional. Unix timestamp."},{"required":"no","param":"bool $gmt Optional, default is false. Whether to convert to GMT for time."}],"desc":"Retrieve the date in localized format, based on timestamp.","returns":"string The date, translated if locale specifies it."},"number_format_i18n":{"params":[{"required":"yes","param":"int $number The number to convert based on locale."},{"required":"yes","param":"int $decimals Precision of the number of decimal places."}],"desc":"Convert integer number to format based on the locale.","returns":"string Converted number in string format."},"size_format":{"params":[{"required":"yes","param":"int|string $bytes Number of bytes. Note max integer size for integers."},{"required":"yes","param":"int $decimals Precision of number of decimal places. Deprecated."}],"desc":"Convert number of bytes largest unit bytes will fit into.","returns":"bool|string False on failure. Number string on success."},"get_weekstartend":{"params":[{"required":"yes","param":"string $mysqlstring Date or datetime field type from mysql."},{"required":"no","param":"int $start_of_week Optional. Start of the week as an integer."}],"desc":"Get the week start and end from the datetime or date string from mysql.","returns":"array Keys are 'start' and 'end'."},"maybe_unserialize":{"params":[{"required":"yes","param":"string $original Maybe unserialized original, if is needed."}],"desc":"Unserialize value only if it was serialized.","returns":"mixed Unserialized data can be any type."},"is_serialized":{"params":[{"required":"yes","param":"mixed $data Value to check to see if was serialized."}],"desc":"Check value to find if it was serialized.","returns":"bool False if not serialized and true if it was."},"is_serialized_string":{"params":[{"required":"yes","param":"mixed $data Serialized data"}],"desc":"Check whether serialized data is of string type.","returns":"bool False if not a serialized string, true if it is."},"wp_protect_special_option":{"params":[{"required":"yes","param":"string $option Option name."}],"desc":"Protect WordPress special option from being modified.","returns":""},"form_option":{"params":[{"required":"yes","param":"string $option Option name."}],"desc":"Print option value after sanitizing for forms.","returns":""},"wp_load_alloptions":{"params":[],"desc":"Loads and caches all autoloaded options, if available or all options.","returns":"array List of all options."},"wp_load_core_site_options":{"params":[{"required":"no","param":"int $site_id Optional site ID for which to query the options. Defaults to the current site."}],"desc":"Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.","returns":""},"update_option":{"params":[{"required":"yes","param":"string $option Option name. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $newvalue Option value. Expected to not be SQL-escaped."}],"desc":"Update the value of an option that was already added.","returns":"bool False if value was not updated and true if value was updated."},"add_option":{"params":[{"required":"yes","param":"string $option Name of option to add. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $deprecated Optional. Description. Not used anymore."},{"required":"no","param":"bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up."}],"desc":"Add a new option.","returns":"bool False if option was not added and true if option was added."},"delete_option":{"params":[{"required":"yes","param":"string $option Name of option to remove. Expected to not be SQL-escaped."}],"desc":"Removes option by name. Prevents removal of protected WordPress options.","returns":"bool True, if option is successfully deleted. False on failure."},"delete_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."}],"desc":"Delete a transient.","returns":"bool true if successful, false otherwise"},"get_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped"}],"desc":"Get the value of a transient.","returns":"mixed Value of transient"},"set_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $value Transient value. Expected to not be SQL-escaped."},{"required":"yes","param":"int $expiration Time until expiration in seconds, default 0"}],"desc":"Set/update the value of a transient.","returns":"bool False if value was not set and true if value was set."},"wp_user_settings":{"params":[],"desc":"Saves and restores user interface settings stored in a cookie.","returns":""},"get_user_setting":{"params":[{"required":"yes","param":"string $name The name of the setting."},{"required":"no","param":"string $default Optional default value to return when $name is not set."}],"desc":"Retrieve user interface setting value based on setting name.","returns":"mixed the last saved user setting or the default value/false if it doesn't exist."},"set_user_setting":{"params":[{"required":"yes","param":"string $name The name of the setting."},{"required":"yes","param":"string $value The value for the setting."}],"desc":"Add or update user interface setting.","returns":"bool true if set successfully/false if not."},"delete_user_setting":{"params":[{"required":"yes","param":"mixed $names The name or array of names of the setting to be deleted."}],"desc":"Delete user interface settings.","returns":"bool true if deleted successfully/false if not."},"get_all_user_settings":{"params":[],"desc":"Retrieve all user interface settings.","returns":"array the last saved user settings or empty array."},"wp_set_all_user_settings":{"params":[{"required":"yes","param":"unknown $all "}],"desc":"Private. Set all user interface settings.","returns":"bool "},"delete_all_user_settings":{"params":[],"desc":"Delete the user settings of the current user.","returns":""},"maybe_serialize":{"params":[{"required":"yes","param":"mixed $data Data that might be serialized."}],"desc":"Serialize data, if needed.","returns":"mixed A scalar data"},"xmlrpc_getposttitle":{"params":[{"required":"yes","param":"string $content XMLRPC XML Request content"}],"desc":"Retrieve post title from XMLRPC XML.","returns":"string Post title"},"xmlrpc_getpostcategory":{"params":[{"required":"yes","param":"string $content XMLRPC XML Request content"}],"desc":"Retrieve the post category or categories from XMLRPC XML.","returns":"string|array List of categories or category name."},"xmlrpc_removepostdata":{"params":[{"required":"yes","param":"string $content XMLRPC XML Request content"}],"desc":"XMLRPC XML content without title and category elements.","returns":"string XMLRPC XML Request content without title and category elements."},"debug_fopen":{"params":[{"required":"yes","param":"string $filename File path to debug file."},{"required":"yes","param":"string $mode Same as fopen() mode parameter."}],"desc":"Open the file handle for debugging.","returns":"bool|resource File handle. False on failure."},"debug_fwrite":{"params":[{"required":"yes","param":"resource $fp File handle for debugging file."},{"required":"yes","param":"string $string Content to write to debug file."}],"desc":"Write contents to the file used for debugging.","returns":""},"debug_fclose":{"params":[{"required":"yes","param":"resource $fp Debug File handle."}],"desc":"Close the debugging file handle.","returns":""},"do_enclose":{"params":[{"required":"yes","param":"string $content Post Content"},{"required":"yes","param":"int $post_ID Post ID"}],"desc":"Check content for video and audio links to add as enclosures.","returns":""},"wp_get_http":{"params":[{"required":"yes","param":"string $url URL to fetch."},{"required":"no","param":"string|bool $file_path Optional. File path to write request to."},{"required":"yes","param":"int $red (private) The number of Redirects followed, Upon 5 being hit, returns false."}],"desc":"Perform a HTTP HEAD or GET request.","returns":"bool|string False on failure and string of headers if HEAD request."},"wp_get_http_headers":{"params":[{"required":"yes","param":"string $url "},{"required":"yes","param":"bool $deprecated Not Used."}],"desc":"Retrieve HTTP Headers from URL.","returns":"bool|string False on failure, headers on success."},"is_new_day":{"params":[],"desc":"Whether today is a new day.","returns":"int 1 when new day, 0 if not a new day."},"build_query":{"params":[{"required":"yes","param":"array $data URL-encode key/value pairs."}],"desc":"Build URL query based on an associative and, or indexed array.","returns":"string URL encoded string"},"_http_build_query":{"params":[],"desc":"","returns":""},"add_query_arg":{"params":[{"required":"yes","param":"mixed $param1 Either newkey or an associative_array"},{"required":"yes","param":"mixed $param2 Either newvalue or oldquery or uri"},{"required":"no","param":"mixed $param3 Optional. Old query or uri"}],"desc":"Retrieve a modified URL query string.","returns":"string New URL query string."},"remove_query_arg":{"params":[{"required":"yes","param":"string|array $key Query key or keys to remove."},{"required":"yes","param":"bool $query When false uses the $_SERVER value."}],"desc":"Removes an item or list from the query string.","returns":"string New URL query string."},"add_magic_quotes":{"params":[{"required":"yes","param":"array $array Array to used to walk while sanitizing contents."}],"desc":"Walks the array while sanitizing the contents.","returns":"array Sanitized $array."},"wp_remote_fopen":{"params":[{"required":"yes","param":"string $uri URI/URL of web page to retrieve."}],"desc":"HTTP request for URI to retrieve content.","returns":"bool|string HTTP content. False on failure."},"wp":{"params":[{"required":"yes","param":"string $query_vars Default WP_Query arguments."}],"desc":"Set up the WordPress query.","returns":""},"get_status_header_desc":{"params":[{"required":"yes","param":"int $code HTTP status code."}],"desc":"Retrieve the description for the HTTP status.","returns":"string Empty string if not found, or description if found."},"status_header":{"params":[{"required":"yes","param":"int $header HTTP status code"}],"desc":"Set HTTP status header.","returns":"unknown "},"wp_get_nocache_headers":{"params":[],"desc":"Gets the header information to prevent caching.","returns":"array The associative array of header names and field values."},"nocache_headers":{"params":[],"desc":"Sets the headers to prevent caching for the different browsers.","returns":""},"cache_javascript_headers":{"params":[],"desc":"Set the headers for caching for 10 days with JavaScript content type.","returns":""},"get_num_queries":{"params":[],"desc":"Retrieve the number of database queries during the WordPress execution.","returns":"int Number of database queries"},"bool_from_yn":{"params":[{"required":"yes","param":"string $yn Character string containing either 'y' or 'n'"}],"desc":"Whether input is yes or no. Must be 'y' to be true.","returns":"bool True if yes, false on anything else"},"do_feed":{"params":[],"desc":"Loads the feed template from the use of an action hook.","returns":""},"do_feed_rdf":{"params":[],"desc":"Load the RDF RSS 0.91 Feed template.","returns":""},"do_feed_rss":{"params":[],"desc":"Load the RSS 1.0 Feed Template.","returns":""},"do_feed_rss2":{"params":[{"required":"yes","param":"bool $for_comments True for the comment feed, false for normal feed."}],"desc":"Load either the RSS2 comment feed or the RSS2 posts feed.","returns":""},"do_feed_atom":{"params":[{"required":"yes","param":"bool $for_comments True for the comment feed, false for normal feed."}],"desc":"Load either Atom comment feed or Atom posts feed.","returns":""},"do_robots":{"params":[],"desc":"Display the robots.txt file content.","returns":""},"is_blog_installed":{"params":[],"desc":"Test whether blog is already installed.","returns":"bool Whether blog is already installed."},"wp_nonce_url":{"params":[{"required":"yes","param":"string $actionurl URL to add nonce action"},{"required":"no","param":"string $action Optional. Nonce action name"}],"desc":"Retrieve URL with nonce added to URL query.","returns":"string URL with nonce action added."},"wp_nonce_field":{"params":[{"required":"no","param":"string $action Optional. Action name."},{"required":"no","param":"string $name Optional. Nonce name."},{"required":"no","param":"bool $referer Optional, default true. Whether to set the referer field for validation."},{"required":"no","param":"bool $echo Optional, default true. Whether to display or return hidden form field."}],"desc":"Retrieve or display nonce hidden field for forms.","returns":"string Nonce field."},"wp_referer_field":{"params":[{"required":"yes","param":"bool $echo Whether to echo or return the referer field."}],"desc":"Retrieve or display referer hidden field for forms.","returns":"string Referer field."},"wp_original_referer_field":{"params":[{"required":"yes","param":"bool $echo Whether to echo the original http referer"},{"required":"no","param":"string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to."}],"desc":"Retrieve or display original referer hidden field for forms.","returns":"string Original referer field."},"wp_get_referer":{"params":[],"desc":"Retrieve referer from '_wp_http_referer' or HTTP referer. If it's the same as the current request URL, will return false.","returns":"string|bool False on failure. Referer URL on success."},"wp_get_original_referer":{"params":[],"desc":"Retrieve original referer that was posted, if it exists.","returns":"string|bool False if no original referer or original referer if set."},"wp_mkdir_p":{"params":[{"required":"yes","param":"string $target Full path to attempt to create."}],"desc":"Recursive directory creation based on full path.","returns":"bool Whether the path was created. True if path already exists."},"path_is_absolute":{"params":[{"required":"yes","param":"string $path File path"}],"desc":"Test if a give filesystem path is absolute ('/foo/bar', 'c:windows').","returns":"bool True if path is absolute, false is not absolute."},"path_join":{"params":[{"required":"yes","param":"string $base "},{"required":"yes","param":"string $path "}],"desc":"Join two filesystem paths together (e.g. 'give me $path relative to $base').","returns":"string The path with the base or absolute path."},"get_temp_dir":{"params":[],"desc":"Determines a writable directory for temporary files.","returns":"string Writable temporary directory"},"wp_upload_dir":{"params":[{"required":"no","param":"string $time Optional. Time formatted in 'yyyy/mm'."}],"desc":"Get an array containing the current upload directory's path and url.","returns":"array See above for description."},"wp_unique_filename":{"params":[{"required":"yes","param":"string $dir "},{"required":"yes","param":"string $filename "},{"required":"yes","param":"mixed $unique_filename_callback Callback."}],"desc":"Get a filename that is sanitized and unique for the given directory.","returns":"string New filename, if given wasn't unique."},"wp_upload_bits":{"params":[{"required":"yes","param":"string $name "},{"required":"yes","param":"null $deprecated Never used. Set to null."},{"required":"yes","param":"mixed $bits File content"},{"required":"no","param":"string $time Optional. Time formatted in 'yyyy/mm'."}],"desc":"Create a file in the upload folder with given content.","returns":"array "},"wp_ext2type":{"params":[{"required":"yes","param":"string $ext The extension to search."}],"desc":"Retrieve the file type based on the extension name.","returns":"string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found."},"wp_check_filetype":{"params":[{"required":"yes","param":"string $filename File name or path."},{"required":"no","param":"array $mimes Optional. Key is the file extension with value as the mime type."}],"desc":"Retrieve the file type from the file name.","returns":"array Values with extension first and mime type."},"wp_check_filetype_and_ext":{"params":[{"required":"yes","param":"string $file Full path to the image."},{"required":"yes","param":"string $filename The filename of the image (may differ from $file due to $file being in a tmp directory)"},{"required":"no","param":"array $mimes Optional. Key is the file extension with value as the mime type."}],"desc":"Attempt to determine the real file type of a file.","returns":"array Values for the extension, MIME, and either a corrected filename or false if original $filename is valid"},"get_allowed_mime_types":{"params":[],"desc":"Retrieve list of allowed mime types and file extensions.","returns":"array Array of mime types keyed by the file extension regex corresponding to those types."},"wp_explain_nonce":{"params":[{"required":"yes","param":"string $action Nonce action."}],"desc":"Retrieve nonce action "Are you sure" message.","returns":"string Are you sure message."},"wp_nonce_ays":{"params":[{"required":"yes","param":"string $action The nonce action."}],"desc":"Display "Are You Sure" message to confirm the action being taken.","returns":""},"wp_die":{"params":[{"required":"yes","param":"string $message Error message."},{"required":"yes","param":"string $title Error title."},{"required":"no","param":"string|array $args Optional arguments to control behavior."}],"desc":"Kill WordPress execution and display HTML message with error message.","returns":""},"_default_wp_die_handler":{"params":[{"required":"yes","param":"string $message Error message."},{"required":"yes","param":"string $title Error title."},{"required":"no","param":"string|array $args Optional arguments to control behavior."}],"desc":"Kill WordPress execution and display HTML message with error message.","returns":""},"_xmlrpc_wp_die_handler":{"params":[{"required":"yes","param":"string $message Error message."},{"required":"yes","param":"string $title Error title."},{"required":"no","param":"string|array $args Optional arguments to control behavior."}],"desc":"Kill WordPress execution and display XML message with error message.","returns":""},"_xmlrpc_wp_die_filter":{"params":[],"desc":"Filter to enable special wp_die handler for xmlrpc requests.","returns":""},"_config_wp_home":{"params":[{"required":"yes","param":"string $url URL for the home location"}],"desc":"Retrieve the WordPress home page URL.","returns":"string Homepage location."},"_config_wp_siteurl":{"params":[{"required":"yes","param":"string $url URL to set the WordPress site location."}],"desc":"Retrieve the WordPress site URL.","returns":"string The WordPress Site URL"},"_mce_set_direction":{"params":[{"required":"yes","param":"array $input MCE plugin array."}],"desc":"Set the localized direction for MCE plugin.","returns":"array Direction set for 'rtl', if needed by locale."},"smilies_init":{"params":[],"desc":"Convert smiley code to the icon graphic file equivalent.","returns":""},"wp_parse_args":{"params":[{"required":"yes","param":"string|array $args Value to merge with $defaults"},{"required":"yes","param":"array $defaults Array that serves as the defaults."}],"desc":"Merge user defined arguments into defaults array.","returns":"array Merged user defined values with defaults."},"wp_parse_id_list":{"params":[{"required":"yes","param":"array|string $list "}],"desc":"Clean up an array, comma- or space-separated list of IDs.","returns":"array Sanitized array of IDs"},"wp_array_slice_assoc":{"params":[{"required":"yes","param":"array $array The original array"},{"required":"yes","param":"array $keys The list of keys"}],"desc":"Extract a slice of an array, given a list of keys.","returns":"array The array slice"},"wp_filter_object_list":{"params":[{"required":"yes","param":"array $list An array of objects to filter"},{"required":"yes","param":"array $args An array of key => value arguments to match against each object"},{"required":"yes","param":"string $operator The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match. The default is 'and'."},{"required":"yes","param":"bool|string $field A field from the object to place instead of the entire object"}],"desc":"Filters a list of objects, based on a set of key => value arguments.","returns":"array A list of objects or object fields"},"wp_list_filter":{"params":[{"required":"yes","param":"array $list An array of objects to filter"},{"required":"yes","param":"array $args An array of key => value arguments to match against each object"},{"required":"yes","param":"string $operator The logical operation to perform: 'AND' means all elements from the array must match; 'OR' means only one element needs to match; 'NOT' means no elements may match. The default is 'AND'."}],"desc":"Filters a list of objects, based on a set of key => value arguments.","returns":"array "},"wp_list_pluck":{"params":[{"required":"yes","param":"array $list A list of objects or arrays"},{"required":"yes","param":"int|string $field A field from the object to place instead of the entire object"}],"desc":"Pluck a certain field out of each object in a list.","returns":"array "},"wp_maybe_load_widgets":{"params":[],"desc":"Determines if Widgets library should be loaded.","returns":""},"wp_widgets_add_menu":{"params":[],"desc":"Append the Widgets menu to the themes main menu.","returns":""},"wp_ob_end_flush_all":{"params":[],"desc":"Flush all output buffers for PHP 5.2.","returns":""},"dead_db":{"params":[],"desc":"Load custom DB error or display WordPress DB error.","returns":""},"absint":{"params":[{"required":"yes","param":"mixed $maybeint Data you wish to have converted to a nonnegative integer"}],"desc":"Converts value to nonnegative integer.","returns":"int An nonnegative integer"},"url_is_accessable_via_ssl":{"params":[{"required":"yes","param":"string $url "}],"desc":"Determines if the blog can be accessed over SSL.","returns":"bool Whether SSL access is available"},"_deprecated_function":{"params":[{"required":"yes","param":"string $function The function that was called"},{"required":"yes","param":"string $version The version of WordPress that deprecated the function"},{"required":"no","param":"string $replacement Optional. The function that should have been called"}],"desc":"Marks a function as deprecated and informs when it has been used.","returns":""},"_deprecated_file":{"params":[{"required":"yes","param":"string $file The file that was included"},{"required":"yes","param":"string $version The version of WordPress that deprecated the file"},{"required":"no","param":"string $replacement Optional. The file that should have been included based on ABSPATH"},{"required":"no","param":"string $message Optional. A message regarding the change"}],"desc":"Marks a file as deprecated and informs when it has been used.","returns":""},"_deprecated_argument":{"params":[{"required":"yes","param":"string $function The function that was called"},{"required":"yes","param":"string $version The version of WordPress that deprecated the argument used"},{"required":"no","param":"string $message Optional. A message regarding the change."}],"desc":"Marks a function argument as deprecated and informs when it has been used.","returns":""},"_doing_it_wrong":{"params":[{"required":"yes","param":"string $function The function that was called."},{"required":"yes","param":"string $message A message explaining what has been done incorrectly."},{"required":"yes","param":"string $version The version of WordPress where the message was added."}],"desc":"Marks something as being incorrectly called.","returns":""},"apache_mod_loaded":{"params":[{"required":"yes","param":"string $mod e.g. mod_rewrite"},{"required":"yes","param":"bool $default The default return value if the module is not found"}],"desc":"Does the specified module exist in the Apache config?","returns":"bool "},"iis7_supports_permalinks":{"params":[],"desc":"Check if IIS 7 supports pretty permalinks.","returns":"bool "},"validate_file":{"params":[{"required":"yes","param":"string $file File path."},{"required":"yes","param":"array $allowed_files List of allowed files."}],"desc":"File validates against allowed set of defined rules.","returns":"int 0 means nothing is wrong, greater than 0 means something was wrong."},"is_ssl":{"params":[],"desc":"Determine if SSL is used.","returns":"bool True if SSL, false if not used."},"force_ssl_login":{"params":[{"required":"no","param":"string|bool $force Optional."}],"desc":"Whether SSL login should be forced.","returns":"bool True if forced, false if not forced."},"force_ssl_admin":{"params":[{"required":"yes","param":"string|bool $force "}],"desc":"Whether to force SSL used for the Administration Screens.","returns":"bool True if forced, false if not forced."},"wp_suspend_cache_addition":{"params":[{"required":"no","param":"bool $suspend Optional. Suspends additions if true, re-enables them if false."}],"desc":"Temporarily suspend cache additions.","returns":"bool The current suspend setting"},"wp_suspend_cache_invalidation":{"params":[{"required":"yes","param":"bool $suspend Whether to suspend or enable cache invalidation"}],"desc":"Suspend cache invalidation.","returns":"bool The current suspend setting"},"get_site_option":{"params":[{"required":"yes","param":"string $option Name of option to retrieve. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $default Optional value to return if option doesn't exist. Default false."},{"required":"yes","param":"bool $use_cache Whether to use cache. Multisite only. Default true."}],"desc":"Retrieve site option value based on name of option.","returns":"mixed Value set for the option."},"add_site_option":{"params":[{"required":"yes","param":"string $option Name of option to add. Expected to not be SQL-escaped."},{"required":"no","param":"mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped."}],"desc":"Add a new site option.","returns":"bool False if option was not added and true if option was added."},"delete_site_option":{"params":[{"required":"yes","param":"string $option Name of option to remove. Expected to not be SQL-escaped."}],"desc":"Removes site option by name.","returns":"bool True, if succeed. False, if failure."},"update_site_option":{"params":[{"required":"yes","param":"string $option Name of option. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $value Option value. Expected to not be SQL-escaped."}],"desc":"Update the value of a site option that was already added.","returns":"bool False if value was not updated and true if value was updated."},"delete_site_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."}],"desc":"Delete a site transient.","returns":"bool True if successful, false otherwise"},"get_site_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."}],"desc":"Get the value of a site transient.","returns":"mixed Value of transient"},"set_site_transient":{"params":[{"required":"yes","param":"string $transient Transient name. Expected to not be SQL-escaped."},{"required":"yes","param":"mixed $value Transient value. Expected to not be SQL-escaped."},{"required":"yes","param":"int $expiration Time until expiration in seconds, default 0"}],"desc":"Set/update the value of a site transient.","returns":"bool False if value was not set and true if value was set."},"is_main_site":{"params":[{"required":"no","param":"int $blog_id optional blog id to test (default current blog)"}],"desc":"Is main site?","returns":"bool True if not multisite or $blog_id is main site"},"global_terms_enabled":{"params":[],"desc":"Whether global terms are enabled.","returns":"bool True if multisite and global terms enabled"},"wp_timezone_override_offset":{"params":[],"desc":"gmt_offset modification for smart timezone handling.","returns":"float|bool "},"_wp_timezone_choice_usort_callback":{"params":[{"required":"yes","param":"unknown_type $a "},{"required":"yes","param":"unknown_type $b "}],"desc":"{@internal Missing Short Description}}","returns":"int "},"wp_timezone_choice":{"params":[{"required":"yes","param":"string $selected_zone Selected Zone"}],"desc":"Gives a nicely formatted list of timezone strings. // temporary! Not in final","returns":"string "},"_cleanup_header_comment":{"params":[{"required":"yes","param":"string $str "}],"desc":"Strip close comment and close php tags from file headers used by WP.","returns":"string "},"wp_scheduled_delete":{"params":[],"desc":"Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.","returns":""},"get_file_data":{"params":[{"required":"yes","param":"string $file Path to the file"},{"required":"yes","param":"array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name')"},{"required":"yes","param":"string $context If specified adds filter hook "extra_{$context}_headers""}],"desc":"Retrieve metadata from a file.","returns":""},"_search_terms_tidy":{"params":[{"required":"yes","param":"string $t "}],"desc":"Used internally to tidy up the search terms.","returns":"string "},"__return_true":{"params":[],"desc":"Returns true.","returns":"bool true"},"__return_false":{"params":[],"desc":"Returns false.","returns":"bool false"},"__return_zero":{"params":[],"desc":"Returns 0.","returns":"int 0"},"__return_empty_array":{"params":[],"desc":"Returns an empty array.","returns":"array Empty array"},"send_nosniff_header":{"params":[],"desc":"Send a HTTP header to disable content type sniffing in browsers which support it.","returns":"none "},"_wp_mysql_week":{"params":[{"required":"yes","param":"string $column "}],"desc":"Returns a MySQL expression for selecting the week number based on the start_of_week option.","returns":"string "},"wp_find_hierarchy_loop":{"params":[{"required":"yes","param":"callback $callback function that accepts ( ID, $callback_args ) and outputs parent_ID"},{"required":"yes","param":"int $start The ID to start the loop check at"},{"required":"yes","param":"int $start_parent the parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback"},{"required":"no","param":"array $callback_args optional additional arguments to send to $callback"}],"desc":"Finds hierarchy loops using a callback function that maps object IDs to parent IDs.","returns":"array IDs of all members of loop"},"wp_find_hierarchy_loop_tortoise_hare":{"params":[{"required":"yes","param":"callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID"},{"required":"yes","param":"int $start The ID to start the loop check at"},{"required":"yes","param":"array $override an array of ( ID => parent_ID, ... ) to use instead of $callback"},{"required":"no","param":"array $callback_args optional additional arguments to send to $callback"},{"required":"yes","param":"bool $_return_loop Return loop members or just detect presence of loop? Only set to true if you already know the given $start is part of a loop (otherwise the returned array might include branches)"}],"desc":"Uses the "The Tortoise and the Hare" algorithm to detect loops.","returns":"mixed scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop"},"send_frame_options_header":{"params":[],"desc":"Send a HTTP header to limit rendering of pages to same origin iframes.","returns":"none "},"wp_allowed_protocols":{"params":[],"desc":"Retrieve a list of protocols to allow in HTML attributes.","returns":"array Array of allowed protocols"},"get_sitestats":{"params":[],"desc":"Gets the network's site and user counts.","returns":"array Site and user count for the network."},"get_admin_users_for_domain":{"params":[{"required":"no","param":"string $sitedomain Optional. Site domain."},{"required":"no","param":"string $path Optional. Site path."}],"desc":"Get the admin for a domain/path combination.","returns":"array The network admins"},"get_active_blog_for_user":{"params":[{"required":"yes","param":"int $user_id The unique ID of the user"}],"desc":"Get one of a user's active blogs","returns":"object The blog object"},"get_user_count":{"params":[],"desc":"The number of active users in your installation.","returns":"int "},"get_blog_count":{"params":[{"required":"no","param":"int $id Optional. A site_id."}],"desc":"The number of active sites on your installation.","returns":"int "},"get_blog_post":{"params":[{"required":"yes","param":"int $blog_id ID of the blog."},{"required":"yes","param":"int $post_id ID of the post you're looking for."}],"desc":"Get a blog post from any site on the network.","returns":"object The post."},"add_user_to_blog":{"params":[{"required":"yes","param":"int $blog_id ID of the blog you're adding the user to."},{"required":"yes","param":"int $user_id ID of the user you're adding."},{"required":"yes","param":"string $role The role you want the user to have"}],"desc":"Add a user to a blog.","returns":"bool "},"remove_user_from_blog":{"params":[{"required":"yes","param":"int $user_id ID of the user you're removing."},{"required":"yes","param":"int $blog_id ID of the blog you're removing the user from."},{"required":"no","param":"string $reassign Optional. A user to whom to reassign posts."}],"desc":"Remove a user from a blog.","returns":"bool "},"create_empty_blog":{"params":[{"required":"yes","param":"string $domain The new blog's domain."},{"required":"yes","param":"string $path The new blog's path."},{"required":"yes","param":"string $string The new blog's title."},{"required":"no","param":"int $site Optional. Defaults to 1."}],"desc":"Create an empty blog.","returns":"int The ID of the newly created blog"},"get_blog_permalink":{"params":[{"required":"yes","param":"int $_blog_id ID of the source blog."},{"required":"yes","param":"int $post_id ID of the desired post."}],"desc":"Get the permalink for a post on another blog.","returns":"string The post's permalink"},"get_blog_id_from_url":{"params":[{"required":"yes","param":"string $domain "},{"required":"no","param":"string $path Optional. Not required for subdomain installations."}],"desc":"Get a blog's numeric ID from its URL.","returns":"int "},"is_email_address_unsafe":{"params":[{"required":"yes","param":"string $user_email The email provided by the user at registration."}],"desc":"Checks an email address against a list of banned domains.","returns":"bool Returns true when the email address is banned."},"wpmu_validate_user_signup":{"params":[{"required":"yes","param":"string $user_name The login name provided by the user."},{"required":"yes","param":"string $user_email The email provided by the user."}],"desc":"Processes new user registrations.","returns":"array Contains username, email, and error messages."},"wpmu_validate_blog_signup":{"params":[{"required":"yes","param":"string $blogname The blog name provided by the user. Must be unique."},{"required":"yes","param":"string $blog_title The blog title provided by the user."}],"desc":"Processes new site registrations.","returns":"array Contains the new site data and error messages."},"wpmu_signup_blog":{"params":[{"required":"yes","param":"string $domain The requested domain."},{"required":"yes","param":"string $path The requested path."},{"required":"yes","param":"string $title The requested site title."},{"required":"yes","param":"string $user The user's requested login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, contains the requested privacy setting and lang_id."}],"desc":"Record site signup information for future activation.","returns":""},"wpmu_signup_user":{"params":[{"required":"yes","param":"string $user The user's requested login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, this is an empty array."}],"desc":"Record user signup information for future activation.","returns":""},"wpmu_signup_blog_notification":{"params":[{"required":"yes","param":"string $domain The new blog domain."},{"required":"yes","param":"string $path The new blog path."},{"required":"yes","param":"string $title The site title."},{"required":"yes","param":"string $user The user's login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, contains the requested privacy setting and lang_id."},{"required":"yes","param":"string $key The activation key created in wpmu_signup_blog()"}],"desc":"Notify user of signup success.","returns":"bool "},"wpmu_signup_user_notification":{"params":[{"required":"yes","param":"string $user The user's login name."},{"required":"yes","param":"string $user_email The user's email address."},{"required":"yes","param":"array $meta By default, an empty array."},{"required":"yes","param":"string $key The activation key created in wpmu_signup_user()"}],"desc":"Notify user of signup success.","returns":"bool "},"wpmu_activate_signup":{"params":[{"required":"yes","param":"string $key The activation key provided to the user."}],"desc":"Activate a signup.","returns":"array An array containing information about the activated user and/or blog"},"wpmu_create_user":{"params":[{"required":"yes","param":"string $user_name The new user's login name."},{"required":"yes","param":"string $password The new user's password."},{"required":"yes","param":"string $email The new user's email address."}],"desc":"Create a user.","returns":"mixed Returns false on failure, or int $user_id on success"},"wpmu_create_blog":{"params":[{"required":"yes","param":"string $domain The new site's domain."},{"required":"yes","param":"string $path The new site's path."},{"required":"yes","param":"string $title The new site's title."},{"required":"yes","param":"int $user_id The user ID of the new site's admin."},{"required":"no","param":"array $meta Optional. Used to set initial site options."},{"required":"no","param":"int $site_id Optional. Only relevant on multi-network installs."}],"desc":"Create a site.","returns":"mixed Returns WP_Error object on failure, int $blog_id on success"},"newblog_notify_siteadmin":{"params":[{"required":"yes","param":"int $blog_id The new site's ID."}],"desc":"Notifies the network admin that a new site has been activated.","returns":"bool "},"newuser_notify_siteadmin":{"params":[{"required":"yes","param":"int $user_id The new user's ID."}],"desc":"Notifies the network admin that a new user has been activated.","returns":"bool "},"domain_exists":{"params":[{"required":"yes","param":"string $domain The domain to be checked."},{"required":"yes","param":"string $path The path to be checked."},{"required":"no","param":"int $site_id Optional. Relevant only on multi-network installs."}],"desc":"Check whether a blogname is already taken.","returns":"int "},"insert_blog":{"params":[{"required":"yes","param":"string $domain The domain of the new site."},{"required":"yes","param":"string $path The path of the new site."},{"required":"yes","param":"int $site_id Unless you're running a multi-network install, be sure to set this value to 1."}],"desc":"Store basic site info in the blogs table.","returns":"int The ID of the new row"},"install_blog":{"params":[{"required":"yes","param":"int $blog_id The value returned by insert_blog()."},{"required":"yes","param":"string $blog_title The title of the new site."}],"desc":"Install an empty blog.","returns":""},"install_blog_defaults":{"params":[{"required":"yes","param":"int $blog_id Ignored in this function."},{"required":"yes","param":"int $user_id "}],"desc":"Set blog defaults.","returns":""},"wpmu_welcome_notification":{"params":[{"required":"yes","param":"int $blog_id "},{"required":"yes","param":"int $user_id "},{"required":"yes","param":"string $password "},{"required":"yes","param":"string $title The new blog's title"},{"required":"no","param":"array $meta Optional. Not used in the default function, but is passed along to hooks for customization."}],"desc":"Notify a user that her blog activation has been successful.","returns":"bool "},"wpmu_welcome_user_notification":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"string $password "},{"required":"no","param":"array $meta Optional. Not used in the default function, but is passed along to hooks for customization."}],"desc":"Notify a user that her account activation has been successful.","returns":"bool "},"get_current_site":{"params":[],"desc":"Get the current site info.","returns":"object "},"get_user_id_from_string":{"params":[{"required":"yes","param":"string $string "}],"desc":"Get a numeric user ID from either an email address or a login.","returns":"int "},"get_most_recent_post_of_user":{"params":[{"required":"yes","param":"int $user_id "}],"desc":"Get a user's most recent post.","returns":"array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts"},"get_dirsize":{"params":[{"required":"yes","param":"string $directory "}],"desc":"Get the size of a directory.","returns":"int "},"recurse_dirsize":{"params":[{"required":"yes","param":"string $directory "}],"desc":"Get the size of a directory recursively.","returns":"int "},"upload_is_user_over_quota":{"params":[{"required":"no","param":"bool $echo Optional. If $echo is set and the quota is exceeded, a warning message is echoed. Default is true."}],"desc":"Check whether a blog has used its allotted upload space.","returns":"int "},"check_upload_mimes":{"params":[{"required":"yes","param":"array $mimes "}],"desc":"Check an array of MIME types against a whitelist.","returns":"array "},"update_posts_count":{"params":[],"desc":"Update a blog's post count.","returns":""},"wpmu_log_new_registrations":{"params":[{"required":"yes","param":"int $blog_id "},{"required":"yes","param":"int $user_id "}],"desc":"Logs user registrations.","returns":""},"fix_import_form_size":{"params":[{"required":"yes","param":"int $size "}],"desc":"Get the remaining upload space for this blog.","returns":"int "},"global_terms":{"params":[{"required":"yes","param":"int $term_id An ID for a term on the current blog."}],"desc":"Maintains a canonical list of terms by syncing terms created for each blog with the global terms table.","returns":"int An ID from the global terms table mapped from $term_id."},"redirect_this_site":{"params":[],"desc":"Ensure that the current site's domain is listed in the allowed redirect host list.","returns":"array The current site's domain"},"upload_is_file_too_big":{"params":[{"required":"yes","param":"array $upload "}],"desc":"Check whether an upload is too big.","returns":"mixed If the upload is under the size limit, $upload is returned. Otherwise returns an error message."},"signup_nonce_fields":{"params":[],"desc":"Add a nonce field to the signup page.","returns":""},"signup_nonce_check":{"params":[{"required":"yes","param":"array $result "}],"desc":"Process the signup nonce created in signup_nonce_fields().","returns":"array "},"maybe_redirect_404":{"params":[],"desc":"Correct 404 redirects when NOBLOGREDIRECT is defined.","returns":""},"maybe_add_existing_user_to_blog":{"params":[],"desc":"Add a new user to a blog by visiting /newbloguser/username/.","returns":""},"add_existing_user_to_blog":{"params":[{"required":"yes","param":"array $details "}],"desc":"Add a user to a blog based on details from maybe_add_existing_user_to_blog().","returns":""},"add_new_user_to_blog":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"string $email "},{"required":"yes","param":"array $meta "}],"desc":"Add a newly created user to the appropriate blog","returns":""},"fix_phpmailer_messageid":{"params":[],"desc":"Correct From host on outgoing mail to match the site domain","returns":""},"is_user_spammy":{"params":[{"required":"yes","param":"string $username "}],"desc":"Check to see whether a user is marked as a spammer, based on username","returns":"bool "},"update_blog_public":{"params":[{"required":"yes","param":"int $old_value "},{"required":"yes","param":"int $value The new public value"}],"desc":"Update this blog's 'public' setting in the global blogs table.","returns":"bool "},"get_dashboard_blog":{"params":[],"desc":"Get the "dashboard blog", the blog where users without a blog edit their profile data.","returns":"int "},"is_user_option_local":{"params":[{"required":"yes","param":"string $key "},{"required":"no","param":"int $user_id Optional. Defaults to current user."},{"required":"no","param":"int $blog_id Optional. Defaults to current blog."}],"desc":"Check whether a usermeta key has to do with the current blog.","returns":"bool "},"users_can_register_signup_filter":{"params":[],"desc":"Check whether users can self-register, based on Network settings.","returns":"bool "},"welcome_user_msg_filter":{"params":[{"required":"yes","param":"string $text "}],"desc":"Ensure that the welcome message is not empty. Currently unused.","returns":"string "},"force_ssl_content":{"params":[{"required":"yes","param":"string|bool $force "}],"desc":"Whether to force SSL on content.","returns":"bool True if forced, false if not forced."},"filter_SSL":{"params":[],"desc":"Formats an String URL to use HTTPS if HTTP is found.","returns":""},"wp_schedule_update_network_counts":{"params":[],"desc":"Schedule update of the network-wide counts for the current network.","returns":""},"wp_update_network_counts":{"params":[],"desc":"Update the network-wide counts for the current network.","returns":""},"ms_upload_constants":{"params":[],"desc":"Defines Multisite upload constants.","returns":""},"ms_cookie_constants":{"params":[],"desc":"Defines Multisite cookie constants.","returns":""},"ms_file_constants":{"params":[],"desc":"Defines Multisite file constants.","returns":""},"ms_subdomain_constants":{"params":[],"desc":"Defines Multisite subdomain constants and handles warnings and notices.","returns":""},"get_postdata":{"params":[{"required":"yes","param":"int $postid "}],"desc":"Entire Post data.","returns":"array "},"start_wp":{"params":[],"desc":"Sets up the WordPress Loop.","returns":""},"the_category_ID":{"params":[{"required":"yes","param":"bool $echo "}],"desc":"Return or Print Category ID.","returns":"null|int "},"the_category_head":{"params":[{"required":"yes","param":"string $before "},{"required":"yes","param":"string $after "}],"desc":"Print category with optional text before and after.","returns":""},"previous_post":{"params":[{"required":"yes","param":"string $format "},{"required":"yes","param":"string $previous "},{"required":"yes","param":"string $title "},{"required":"yes","param":"string $in_same_cat "},{"required":"yes","param":"int $limitprev "},{"required":"yes","param":"string $excluded_categories "}],"desc":"Prints link to the previous post.","returns":""},"next_post":{"params":[{"required":"yes","param":"string $format "},{"required":"yes","param":"string $next "},{"required":"yes","param":"string $title "},{"required":"yes","param":"string $in_same_cat "},{"required":"yes","param":"int $limitnext "},{"required":"yes","param":"string $excluded_categories "}],"desc":"Prints link to the next post.","returns":""},"user_can_create_post":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $blog_id Not Used"},{"required":"yes","param":"int $category_id Not Used"}],"desc":"Whether user can create a post.","returns":"bool "},"user_can_create_draft":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $blog_id Not Used"},{"required":"yes","param":"int $category_id Not Used"}],"desc":"Whether user can create a post.","returns":"bool "},"user_can_edit_post":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can edit a post.","returns":"bool "},"user_can_delete_post":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool "},"user_can_set_post_date":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $blog_id Not Used"},{"required":"yes","param":"int $category_id Not Used"}],"desc":"Whether user can set new posts' dates.","returns":"bool "},"user_can_edit_post_date":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool returns true if $user_id can edit $post_id's date"},"user_can_edit_post_comments":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool returns true if $user_id can edit $post_id's comments"},"user_can_delete_post_comments":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $post_id "},{"required":"yes","param":"int $blog_id Not Used"}],"desc":"Whether user can delete a post.","returns":"bool returns true if $user_id can delete $post_id's comments"},"user_can_edit_user":{"params":[{"required":"yes","param":"int $user_id "},{"required":"yes","param":"int $other_user "}],"desc":"Can user can edit other user.","returns":"bool "},"get_linksbyname":{"params":[{"required":"no","param":"string $cat_name Optional. The category name to use. If no match is found uses all."},{"required":"no","param":"string $before Optional. The html to output before the link."},{"required":"no","param":"string $after Optional. The html to output after the link."},{"required":"no","param":"string $between Optional. The html to output between the link/image and it's description. Not used if no image or $show_images is true."},{"required":"no","param":"bool $show_images Optional. Whether to show images (if defined)."},{"required":"no","param":"string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"no","param":"bool $show_description Optional. Whether to show the description if show_images=false/not defined."},{"required":"no","param":"bool $show_rating Optional. Show rating stars/chars."},{"required":"no","param":"int $limit Optional. Limit to X entries. If not specified, all entries are shown."},{"required":"no","param":"int $show_updated Optional. Whether to show last updated timestamp"}],"desc":"Gets the links associated with category $cat_name.","returns":""},"wp_get_linksbyname":{"params":[{"required":"yes","param":"string $category The category to use."},{"required":"yes","param":"string $args "}],"desc":"Gets the links associated with the named category.","returns":"bool|null "},"get_linkobjectsbyname":{"params":[{"required":"yes","param":"string $cat_name The category name to use. If no match is found uses all."},{"required":"yes","param":"string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."}],"desc":"Gets an array of link objects associated with category $cat_name.","returns":"unknown "},"get_linkobjects":{"params":[{"required":"yes","param":"int $category The category to use. If no category supplied uses all"},{"required":"yes","param":"string $orderby the order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."}],"desc":"Gets an array of link objects associated with category n.","returns":"unknown "},"get_linksbyname_withrating":{"params":[{"required":"yes","param":"string $cat_name The category name to use. If no match is found uses all"},{"required":"yes","param":"string $before The html to output before the link"},{"required":"yes","param":"string $after The html to output after the link"},{"required":"yes","param":"string $between The html to output between the link/image and it's description. Not used if no image or show_images is true"},{"required":"yes","param":"bool $show_images Whether to show images (if defined)."},{"required":"yes","param":"string $orderby the order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"bool $show_description Whether to show the description if show_images=false/not defined"},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."},{"required":"yes","param":"int $show_updated Whether to show last updated timestamp"}],"desc":"Gets the links associated with category 'cat_name' and display rating stars/chars.","returns":""},"get_links_withrating":{"params":[{"required":"yes","param":"int $category The category to use. If no category supplied uses all"},{"required":"yes","param":"string $before The html to output before the link"},{"required":"yes","param":"string $after The html to output after the link"},{"required":"yes","param":"string $between The html to output between the link/image and it's description. Not used if no image or show_images == true"},{"required":"yes","param":"bool $show_images Whether to show images (if defined)."},{"required":"yes","param":"string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"bool $show_description Whether to show the description if show_images=false/not defined."},{"required":"yes","param":"string $limit Limit to X entries. If not specified, all entries are shown."},{"required":"yes","param":"int $show_updated Whether to show last updated timestamp"}],"desc":"Gets the links associated with category n and display rating stars/chars.","returns":""},"get_autotoggle":{"params":[{"required":"yes","param":"int $id The category to get. If no category supplied uses 0"}],"desc":"Gets the auto_toggle setting.","returns":"int Only returns 0."},"list_cats":{"params":[{"required":"yes","param":"int $optionall "},{"required":"yes","param":"string $all "},{"required":"yes","param":"string $sort_column "},{"required":"yes","param":"string $sort_order "},{"required":"yes","param":"string $file "},{"required":"yes","param":"bool $list "},{"required":"yes","param":"int $optiondates "},{"required":"yes","param":"int $optioncount "},{"required":"yes","param":"int $hide_empty "},{"required":"yes","param":"int $use_desc_for_title "},{"required":"yes","param":"bool $children "},{"required":"yes","param":"int $child_of "},{"required":"yes","param":"int $categories "},{"required":"yes","param":"int $recurse "},{"required":"yes","param":"string $feed "},{"required":"yes","param":"string $feed_image "},{"required":"yes","param":"string $exclude "},{"required":"yes","param":"bool $hierarchical "}],"desc":"","returns":"unknown "},"wp_list_cats":{"params":[{"required":"yes","param":"string|array $args "}],"desc":"","returns":"unknown "},"dropdown_cats":{"params":[{"required":"yes","param":"int $optionall "},{"required":"yes","param":"string $all "},{"required":"yes","param":"string $orderby "},{"required":"yes","param":"string $order "},{"required":"yes","param":"int $show_last_update "},{"required":"yes","param":"int $show_count "},{"required":"yes","param":"int $hide_empty "},{"required":"yes","param":"bool $optionnone "},{"required":"yes","param":"int $selected "},{"required":"yes","param":"int $exclude "}],"desc":"","returns":"unknown "},"list_authors":{"params":[{"required":"yes","param":"bool $optioncount "},{"required":"yes","param":"bool $exclude_admin "},{"required":"yes","param":"bool $show_fullname "},{"required":"yes","param":"bool $hide_empty "},{"required":"yes","param":"string $feed "},{"required":"yes","param":"string $feed_image "}],"desc":"","returns":"unknown "},"wp_get_post_cats":{"params":[{"required":"yes","param":"int $blogid Not Used"},{"required":"yes","param":"int $post_ID "}],"desc":"","returns":"unknown "},"wp_set_post_cats":{"params":[{"required":"yes","param":"int $blogid Not used"},{"required":"yes","param":"int $post_ID "},{"required":"yes","param":"array $post_categories "}],"desc":"Sets the categories that the post id belongs to.","returns":"unknown "},"get_archives":{"params":[{"required":"yes","param":"string $type "},{"required":"yes","param":"string $limit "},{"required":"yes","param":"string $format "},{"required":"yes","param":"string $before "},{"required":"yes","param":"string $after "},{"required":"yes","param":"bool $show_post_count "}],"desc":"","returns":"unknown "},"get_author_link":{"params":[{"required":"no","param":"bool $echo Optional."},{"required":"yes","param":"int $author_id Required."},{"required":"no","param":"string $author_nicename Optional."}],"desc":"Returns or Prints link to the author's posts.","returns":"string|null "},"link_pages":{"params":[{"required":"yes","param":"string $before "},{"required":"yes","param":"string $after "},{"required":"yes","param":"string $next_or_number "},{"required":"yes","param":"string $nextpagelink "},{"required":"yes","param":"string $previouspagelink "},{"required":"yes","param":"string $pagelink "},{"required":"yes","param":"string $more_file "}],"desc":"Print list of pages based on arguments.","returns":"string "},"get_settings":{"params":[{"required":"yes","param":"string $option "}],"desc":"Get value based on option.","returns":"string "},"permalink_link":{"params":[],"desc":"Print the permalink of the current post in the loop.","returns":""},"permalink_single_rss":{"params":[{"required":"yes","param":"string $deprecated "}],"desc":"Print the permalink to the RSS feed.","returns":""},"wp_get_links":{"params":[{"required":"yes","param":"string $args a query string"}],"desc":"Gets the links associated with category.","returns":"null|string "},"get_links":{"params":[{"required":"yes","param":"int $category The category to use. If no category supplied uses all"},{"required":"yes","param":"string $before the html to output before the link"},{"required":"yes","param":"string $after the html to output after the link"},{"required":"yes","param":"string $between the html to output between the link/image and its description. Not used if no image or show_images == true"},{"required":"yes","param":"bool $show_images whether to show images (if defined)."},{"required":"yes","param":"string $orderby the order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. Or maybe owner. If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a random order."},{"required":"yes","param":"bool $show_description whether to show the description if show_images=false/not defined."},{"required":"yes","param":"bool $show_rating show rating stars/chars"},{"required":"yes","param":"int $limit Limit to X entries. If not specified, all entries are shown."},{"required":"yes","param":"int $show_updated whether to show last updated timestamp"},{"required":"yes","param":"bool $echo whether to echo the results, or return them instead"}],"desc":"Gets the links associated with category by id.","returns":"null|string "},"get_links_list":{"params":[{"required":"yes","param":"string $order Sort link categories by 'name' or 'id'"}],"desc":"Output entire list of links by category.","returns":""},"links_popup_script":{"params":[{"required":"yes","param":"string $text the text of the link"},{"required":"yes","param":"int $width the width of the popup window"},{"required":"yes","param":"int $height the height of the popup window"},{"required":"yes","param":"string $file the page to open in the popup window"},{"required":"yes","param":"bool $count the number of links in the db"}],"desc":"Show the link to the links popup and the number of links.","returns":""},"get_linkrating":{"params":[{"required":"yes","param":"object $link "}],"desc":"","returns":"unknown "},"get_linkcatname":{"params":[{"required":"yes","param":"int $id The category to get. If no category supplied uses 0"}],"desc":"Gets the name of category by id.","returns":"string "},"comments_rss_link":{"params":[{"required":"yes","param":"string $link_text "}],"desc":"Print RSS comment feed link.","returns":""},"get_category_rss_link":{"params":[{"required":"yes","param":"bool $echo "},{"required":"yes","param":"int $cat_ID "}],"desc":"Print/Return link to category RSS2 feed.","returns":"string|null "},"get_author_rss_link":{"params":[{"required":"yes","param":"bool $echo "},{"required":"yes","param":"int $author_id "}],"desc":"Print/Return link to author RSS feed.","returns":"string|null "},"comments_rss":{"params":[],"desc":"Return link to the post RSS feed.","returns":"string "},"create_user":{"params":[{"required":"yes","param":"string $username The user's username."},{"required":"yes","param":"string $password The user's password."},{"required":"no","param":"string $email The user's email (optional)."}],"desc":"An alias of wp_create_user().","returns":"int The new user's ID."},"gzip_compression":{"params":[],"desc":"Unused function.","returns":""},"get_commentdata":{"params":[{"required":"yes","param":"int $comment_ID The ID of the comment"},{"required":"yes","param":"int $no_cache Whether to use the cache (cast to bool)"},{"required":"yes","param":"bool $include_unapproved Whether to include unapproved comments"}],"desc":"Retrieve an array of comment data about comment $comment_ID.","returns":"array The comment data"},"get_catname":{"params":[{"required":"yes","param":"int $cat_ID Category ID"}],"desc":"Retrieve the category name by the category ID.","returns":"string category name"},"get_category_children":{"params":[{"required":"yes","param":"int $id Category ID to retrieve children."},{"required":"no","param":"string $before Optional. Prepend before category term ID."},{"required":"no","param":"string $after Optional, default is empty string. Append after category term ID."},{"required":"no","param":"array $visited Optional. Category Term IDs that have already been added."}],"desc":"Retrieve category children list separated before and after the term IDs.","returns":"string "},"get_the_author_description":{"params":[],"desc":"Retrieve the description of the author of the current post.","returns":"string The author's description."},"the_author_description":{"params":[],"desc":"Display the description of the author of the current post.","returns":""},"get_the_author_login":{"params":[],"desc":"Retrieve the login name of the author of the current post.","returns":"string The author's login name (username)."},"the_author_login":{"params":[],"desc":"Display the login name of the author of the current post.","returns":""},"get_the_author_firstname":{"params":[],"desc":"Retrieve the first name of the author of the current post.","returns":"string The author's first name."},"the_author_firstname":{"params":[],"desc":"Display the first name of the author of the current post.","returns":""},"get_the_author_lastname":{"params":[],"desc":"Retrieve the last name of the author of the current post.","returns":"string The author's last name."},"the_author_lastname":{"params":[],"desc":"Display the last name of the author of the current post.","returns":""},"get_the_author_nickname":{"params":[],"desc":"Retrieve the nickname of the author of the current post.","returns":"string The author's nickname."},"the_author_nickname":{"params":[],"desc":"Display the nickname of the author of the current post.","returns":""},"get_the_author_email":{"params":[],"desc":"Retrieve the email of the author of the current post.","returns":"string The author's username."},"the_author_email":{"params":[],"desc":"Display the email of the author of the current post.","returns":""},"get_the_author_icq":{"params":[],"desc":"Retrieve the ICQ number of the author of the current post.","returns":"string The author's ICQ number."},"the_author_icq":{"params":[],"desc":"Display the ICQ number of the author of the current post.","returns":""},"get_the_author_yim":{"params":[],"desc":"Retrieve the Yahoo! IM name of the author of the current post.","returns":"string The author's Yahoo! IM name."},"the_author_yim":{"params":[],"desc":"Display the Yahoo! IM name of the author of the current post.","returns":""},"get_the_author_msn":{"params":[],"desc":"Retrieve the MSN address of the author of the current post.","returns":"string The author's MSN address."},"the_author_msn":{"params":[],"desc":"Display the MSN address of the author of the current post.","returns":""},"get_the_author_aim":{"params":[],"desc":"Retrieve the AIM address of the author of the current post.","returns":"string The author's AIM address."},"the_author_aim":{"params":[],"desc":"Display the AIM address of the author of the current post.","returns":""},"get_author_name":{"params":[{"required":"yes","param":"int $auth_id The ID of the author."}],"desc":"Retrieve the specified author's preferred display name.","returns":"string The author's display name."},"get_the_author_url":{"params":[],"desc":"Retrieve the URL to the home page of the author of the current post.","returns":"string The URL to the author's page."},"the_author_url":{"params":[],"desc":"Display the URL to the home page of the author of the current post.","returns":""},"get_the_author_ID":{"params":[],"desc":"Retrieve the ID of the author of the current post.","returns":"int The author's ID."},"the_author_ID":{"params":[],"desc":"Display the ID of the author of the current post.","returns":""},"the_content_rss":{"params":[{"required":"no","param":"string $more_link_text Optional. Text to display when more content is available but not displayed."},{"required":"no","param":"int|bool $stripteaser Optional. Default is 0."},{"required":"no","param":"string $more_file Optional."},{"required":"no","param":"int $cut Optional. Amount of words to keep for the content."},{"required":"no","param":"int $encode_html Optional. How to encode the content."}],"desc":"Display the post content for the feed.","returns":""},"make_url_footnote":{"params":[{"required":"yes","param":"string $content Content to get links"}],"desc":"Strip HTML and put links at the bottom of stripped content.","returns":"string HTML stripped out of content with links at the bottom."},"_c":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieve translated string with vertical bar context","returns":"string Translated context string without pipe"},"translate_with_context":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"yes","param":"string $domain Domain to retrieve the translated text"}],"desc":"Translates $text like translate(), but assumes that the text contains a context after its last vertical bar.","returns":"string Translated text"},"_nc":{"params":[],"desc":"A version of _n(), which supports contexts.","returns":""},"__ngettext":{"params":[],"desc":"Retrieve the plural or single form based on the amount.","returns":""},"__ngettext_noop":{"params":[],"desc":"Register plural strings in POT file, but don't translate them.","returns":""},"get_alloptions":{"params":[],"desc":"Retrieve all autoload options, or all options if no autoloaded ones exist.","returns":"array List of all options."},"get_the_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default is false. Whether to use full size image."},{"required":"no","param":"array $max_dims Optional. Max image dimensions."},{"required":"no","param":"bool $permalink Optional, default is false. Whether to include permalink to image."}],"desc":"Retrieve HTML content of attachment image with link.","returns":"string "},"get_attachment_icon_src":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default to false. Whether to have full image."}],"desc":"Retrieve icon URL and Path.","returns":"array Icon URL and full path to file, respectively."},"get_attachment_icon":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default to false. Whether to have full size image."},{"required":"no","param":"array $max_dims Optional. Dimensions of image."}],"desc":"Retrieve HTML content of icon attachment image element.","returns":"string HTML content."},"get_attachment_innerHTML":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default to false. Whether to have full size image."},{"required":"no","param":"array $max_dims Optional. Dimensions of image."}],"desc":"Retrieve HTML content of image element.","returns":"string "},"get_link":{"params":[{"required":"yes","param":"int $bookmark_id ID of link"},{"required":"yes","param":"string $output OBJECT, ARRAY_N, or ARRAY_A"}],"desc":"Retrieve bookmark data based on ID.","returns":"object|array "},"sanitize_url":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"yes","param":"array $protocols An array of acceptable protocols."}],"desc":"Performs esc_url() for database or redirect usage.","returns":"string The cleaned URL."},"clean_url":{"params":[{"required":"yes","param":"string $url The URL to be cleaned."},{"required":"no","param":"array $protocols Optional. An array of acceptable protocols."},{"required":"no","param":"string $context Optional. How the URL will be used. Default is 'display'."}],"desc":"Checks and cleans a URL.","returns":"string The cleaned $url after the 'clean_url' filter is applied."},"js_escape":{"params":[{"required":"yes","param":"string $text The text to be escaped."}],"desc":"Escape single quotes, specialchar double quotes, and fix line endings.","returns":"string Escaped text."},"wp_specialchars":{"params":[],"desc":"Escaping for HTML blocks.","returns":""},"attribute_escape":{"params":[{"required":"yes","param":"string $text "}],"desc":"Escaping for HTML attributes.","returns":"string "},"register_sidebar_widget":{"params":[{"required":"yes","param":"string|int $name Widget ID."},{"required":"yes","param":"callback $output_callback Run when widget is called."},{"required":"yes","param":"string $classname Classname widget option."},{"required":"yes","param":"mixed $params,... Widget parameters."}],"desc":"Register widget for sidebar with backwards compatibility.","returns":""},"unregister_sidebar_widget":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Alias of {@link wp_unregister_sidebar_widget()}.","returns":""},"register_widget_control":{"params":[{"required":"yes","param":"int|string $name Sidebar ID."},{"required":"yes","param":"callback $control_callback Widget control callback to display and process form."},{"required":"yes","param":"int $width Widget width."},{"required":"yes","param":"int $height Widget height."}],"desc":"Registers widget control callback for customizing options.","returns":""},"unregister_widget_control":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Alias of {@link wp_unregister_widget_control()}.","returns":""},"delete_usermeta":{"params":[{"required":"yes","param":"int $user_id User ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."}],"desc":"Remove user meta data.","returns":"bool True deletion completed and false if user_id is not a number."},"get_usermeta":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"no","param":"string $meta_key Optional. Metadata key."}],"desc":"Retrieve user metadata.","returns":"mixed "},"update_usermeta":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."}],"desc":"Update metadata of user.","returns":"bool True on successful update, false on failure."},"get_users_of_blog":{"params":[{"required":"yes","param":"int $id Blog ID."}],"desc":"Get users for the blog.","returns":"array List of users that are part of that Blog ID"},"automatic_feed_links":{"params":[{"required":"no","param":"boolean $add Optional, default is true. Add or remove links. Defaults to true."}],"desc":"Enable/disable automatic general feed link outputting.","returns":""},"get_profile":{"params":[],"desc":"Retrieve user data based on field.","returns":""},"get_usernumposts":{"params":[],"desc":"Number of posts user has written.","returns":""},"funky_javascript_callback":{"params":[{"required":"yes","param":"array $matches Single Match"}],"desc":"Callback used to change %uXXXX to &#YYY; syntax","returns":"string An HTML entity"},"funky_javascript_fix":{"params":[{"required":"yes","param":"string $text Text to be made safe."}],"desc":"Fixes javascript bugs in browsers.","returns":"string Fixed text."},"is_taxonomy":{"params":[{"required":"yes","param":"string $taxonomy Name of taxonomy object"}],"desc":"Checks that the taxonomy name exists.","returns":"bool Whether the taxonomy exists."},"is_term":{"params":[{"required":"yes","param":"int|string $term The term to check"},{"required":"yes","param":"string $taxonomy The taxonomy name to use"},{"required":"yes","param":"int $parent ID of parent term under which to confine the exists search."}],"desc":"Check if Term exists.","returns":"mixed Get the term id or Term Object, if exists."},"is_plugin_page":{"params":[],"desc":"Is the current admin page generated by a plugin?","returns":"bool "},"update_category_cache":{"params":[],"desc":"Update the categories cache.","returns":"bool Always return True"},"wp_timezone_supported":{"params":[],"desc":"Check for PHP timezone support","returns":"bool "},"the_editor":{"params":[{"required":"yes","param":"string $content Textarea content."},{"required":"no","param":"string $id Optional, default is 'content'. HTML ID attribute value."},{"required":"no","param":"string $prev_id Optional, not used"},{"required":"no","param":"bool $media_buttons Optional, default is true. Whether to display media buttons."},{"required":"no","param":"int $tab_index Optional, not used"}],"desc":"Display editor: TinyMCE, HTML, or both.","returns":""},"get_user_metavalues":{"params":[{"required":"yes","param":"array $ids User ID numbers list."}],"desc":"Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users","returns":"array of arrays. The array is indexed by user_id, containing $metavalues object arrays."},"sanitize_user_object":{"params":[{"required":"yes","param":"object|array $user The User Object or Array"},{"required":"no","param":"string $context Optional, default is 'display'. How to sanitize user fields."}],"desc":"Sanitize every user field.","returns":"object|array The now sanitized User Object or Array (will be the same type as $user)"},"get_boundary_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"string $excluded_categories Optional. Excluded categories IDs."},{"required":"no","param":"bool $start Optional, default is true. Whether to display link to first or last post."}],"desc":"Get boundary post relational link.","returns":"string "},"start_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."},{"required":"no","param":"bool $in_same_cat Optional. Whether link should be in a same category."},{"required":"no","param":"string $excluded_categories Optional. Excluded categories IDs."}],"desc":"Display relational link for the first post.","returns":""},"get_index_rel_link":{"params":[],"desc":"Get site index relational link.","returns":"string "},"index_rel_link":{"params":[],"desc":"Display relational link for the site index.","returns":""},"get_parent_post_rel_link":{"params":[{"required":"no","param":"string $title Optional. Link title format."}],"desc":"Get parent post relational link.","returns":"string "},"parent_post_rel_link":{"params":[],"desc":"Display relational link for parent item","returns":""},"wp_admin_bar_dashboard_view_site_menu":{"params":[],"desc":"Add the "Dashboard"/"Visit Site" menu.","returns":""},"is_blog_user":{"params":[{"required":"yes","param":"int $blog_id Blog ID"}],"desc":"Checks if the current user belong to a given blog.","returns":"bool True if the current users belong to $blog_id, false if not."},"stripos":{"params":[],"desc":"","returns":""},"wp_print_styles":{"params":[{"required":"yes","param":"array|bool $handles Styles to be printed. An empty array prints the queue, an array with one string prints that style, and an array of strings prints those styles."}],"desc":"Display styles that are in the queue or part of $handles.","returns":"bool True on success, false on failure."},"wp_add_inline_style":{"params":[],"desc":"Adds extra CSS.","returns":""},"wp_register_style":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."},{"required":"yes","param":"string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'."},{"required":"yes","param":"array $deps Array of handles of any stylesheet that this stylesheet depends on. (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies."},{"required":"yes","param":"string|bool $ver String specifying the stylesheet version number. Set to NULL to disable. Used to ensure that the correct version is sent to the client regardless of caching."},{"required":"yes","param":"string $media The media for which this stylesheet has been defined."}],"desc":"Register CSS style file.","returns":""},"wp_deregister_style":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."}],"desc":"Remove a registered CSS file.","returns":""},"wp_enqueue_style":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."},{"required":"yes","param":"string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'."},{"required":"yes","param":"array $deps Array of handles (names) of any stylesheet that this stylesheet depends on. (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies."},{"required":"yes","param":"string|bool $ver String specifying the stylesheet version number, if it has one. This parameter is used to ensure that the correct version is sent to the client regardless of caching, and so should be included if a version number is available and makes sense for the stylesheet."},{"required":"yes","param":"string $media The media for which this stylesheet has been defined."}],"desc":"Enqueue a CSS style file.","returns":""},"wp_dequeue_style":{"params":[],"desc":"Remove an enqueued style.","returns":""},"wp_style_is":{"params":[{"required":"yes","param":"string $handle Name of the stylesheet."},{"required":"yes","param":"string $list Values are 'registered', 'done', 'queue' and 'to_do'."}],"desc":"Check whether style has been added to WordPress Styles.","returns":"bool True on success, false on failure."},"redirect_canonical":{"params":[{"required":"no","param":"string $requested_url Optional. The URL that was requested, used to figure if redirect is needed."},{"required":"no","param":"bool $do_redirect Optional. Redirect to the new URL."}],"desc":"Redirects incoming links to the proper URL based on the site url.","returns":"null|false|string Null, if redirect not needed. False, if redirect not needed or the string of the URL"},"redirect_guess_404_permalink":{"params":[],"desc":"Attempts to guess correct post based on query vars.","returns":"bool|string Returns False, if it can't find post, returns correct location on success."},"wp_get_nav_menu_object":{"params":[{"required":"yes","param":"string $menu Menu id, slug or name"}],"desc":"Returns a navigation menu object.","returns":"mixed false if $menu param isn't supplied or term does not exist, menu object if successful."},"is_nav_menu":{"params":[{"required":"yes","param":"int|string $menu The menu to check (id, slug, or name)"}],"desc":"Check if the given ID is a navigation menu.","returns":"bool Whether the menu exists."},"register_nav_menus":{"params":[{"required":"yes","param":"array $locations Associative array of menu location identifiers (like a slug) and descriptive text."}],"desc":"Register navigation menus for a theme.","returns":""},"unregister_nav_menu":{"params":[{"required":"yes","param":"array $location the menu location identifier"}],"desc":"Unregisters a navigation menu for a theme.","returns":"bool True on success, false on failure."},"register_nav_menu":{"params":[{"required":"yes","param":"string $location Menu location identifier, like a slug."},{"required":"yes","param":"string $description Menu location descriptive text."}],"desc":"Register a navigation menu for a theme.","returns":""},"get_registered_nav_menus":{"params":[],"desc":"Returns an array of all registered navigation menus in a theme","returns":"array "},"get_nav_menu_locations":{"params":[],"desc":"Returns an array with the registered navigation menu locations and the menu assigned to it","returns":"array "},"has_nav_menu":{"params":[{"required":"yes","param":"string $location Menu location identifier."}],"desc":"Whether a registered nav menu location has a menu assigned to it.","returns":"bool Whether location has a menu."},"is_nav_menu_item":{"params":[{"required":"yes","param":"int $menu_item_id The ID of the potential nav menu item."}],"desc":"Determine whether the given ID is a nav menu item.","returns":"bool Whether the given ID is that of a nav menu item."},"wp_create_nav_menu":{"params":[{"required":"yes","param":"string $menu_name Menu Name"}],"desc":"Create a Navigation Menu.","returns":"mixed Menu object on success|WP_Error on failure"},"wp_delete_nav_menu":{"params":[{"required":"yes","param":"string $menu name|id|slug"}],"desc":"Delete a Navigation Menu.","returns":"mixed Menu object on success|WP_Error on failure"},"wp_update_nav_menu_object":{"params":[{"required":"yes","param":"int $menu_id The ID of the menu or "0" to create a new menu."},{"required":"yes","param":"array $menu_data The array of menu data."}],"desc":"Save the properties of a menu or create a new menu with those properties.","returns":"int|error object The menu's ID or WP_Error object."},"wp_update_nav_menu_item":{"params":[{"required":"yes","param":"int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan."},{"required":"yes","param":"int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item."},{"required":"yes","param":"array $menu_item_data The menu item's data."}],"desc":"Save the properties of a menu item or create a new one.","returns":"int The menu item's database ID or WP_Error object on failure."},"wp_get_nav_menus":{"params":[{"required":"yes","param":"array $args Array of arguments passed on to get_terms()."}],"desc":"Returns all navigation menu objects.","returns":"array menu objects"},"_sort_nav_menu_items":{"params":[{"required":"yes","param":"object $a The first object to compare"},{"required":"yes","param":"object $b The second object to compare"}],"desc":"Sort menu items by the desired key.","returns":"int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b."},"_is_valid_nav_menu_item":{"params":[{"required":"yes","param":"object $menu_item The menu item to check"}],"desc":"Returns if a menu item is valid. Bug #13958","returns":"bool false if invalid, else true."},"wp_get_nav_menu_items":{"params":[{"required":"yes","param":"string $menu menu name, id, or slug"},{"required":"yes","param":"string $args "}],"desc":"Returns all menu items of a navigation menu.","returns":"mixed $items array of menu items, else false."},"wp_setup_nav_menu_item":{"params":[{"required":"yes","param":"object $menu_item The menu item to modify."}],"desc":"Decorates a menu item object with the shared navigation menu item properties.","returns":"object $menu_item The menu item with standard menu item properties."},"wp_get_associated_nav_menu_items":{"params":[{"required":"yes","param":"int $object_id The ID of the original object."},{"required":"yes","param":"string $object_type The type of object, such as "taxonomy" or "post_type.""}],"desc":"Get the menu items associated with a particular object.","returns":"array The array of menu item IDs; empty array if none;"},"_wp_delete_post_menu_item":{"params":[{"required":"yes","param":"int $object_id The ID of the original object being trashed."}],"desc":"Callback for handling a menu item when its original object is deleted.","returns":""},"_wp_delete_tax_menu_item":{"params":[{"required":"yes","param":"int $object_id The ID of the original object being trashed."}],"desc":"Callback for handling a menu item when its original object is deleted.","returns":""},"_wp_auto_add_pages_to_menu":{"params":[{"required":"yes","param":"string $new_status The new status of the post object."},{"required":"yes","param":"string $old_status The old status of the post object."},{"required":"yes","param":"object $post The post object being transitioned from one status to another."}],"desc":"Automatically add newly published page objects to menus with that as an option.","returns":"void "},"wp_unregister_GLOBALS":{"params":[],"desc":"Turn register globals off.","returns":"null Will return null if register_globals PHP directive was disabled"},"wp_fix_server_vars":{"params":[],"desc":"Fix $_SERVER variables for various setups.","returns":""},"wp_check_php_mysql_versions":{"params":[],"desc":"Check for the required PHP version, and the MySQL extension or a database drop-in.","returns":""},"wp_favicon_request":{"params":[],"desc":"Don't load all of WordPress when handling a favicon.ico request.","returns":""},"wp_maintenance":{"params":[],"desc":"Dies with a maintenance message when conditions are met.","returns":""},"timer_start":{"params":[],"desc":"PHP 4 standard microtime start capture.","returns":"bool Always returns true."},"timer_stop":{"params":[{"required":"yes","param":"int $display Use '0' or null to not echo anything and 1 to echo the total time"},{"required":"yes","param":"int $precision The amount of digits from the right of the decimal to display. Default is 3."}],"desc":"Return and/or display the time from the page start to when function is called.","returns":"float The "second.microsecond" finished time calculation"},"wp_debug_mode":{"params":[],"desc":"Sets PHP error handling and handles WordPress debug mode.","returns":""},"wp_set_lang_dir":{"params":[],"desc":"Sets the location of the language directory.","returns":""},"require_wp_db":{"params":[],"desc":"Load the correct database class file.","returns":""},"wp_set_wpdb_vars":{"params":[],"desc":"Sets the database table prefix and the format specifiers for database table columns.","returns":""},"wp_start_object_cache":{"params":[],"desc":"Starts the WordPress object cache.","returns":""},"wp_not_installed":{"params":[],"desc":"Redirects to the installer if WordPress is not installed.","returns":""},"wp_get_mu_plugins":{"params":[],"desc":"Returns array of must-use plugin files to be included in global scope.","returns":"array Files to include"},"wp_get_active_and_valid_plugins":{"params":[],"desc":"Returns array of plugin files to be included in global scope.","returns":"array Files to include"},"wp_set_internal_encoding":{"params":[],"desc":"Sets internal encoding using mb_internal_encoding().","returns":""},"wp_magic_quotes":{"params":[],"desc":"Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER.","returns":""},"shutdown_action_hook":{"params":[],"desc":"Runs just before PHP shuts down execution.","returns":""},"wp_clone":{"params":[{"required":"yes","param":"object $object The object to clone"}],"desc":"Copy an object.","returns":"object The cloned object"},"is_blog_admin":{"params":[],"desc":"Whether the current request is for a blog admin screen /wp-admin/","returns":"bool True if inside WordPress network administration pages."},"is_network_admin":{"params":[],"desc":"Whether the current request is for a network admin screen /wp-admin/network/","returns":"bool True if inside WordPress network administration pages."},"is_user_admin":{"params":[],"desc":"Whether the current request is for a user admin screen /wp-admin/user/","returns":"bool True if inside WordPress user administration pages."},"is_multisite":{"params":[],"desc":"Whether Multisite support is enabled","returns":"bool True if multisite is enabled, false otherwise."},"wp_schedule_single_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Schedules a hook to run only once.","returns":""},"wp_schedule_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $recurrence How often the event should recur."},{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Schedule a periodic event.","returns":"bool|null False on failure, null when complete with scheduling event."},"wp_reschedule_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $recurrence How often the event should recur."},{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Reschedule a recurring event.","returns":"bool|null False on failure. Null when event is rescheduled."},"wp_unschedule_event":{"params":[{"required":"yes","param":"int $timestamp Timestamp for when to run the event."},{"required":"yes","param":"string $hook Action hook, the execution of which will be unscheduled."},{"required":"yes","param":"array $args Arguments to pass to the hook's callback function. Although not passed to a callback function, these arguments are used to uniquely identify the scheduled event, so they should be the same as those used when originally scheduling the event."}],"desc":"Unschedule a previously scheduled cron job.","returns":""},"wp_clear_scheduled_hook":{"params":[{"required":"yes","param":"string $hook Action hook, the execution of which will be unscheduled."},{"required":"no","param":"array $args Optional. Arguments that were to be pass to the hook's callback function."}],"desc":"Unschedule all cron jobs attached to a specific hook.","returns":""},"wp_next_scheduled":{"params":[{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Retrieve the next timestamp for a cron event.","returns":"bool|int The UNIX timestamp of the next time the scheduled event will occur."},"spawn_cron":{"params":[],"desc":"Send request to run cron through HTTP request that doesn't halt page loading.","returns":"null Cron could not be spawned, because it is not needed to run."},"wp_cron":{"params":[],"desc":"Run scheduled callbacks or spawn cron for all scheduled events.","returns":"null When doesn't need to run Cron."},"wp_get_schedules":{"params":[],"desc":"Retrieve supported and filtered Cron recurrences.","returns":"array "},"wp_get_schedule":{"params":[{"required":"yes","param":"string $hook Action hook to execute when cron is run."},{"required":"no","param":"array $args Optional. Arguments to pass to the hook's callback function."}],"desc":"Retrieve Cron schedule for hook with arguments.","returns":"string|bool False, if no schedule. Schedule on success."},"_get_cron_array":{"params":[],"desc":"Retrieve cron info array option.","returns":"array CRON info array."},"_set_cron_array":{"params":[{"required":"yes","param":"array $cron Cron info array from {@link _get_cron_array()}."}],"desc":"Updates the CRON option with the new CRON array.","returns":""},"_upgrade_cron_array":{"params":[{"required":"yes","param":"array $cron Cron info array from {@link _get_cron_array()}."}],"desc":"Upgrade a Cron info array.","returns":"array An upgraded Cron info array."},"_wp_oembed_get_object":{"params":[],"desc":"Returns the initialized {@link WP_oEmbed} object","returns":"WP_oEmbed object."},"get_locale":{"params":[],"desc":"Gets the current locale.","returns":"string The locale of the blog or from the 'locale' hook."},"translate":{"params":[{"required":"yes","param":"string $text Text to translate."},{"required":"yes","param":"string $domain Domain to retrieve the translated text."}],"desc":"Retrieves the translation of $text. If there is no translation, or the domain isn't loaded, the original text is returned.","returns":"string Translated text"},"before_last_bar":{"params":[],"desc":"","returns":""},"translate_with_gettext_context":{"params":[],"desc":"","returns":""},"esc_attr__":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieves the translation of $text and escapes it for safe use in an attribute.","returns":"string Translated text"},"esc_html__":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Retrieves the translation of $text and escapes it for safe use in HTML output.","returns":"string Translated text"},"_e":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays the returned translated text from translate().","returns":""},"esc_attr_e":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays translated text that has been escaped for safe use in an attribute.","returns":""},"esc_html_e":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays translated text that has been escaped for safe use in HTML output.","returns":""},"_ex":{"params":[{"required":"yes","param":"string $text Text to translate"},{"required":"yes","param":"string $context Context information for the translators"},{"required":"no","param":"string $domain Optional. Domain to retrieve the translated text"}],"desc":"Displays translated string with gettext context","returns":"string Translated context string without pipe"},"esc_attr_x":{"params":[],"desc":"","returns":""},"esc_html_x":{"params":[],"desc":"","returns":""},"_n":{"params":[{"required":"yes","param":"string $single The text that will be used if $number is 1"},{"required":"yes","param":"string $plural The text that will be used if $number is not 1"},{"required":"yes","param":"int $number The number to compare against to use either $single or $plural"},{"required":"no","param":"string $domain Optional. The domain identifier the text should be retrieved in"}],"desc":"Retrieve the plural or single form based on the amount.","returns":"string Either $single or $plural translated text"},"_nx":{"params":[],"desc":"A hybrid of _n() and _x(). It supports contexts and plurals.","returns":""},"_n_noop":{"params":[{"required":"yes","param":"string $singular Single form to be i18ned"},{"required":"yes","param":"string $plural Plural form to be i18ned"}],"desc":"Register plural strings in POT file, but don't translate them.","returns":"array array($singular, $plural)"},"_nx_noop":{"params":[],"desc":"Register plural strings with context in POT file, but don't translate them.","returns":""},"translate_nooped_plural":{"params":[{"required":"yes","param":"array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()"},{"required":"yes","param":"int $count Number of objects"},{"required":"no","param":"string $domain Optional. The domain identifier the text should be retrieved in"}],"desc":"Translate the result of _n_noop() or _nx_noop()","returns":""},"load_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"},{"required":"yes","param":"string $mofile Path to the .mo file"}],"desc":"Loads a MO file into the domain $domain.","returns":"bool True on success, false on failure"},"unload_textdomain":{"params":[{"required":"yes","param":"string $domain Textdomain to be unloaded"}],"desc":"Unloads translations for a domain","returns":"bool Whether textdomain was unloaded"},"load_default_textdomain":{"params":[],"desc":"Loads default translated strings based on locale.","returns":""},"load_plugin_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"},{"required":"no","param":"string $abs_rel_path Optional. Relative path to ABSPATH of a folder, where the .mo file resides. Deprecated, but still functional until 2.7"},{"required":"no","param":"string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precedence over $abs_rel_path"}],"desc":"Loads the plugin's translated strings.","returns":""},"load_muplugin_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"},{"required":"yes","param":"string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which the MO file resides. Defaults to empty string."}],"desc":"Load the translated strings for a plugin residing in the mu-plugins dir.","returns":""},"load_theme_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"}],"desc":"Loads the theme's translated strings.","returns":""},"load_child_theme_textdomain":{"params":[{"required":"yes","param":"string $domain Unique identifier for retrieving translated strings"}],"desc":"Loads the child themes translated strings.","returns":""},"get_translations_for_domain":{"params":[{"required":"yes","param":"string $domain "}],"desc":"Returns the Translations instance for a domain. If there isn't one, returns empty Translations instance.","returns":"object A Translation instance"},"is_textdomain_loaded":{"params":[{"required":"yes","param":"string $domain "}],"desc":"Whether there are translations for the domain","returns":"bool Whether there are translations"},"translate_user_role":{"params":[],"desc":"Translates role name. Since the role names are in the database and not in the source there are dummy gettext calls to get them into the POT file and this function properly translates them back.","returns":""},"get_available_languages":{"params":[{"required":"yes","param":"string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR."}],"desc":"Get all available languages based on the presence of *.mo files in a given directory. The default directory is WP_LANG_DIR.","returns":"array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names."},"has_filter":{"params":[{"required":"yes","param":"string $tag The name of the filter hook."},{"required":"no","param":"callback $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached."}],"desc":"Check if any filter has been registered for a hook.","returns":"int|boolean Optionally returns the priority on that hook for the specified function."},"apply_filters_ref_array":{"params":[{"required":"yes","param":"string $tag The name of the filter hook."},{"required":"yes","param":"array $args The arguments supplied to the functions hooked to <tt>$tag</tt>"}],"desc":"Execute functions hooked on a specific filter hook, specifying arguments in an array.","returns":"mixed The filtered value after all hooked functions are applied to it."},"remove_filter":{"params":[{"required":"yes","param":"string $tag The filter hook to which the function to be removed is hooked."},{"required":"yes","param":"callback $function_to_remove The name of the function which should be removed."},{"required":"no","param":"int $priority optional. The priority of the function (default: 10)."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accepts (default: 1)."}],"desc":"Removes a function from a specified filter hook.","returns":"boolean Whether the function existed before it was removed."},"remove_all_filters":{"params":[{"required":"yes","param":"string $tag The filter to remove hooks from."},{"required":"yes","param":"int $priority The priority number to remove."}],"desc":"Remove all of the hooks from a filter.","returns":"bool True when finished."},"current_filter":{"params":[],"desc":"Retrieve the name of the current filter or action.","returns":"string Hook name of the current filter or action."},"do_action":{"params":[{"required":"yes","param":"string $tag The name of the action to be executed."},{"required":"no","param":"mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the action."}],"desc":"Execute functions hooked on a specific action hook.","returns":"null Will return null if $tag does not exist in $wp_filter array"},"did_action":{"params":[{"required":"yes","param":"string $tag The name of the action hook."}],"desc":"Retrieve the number of times an action is fired.","returns":"int The number of times action hook <tt>$tag</tt> is fired"},"has_action":{"params":[{"required":"yes","param":"string $tag The name of the action hook."},{"required":"no","param":"callback $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached."}],"desc":"Check if any action has been registered for a hook.","returns":"int|boolean Optionally returns the priority on that hook for the specified function."},"remove_action":{"params":[{"required":"yes","param":"string $tag The action hook to which the function to be removed is hooked."},{"required":"yes","param":"callback $function_to_remove The name of the function which should be removed."},{"required":"no","param":"int $priority optional The priority of the function (default: 10)."},{"required":"no","param":"int $accepted_args optional. The number of arguments the function accepts (default: 1)."}],"desc":"Removes a function from a specified action hook.","returns":"boolean Whether the function is removed."},"remove_all_actions":{"params":[{"required":"yes","param":"string $tag The action to remove hooks from."},{"required":"yes","param":"int $priority The priority number to remove them from."}],"desc":"Remove all of the hooks from an action.","returns":"bool True when finished."},"plugin_basename":{"params":[{"required":"yes","param":"string $file The filename of plugin."}],"desc":"Gets the basename of a plugin.","returns":"string The name of a plugin."},"plugin_dir_path":{"params":[{"required":"yes","param":"string $file The filename of the plugin (__FILE__)"}],"desc":"Gets the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in","returns":"string the filesystem path of the directory that contains the plugin"},"plugin_dir_url":{"params":[{"required":"yes","param":"string $file The filename of the plugin (__FILE__)"}],"desc":"Gets the URL directory path (with trailing slash) for the plugin __FILE__ passed in","returns":"string the URL path of the directory that contains the plugin"},"register_activation_hook":{"params":[{"required":"yes","param":"string $file The filename of the plugin including the path."},{"required":"yes","param":"callback $function the function hooked to the 'activate_PLUGIN' action."}],"desc":"Set the activation hook for a plugin.","returns":""},"register_deactivation_hook":{"params":[{"required":"yes","param":"string $file The filename of the plugin including the path."},{"required":"yes","param":"callback $function the function hooked to the 'activate_PLUGIN' action."}],"desc":"Set the deactivation hook for a plugin.","returns":""},"register_uninstall_hook":{"params":[{"required":"yes","param":"string $file "},{"required":"yes","param":"callback $callback The callback to run when the hook is called. Must be a static method or function."}],"desc":"Set the uninstallation hook for a plugin.","returns":""},"_wp_call_all_hook":{"params":[{"required":"yes","param":"array $args The collected parameters from the hook that was called."},{"required":"no","param":"string $hook Optional. The hook name that was used to call the 'all' hook."}],"desc":"Calls the 'all' hook, which will process the functions hooked into it.","returns":""},"_wp_filter_build_unique_id":{"params":[{"required":"yes","param":"string $tag Used in counting how many hooks were applied"},{"required":"yes","param":"callback $function Used for creating unique id"},{"required":"yes","param":"int|bool $priority Used in counting how many hooks were applied. If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise."}],"desc":"Build Unique ID for storage and retrieval.","returns":"string|bool Unique ID for usage as array key or false if $priority === false and $function is an object reference, and it does not already have a unique id."},"generate_random_password":{"params":[],"desc":"","returns":""},"is_site_admin":{"params":[],"desc":"Determine if user is a site admin.","returns":""},"graceful_fail":{"params":[],"desc":"","returns":""},"get_user_details":{"params":[],"desc":"","returns":""},"clear_global_post_cache":{"params":[],"desc":"","returns":""},"is_main_blog":{"params":[],"desc":"","returns":""},"validate_email":{"params":[],"desc":"","returns":""},"get_blog_list":{"params":[],"desc":"","returns":""},"get_most_active_blogs":{"params":[],"desc":"","returns":""},"wpmu_admin_do_redirect":{"params":[{"required":"yes","param":"string $url "}],"desc":"Redirect a user based on $_GET or $_POST arguments.","returns":""},"wpmu_admin_redirect_add_updated_param":{"params":[{"required":"yes","param":"string $url "}],"desc":"Adds an 'updated=true' argument to a URL.","returns":"string "},"has_post_thumbnail":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Check if post has an image attached.","returns":"bool Whether post has an image attached."},"get_post_thumbnail_id":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."}],"desc":"Retrieve Post Thumbnail ID.","returns":"int "},"the_post_thumbnail":{"params":[{"required":"no","param":"int $size Optional. Image size. Defaults to 'post-thumbnail', which theme sets using set_post_thumbnail_size( $width, $height, $crop_flag );."},{"required":"no","param":"string|array $attr Optional. Query string or array of attributes."}],"desc":"Display Post Thumbnail.","returns":""},"update_post_thumbnail_cache":{"params":[],"desc":"Update cache for thumbnails in the current loop","returns":""},"get_the_post_thumbnail":{"params":[{"required":"no","param":"int $post_id Optional. Post ID."},{"required":"no","param":"string $size Optional. Image size. Defaults to 'thumbnail'."},{"required":"no","param":"string|array $attr Optional. Query string or array of attributes."}],"desc":"Retrieve Post Thumbnail.","returns":""},"wp_version_check":{"params":[],"desc":"Check WordPress version against the newest version.","returns":"mixed Returns null if update is unsupported. Returns false if check is too soon."},"wp_update_plugins":{"params":[],"desc":"Check plugin versions against the latest versions hosted on WordPress.org.","returns":"mixed Returns null if update is unsupported. Returns false if check is too soon."},"wp_update_themes":{"params":[],"desc":"Check theme versions against the latest versions hosted on WordPress.org.","returns":"mixed Returns null if update is unsupported. Returns false if check is too soon."},"wp_get_update_data":{"params":[],"desc":"","returns":""},"_maybe_update_core":{"params":[],"desc":"","returns":""},"_maybe_update_plugins":{"params":[],"desc":"Check the last time plugins were run before checking plugin versions.","returns":""},"_maybe_update_themes":{"params":[],"desc":"Check themes versions only after a duration of time.","returns":""},"wp_schedule_update_checks":{"params":[],"desc":"Schedule core, theme, and plugin update checks.","returns":""},"_wp_admin_bar_init":{"params":[],"desc":"Instantiate the admin bar object and set it up as a global for access elsewhere.","returns":"bool Whether the admin bar was successfully initialized."},"wp_admin_bar_render":{"params":[],"desc":"Render the admin bar to the page based on the $wp_admin_bar->menu member var.","returns":""},"wp_admin_bar_wp_menu":{"params":[],"desc":"Add the WordPress logo menu.","returns":""},"wp_admin_bar_my_account_item":{"params":[],"desc":"Add the "My Account" item.","returns":""},"wp_admin_bar_my_account_menu":{"params":[],"desc":"Add the "My Account" submenu items.","returns":""},"wp_admin_bar_site_menu":{"params":[],"desc":"Add the "Site Name" menu.","returns":""},"wp_admin_bar_my_sites_menu":{"params":[],"desc":"Add the "My Sites/[Site Name]" menu and all submenus.","returns":""},"wp_admin_bar_shortlink_menu":{"params":[],"desc":"Provide a shortlink.","returns":""},"wp_admin_bar_edit_menu":{"params":[],"desc":"Provide an edit link for posts and terms.","returns":""},"wp_admin_bar_new_content_menu":{"params":[],"desc":"Add "Add New" menu.","returns":""},"wp_admin_bar_comments_menu":{"params":[],"desc":"Add edit comments link with awaiting moderation count bubble.","returns":""},"wp_admin_bar_appearance_menu":{"params":[],"desc":"Add appearance submenu items to the "Site Name" menu.","returns":""},"wp_admin_bar_updates_menu":{"params":[],"desc":"Provide an update link if theme/plugin/core updates are available.","returns":""},"wp_admin_bar_search_menu":{"params":[],"desc":"Add search form.","returns":""},"wp_admin_bar_add_secondary_groups":{"params":[],"desc":"Add secondary menus.","returns":""},"wp_admin_bar_header":{"params":[],"desc":"Style and scripts for the admin bar.","returns":""},"_admin_bar_bump_cb":{"params":[],"desc":"Default admin bar callback.","returns":""},"show_admin_bar":{"params":[{"required":"yes","param":"bool $show Whether to allow the admin bar to show."}],"desc":"Set the display status of the admin bar.","returns":"void "},"is_admin_bar_showing":{"params":[],"desc":"Determine whether the admin bar should be showing.","returns":"bool Whether the admin bar should be showing."},"_get_admin_bar_pref":{"params":[{"required":"yes","param":"string $context Context of this preference check. Defaults to 'front'. The 'admin' preference is no longer used."},{"required":"no","param":"int $user Optional. ID of the user to check, defaults to 0 for current user."}],"desc":"Retrieve the admin bar display preference of a user.","returns":"bool Whether the admin bar should be showing for this user."},"map_meta_cap":{"params":[{"required":"yes","param":"string $cap Capability name."},{"required":"yes","param":"int $user_id User ID."}],"desc":"Map meta capabilities to primitive capabilities.","returns":"array Actual capabilities for meta capability."},"current_user_can":{"params":[{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether current user has capability or role.","returns":"bool "},"current_user_can_for_blog":{"params":[{"required":"yes","param":"int $blog_id Blog ID"},{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether current user has a capability or role for a given blog.","returns":"bool "},"author_can":{"params":[{"required":"yes","param":"int|object $post Post ID or post object."},{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether author of supplied post has capability or role.","returns":"bool "},"user_can":{"params":[{"required":"yes","param":"int|object $user User ID or object."},{"required":"yes","param":"string $capability Capability or role name."}],"desc":"Whether a particular user has capability or role.","returns":"bool "},"get_role":{"params":[{"required":"yes","param":"string $role Role name."}],"desc":"Retrieve role object.","returns":"object "},"add_role":{"params":[{"required":"yes","param":"string $role Role name."},{"required":"yes","param":"string $display_name Display name for role."},{"required":"yes","param":"array $capabilities List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );"}],"desc":"Add role, if it does not exist.","returns":"null|WP_Role WP_Role object if role is added, null if already exists."},"remove_role":{"params":[{"required":"yes","param":"string $role Role name."}],"desc":"Remove role, if it exists.","returns":"null "},"get_super_admins":{"params":[],"desc":"Retrieve a list of super admins.","returns":"array List of super admin logins"},"is_super_admin":{"params":[{"required":"no","param":"int $user_id (Optional) The ID of a user. Defaults to the current user."}],"desc":"Determine if user is a site admin.","returns":"bool True if the user is a site admin."},"the_ID":{"params":[],"desc":"Display the ID of the current item in the WordPress Loop.","returns":""},"get_the_ID":{"params":[],"desc":"Retrieve the ID of the current item in the WordPress Loop.","returns":"int "},"the_title":{"params":[{"required":"no","param":"string $before Optional. Content to prepend to the title."},{"required":"no","param":"string $after Optional. Content to append to the title."},{"required":"no","param":"bool $echo Optional, default to true.Whether to display or return."}],"desc":"Display or retrieve the current post title with optional content.","returns":"null|string Null on no title. String if $echo parameter is false."},"the_title_attribute":{"params":[{"required":"no","param":"string|array $args Optional. Override the defaults."}],"desc":"Sanitize the current title when retrieving or displaying.","returns":"string|null Null on failure or display. String when echo is false."},"get_the_title":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Retrieve post title.","returns":"string "},"the_guid":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Display the Post Global Unique Identifier (guid).","returns":""},"get_the_guid":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Retrieve the Post Global Unique Identifier (guid).","returns":"string "},"the_content":{"params":[{"required":"no","param":"string $more_link_text Optional. Content for when there is more text."},{"required":"no","param":"bool $stripteaser Optional. Strip teaser content before the more text. Default is false."}],"desc":"Display the post content.","returns":""},"get_the_content":{"params":[{"required":"no","param":"string $more_link_text Optional. Content for when there is more text."},{"required":"no","param":"bool $stripteaser Optional. Strip teaser content before the more text. Default is false."}],"desc":"Retrieve the post content.","returns":"string "},"_convert_urlencoded_to_entities":{"params":[{"required":"yes","param":"array $match Match array from preg_replace_callback"}],"desc":"Preview fix for javascript bug with foreign languages","returns":""},"the_excerpt":{"params":[],"desc":"Display the post excerpt.","returns":""},"get_the_excerpt":{"params":[{"required":"yes","param":"mixed $deprecated Not used."}],"desc":"Retrieve the post excerpt.","returns":"string "},"has_excerpt":{"params":[{"required":"no","param":"int $id Optional. Post ID."}],"desc":"Whether post has excerpt.","returns":"bool "},"post_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."},{"required":"no","param":"int $post_id An optional post ID."}],"desc":"Display the classes for the post div.","returns":""},"get_post_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."},{"required":"no","param":"int $post_id An optional post ID."}],"desc":"Retrieve the classes for the post div as an array.","returns":"array Array of classes."},"body_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."}],"desc":"Display the classes for the body element.","returns":""},"get_body_class":{"params":[{"required":"yes","param":"string|array $class One or more classes to add to the class list."}],"desc":"Retrieve the classes for the body element as an array.","returns":"array Array of classes."},"post_password_required":{"params":[{"required":"no","param":"int|object $post An optional post. Global $post used if not provided."}],"desc":"Whether post requires password and correct password has been provided.","returns":"bool false if a password is not required or the correct password cookie is present, true otherwise."},"sticky_class":{"params":[{"required":"no","param":"int $post_id An optional post ID."}],"desc":"Display "sticky" CSS class, if a post is sticky.","returns":""},"wp_link_pages":{"params":[{"required":"no","param":"string|array $args Optional. Overwrite the defaults."}],"desc":"The formatted output of a list of pages.","returns":"string Formatted output in HTML."},"_wp_link_page":{"params":[{"required":"yes","param":"int $i Page number."}],"desc":"Helper function for wp_link_pages().","returns":"string Link."},"post_custom":{"params":[{"required":"yes","param":"string $key Meta data key name."}],"desc":"Retrieve post custom meta data field.","returns":"bool|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist."},"the_meta":{"params":[],"desc":"Display list of post custom fields.","returns":""},"wp_dropdown_pages":{"params":[{"required":"no","param":"array|string $args Optional. Override default arguments."}],"desc":"Retrieve or display list of pages as a dropdown (select list).","returns":"string HTML content, if not displaying."},"wp_list_pages":{"params":[{"required":"no","param":"array|string $args Optional. Override default arguments."}],"desc":"Retrieve or display list of pages in list (li) format.","returns":"string HTML content, if not displaying."},"wp_page_menu":{"params":[{"required":"yes","param":"array|string $args "}],"desc":"Display or retrieve list of pages with optional home link.","returns":""},"walk_page_tree":{"params":[],"desc":"Retrieve HTML list content for page list.","returns":""},"walk_page_dropdown_tree":{"params":[],"desc":"Retrieve HTML dropdown (select) content for page list.","returns":""},"the_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"bool $fullsize Optional, default is false. Whether to use full size."},{"required":"yes","param":"bool $deprecated Deprecated. Not used."},{"required":"no","param":"bool $permalink Optional, default is false. Whether to include permalink."}],"desc":"Display an attachment page link using an image or icon.","returns":""},"wp_get_attachment_link":{"params":[{"required":"no","param":"int $id Optional. Post ID."},{"required":"no","param":"string $size Optional, default is 'thumbnail'. Size of image, either array or string."},{"required":"no","param":"bool $permalink Optional, default is false. Whether to add permalink to image."},{"required":"no","param":"bool $icon Optional, default is false. Whether to include icon."},{"required":"no","param":"string $text Optional, default is false. If string, then will be link text."}],"desc":"Retrieve an attachment page link using an image or icon, if possible.","returns":"string HTML content."},"prepend_attachment":{"params":[{"required":"yes","param":"string $content "}],"desc":"Wrap attachment in <<p>> element before content.","returns":"string "},"get_the_password_form":{"params":[],"desc":"Retrieve protected post password form content.","returns":"string HTML content for password form for password protected post."},"is_page_template":{"params":[{"required":"yes","param":"string $template The specific template name if specific matching is required."}],"desc":"Whether currently in a page template.","returns":"bool False on failure, true if success."},"wp_post_revision_title":{"params":[{"required":"yes","param":"int|object $revision Revision ID or revision object."},{"required":"no","param":"bool $link Optional, default is true. Link to revisions's page?"}],"desc":"Retrieve formatted date timestamp of a revision (linked to that revisions's page).","returns":"string i18n formatted datetimestamp or localized 'Current Revision'."},"wp_list_post_revisions":{"params":[{"required":"yes","param":"int|object $post_id Post ID or post object."},{"required":"yes","param":"string|array $args See description {@link wp_parse_args()}."}],"desc":"Display list of a post's revisions.","returns":"null "},"get_bookmark":{"params":[{"required":"yes","param":"mixed $bookmark "},{"required":"no","param":"string $output Optional. Either OBJECT, ARRAY_N, or ARRAY_A constant"},{"required":"no","param":"string $filter Optional, default is 'raw'."}],"desc":"Retrieve Bookmark data","returns":"array|object Type returned depends on $output value."},"get_bookmark_field":{"params":[{"required":"yes","param":"string $field The name of the data field to return"},{"required":"yes","param":"int $bookmark The bookmark ID to get field"},{"required":"no","param":"string $context Optional. The context of how the field will be used."}],"desc":"Retrieve single bookmark data item or field.","returns":"string "},"get_bookmarks":{"params":[{"required":"yes","param":"string|array $args List of arguments to overwrite the defaults"}],"desc":"Retrieves the list of bookmarks","returns":"array List of bookmark row objects"},"sanitize_bookmark":{"params":[{"required":"yes","param":"object|array $bookmark Bookmark row"},{"required":"no","param":"string $context Optional, default is 'display'. How to filter the fields"}],"desc":"Sanitizes all bookmark fields","returns":"object|array Same type as $bookmark but with fields sanitized."},"sanitize_bookmark_field":{"params":[{"required":"yes","param":"string $field The bookmark field"},{"required":"yes","param":"mixed $value The bookmark field value"},{"required":"yes","param":"int $bookmark_id Bookmark ID"},{"required":"yes","param":"string $context How to filter the field value. Either 'raw', 'edit', 'attribute', 'js', 'db', or 'display'"}],"desc":"Sanitizes a bookmark field","returns":"mixed The filtered value"},"clean_bookmark_cache":{"params":[],"desc":"Deletes bookmark cache","returns":""},"register_widget":{"params":[{"required":"yes","param":"string $widget_class The name of a class that extends WP_Widget"}],"desc":"Register a widget","returns":""},"unregister_widget":{"params":[{"required":"yes","param":"string $widget_class The name of a class that extends WP_Widget"}],"desc":"Unregister a widget","returns":""},"register_sidebars":{"params":[{"required":"yes","param":"int $number Number of sidebars to create."},{"required":"yes","param":"string|array $args Builds Sidebar based off of 'name' and 'id' values."}],"desc":"Creates multiple sidebars.","returns":""},"register_sidebar":{"params":[{"required":"yes","param":"string|array $args Builds Sidebar based off of 'name' and 'id' values"}],"desc":"Builds the definition for a single sidebar and returns the ID.","returns":"string The sidebar id that was added."},"unregister_sidebar":{"params":[{"required":"yes","param":"string $name The ID of the sidebar when it was added."}],"desc":"Removes a sidebar from the list.","returns":""},"wp_register_sidebar_widget":{"params":[{"required":"yes","param":"int|string $id Widget ID."},{"required":"yes","param":"string $name Widget display title."},{"required":"yes","param":"callback $output_callback Run when widget is called."},{"required":"no","param":"array|string $options Optional. Widget Options."},{"required":"yes","param":"mixed $params,... Widget parameters to add to widget."}],"desc":"Register widget for use in sidebars.","returns":"null Will return if $output_callback is empty after removing widget."},"wp_widget_description":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Retrieve description for widget.","returns":"string Widget description, if available. Null on failure to retrieve description."},"wp_sidebar_description":{"params":[{"required":"yes","param":"int|string $id sidebar ID."}],"desc":"Retrieve description for a sidebar.","returns":"string Sidebar description, if available. Null on failure to retrieve description."},"wp_unregister_sidebar_widget":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Remove widget from sidebar.","returns":""},"wp_register_widget_control":{"params":[{"required":"yes","param":"int|string $id Sidebar ID."},{"required":"yes","param":"string $name Sidebar display name."},{"required":"yes","param":"callback $control_callback Run when sidebar is displayed."},{"required":"no","param":"array|string $options Optional. Widget options. See above long description."},{"required":"no","param":"mixed $params,... Optional. Additional parameters to add to widget."}],"desc":"Registers widget control callback for customizing options.","returns":""},"_register_widget_update_callback":{"params":[],"desc":"","returns":""},"_register_widget_form_callback":{"params":[],"desc":"","returns":""},"wp_unregister_widget_control":{"params":[{"required":"yes","param":"int|string $id Widget ID."}],"desc":"Remove control callback for widget.","returns":""},"dynamic_sidebar":{"params":[{"required":"no","param":"int|string $index Optional, default is 1. Name or ID of dynamic sidebar."}],"desc":"Display dynamic sidebar.","returns":"bool True, if widget sidebar was found and called. False if not found or not called."},"is_active_widget":{"params":[{"required":"no","param":"string $callback Optional, Widget callback to check."},{"required":"no","param":"int $widget_id Optional, but needed for checking. Widget ID."},{"required":"no","param":"string $id_base Optional, the base ID of a widget created by extending WP_Widget."},{"required":"no","param":"bool $skip_inactive Optional, whether to check in 'wp_inactive_widgets'."}],"desc":"Whether widget is displayed on the front-end.","returns":"mixed false if widget is not active or id of sidebar in which the widget is active."},"is_dynamic_sidebar":{"params":[],"desc":"Whether the dynamic sidebar is enabled and used by theme.","returns":"bool True, if using widgets. False, if not using widgets."},"is_active_sidebar":{"params":[{"required":"yes","param":"mixed $index Sidebar name, id or number to check."}],"desc":"Whether a sidebar is in use.","returns":"bool true if the sidebar is in use, false otherwise."},"wp_get_sidebars_widgets":{"params":[{"required":"yes","param":"bool $deprecated Not used (deprecated)."}],"desc":"Retrieve full list of sidebars and their widgets.","returns":"array Upgraded list of widgets to version 3 array format when called from the admin."},"wp_set_sidebars_widgets":{"params":[{"required":"yes","param":"array $sidebars_widgets Sidebar widgets and their settings."}],"desc":"Set the sidebar widget option to update sidebars.","returns":""},"wp_get_widget_defaults":{"params":[],"desc":"Retrieve default registered sidebars list.","returns":"array "},"wp_convert_widget_settings":{"params":[],"desc":"Convert the widget settings from single to multi-widget format.","returns":"array "},"the_widget":{"params":[{"required":"yes","param":"string $widget the widget's PHP class name (see default-widgets.php)"},{"required":"yes","param":"array $instance the widget's instance settings"},{"required":"yes","param":"array $args the widget's sidebar args"}],"desc":"Output an arbitrary widget as a template tag","returns":"void "},"_get_widget_id_base":{"params":[],"desc":"Private","returns":""},"_wp_sidebars_changed":{"params":[],"desc":"Handle sidebars config after theme change","returns":""},"retrieve_widgets":{"params":[],"desc":"","returns":""},"wp_nav_menu":{"params":[{"required":"yes","param":"array $args Arguments"}],"desc":"Displays a navigation menu.","returns":""},"_wp_menu_item_classes_by_context":{"params":[{"required":"yes","param":"array $menu_items The current menu item objects to which to add the class property information."}],"desc":"Add the class property classes for the current context, if applicable.","returns":""},"walk_nav_menu_tree":{"params":[],"desc":"Retrieve the HTML list content for nav menu items.","returns":""},"_nav_menu_item_id_use_once":{"params":[],"desc":"Prevents a menu item ID from being used more than once.","returns":""},"wp_default_scripts":{"params":[{"required":"yes","param":"object $scripts WP_Scripts object."}],"desc":"Register all WordPress scripts.","returns":""},"wp_default_styles":{"params":[{"required":"yes","param":"object $styles "}],"desc":"Assign default styles to $styles object.","returns":""},"wp_prototype_before_jquery":{"params":[{"required":"yes","param":"array $js_array JavaScript scripts array"}],"desc":"Reorder JavaScript scripts array to place prototype before jQuery.","returns":"array Reordered array, if needed."},"wp_just_in_time_script_localization":{"params":[],"desc":"Load localized data on print rather than initialization.","returns":""},"wp_style_loader_src":{"params":[{"required":"yes","param":"string $src Source URL."},{"required":"yes","param":"string $handle Either 'colors' or 'colors-rtl'."}],"desc":"Administration Screen CSS for changing the styles.","returns":"string URL path to CSS stylesheet for Administration Screens."},"print_head_scripts":{"params":[],"desc":"Prints the script queue in the HTML head on admin pages.","returns":""},"print_footer_scripts":{"params":[],"desc":"Prints the scripts that were queued for the footer or too late for the HTML head.","returns":""},"_print_scripts":{"params":[],"desc":"","returns":""},"wp_print_head_scripts":{"params":[],"desc":"Prints the script queue in the HTML head on the front end.","returns":""},"_wp_footer_scripts":{"params":[],"desc":"Private, for use in *_footer_scripts hooks","returns":""},"wp_print_footer_scripts":{"params":[],"desc":"Hooks to print the scripts and styles in the footer.","returns":""},"wp_enqueue_scripts":{"params":[],"desc":"Wrapper for do_action('wp_enqueue_scripts')","returns":""},"print_admin_styles":{"params":[],"desc":"Prints the styles queue in the HTML head on admin pages.","returns":""},"print_late_styles":{"params":[],"desc":"Prints the styles that were queued too late for the HTML head.","returns":""},"_print_styles":{"params":[],"desc":"","returns":""},"script_concat_settings":{"params":[],"desc":"Determine the concatenation and compression settings for scripts and styles.","returns":""},"getRequestParam":{"params":[{"required":"yes","param":"String $name Name of parameter to get."},{"required":"yes","param":"String $default_value Default value to return if value not found."}],"desc":"Returns an request value by name without magic quoting.","returns":"String request value by name without magic quoting or default value."},"getLogger":{"params":[],"desc":"","returns":""},"debug":{"params":[],"desc":"","returns":""},"info":{"params":[],"desc":"","returns":""},"error":{"params":[],"desc":"","returns":""},"warn":{"params":[],"desc":"","returns":""},"fatal":{"params":[],"desc":"","returns":""},"mce_escape":{"params":[],"desc":"","returns":""},"wp_signon":{"params":[{"required":"no","param":"array $credentials Optional. User info in order to sign on."},{"required":"no","param":"bool $secure_cookie Optional. Whether to use secure cookie."}],"desc":"Authenticate user with remember capability.","returns":"object Either WP_Error on failure, or WP_User on success."},"wp_authenticate_username_password":{"params":[],"desc":"","returns":""},"wp_authenticate_cookie":{"params":[],"desc":"Authenticate the user using the WordPress auth cookie.","returns":""},"count_user_posts":{"params":[{"required":"yes","param":"int $userid User ID."}],"desc":"Number of posts user has written.","returns":"int Amount of posts user has written."},"count_many_users_posts":{"params":[{"required":"yes","param":"array $user_ids Array of user IDs."},{"required":"no","param":"string|array $post_type Optional. Post type to check. Defaults to post."}],"desc":"Number of posts written by a list of users.","returns":"array Amount of posts each user has written."},"user_pass_ok":{"params":[{"required":"yes","param":"string $user_login User name."},{"required":"yes","param":"string $user_pass User password."}],"desc":"Check that the user login name and password is correct.","returns":"bool False if does not authenticate, true if username and password authenticates."},"get_current_user_id":{"params":[],"desc":"Get the current user's ID","returns":"int The current user's ID"},"get_user_option":{"params":[{"required":"yes","param":"string $option User option name."},{"required":"no","param":"int $user Optional. User ID."},{"required":"yes","param":"bool $deprecated Use get_option() to check for an option in the options table."}],"desc":"Retrieve user option that can be either per Site or per Network.","returns":"mixed "},"update_user_option":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"string $option_name User option name."},{"required":"yes","param":"mixed $newvalue User option value."},{"required":"no","param":"bool $global Optional. Whether option name is global or blog specific. Default false (blog specific)."}],"desc":"Update user option with global blog capability.","returns":"unknown "},"delete_user_option":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"string $option_name User option name."},{"required":"no","param":"bool $global Optional. Whether option name is global or blog specific. Default false (blog specific)."}],"desc":"Delete user option with global blog capability.","returns":"unknown "},"get_users":{"params":[{"required":"no","param":"array $args Optional."}],"desc":"Retrieve list of users matching criteria.","returns":"array List of users."},"get_blogs_of_user":{"params":[{"required":"yes","param":"int $user_id User ID"},{"required":"yes","param":"bool $all Whether to retrieve all blogs, or only blogs that are not marked as deleted, archived, or spam."}],"desc":"Get the blogs a user belongs to.","returns":"array A list of the user's blogs. False if the user was not found or an empty array if the user has no blogs."},"is_user_member_of_blog":{"params":[{"required":"yes","param":"int $user_id The unique ID of the user"},{"required":"no","param":"int $blog Optional. If no blog_id is provided, current site is used"}],"desc":"Find out whether a user is a member of a given blog.","returns":"bool "},"add_user_meta":{"params":[{"required":"yes","param":"int $user_id Post ID."},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"bool $unique Optional, default is false. Whether the same key should not be added."}],"desc":"Add meta data field to a user.","returns":"bool False for failure. True for success."},"delete_user_meta":{"params":[{"required":"yes","param":"int $user_id user ID"},{"required":"yes","param":"string $meta_key Metadata name."},{"required":"no","param":"mixed $meta_value Optional. Metadata value."}],"desc":"Remove metadata matching criteria from a user.","returns":"bool False for failure. True for success."},"get_user_meta":{"params":[{"required":"yes","param":"int $user_id Post ID."},{"required":"yes","param":"string $key The meta key to retrieve."},{"required":"yes","param":"bool $single Whether to return a single value."}],"desc":"Retrieve user meta field for a user.","returns":"mixed Will be an array if $single is false. Will be value of meta data field if $single is true."},"update_user_meta":{"params":[{"required":"yes","param":"int $user_id Post ID."},{"required":"yes","param":"string $meta_key Metadata key."},{"required":"yes","param":"mixed $meta_value Metadata value."},{"required":"no","param":"mixed $prev_value Optional. Previous value to check before removing."}],"desc":"Update user meta field based on user ID.","returns":"bool False on failure, true if success."},"count_users":{"params":[{"required":"yes","param":"string $strategy 'time' or 'memory'"}],"desc":"Count number of users who have each of the user roles.","returns":"array Includes a grand total and an array of counts indexed by role strings."},"setup_userdata":{"params":[{"required":"no","param":"int $for_user_id Optional. User ID to set up global data."}],"desc":"Set up global user vars.","returns":""},"wp_dropdown_users":{"params":[{"required":"no","param":"string|array $args Optional. Override defaults."}],"desc":"Create dropdown HTML content of users.","returns":"string|null Null on display. String of HTML content on retrieve."},"sanitize_user_field":{"params":[{"required":"yes","param":"string $field The user Object field name."},{"required":"yes","param":"mixed $value The user Object value."},{"required":"yes","param":"int $user_id user ID."},{"required":"yes","param":"string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display', 'attribute' and 'js'."}],"desc":"Sanitize user field based on context.","returns":"mixed Sanitized value."},"update_user_caches":{"params":[{"required":"yes","param":"object $user User object to be cached"}],"desc":"Update all user caches","returns":""},"clean_user_cache":{"params":[{"required":"yes","param":"int $id User ID"}],"desc":"Clean all user caches","returns":""},"username_exists":{"params":[{"required":"yes","param":"string $username Username."}],"desc":"Checks whether the given username exists.","returns":"null|int The user's ID on success, and null on failure."},"email_exists":{"params":[{"required":"yes","param":"string $email Email."}],"desc":"Checks whether the given email exists.","returns":"bool|int The user's ID on success, and false on failure."},"validate_username":{"params":[{"required":"yes","param":"string $username Username."}],"desc":"Checks whether an username is valid.","returns":"bool Whether username given is valid"},"wp_insert_user":{"params":[{"required":"yes","param":"array $userdata An array of user data."}],"desc":"Insert an user into the database.","returns":"int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created."},"wp_update_user":{"params":[{"required":"yes","param":"array $userdata An array of user data."}],"desc":"Update an user in the database.","returns":"int The updated user's ID."},"wp_create_user":{"params":[{"required":"yes","param":"string $username The user's username."},{"required":"yes","param":"string $password The user's password."},{"required":"no","param":"string $email The user's email (optional)."}],"desc":"A simpler way of inserting an user into the database.","returns":"int The new user's ID."},"_get_additional_user_keys":{"params":[{"required":"yes","param":"object $user WP_User instance"}],"desc":"Return a list of meta keys that wp_insert_user() is supposed to set.","returns":"array "},"_wp_get_user_contactmethods":{"params":[{"required":"no","param":"object $user User data object (optional)"}],"desc":"Set up the default contact methods","returns":"array $user_contactmethods Array of contact methods and their labels."},"get_category_link":{"params":[{"required":"yes","param":"int|object $category Category ID or object."}],"desc":"Retrieve category link URL.","returns":"string Link on success, empty string if category does not exist."},"get_category_parents":{"params":[{"required":"yes","param":"int $id Category ID."},{"required":"no","param":"bool $link Optional, default is false. Whether to format with link."},{"required":"no","param":"string $separator Optional, default is '/'. How to separate categories."},{"required":"no","param":"bool $nicename Optional, default is false. Whether to use nice name for display."},{"required":"no","param":"array $visited Optional. Already linked to categories to prevent duplicates."}],"desc":"Retrieve category parents with separator.","returns":"string "},"get_the_category":{"params":[{"required":"no","param":"int $id Optional, default to current post ID. The post ID."}],"desc":"Retrieve post categories.","returns":"array "},"_usort_terms_by_name":{"params":[{"required":"yes","param":"object $a "},{"required":"yes","param":"object $b "}],"desc":"Sort categories by name.","returns":"int "},"_usort_terms_by_ID":{"params":[{"required":"yes","param":"object $a "},{"required":"yes","param":"object $b "}],"desc":"Sort categories by ID.","returns":"int "},"get_the_category_by_ID":{"params":[{"required":"yes","param":"int $cat_ID Category ID."}],"desc":"Retrieve category name based on category ID.","returns":"string Category name."},"get_the_category_list":{"params":[{"required":"no","param":"string $separator Optional, default is empty string. Separator for between the categories."},{"required":"no","param":"string $parents Optional. How to display the parents."},{"required":"no","param":"int $post_id Optional. Post ID to retrieve categories."}],"desc":"Retrieve category list in either HTML list or custom format.","returns":"string "},"in_category":{"params":[{"required":"yes","param":"int|string|array $category Category ID, name or slug, or array of said."},{"required":"no","param":"int|object $_post Optional. Post to check instead of the current post. (since 2.7.0)"}],"desc":"Check if the current post in within any of the given categories.","returns":"bool True if the current post is in any of the given categories."},"the_category":{"params":[{"required":"no","param":"string $separator Optional, default is empty string. Separator for between the categories."},{"required":"no","param":"string $parents Optional. How to display the parents."},{"required":"no","param":"int $post_id Optional. Post ID to retrieve categories."}],"desc":"Display the category list for the post.","returns":""},"category_description":{"params":[{"required":"no","param":"int $category Optional. Category ID. Will use global category ID by default."}],"desc":"Retrieve category description.","returns":"string Category description, available."},"wp_dropdown_categories":{"params":[{"required":"no","param":"string|array $args Optional. Override default arguments."}],"desc":"Display or retrieve the HTML dropdown list of categories.","returns":"string HTML content only if 'echo' argument is 0."},"wp_list_categories":{"params":[{"required":"no","param":"string|array $args Optional. Override default arguments."}],"desc":"Display or retrieve the HTML list of categories.","returns":"string HTML content only if 'echo' argument is 0."},"wp_tag_cloud":{"params":[{"required":"no","param":"array|string $args Optional. Override default arguments."}],"desc":"Display tag cloud.","returns":"array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument."},"default_topic_count_text":{"params":[{"required":"yes","param":"integer $count number of posts with that tag"}],"desc":"Default text for tooltip for tag links","returns":"string text for the tooltip of a tag link."},"default_topic_count_scale":{"params":[{"required":"yes","param":"integer $count number of posts with that tag"}],"desc":"Default topic count scaling for tag links","returns":"integer scaled count"},"wp_generate_tag_cloud":{"params":[{"required":"yes","param":"array $tags List of tags."},{"required":"no","param":"string|array $args Optional, override default arguments."}],"desc":"Generates a tag cloud (heatmap) from provided data.","returns":"string "},"_wp_object_name_sort_cb":{"params":[],"desc":"Callback for comparing objects based on name","returns":""},"_wp_object_count_sort_cb":{"params":[],"desc":"Callback for comparing objects based on count","returns":""},"walk_category_tree":{"params":[],"desc":"Retrieve HTML list content for category list.","returns":""},"walk_category_dropdown_tree":{"params":[],"desc":"Retrieve HTML dropdown (select) content for category list.","returns":""},"get_tag_link":{"params":[{"required":"yes","param":"int|object $tag Tag ID or object."}],"desc":"Retrieve the link to the tag.","returns":"string Link on success, empty string if tag does not exist."},"get_the_tags":{"params":[{"required":"yes","param":"int $id Post ID."}],"desc":"Retrieve the tags for a post.","returns":"array "},"get_the_tag_list":{"params":[{"required":"no","param":"string $before Optional. Before tags."},{"required":"no","param":"string $sep Optional. Between tags."},{"required":"no","param":"string $after Optional. After tags."}],"desc":"Retrieve the tags for a post formatted as a string.","returns":"string "},"the_tags":{"params":[{"required":"no","param":"string $before Optional. Before list."},{"required":"no","param":"string $sep Optional. Separate items using this."},{"required":"no","param":"string $after Optional. After list."}],"desc":"Retrieve the tags for a post.","returns":"string "},"tag_description":{"params":[{"required":"no","param":"int $tag Optional. Tag ID. Will use global tag ID by default."}],"desc":"Retrieve tag description.","returns":"string Tag description, available."},"term_description":{"params":[{"required":"no","param":"int $term Optional. Term ID. Will use global term ID by default."}],"desc":"Retrieve term description.","returns":"string Term description, available."},"get_the_terms":{"params":[{"required":"no","param":"int $id Post ID. Is not optional."},{"required":"yes","param":"string $taxonomy Taxonomy name."}],"desc":"Retrieve the terms of the taxonomy that are attached to the post.","returns":"array|bool False on failure. Array of term objects on success."},"get_the_term_list":{"params":[{"required":"yes","param":"int $id Post ID."},{"required":"yes","param":"string $taxonomy Taxonomy name."},{"required":"no","param":"string $before Optional. Before list."},{"required":"no","param":"string $sep Optional. Separate items using this."},{"required":"no","param":"string $after Optional. After list."}],"desc":"Retrieve a post's terms as a list with specified format.","returns":"string "},"the_terms":{"params":[{"required":"yes","param":"int $id Post ID."},{"required":"yes","param":"string $taxonomy Taxonomy name."},{"required":"no","param":"string $before Optional. Before list."},{"required":"no","param":"string $sep Optional. Separate items using this."},{"required":"no","param":"string $after Optional. After list."}],"desc":"Display the terms in a list.","returns":"null|bool False on WordPress error. Returns null when displaying."},"has_category":{"params":[{"required":"no","param":"string|int|array $tag Optional. The category name/term_id/slug or array of them to check for."},{"required":"no","param":"int|object $post Optional. Post to check instead of the current post."}],"desc":"Check if the current post has any of given category.","returns":"bool True if the current post has any of the given categories (or any category, if no category specified)."},"has_tag":{"params":[{"required":"no","param":"string|int|array $tag Optional. The tag name/term_id/slug or array of them to check for."},{"required":"no","param":"int|object $post Optional. Post to check instead of the current post. (since 2.7.0)"}],"desc":"Check if the current post has any of given tags.","returns":"bool True if the current post has any of the given tags (or any tag, if no tag specified)."},"has_term":{"params":[{"required":"no","param":"string|int|array $term Optional. The term name/term_id/slug or array of them to check for."},{"required":"yes","param":"string $taxonomy Taxonomy name"},{"required":"no","param":"int|object $post Optional. Post to check instead of the current post."}],"desc":"Check if the current post has any of given terms.","returns":"bool True if the current post has any of the given tags (or any tag, if no tag specified)."}}' );
\ No newline at end of file