Last active
July 5, 2019 09:27
-
-
Save abdul-alhasany/16ef7f3399db29eed28c3db3d41775bb to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| [{"name":"_wp_admin_bar_init","desc":"<p>UNHOOKING THIS FUNCTION WILL NOT PROPERLY REMOVE THE ADMIN BAR. For that, use show_admin_bar(false) or the {@see 'show_admin_bar'} filter.</p>","summary":"Instantiate the admin bar object and set it up as a global for access elsewhere.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","return":{"content":"Whether the admin bar was successfully initialized.","types":"bool"}},{"name":"wp_admin_bar_render","desc":"<p>This is called very late on the footer actions so that it will render after anything else being added to the footer.</p> <p>It includes the {@see 'admin_bar_menu'} action which should be used to hook in and add new menus to the admin bar. That way you can be sure that you are adding at most optimal point, right before the admin bar is rendered. This also gives you access to the <code>$post</code> global, among others.</p>","summary":"Renders the admin bar to the page based on the $wp_admin_bar->menu member var.","type":"function","category":"Uncategorised","since":"3.1.0"},{"name":"wp_admin_bar_wp_menu","desc":"","summary":"Add the WordPress logo menu.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_sidebar_toggle","desc":"","summary":"Add the sidebar toggle button.","type":"function","category":"Uncategorised","since":"3.8.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_my_account_item","desc":"","summary":"Add the \"My Account\" item.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_my_account_menu","desc":"","summary":"Add the \"My Account\" submenu items.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_site_menu","desc":"","summary":"Add the \"Site Name\" menu.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_customize_menu","desc":"","summary":"Adds the \"Customize\" link to the Toolbar.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":"WP_Admin_Bar instance.","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_my_sites_menu","desc":"","summary":"Add the \"My Sites/[Site Name]\" menu and all submenus.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_shortlink_menu","desc":"","summary":"Provide a shortlink.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_edit_menu","desc":"","summary":"Provide an edit link for posts and terms.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_new_content_menu","desc":"","summary":"Add \"Add New\" menu.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_comments_menu","desc":"","summary":"Add edit comments link with awaiting moderation count bubble.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_appearance_menu","desc":"","summary":"Add appearance submenu items to the \"Site Name\" menu.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_updates_menu","desc":"","summary":"Provide an update link if theme/plugin/core updates are available.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_search_menu","desc":"","summary":"Add search form.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_recovery_mode_menu","desc":"","summary":"Add a link to exit recovery mode when Recovery Mode is active.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_add_secondary_groups","desc":"","summary":"Add secondary menus.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"wp_admin_bar_header","desc":"","summary":"Style and scripts for the admin bar.","type":"function","category":"Uncategorised","since":"3.1.0"},{"name":"_admin_bar_bump_cb","desc":"","summary":"Default admin bar callback.","type":"function","category":"Uncategorised","since":"3.1.0"},{"name":"show_admin_bar","desc":"<p>This can be called immediately upon plugin load. It does not need to be called from a function hooked to the {@see 'init'} action.</p>","summary":"Sets the display status of the admin bar.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"Whether to allow the admin bar to show.","types":"bool","variable":"$show","default":"null","required":"yes"}]},{"name":"is_admin_bar_showing","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the admin bar should be showing.","type":"function","category":"Other functions","since":"3.1.0","return":{"content":"Whether the admin bar should be showing.","types":"bool"}},{"name":"_get_admin_bar_pref","desc":"","summary":"Retrieve the admin bar display preference of a user.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"Context of this preference check. Defaults to 'front'. The 'admin' preference is no longer used.","types":"string","variable":"$context","default":"'front'","required":"no"},{"content":" ID of the user to check, defaults to 0 for current user.","types":"int","variable":"$user","default":"0","required":"no"}],"return":{"content":"Whether the admin bar should be showing for this user.","types":"bool"}},{"name":"get_the_author","desc":"","summary":"Retrieve the author of the current post.","type":"function","category":"Others","since":"1.5.0","param":[{"content":"Deprecated.","types":"string","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"The author's display name.","types":"string|null"}},{"name":"the_author","desc":"<p>The behavior of this function is based off of old functionality predating get_the_author(). This function is not deprecated, but is designed to echo the value from get_the_author() and as an result of any old theme that might still use the old behavior will also pass the value from get_the_author().</p> <p>The normal, expected behavior of this function is to echo the author and not return it. However, backward compatibility has to be maintained.</p>","summary":"Display the name of the author of the current post.","type":"function","category":"Others","since":"0.71","param":[{"content":"Deprecated.","types":"string","variable":"$deprecated","default":"''","required":"no"},{"content":"Deprecated. Use get_the_author(). Echo the string or return it.","types":"bool","variable":"$deprecated_echo","default":"true","required":"no"}],"return":{"content":"The author's display name, from get_the_author().","types":"string|null"}},{"name":"get_the_modified_author","desc":"","summary":"Retrieve the author who last edited the current post.","type":"function","category":"Users and Authors","since":"2.8.0","return":{"content":"The author's display name.","types":"string|void"}},{"name":"the_modified_author","desc":"","summary":"Display the name of the author who last edited the current post, if the author's ID is available.","type":"function","category":"Uncategorised","since":"2.8.0"},{"name":"get_the_author_meta","desc":"<p>Valid values for the <code>$field</code> parameter include:</p> <ul> <li>admin_color</li> <li>aim</li> <li>comment_shortcuts</li> <li>description</li> <li>display_name</li> <li>first_name</li> <li>ID</li> <li>jabber</li> <li>last_name</li> <li>nickname</li> <li>plugins_last_view</li> <li>plugins_per_page</li> <li>rich_editing</li> <li>syntax_highlighting</li> <li>user_activation_key</li> <li>user_description</li> <li>user_email</li> <li>user_firstname</li> <li>user_lastname</li> <li>user_level</li> <li>user_login</li> <li>user_nicename</li> <li>user_pass</li> <li>user_registered</li> <li>user_status</li> <li>user_url</li> <li>yim</li> </ul>","summary":"Retrieves the requested data of the author of the current post.","type":"function","category":"User meta","since":"2.8.0","param":[{"content":" The user field to retrieve. Default empty.","types":"string","variable":"$field","default":"''","required":"no"},{"content":" User ID.","types":"int|false","variable":"$user_id","default":"false","required":"no"}],"return":{"content":"The author's field from the current author's DB object, otherwise an empty string.","types":"string"}},{"name":"the_author_meta","desc":"","summary":"Outputs the field from the user's DB object. Defaults to current post's author.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Selects the field of the users record. See get_the_author_meta() for the list of possible fields.","types":"string","variable":"$field","default":"''","required":"no"},{"content":" User ID.","types":"int|false","variable":"$user_id","default":"false","required":"no"}]},{"name":"get_the_author_link","desc":"<p>If the author has a home page set, return an HTML link, otherwise just return the author's name.</p>","summary":"Retrieve either author's link or author's name.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"An HTML link if the author's url exist in user meta, else the result of get_the_author().","types":"string|null"}},{"name":"the_author_link","desc":"<p>If the author has a home page set, echo an HTML link, otherwise just echo the author's name.</p>","summary":"Display either author's link or author's name.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"get_the_author_posts","desc":"","summary":"Retrieve the number of posts by the author of the current post.","type":"function","category":"Others","since":"1.5.0","return":{"content":"The number of posts by the author.","types":"int"}},{"name":"the_author_posts","desc":"","summary":"Display the number of posts by the author of the current post.","type":"function","category":"Uncategorised","since":"0.71"},{"name":"get_the_author_posts_link","desc":"<p>Returns an HTML-formatted link using get_author_posts_url().</p>","summary":"Retrieves an HTML link to the author page of the current post's author.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"An HTML link to the author page, or an empty string if $authordata isn't defined.","types":"string"}},{"name":"the_author_posts_link","desc":"","summary":"Displays an HTML link to the author page of the current post's author.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Unused.","types":"string","variable":"$deprecated","default":"''","required":"no"}]},{"name":"get_author_posts_url","desc":"","summary":"Retrieve the URL to the author page for the user with the ID provided.","type":"function","category":"Users and Authors","since":"2.1.0","param":[{"content":"Author ID.","types":"int","variable":"$author_id","default":"null","required":"yes"},{"content":" The author's nicename (slug). Default empty.","types":"string","variable":"$author_nicename","default":"''","required":"no"}],"return":{"content":"The URL to the author's page.","types":"string"}},{"name":"wp_list_authors","desc":"","summary":"List all the authors of the site, with several options available.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"{ Optional. Array or string of default arguments. @type string $orderby How to sort the authors. Accepts 'nicename', 'email', 'url', 'registered', 'user_nicename', 'user_email', 'user_url', 'user_registered', 'name', 'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'. @type string $order Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'. @type int $number Maximum authors to return or display. Default empty (all authors). @type bool $optioncount Show the count in parenthesis next to the author's name. Default false. @type bool $exclude_admin Whether to exclude the 'admin' account, if it exists. Default true. @type bool $show_fullname Whether to show the author's full name. Default false. @type bool $hide_empty Whether to hide any authors with no posts. Default true. @type string $feed If not empty, show a link to the author's feed and use this text as the alt parameter of the link. Default empty. @type string $feed_image If not empty, show a link to the author's feed and use this image URL as clickable anchor. Default empty. @type string $feed_type The feed type to link to, such as 'rss2'. Defaults to default feed type. @type bool $echo Whether to output the result or instead return it. Default true. @type string $style If 'list', each author is wrapped in an <code><li></code> element, otherwise the authors will be separated by commas. @type bool $html Whether to list the items in HTML form or plaintext. Default true. @type array|string $exclude Array or comma/space-separated list of author IDs to exclude. Default empty. @type array|string $include Array or comma/space-separated list of author IDs to include. Default empty. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"The output, if echo is set to false.","types":"string|void"}},{"name":"is_multi_author","desc":"<p>Checks to see if more than one author has published posts.</p> <p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether this site has more than one author.","type":"function","category":"Users and Authors","since":"3.2.0","return":{"content":"Whether or not we have more than one author","types":"bool"}},{"name":"__clear_multi_author_cache","desc":"","summary":"Helper function to clear the cache for number of authors.","type":"function","category":"Uncategorised","since":"3.2.0","access":"private"},{"name":"render_block_core_archives","desc":"","summary":"Renders the `core/archives` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Returns the post content with archives added.","types":"string"}},{"name":"register_block_core_archives","desc":"","summary":"Register archives block.","type":"function","category":"Uncategorised"},{"name":"render_block_core_block","desc":"","summary":"Renders the `core/block` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Rendered HTML of the referenced block.","types":"string"}},{"name":"render_block_core_calendar","desc":"","summary":"Renders the `core/calendar` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Returns the block content.","types":"string"}},{"name":"register_block_core_calendar","desc":"","summary":"Registers the `core/calendar` block on server.","type":"function","category":"Uncategorised"},{"name":"render_block_core_categories","desc":"","summary":"Renders the `core/categories` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Returns the categories list/dropdown markup.","types":"string"}},{"name":"build_dropdown_script_block_core_categories","desc":"","summary":"Generates the inline script for a categories dropdown field.","type":"function","category":"Uncategorised","param":[{"content":"ID of the dropdown field.","types":"string","variable":"$dropdown_id","default":"null","required":"yes"}],"return":{"content":"Returns the dropdown onChange redirection script.","types":"string"}},{"name":"register_block_core_categories","desc":"","summary":"Registers the `core/categories` block on server.","type":"function","category":"Uncategorised"},{"name":"wp_latest_comments_draft_or_post_title","desc":"<p>The post title is fetched and if it is blank then a default string is returned.</p> <p>Copied from <code>wp-admin/includes/template.php</code>, but we can't include that file because:</p> <ol> <li>It causes bugs with test fixture generation and strange Docker 255 error codes.</li> <li>It's in the admin; ideally we <em>shouldn't</em> be including files from the admin for a block's output. It's a very small/simple function as well, so duplicating it isn't too terrible.</li> </ol>","summary":"Get the post title.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":" Post ID or WP_Post object. Default is global $post.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"}],"return":{"content":"The post title if set; "(no title)" if no title is set.","types":"string"}},{"name":"render_block_core_latest_comments","desc":"","summary":"Renders the `core/latest-comments` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"array()","required":"no"}],"return":{"content":"Returns the post content with latest comments added.","types":"string"}},{"name":"render_block_core_latest_posts","desc":"","summary":"Renders the `core/latest-posts` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Returns the post content with latest posts added.","types":"string"}},{"name":"register_block_core_latest_posts","desc":"","summary":"Registers the `core/latest-posts` block on server.","type":"function","category":"Uncategorised"},{"name":"render_block_core_rss","desc":"","summary":"Renders the `core/rss` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Returns the block content with received rss items.","types":"string"}},{"name":"register_block_core_rss","desc":"","summary":"Registers the `core/rss` block on server.","type":"function","category":"Uncategorised"},{"name":"render_block_core_search","desc":"","summary":"Dynamically renders the `core/search` block.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"The search block markup.","types":"string"}},{"name":"register_block_core_search","desc":"","summary":"Registers the `core/search` block on the server.","type":"function","category":"Uncategorised"},{"name":"render_block_core_shortcode","desc":"","summary":"Performs wpautop() on the shortcode block content.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"},{"content":"The block content.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"Returns the block content.","types":"string"}},{"name":"register_block_core_shortcode","desc":"","summary":"Registers the `core/shortcode` block on server.","type":"function","category":"Uncategorised"},{"name":"render_block_core_tag_cloud","desc":"","summary":"Renders the `core/tag-cloud` block on server.","type":"function","category":"Uncategorised","param":[{"content":"The block attributes.","types":"array","variable":"$attributes","default":"null","required":"yes"}],"return":{"content":"Returns the tag cloud for selected taxonomy.","types":"string"}},{"name":"register_block_core_tag_cloud","desc":"","summary":"Registers the `core/tag-cloud` block on server.","type":"function","category":"Uncategorised"},{"name":"register_block_type","desc":"","summary":"Registers a block type.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"Block type name including namespace, or alternatively a complete WP_Block_Type instance. In case a WP_Block_Type is provided, the $args parameter will be ignored.","types":"string|WP_Block_Type","variable":"$name","default":"null","required":"yes"},{"content":"{ Optional. Array of block type arguments. Any arguments may be defined, however the ones described below are supported by default. Default empty array. @type callable $render_callback Callback used to render blocks of this block type. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The registered block type on success, or false on failure.","types":"WP_Block_Type|false"}},{"name":"unregister_block_type","desc":"","summary":"Unregisters a block type.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"Block type name including namespace, or alternatively a complete WP_Block_Type instance.","types":"string|WP_Block_Type","variable":"$name","default":"null","required":"yes"}],"return":{"content":"The unregistered block type on success, or false on failure.","types":"WP_Block_Type|false"}},{"name":"has_blocks","desc":"<p>This test optimizes for performance rather than strict accuracy, detecting the pattern of a block but not validating its structure. For strict accuracy, you should use the block parser on post content.</p>","summary":"Determine whether a post or content string has blocks.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":" Post content, post ID, or post object. Defaults to global $post.","types":"int|string|WP_Post|null","variable":"$post","default":"null","required":"no"}],"return":{"content":"Whether the post has blocks.","types":"bool"}},{"name":"has_block","desc":"<p>This test optimizes for performance rather than strict accuracy, detecting the block type exists but not validating its structure. For strict accuracy, you should use the block parser on post content.</p>","summary":"Determine whether a $post or a string contains a specific block type.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"Full Block type to look for.","types":"string","variable":"$block_type","default":"null","required":"yes"},{"content":" Post content, post ID, or post object. Defaults to global $post.","types":"int|string|WP_Post|null","variable":"$post","default":"null","required":"no"}],"return":{"content":"Whether the post content contains the specified block.","types":"bool"}},{"name":"get_dynamic_block_names","desc":"","summary":"Returns an array of the names of all registered dynamic block types.","type":"function","category":"Uncategorised","since":"5.0.0","return":{"content":"Array of dynamic block names.","types":"array"}},{"name":"excerpt_remove_blocks","desc":"<p>As the excerpt should be a small string of text relevant to the full post content, this function renders the blocks that are most likely to contain such text.</p>","summary":"Parses blocks out of a content string, and renders those appropriate for the excerpt.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"The content to parse.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The parsed and filtered content.","types":"string"}},{"name":"_excerpt_render_inner_columns_blocks","desc":"","summary":"Render inner blocks from the `core/columns` block for generating an excerpt.","type":"function","category":"Uncategorised","since":"5.2.0","access":"private","param":[{"content":"The parsed columns block.","types":"array","variable":"$columns","default":"null","required":"yes"},{"content":"The list of allowed inner blocks.","types":"array","variable":"$allowed_blocks","default":"null","required":"yes"}],"return":{"content":"The rendered inner blocks.","types":"string"}},{"name":"render_block","desc":"","summary":"Renders a single block into a HTML string.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"A single parsed block object.","types":"array","variable":"$block","default":"null","required":"yes"}],"return":{"content":"String of rendered HTML.","types":"string"}},{"name":"parse_blocks","desc":"","summary":"Parses blocks out of a content string.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"Post content.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"Array of parsed block objects.","types":"array"}},{"name":"do_blocks","desc":"","summary":"Parses dynamic blocks out of `post_content` and re-renders them.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"Post content.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"Updated post content.","types":"string"}},{"name":"_restore_wpautop_hook","desc":"","summary":"If do_blocks() needs to remove wpautop() from the `the_content` filter, this re-adds it afterwards, for subsequent `the_content` usage.","type":"function","category":"Uncategorised","access":"private","since":"5.0.0","param":[{"content":"The post content running through this filter.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The unmodified content.","types":"string"}},{"name":"block_version","desc":"<p>If the string doesn't contain blocks, it returns 0.</p>","summary":"Returns the current version of the block format that the content string is using.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"Content to test.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The block format version is 1 if the content contains one or more blocks, 0 otherwise.","types":"int"}},{"name":"_walk_bookmarks","desc":"<p>The $bookmarks array must contain bookmark objects and will be iterated over to retrieve the bookmark to be used in the output.</p> <p>The output is formatted as HTML with no way to change that format. However, what is between, before, and after can be changed. The link itself will be HTML.</p> <p>This function is used internally by wp_list_bookmarks() and should not be used by themes.</p>","summary":"The formatted output of a list of bookmarks.","type":"function","category":"Uncategorised","since":"2.1.0","access":"private","param":[{"content":"List of bookmarks to traverse.","types":"array","variable":"$bookmarks","default":"null","required":"yes"},{"content":"{ Optional. Bookmarks arguments. @type int|bool $show_updated Whether to show the time the bookmark was last updated. Accepts 1|true or 0|false. Default 0|false. @type int|bool $show_description Whether to show the bookmark description. Accepts 1|true, Accepts 1|true or 0|false. Default 0|false. @type int|bool $show_images Whether to show the link image if available. Accepts 1|true or 0|false. Default 1|true. @type int|bool $show_name Whether to show link name if available. Accepts 1|true or 0|false. Default 0|false. @type string $before The HTML or text to prepend to each bookmark. Default <code><li></code>. @type string $after The HTML or text to append to each bookmark. Default <code></li></code>. @type string $link_before The HTML or text to prepend to each bookmark inside the anchor tags. Default empty. @type string $link_after The HTML or text to append to each bookmark inside the anchor tags. Default empty. @type string $between The string for use in between the link, description, and image. Default "\\n". @type int|bool $show_rating Whether to show the link rating. Accepts 1|true or 0|false. Default 0|false. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"Formatted output in HTML","types":"string"}},{"name":"wp_list_bookmarks","desc":"<p>List of default arguments are as follows:</p> <p>These options define how the Category name will appear before the category links are displayed, if 'categorize' is 1. If 'categorize' is 0, then it will display for only the 'title_li' string and only if 'title_li' is not empty.</p>","summary":"Retrieve or echo all of the bookmarks.","type":"function","category":"Bookmarks","since":"2.1.0","param":[{"content":"{ Optional. String or array of arguments to list bookmarks. @type string $orderby How to order the links by. Accepts post fields. Default 'name'. @type string $order Whether to order bookmarks in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. @type int $limit Amount of bookmarks to display. Accepts 1+ or -1 for all. Default -1. @type string $category Comma-separated list of category ids to include links from. Default empty. @type string $category_name Category to retrieve links for by name. Default empty. @type int|bool $hide_invisible Whether to show or hide links marked as 'invisible'. Accepts 1|true or 0|false. Default 1|true. @type int|bool $show_updated Whether to display the time the bookmark was last updated. Accepts 1|true or 0|false. Default 0|false. @type int|bool $echo Whether to echo or return the formatted bookmarks. Accepts 1|true (echo) or 0|false (return). Default 1|true. @type int|bool $categorize Whether to show links listed by category or in a single column. Accepts 1|true (by category) or 0|false (one column). Default 1|true. @type int|bool $show_description Whether to show the bookmark descriptions. Accepts 1|true or 0|false. Default 0|false. @type string $title_li What to show before the links appear. Default 'Bookmarks'. @type string $title_before The HTML or text to prepend to the $title_li string. Default '<h2>'. @type string $title_after The HTML or text to append to the $title_li string. Default '</h2>'. @type string $class The CSS class to use for the $title_li. Default 'linkcat'. @type string $category_before The HTML or text to prepend to $title_before if $categorize is true. String must contain '%id' and '%class' to inherit the category ID and the $class argument used for formatting in themes. Default '<li id=\"%id\" class=\"%class\">'. @type string $category_after The HTML or text to append to $title_after if $categorize is true. Default '</li>'. @type string $category_orderby How to order the bookmark category based on term scheme if $categorize is true. Default 'name'. @type string $category_order Whether to order categories in ascending or descending order if $categorize is true. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"Will only return if echo option is set to not echo. Default is not return anything.","types":"string|void"}},{"name":"get_bookmark","desc":"","summary":"Retrieve Bookmark data","type":"function","category":"Bookmarks","since":"2.1.0","param":[{"content":"","types":"int|stdClass","variable":"$bookmark","default":"null","required":"yes"},{"content":" The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to an stdClass object, an associative array, or a numeric array, respectively. Default OBJECT.","types":"string","variable":"$output","default":"OBJECT","required":"no"},{"content":" default is 'raw'.","types":"string","variable":"$filter","default":"'raw'","required":"no"}],"return":{"content":"Type returned depends on $output value.","types":"array|object|null"}},{"name":"get_bookmark_field","desc":"","summary":"Retrieve single bookmark data item or field.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"The name of the data field to return","types":"string","variable":"$field","default":"null","required":"yes"},{"content":"The bookmark ID to get field","types":"int","variable":"$bookmark","default":"null","required":"yes"},{"content":" The context of how the field will be used.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"","types":"string|WP_Error"}},{"name":"get_bookmarks","desc":"<p>Attempts to retrieve from the cache first based on MD5 hash of arguments. If that fails, then the query will be built from the arguments and executed. The results will be stored to the cache.</p>","summary":"Retrieves the list of bookmarks","type":"function","category":"Bookmarks","since":"2.1.0","param":[{"content":"{ Optional. String or array of arguments to retrieve bookmarks. @type string $orderby How to order the links by. Accepts post fields. Default 'name'. @type string $order Whether to order bookmarks in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. @type int $limit Amount of bookmarks to display. Accepts 1+ or -1 for all. Default -1. @type string $category Comma-separated list of category ids to include links from. Default empty. @type string $category_name Category to retrieve links for by name. Default empty. @type int|bool $hide_invisible Whether to show or hide links marked as 'invisible'. Accepts 1|true or 0|false. Default 1|true. @type int|bool $show_updated Whether to display the time the bookmark was last updated. Accepts 1|true or 0|false. Default 0|false. @type string $include Comma-separated list of bookmark IDs to include. Default empty. @type string $exclude Comma-separated list of bookmark IDs to exclude. Default empty. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"List of bookmark row objects.","types":"array"}},{"name":"sanitize_bookmark","desc":"","summary":"Sanitizes all bookmark fields","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Bookmark row","types":"stdClass|array","variable":"$bookmark","default":"null","required":"yes"},{"content":" default is 'display'. How to filter the fields","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"Same type as $bookmark but with fields sanitized.","types":"stdClass|array"}},{"name":"sanitize_bookmark_field","desc":"<p>Sanitizes the bookmark fields based on what the field name is. If the field has a strict value set, then it will be tested for that, else a more generic filtering is applied. After the more strict filter is applied, if the <code>$context</code> is 'raw' then the value is immediately return.</p> <p>Hooks exist for the more generic cases. With the 'edit' context, the {@see 'edit_$field'} filter will be called and passed the <code>$value</code> and <code>$bookmark_id</code> respectively.</p> <p>With the 'db' context, the {@see 'pre_$field'} filter is called and passed the value. The 'display' context is the final context and has the <code>$field</code> has the filter name and is passed the <code>$value</code>, <code>$bookmark_id</code>, and <code>$context</code>, respectively.</p>","summary":"Sanitizes a bookmark field.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"The bookmark field.","types":"string","variable":"$field","default":"null","required":"yes"},{"content":"The bookmark field value.","types":"mixed","variable":"$value","default":"null","required":"yes"},{"content":"Bookmark ID.","types":"int","variable":"$bookmark_id","default":"null","required":"yes"},{"content":"How to filter the field value. Accepts 'raw', 'edit', 'attribute', 'js', 'db', or 'display'","types":"string","variable":"$context","default":"null","required":"yes"}],"return":{"content":"The filtered value.","types":"mixed"}},{"name":"clean_bookmark_cache","desc":"","summary":"Deletes the bookmark cache.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Bookmark ID.","types":"int","variable":"$bookmark_id","default":"null","required":"yes"}]},{"name":"wp_cache_add","desc":"","summary":"Adds data to the cache, if the cache key doesn't already exist.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"The cache key to use for retrieval later.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":"The data to add to the cache.","types":"mixed","variable":"$data","default":"null","required":"yes"},{"content":" The group to add the cache to. Enables the same key to be used across groups. Default empty.","types":"string","variable":"$group","default":"''","required":"no"},{"content":" When the cache data should expire, in seconds. Default 0 (no expiration).","types":"int","variable":"$expire","default":"0","required":"no"}],"return":{"content":"False if cache key and group already exist, true on success.","types":"bool"}},{"name":"wp_cache_close","desc":"<p>This function has ceased to do anything since WordPress 2.5. The functionality was removed along with the rest of the persistent cache.</p> <p>This does not mean that plugins can't implement this function when they need to make sure that the cache is cleaned up after WordPress no longer needs it.</p>","summary":"Closes the cache.","type":"function","category":"Uncategorised","since":"2.0.0","return":{"content":"Always returns true.","types":"true"}},{"name":"wp_cache_decr","desc":"","summary":"Decrements numeric cache item's value.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"The cache key to decrement.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":" The amount by which to decrement the item's value. Default 1.","types":"int","variable":"$offset","default":"1","required":"no"},{"content":" The group the key is in. Default empty.","types":"string","variable":"$group","default":"''","required":"no"}],"return":{"content":"False on failure, the item's new value on success.","types":"false|int"}},{"name":"wp_cache_delete","desc":"","summary":"Removes the cache contents matching key and group.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"What the contents in the cache are called.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":" Where the cache contents are grouped. Default empty.","types":"string","variable":"$group","default":"''","required":"no"}],"return":{"content":"True on successful removal, false on failure.","types":"bool"}},{"name":"wp_cache_flush","desc":"","summary":"Removes all cache items.","type":"function","category":"Uncategorised","since":"2.0.0","return":{"content":"False on failure, true on success","types":"bool"}},{"name":"wp_cache_get","desc":"","summary":"Retrieves the cache contents from the cache by key and group.","type":"function","category":"Miscellaneous","since":"2.0.0","param":[{"content":"The key under which the cache contents are stored.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":" Where the cache contents are grouped. Default empty.","types":"string","variable":"$group","default":"''","required":"no"},{"content":" Whether to force an update of the local cache from the persistent cache. Default false.","types":"bool","variable":"$force","default":"false","required":"no"},{"content":" Whether the key was found in the cache (passed by reference). Disambiguates a return of false, a storable value. Default null.","types":"bool","variable":"$found","default":"null","required":"no"}],"return":{"content":"False on failure to retrieve contents or the cache contents on success","types":"bool|mixed"}},{"name":"wp_cache_incr","desc":"","summary":"Increment numeric cache item's value","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"The key for the cache contents that should be incremented.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":" The amount by which to increment the item's value. Default 1.","types":"int","variable":"$offset","default":"1","required":"no"},{"content":" The group the key is in. Default empty.","types":"string","variable":"$group","default":"''","required":"no"}],"return":{"content":"False on failure, the item's new value on success.","types":"false|int"}},{"name":"wp_cache_init","desc":"","summary":"Sets up Object Cache Global and assigns it.","type":"function","category":"Uncategorised","since":"2.0.0"},{"name":"wp_cache_replace","desc":"","summary":"Replaces the contents of the cache with new data.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"The key for the cache data that should be replaced.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":"The new data to store in the cache.","types":"mixed","variable":"$data","default":"null","required":"yes"},{"content":" The group for the cache data that should be replaced. Default empty.","types":"string","variable":"$group","default":"''","required":"no"},{"content":" When to expire the cache contents, in seconds. Default 0 (no expiration).","types":"int","variable":"$expire","default":"0","required":"no"}],"return":{"content":"False if original value does not exist, true if contents were replaced","types":"bool"}},{"name":"wp_cache_set","desc":"<p>Differs from wp_cache_add() and wp_cache_replace() in that it will always write data.</p>","summary":"Saves the data to the cache.","type":"function","category":"Miscellaneous","since":"2.0.0","param":[{"content":"The cache key to use for retrieval later.","types":"int|string","variable":"$key","default":"null","required":"yes"},{"content":"The contents to store in the cache.","types":"mixed","variable":"$data","default":"null","required":"yes"},{"content":" Where to group the cache contents. Enables the same key to be used across groups. Default empty.","types":"string","variable":"$group","default":"''","required":"no"},{"content":" When to expire the cache contents, in seconds. Default 0 (no expiration).","types":"int","variable":"$expire","default":"0","required":"no"}],"return":{"content":"False on failure, true on success","types":"bool"}},{"name":"wp_cache_switch_to_blog","desc":"<p>This changes the blog id used to create keys in blog specific groups.</p>","summary":"Switches the internal blog ID.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":"Site ID.","types":"int","variable":"$blog_id","default":"null","required":"yes"}]},{"name":"wp_cache_add_global_groups","desc":"","summary":"Adds a group or set of groups to the list of global groups.","type":"function","category":"Uncategorised","since":"2.6.0","param":[{"content":"A group or an array of groups to add.","types":"string|array","variable":"$groups","default":"null","required":"yes"}]},{"name":"wp_cache_add_non_persistent_groups","desc":"","summary":"Adds a group or set of groups to the list of non-persistent groups.","type":"function","category":"Uncategorised","since":"2.6.0","param":[{"content":"A group or an array of groups to add.","types":"string|array","variable":"$groups","default":"null","required":"yes"}]},{"name":"wp_cache_reset","desc":"<p>If the cache back end uses global blog or site IDs as part of its cache keys, this function instructs the back end to reset those keys and perform any cleanup since blog or site IDs have changed since cache init.</p> <p>This function is deprecated. Use wp_cache_switch_to_blog() instead of this function when preparing the cache for a blog switch. For clearing the cache during unit tests, consider using wp_cache_init(). wp_cache_init() is not recommended outside of unit tests as the performance penalty for using it is high.</p>","summary":"Reset internal cache keys and structures.","type":"function","category":"Miscellaneous","since":"2.6.0","deprecated":{"content":"3.5.0","desc":"WP_Object_Cache::reset()"}},{"name":"lowercase_octets","desc":"","summary":"Converts the first hex-encoded octet match to lowercase.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"Hex-encoded octet matches for the requested URL.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"Lowercased version of the first match.","types":"string"}},{"name":"redirect_canonical","desc":"<p>Search engines consider www.somedomain.com and somedomain.com to be two different URLs when they both go to the same location. This SEO enhancement prevents penalty for duplicate content by redirecting all incoming links to one or the other.</p> <p>Prevents redirection for feeds, trackbacks, searches, and admin URLs. Does not redirect on non-pretty-permalink-supporting IIS 7+, page/post previews, WP admin, Trackbacks, robots.txt, searches, or on POST requests.</p> <p>Will also attempt to find the correct link when a user enters a URL that does not exist based on exact WordPress query. Will instead try to parse the URL or query in an attempt to figure the correct page to go to.</p>","summary":"Redirects incoming links to the proper URL based on the site url.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":" The URL that was requested, used to figure if redirect is needed.","types":"string","variable":"$requested_url","default":"null","required":"no"},{"content":" Redirect to the new URL.","types":"bool","variable":"$do_redirect","default":"true","required":"no"}],"return":{"content":"The string of the URL, if redirect needed.","types":"string|void"}},{"name":"_remove_qs_args_if_not_in_url","desc":"","summary":"Removes arguments from a query string if they are not present in a URL DO NOT use this in plugin code.","type":"function","category":"Uncategorised","since":"3.4.0","access":"private","param":[{"content":"","types":"string","variable":"$query_string","default":"null","required":"yes"},{"content":"","types":"array","variable":"$args_to_check","default":"null","required":"yes"},{"content":"","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"The altered query string","types":"string"}},{"name":"strip_fragment_from_url","desc":"","summary":"Strips the #fragment from a URL, if one is present.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The URL to strip.","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"The altered URL.","types":"string"}},{"name":"redirect_guess_404_permalink","desc":"","summary":"Attempts to guess the correct URL based on query vars","type":"function","category":"Uncategorised","since":"2.3.0","return":{"content":"The correct URL if one is found. False on failure.","types":"false|string"}},{"name":"wp_redirect_admin_locations","desc":"<p>If a user visits example.com/admin, they'll be redirected to /wp-admin. Visiting /login redirects to /wp-login.php, and so on.</p>","summary":"Redirects a variety of shorthand URLs to the admin.","type":"function","category":"Uncategorised","since":"3.4.0"},{"name":"map_meta_cap","desc":"<p>This does not actually compare whether the user ID has the actual capability, just what the capability or capabilities are. Meta capability list value can be 'delete_user', 'edit_user', 'remove_user', 'promote_user', 'delete_post', 'delete_page', 'edit_post', 'edit_page', 'read_post', or 'read_page'.</p>","summary":"Map meta capabilities to primitive capabilities.","type":"function","category":"Admins, Roles and Capabilities","since":"2.0.0","param":[{"content":"Capability name.","types":"string","variable":"$cap","default":"null","required":"yes"},{"content":"User ID.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":" ID of the specific object to check against if <code>$cap</code> is a "meta" cap. "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts', 'edit_others_posts', etc. The parameter is accessed via func_get_args().","types":"int","variable":"$object_id","default":"null","required":"no"}],"return":{"content":"Actual capabilities for meta capability.","types":"array"}},{"name":"current_user_can","desc":"<p>While checking against particular roles in place of a capability is supported in part, this practice is discouraged as it may produce unreliable results.</p> <p>Note: Will always return true if the current user is a super admin, unless specifically denied.</p>","summary":"Whether the current user has a specific capability.","type":"function","category":"Admins, Roles and Capabilities","since":"2.0.0","param":[{"content":"Capability name.","types":"string","variable":"$capability","default":"null","required":"yes"},{"content":" ID of the specific object to check against if <code>$capability</code> is a "meta" cap. "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts', 'edit_others_posts', etc. Accessed via func_get_args() and passed to WP_User::has_cap(), then map_meta_cap().","types":"int","variable":"$object_id","default":"null","required":"no"}],"return":{"content":"Whether the current user has the given capability. If <code>$capability</code> is a meta cap and <code>$object_id</code> is passed, whether the current user has the given meta capability for the given object.","types":"bool"}},{"name":"current_user_can_for_blog","desc":"","summary":"Whether the current user has a specific capability for a given site.","type":"function","category":"Admins, Roles and Capabilities","since":"3.0.0","param":[{"content":"Site ID.","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"Capability name.","types":"string","variable":"$capability","default":"null","required":"yes"}],"return":{"content":"Whether the user has the given capability.","types":"bool"}},{"name":"author_can","desc":"","summary":"Whether the author of the supplied post has a specific capability.","type":"function","category":"Admins, Roles and Capabilities","since":"2.9.0","param":[{"content":"Post ID or post object.","types":"int|WP_Post","variable":"$post","default":"null","required":"yes"},{"content":"Capability name.","types":"string","variable":"$capability","default":"null","required":"yes"}],"return":{"content":"Whether the post author has the given capability.","types":"bool"}},{"name":"user_can","desc":"","summary":"Whether a particular user has a specific capability.","type":"function","category":"Admins, Roles and Capabilities","since":"3.1.0","param":[{"content":"User ID or object.","types":"int|WP_User","variable":"$user","default":"null","required":"yes"},{"content":"Capability name.","types":"string","variable":"$capability","default":"null","required":"yes"}],"return":{"content":"Whether the user has the given capability.","types":"bool"}},{"name":"wp_roles","desc":"","summary":"Retrieves the global WP_Roles instance and instantiates it if necessary.","type":"function","category":"Uncategorised","since":"4.3.0","return":{"content":"WP_Roles global instance if not already instantiated.","types":"WP_Roles"}},{"name":"get_role","desc":"","summary":"Retrieve role object.","type":"function","category":"Admins, Roles and Capabilities","since":"2.0.0","param":[{"content":"Role name.","types":"string","variable":"$role","default":"null","required":"yes"}],"return":{"content":"WP_Role object if found, null if the role does not exist.","types":"WP_Role|null"}},{"name":"add_role","desc":"","summary":"Add role, if it does not exist.","type":"function","category":"Admins, Roles and Capabilities","since":"2.0.0","param":[{"content":"Role name.","types":"string","variable":"$role","default":"null","required":"yes"},{"content":"Display name for role.","types":"string","variable":"$display_name","default":"null","required":"yes"},{"content":"List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );","types":"array","variable":"$capabilities","default":"array()","required":"no"}],"return":{"content":"WP_Role object if role is added, null if already exists.","types":"WP_Role|null"}},{"name":"remove_role","desc":"","summary":"Remove role, if it exists.","type":"function","category":"Admins, Roles and Capabilities","since":"2.0.0","param":[{"content":"Role name.","types":"string","variable":"$role","default":"null","required":"yes"}]},{"name":"get_super_admins","desc":"","summary":"Retrieve a list of super admins.","type":"function","category":"Admins, Roles and Capabilities","since":"3.0.0","return":{"content":"List of super admin logins","types":"array"}},{"name":"is_super_admin","desc":"","summary":"Determine if user is a site admin.","type":"function","category":"Admins, Roles and Capabilities","since":"3.0.0","param":[{"content":"(Optional) The ID of a user. Defaults to the current user.","types":"int","variable":"$user_id","default":"false","required":"no"}],"return":{"content":"True if the user is a site admin.","types":"bool"}},{"name":"grant_super_admin","desc":"","summary":"Grants Super Admin privileges.","type":"function","category":"Multisite administration Functions","since":"3.0.0","param":[{"content":"ID of the user to be granted Super Admin privileges.","types":"int","variable":"$user_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure. This can fail when the user is already a super admin or when the <code>$super_admins</code> global is defined.","types":"bool"}},{"name":"revoke_super_admin","desc":"","summary":"Revokes Super Admin privileges.","type":"function","category":"Multisite administration Functions","since":"3.0.0","param":[{"content":"ID of the user Super Admin privileges to be revoked from.","types":"int","variable":"$user_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure. This can fail when the user's email is the network admin email or when the <code>$super_admins</code> global is defined.","types":"bool"}},{"name":"wp_maybe_grant_install_languages_cap","desc":"<p>A user must have at least one out of the 'update_core', 'install_plugins', and 'install_themes' capabilities to qualify for 'install_languages'.</p>","summary":"Filters the user capabilities to grant the 'install_languages' capability as necessary.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"An array of all the user's capabilities.","types":"bool[]","variable":"$allcaps","default":"null","required":"yes"}],"return":{"content":"Filtered array of the user's capabilities.","types":"bool[]"}},{"name":"wp_maybe_grant_resume_extensions_caps","desc":"","summary":"Filters the user capabilities to grant the 'resume_plugins' and 'resume_themes' capabilities as necessary.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"An array of all the user's capabilities.","types":"bool[]","variable":"$allcaps","default":"null","required":"yes"}],"return":{"content":"Filtered array of the user's capabilities.","types":"bool[]"}},{"name":"wp_maybe_grant_site_health_caps","desc":"","summary":"Filters the user capabilities to grant the 'view_site_health_checks' capabilities as necessary.","type":"function","category":"Uncategorised","since":"5.2.2","param":[{"content":"An array of all the user's capabilities.","types":"bool[]","variable":"$allcaps","default":"null","required":"yes"},{"content":"Required primitive capabilities for the requested capability.","types":"string[]","variable":"$caps","default":"null","required":"yes"},{"content":"{ Arguments that accompany the requested capability check. @type string $0 Requested capability. @type int $1 Concerned user ID. @type mixed ...$2 Optional second and further parameters, typically object ID. }","types":"array","variable":"$args","default":"null","required":"yes"},{"content":"The user object.","types":"WP_User","variable":"$user","default":"null","required":"yes"}],"return":{"content":"Filtered array of the user's capabilities.","types":"bool[]"}},{"name":"get_category_link","desc":"","summary":"Retrieve category link URL.","type":"function","category":"Categories","since":"1.0.0","param":[{"content":"Category ID or object.","types":"int|object","variable":"$category","default":"null","required":"yes"}],"return":{"content":"Link on success, empty string if category does not exist.","types":"string"}},{"name":"get_category_parents","desc":"","summary":"Retrieve category parents with separator.","type":"function","category":"Categories","since":"4.8.0","param":[{"content":"Category ID.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":" default is false. Whether to format with link.","types":"bool","variable":"$link","default":"false","required":"no"},{"content":" default is '/'. How to separate categories.","types":"string","variable":"$separator","default":"'/'","required":"no"},{"content":" default is false. Whether to use nice name for display.","types":"bool","variable":"$nicename","default":"false","required":"no"},{"content":"Not used.","types":"array","variable":"$deprecated","default":"array()","required":"no"}],"return":{"content":"A list of category parents on success, WP_Error on failure.","types":"string|WP_Error"}},{"name":"get_the_category","desc":"<p>This tag may be used outside The Loop by passing a post id as the parameter.</p> <p>Note: This function only returns results from the default "category" taxonomy. For custom taxonomies use get_the_terms().</p>","summary":"Retrieve post categories.","type":"function","category":"Categories","since":"0.71","param":[{"content":" default to current post ID. The post ID.","types":"int","variable":"$id","default":"false","required":"no"}],"return":{"content":"Array of WP_Term objects, one for each category assigned to the post.","types":"WP_Term[]"}},{"name":"get_the_category_by_ID","desc":"","summary":"Retrieve category name based on category ID.","type":"function","category":"Categories","since":"0.71","param":[{"content":"Category ID.","types":"int","variable":"$cat_ID","default":"null","required":"yes"}],"return":{"content":"Category name on success, WP_Error on failure.","types":"string|WP_Error"}},{"name":"get_the_category_list","desc":"","summary":"Retrieve category list for a post in either HTML list or custom format.","type":"function","category":"Categories","since":"1.5.1","param":[{"content":" Separator between the categories. By default, the links are placed in an unordered list. An empty string will result in the default behavior.","types":"string","variable":"$separator","default":"''","required":"no"},{"content":" How to display the parents.","types":"string","variable":"$parents","default":"''","required":"no"},{"content":" Post ID to retrieve categories.","types":"int","variable":"$post_id","default":"false","required":"no"}],"return":{"content":"","types":"string"}},{"name":"in_category","desc":"<p>The given categories are checked against the post's categories' term_ids, names and slugs. Categories given as integers will only be checked against the post's categories' term_ids.</p> <p>Prior to v2.5 of WordPress, category names were not supported. Prior to v2.7, category slugs were not supported. Prior to v2.7, only one category could be compared: in_category( $single_category ). Prior to v2.7, this function could only be used in the WordPress Loop. As of 2.7, the function can be used anywhere if it is provided a post ID or post object.</p> <p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Checks if the current post is within any of the given categories.","type":"function","category":"Conditional Tags Index","since":"1.2.0","param":[{"content":"Category ID, name or slug, or array of said.","types":"int|string|array","variable":"$category","default":"null","required":"yes"},{"content":" Post to check instead of the current post. (since 2.7.0)","types":"int|object","variable":"$post","default":"null","required":"no"}],"return":{"content":"True if the current post is in any of the given categories.","types":"bool"}},{"name":"the_category","desc":"","summary":"Display category list for a post in either HTML list or custom format.","type":"function","category":"Categories","since":"0.71","param":[{"content":" Separator between the categories. By default, the links are placed in an unordered list. An empty string will result in the default behavior.","types":"string","variable":"$separator","default":"''","required":"no"},{"content":" How to display the parents.","types":"string","variable":"$parents","default":"''","required":"no"},{"content":" Post ID to retrieve categories.","types":"int","variable":"$post_id","default":"false","required":"no"}]},{"name":"category_description","desc":"","summary":"Retrieve category description.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":" Category ID. Will use global category ID by default.","types":"int","variable":"$category","default":"0","required":"no"}],"return":{"content":"Category description, available.","types":"string"}},{"name":"wp_dropdown_categories","desc":"<p>The 'hierarchical' argument, which is disabled by default, will override the depth argument, unless it is true. When the argument is false, it will display all of the categories. When it is enabled it will use the value in the 'depth' argument.</p>","summary":"Display or retrieve the HTML dropdown list of categories.","type":"function","category":"Categories","since":"4.6.0","param":[{"content":"{ Optional. Array or string of arguments to generate a categories drop-down element. See WP_Term_Query::__construct() for information on additional accepted arguments. @type string $show_option_all Text to display for showing all categories. Default empty. @type string $show_option_none Text to display for showing no categories. Default empty. @type string $option_none_value Value to use when no category is selected. Default empty. @type string $orderby Which column to use for ordering categories. See get_terms() for a list of accepted values. Default 'id' (term_id). @type bool $pad_counts See get_terms() for an argument description. Default false. @type bool|int $show_count Whether to include post counts. Accepts 0, 1, or their bool equivalents. Default 0. @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, or their bool equivalents. Default 1. @type bool|int $hierarchical Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool equivalents. Default 0. @type int $depth Maximum depth. Default 0. @type int $tab_index Tab index for the select element. Default 0 (no tabindex). @type string $name Value for the 'name' attribute of the select element. Default 'cat'. @type string $id Value for the 'id' attribute of the select element. Defaults to the value of <code>$name</code>. @type string $class Value for the 'class' attribute of the select element. Default 'postform'. @type int|string $selected Value of the option that should be selected. Default 0. @type string $value_field Term field that should be used to populate the 'value' attribute of the option elements. Accepts any valid term field: 'term_id', 'name', 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description', 'parent', 'count'. Default 'term_id'. @type string|array $taxonomy Name of the category or categories to retrieve. Default 'category'. @type bool $hide_if_empty True to skip generating markup if no categories are found. Default false (create select element even if no categories are found). @type bool $required Whether the <code><select></code> element should have the HTML5 'required' attribute. Default false. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"HTML content only if 'echo' argument is 0.","types":"string"}},{"name":"wp_list_categories","desc":"","summary":"Display or retrieve the HTML list of categories.","type":"function","category":"Categories","since":"4.4.0","param":[{"content":"{ Array of optional arguments. @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0. @type int|array $current_category ID of category, or array of IDs of categories, that should get the 'current-cat' class. Default 0. @type int $depth Category depth. Used for tab indentation. Default 0. @type bool|int $echo True to echo markup, false to return it. Default 1. @type array|string $exclude Array or comma/space-separated string of term IDs to exclude. If <code>$hierarchical</code> is true, descendants of <code>$exclude</code> terms will also be excluded; see <code>$exclude_tree</code>. See get_terms(). Default empty string. @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along with their descendants. See get_terms(). Default empty string. @type string $feed Text to use for the feed link. Default 'Feed for all posts filed under [cat name]'. @type string $feed_image URL of an image to use for the feed link. Default empty string. @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link(). Default empty string (default feed). @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them. Default 1. @type bool $hide_title_if_empty Whether to hide the <code>$title_li</code> element if there are no terms in the list. Default false (title will always be shown). @type bool $hierarchical Whether to include terms that have non-empty descendants. See get_terms(). Default true. @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'. Default 'ASC'. @type string $orderby The column to use for ordering categories. Default 'name'. @type string $separator Separator between links. Default '<br />'. @type bool|int $show_count Whether to show how many posts are in the category. Default 0. @type string $show_option_all Text to display for showing all categories. Default empty string. @type string $show_option_none Text to display for the 'no categories' option. Default 'No categories'. @type string $style The style used to display the categories list. If 'list', categories will be output as an unordered list. If left empty or another value, categories will be output separated by <code><br></code> tags. Default 'list'. @type string $taxonomy Taxonomy name. Default 'category'. @type string $title_li Text to use for the list title <code><li></code> element. Pass an empty string to disable. Default 'Categories'. @type bool|int $use_desc_for_title Whether to use the category description as the title attribute. Default 1. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"HTML content only if 'echo' argument is 0.","types":"false|string"}},{"name":"wp_tag_cloud","desc":"","summary":"Displays a tag cloud.","type":"function","category":"Tags","since":"4.8.0","param":[{"content":"{ Optional. Array or string of arguments for displaying a tag cloud. See wp_generate_tag_cloud() and get_terms() for the full lists of arguments that can be passed in <code>$args</code>. @type int $number The number of tags to display. Accepts any positive integer or zero to return all. Default 0 (all tags). @type string $link Whether to display term editing links or term permalinks. Accepts 'edit' and 'view'. Default 'view'. @type string $post_type The post type. Used to highlight the proper post type menu on the linked edit page. Defaults to the first post type associated with the taxonomy. @type bool $echo Whether or not to echo the return value. Default true. }","types":"array|string","variable":"$args","default":"''","required":"no"}],"return":{"content":"Generated tag cloud, only if no failures and 'array' is set for the 'format' argument. Otherwise, this function outputs the tag cloud.","types":"void|array"}},{"name":"default_topic_count_scale","desc":"","summary":"Default topic count scaling for tag links.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Number of posts with that tag.","types":"int","variable":"$count","default":"null","required":"yes"}],"return":{"content":"Scaled count.","types":"int"}},{"name":"wp_generate_tag_cloud","desc":"","summary":"Generates a tag cloud (heatmap) from provided data.","type":"function","category":"Tags","since":"4.8.0","param":[{"content":"Array of WP_Term objects to generate the tag cloud for.","types":"WP_Term[]","variable":"$tags","default":"null","required":"yes"},{"content":"{ Optional. Array or string of arguments for generating a tag cloud. @type int $smallest Smallest font size used to display tags. Paired with the value of <code>$unit</code>, to determine CSS text size unit. Default 8 (pt). @type int $largest Largest font size used to display tags. Paired with the value of <code>$unit</code>, to determine CSS text size unit. Default 22 (pt). @type string $unit CSS text size unit to use with the <code>$smallest</code> and <code>$largest</code> values. Accepts any valid CSS text size unit. Default 'pt'. @type int $number The number of tags to return. Accepts any positive integer or zero to return all. Default 0. @type string $format Format to display the tag cloud in. Accepts 'flat' (tags separated with spaces), 'list' (tags displayed in an unordered list), or 'array' (returns an array). Default 'flat'. @type string $separator HTML or text to separate the tags. Default "\\n" (newline). @type string $orderby Value to order tags by. Accepts 'name' or 'count'. Default 'name'. The {@see 'tag_cloud_sort'} filter can also affect how tags are sorted. @type string $order How to order the tags. Accepts 'ASC' (ascending), 'DESC' (descending), or 'RAND' (random). Default 'ASC'. @type int|bool $filter Whether to enable filtering of the final output via {@see 'wp_generate_tag_cloud'}. Default 1|true. @type string $topic_count_text Nooped plural text from _n_noop() to supply to tag counts. Default null. @type callable $topic_count_text_callback Callback used to generate nooped plural text for tag counts based on the count. Default null. @type callable $topic_count_scale_callback Callback used to determine the tag count scaling value. Default default_topic_count_scale(). @type bool|int $show_count Whether to display the tag counts. Default 0. Accepts 0, 1, or their bool equivalents. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"Tag cloud as a string or an array, depending on 'format' argument.","types":"string|array"}},{"name":"_wp_object_name_sort_cb","desc":"<p>Used with <code>uasort()</code>.</p>","summary":"Serves as a callback for comparing objects based on name.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"The first object to compare.","types":"object","variable":"$a","default":"null","required":"yes"},{"content":"The second object to compare.","types":"object","variable":"$b","default":"null","required":"yes"}],"return":{"content":"Negative number if <code>$a->name</code> is less than <code>$b->name</code>, zero if they are equal, or greater than zero if <code>$a->name</code> is greater than <code>$b->name</code>.","types":"int"}},{"name":"_wp_object_count_sort_cb","desc":"<p>Used with <code>uasort()</code>.</p>","summary":"Serves as a callback for comparing objects based on count.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"The first object to compare.","types":"object","variable":"$a","default":"null","required":"yes"},{"content":"The second object to compare.","types":"object","variable":"$b","default":"null","required":"yes"}],"return":{"content":"Whether the count value for <code>$a</code> is greater than the count value for <code>$b</code>.","types":"bool"}},{"name":"walk_category_tree","desc":"","summary":"Retrieve HTML list content for category list.","type":"function","category":"Uncategorised","since":"2.1.0","return":{"content":"","types":"string"}},{"name":"walk_category_dropdown_tree","desc":"","summary":"Retrieve HTML dropdown (select) content for category list.","type":"function","category":"Uncategorised","since":"2.1.0","return":{"content":"","types":"string"}},{"name":"get_tag_link","desc":"","summary":"Retrieve the link to the tag.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":"Tag ID or object.","types":"int|object","variable":"$tag","default":"null","required":"yes"}],"return":{"content":"Link on success, empty string if tag does not exist.","types":"string"}},{"name":"get_the_tags","desc":"","summary":"Retrieve the tags for a post.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":"Post ID.","types":"int","variable":"$id","default":"0","required":"yes"}],"return":{"content":"Array of tag objects on success, false on failure.","types":"array|false|WP_Error"}},{"name":"get_the_tag_list","desc":"","summary":"Retrieve the tags for a post formatted as a string.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":" Before tags.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Between tags.","types":"string","variable":"$sep","default":"''","required":"no"},{"content":" After tags.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Post ID. Defaults to the current post.","types":"int","variable":"$id","default":"0","required":"no"}],"return":{"content":"A list of tags on success, false if there are no terms, WP_Error on failure.","types":"string|false|WP_Error"}},{"name":"the_tags","desc":"","summary":"Retrieve the tags for a post.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":" Before list.","types":"string","variable":"$before","default":"null","required":"no"},{"content":" Separate items using this.","types":"string","variable":"$sep","default":"', '","required":"no"},{"content":" After list.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"tag_description","desc":"","summary":"Retrieve tag description.","type":"function","category":"Tags","since":"2.8.0","param":[{"content":" Tag ID. Will use global tag ID by default.","types":"int","variable":"$tag","default":"0","required":"no"}],"return":{"content":"Tag description, available.","types":"string"}},{"name":"term_description","desc":"","summary":"Retrieve term description.","type":"function","category":"Uncategorised","since":"4.9.2","param":[{"content":" Term ID. Will use global term ID by default.","types":"int","variable":"$term","default":"0","required":"no"},{"content":"Deprecated argument.","types":"null","variable":"$deprecated","default":"null","required":"no"}],"return":{"content":"Term description, available.","types":"string"}},{"name":"get_the_terms","desc":"","summary":"Retrieve the terms of the taxonomy that are attached to the post.","type":"function","category":"Taxonomy","since":"2.5.0","param":[{"content":"Post ID or object.","types":"int|WP_Post","variable":"$post","default":"null","required":"yes"},{"content":"Taxonomy name.","types":"string","variable":"$taxonomy","default":"null","required":"yes"}],"return":{"content":"Array of WP_Term objects on success, false if there are no terms or the post does not exist, WP_Error on failure.","types":"WP_Term[]|false|WP_Error"}},{"name":"get_the_term_list","desc":"","summary":"Retrieve a post's terms as a list with specified format.","type":"function","category":"Taxonomy","since":"2.5.0","param":[{"content":"Post ID.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"Taxonomy name.","types":"string","variable":"$taxonomy","default":"null","required":"yes"},{"content":" Before list.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Separate items using this.","types":"string","variable":"$sep","default":"''","required":"no"},{"content":" After list.","types":"string","variable":"$after","default":"''","required":"no"}],"return":{"content":"A list of terms on success, false if there are no terms, WP_Error on failure.","types":"string|false|WP_Error"}},{"name":"get_term_parents_list","desc":"","summary":"Retrieve term parents with separator.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"Term ID.","types":"int","variable":"$term_id","default":"null","required":"yes"},{"content":"Taxonomy name.","types":"string","variable":"$taxonomy","default":"null","required":"yes"},{"content":"{ Array of optional arguments. @type string $format Use term names or slugs for display. Accepts 'name' or 'slug'. Default 'name'. @type string $separator Separator for between the terms. Default '/'. @type bool $link Whether to format as a link. Default true. @type bool $inclusive Include the term to get the parents for. Default true. }","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"A list of term parents on success, WP_Error or empty string on failure.","types":"string|WP_Error"}},{"name":"the_terms","desc":"","summary":"Display the terms in a list.","type":"function","category":"Taxonomy","since":"2.5.0","param":[{"content":"Post ID.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"Taxonomy name.","types":"string","variable":"$taxonomy","default":"null","required":"yes"},{"content":" Before list.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Separate items using this.","types":"string","variable":"$sep","default":"', '","required":"no"},{"content":" After list.","types":"string","variable":"$after","default":"''","required":"no"}],"return":{"content":"False on WordPress error.","types":"false|void"}},{"name":"has_category","desc":"","summary":"Check if the current post has any of given category.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":" The category name/term_id/slug or array of them to check for.","types":"string|int|array","variable":"$category","default":"''","required":"no"},{"content":" Post to check instead of the current post.","types":"int|object","variable":"$post","default":"null","required":"no"}],"return":{"content":"True if the current post has any of the given categories (or any category, if no category specified).","types":"bool"}},{"name":"has_tag","desc":"<p>The given tags are checked against the post's tags' term_ids, names and slugs. Tags given as integers will only be checked against the post's tags' term_ids. If no tags are given, determines if post has any tags.</p> <p>Prior to v2.7 of WordPress, tags given as integers would also be checked against the post's tags' names and slugs (in addition to term_ids) Prior to v2.7, this function could only be used in the WordPress Loop. As of 2.7, the function can be used anywhere if it is provided a post ID or post object.</p> <p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Checks if the current post has any of given tags.","type":"function","category":"Conditional Tags Index","since":"2.6.0","param":[{"content":" The tag name/term_id/slug or array of them to check for.","types":"string|int|array","variable":"$tag","default":"''","required":"no"},{"content":" Post to check instead of the current post. (since 2.7.0)","types":"int|object","variable":"$post","default":"null","required":"no"}],"return":{"content":"True if the current post has any of the given tags (or any tag, if no tag specified).","types":"bool"}},{"name":"has_term","desc":"<p>The given terms are checked against the post's terms' term_ids, names and slugs. Terms given as integers will only be checked against the post's terms' term_ids. If no terms are given, determines if post has any terms.</p>","summary":"Check if the current post has any of given terms.","type":"function","category":"Terms","since":"3.1.0","param":[{"content":" The term name/term_id/slug or array of them to check for.","types":"string|int|array","variable":"$term","default":"''","required":"no"},{"content":"Taxonomy name","types":"string","variable":"$taxonomy","default":"''","required":"no"},{"content":" Post to check instead of the current post.","types":"int|object","variable":"$post","default":"null","required":"no"}],"return":{"content":"True if the current post has any of the given tags (or any tag, if no tag specified).","types":"bool"}},{"name":"get_categories","desc":"<p>If you change the type to 'link' in the arguments, then the link categories will be returned instead. Also all categories will be updated to be backward compatible with pre-2.3 plugins and themes.</p>","summary":"Retrieve list of category objects.","type":"function","category":"Categories","since":"2.1.0","param":[{"content":"{ Optional. Arguments to retrieve categories. See get_terms() for additional options. @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"List of categories.","types":"array"}},{"name":"get_category","desc":"<p>If you pass the $category parameter an object, which is assumed to be the category row object retrieved the database. It will cache the category data.</p> <p>If you pass $category an integer of the category ID, then that category will be retrieved from the database, if it isn't already cached, and pass it back.</p> <p>If you look at get_term(), then both types will be passed through several filters and finally sanitized based on the $filter parameter value.</p> <p>The category will converted to maintain backward compatibility.</p>","summary":"Retrieves category data given a category ID or category object.","type":"function","category":"Categories","since":"1.5.1","param":[{"content":"Category ID or Category row object","types":"int|object","variable":"$category","default":"null","required":"yes"},{"content":" The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.","types":"string","variable":"$output","default":"OBJECT","required":"no"},{"content":" Default is raw or no WordPress defined filter will applied.","types":"string","variable":"$filter","default":"'raw'","required":"no"}],"return":{"content":"Category data in type defined by $output parameter. WP_Error if $category is empty, null if it does not exist.","types":"object|array|WP_Error|null"}},{"name":"get_category_by_path","desc":"<p>Breaks the $category_path parameter up to get the category slug.</p> <p>Tries to find the child path and will return it. If it doesn't find a match, then it will return the first category matching slug, if $full_match, is set to false. If it does not, then it will return null.</p> <p>It is also possible that it will return a WP_Error object on failure. Check for it when using this function.</p>","summary":"Retrieve category based on URL containing the category slug.","type":"function","category":"Categories","since":"2.1.0","param":[{"content":"URL containing category slugs.","types":"string","variable":"$category_path","default":"null","required":"yes"},{"content":" Whether full path should be matched.","types":"bool","variable":"$full_match","default":"true","required":"no"},{"content":" The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.","types":"string","variable":"$output","default":"OBJECT","required":"no"}],"return":{"content":"Type is based on $output value.","types":"WP_Term|array|WP_Error|null"}},{"name":"get_category_by_slug","desc":"","summary":"Retrieve category object by category slug.","type":"function","category":"Categories","since":"2.3.0","param":[{"content":"The category slug.","types":"string","variable":"$slug","default":"null","required":"yes"}],"return":{"content":"Category data object","types":"object"}},{"name":"get_cat_ID","desc":"","summary":"Retrieve the ID of a category from its name.","type":"function","category":"Categories","since":"1.0.0","param":[{"content":"Category name.","types":"string","variable":"$cat_name","default":"null","required":"yes"}],"return":{"content":"0, if failure and ID of category on success.","types":"int"}},{"name":"get_cat_name","desc":"","summary":"Retrieve the name of a category from its ID.","type":"function","category":"Categories","since":"1.0.0","param":[{"content":"Category ID","types":"int","variable":"$cat_id","default":"null","required":"yes"}],"return":{"content":"Category name, or an empty string if category doesn't exist.","types":"string"}},{"name":"cat_is_ancestor_of","desc":"<p>You can use either an id or the category object for both parameters. If you use an integer the category will be retrieved.</p>","summary":"Check if a category is an ancestor of another category.","type":"function","category":"Categories","since":"2.1.0","param":[{"content":"ID or object to check if this is the parent category.","types":"int|object","variable":"$cat1","default":"null","required":"yes"},{"content":"The child category.","types":"int|object","variable":"$cat2","default":"null","required":"yes"}],"return":{"content":"Whether $cat2 is child of $cat1","types":"bool"}},{"name":"sanitize_category","desc":"","summary":"Sanitizes category data based on context.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Category data","types":"object|array","variable":"$category","default":"null","required":"yes"},{"content":" Default is 'display'.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"Same type as $category with sanitized data for safe use.","types":"object|array"}},{"name":"sanitize_category_field","desc":"","summary":"Sanitizes data in single category key field.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Category key to sanitize","types":"string","variable":"$field","default":"null","required":"yes"},{"content":"Category value to sanitize","types":"mixed","variable":"$value","default":"null","required":"yes"},{"content":"Category ID","types":"int","variable":"$cat_id","default":"null","required":"yes"},{"content":"What filter to use, 'raw', 'display', etc.","types":"string","variable":"$context","default":"null","required":"yes"}],"return":{"content":"Same type as $value after $value has been sanitized.","types":"mixed"}},{"name":"get_tags","desc":"","summary":"Retrieves all post tags.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":"Tag arguments to use when retrieving tags.","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"$tags Array of 'post_tag' term objects, or a count thereof.","types":"WP_Term[]|int"}},{"name":"get_tag","desc":"<p>If you pass the $tag parameter an object, which is assumed to be the tag row object retrieved the database. It will cache the tag data.</p> <p>If you pass $tag an integer of the tag ID, then that tag will be retrieved from the database, if it isn't already cached, and pass it back.</p> <p>If you look at get_term(), then both types will be passed through several filters and finally sanitized based on the $filter parameter value.</p>","summary":"Retrieve post tag by tag ID or tag object.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":"A tag ID or object.","types":"int|WP_Term|object","variable":"$tag","default":"null","required":"yes"},{"content":" The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.","types":"string","variable":"$output","default":"OBJECT","required":"no"},{"content":" Default is raw or no WordPress defined filter will applied.","types":"string","variable":"$filter","default":"'raw'","required":"no"}],"return":{"content":"Tag data in type defined by $output parameter. WP_Error if $tag is empty, null if it does not exist.","types":"WP_Term|array|WP_Error|null"}},{"name":"clean_category_cache","desc":"","summary":"Remove the category cache data based on ID.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"Category ID","types":"int","variable":"$id","default":"null","required":"yes"}]},{"name":"_make_cat_compat","desc":"<p>This function was added for the taxonomy support to update the new category structure with the old category one. This will maintain compatibility with plugins and themes which depend on the old key or property names.</p> <p>The parameter should only be passed a variable and not create the array or object inline to the parameter. The reason for this is that parameter is passed by reference and PHP will fail unless it has the variable.</p> <p>There is no return value, because everything is updated on the variable you pass to it. This is one of the features with using pass by reference in PHP.</p>","summary":"Update category structure to old pre 2.3 from new taxonomy structure.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private","param":[{"content":"Category Row object or array","types":"array|object|WP_Term","variable":"$category","default":"null","required":"yes"}]},{"name":"stripos","desc":"","summary":"","type":"function","category":"Uncategorised"},{"name":"wp_simplepie_autoload","desc":"","summary":"WordPress autoloader for SimplePie.","type":"function","category":"Uncategorised","since":"3.5.0"},{"name":"get_comment_author","desc":"<p>If the comment has an empty comment_author field, then 'Anonymous' person is assumed.</p>","summary":"Retrieve the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to retrieve the author. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}],"return":{"content":"The comment author","types":"string"}},{"name":"comment_author","desc":"","summary":"Displays the author of the current comment.","type":"function","category":"Comments Loop","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to print the author. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}]},{"name":"get_comment_author_email","desc":"","summary":"Retrieve the email of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to get the author's email. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}],"return":{"content":"The current comment author's email","types":"string"}},{"name":"comment_author_email","desc":"<p>Care should be taken to protect the email address and assure that email harvesters do not capture your commenter's email address. Most assume that their email address will not appear in raw form on the site. Doing so will enable anyone, including those that people don't want to get the email address and use it for their own means good and bad.</p>","summary":"Display the email of the author of the current global $comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to print the author's email. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}]},{"name":"comment_author_email_link","desc":"<p>Care should be taken to protect the email address and assure that email harvesters do not capture your commenter's email address. Most assume that their email address will not appear in raw form on the site. Doing so will enable anyone, including those that people don't want to get the email address and use it for their own means good and bad.</p>","summary":"Display the html email link to the author of the current comment.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Text to display instead of the comment author's email address. Default empty.","types":"string","variable":"$linktext","default":"''","required":"no"},{"content":" Text or HTML to display before the email link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Text or HTML to display after the email link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Comment ID or WP_Comment object. Default is the current comment.","types":"int|WP_Comment","variable":"$comment","default":"null","required":"no"}]},{"name":"get_comment_author_email_link","desc":"<p>Care should be taken to protect the email address and assure that email harvesters do not capture your commenter's email address. Most assume that their email address will not appear in raw form on the site. Doing so will enable anyone, including those that people don't want to get the email address and use it for their own means good and bad.</p>","summary":"Return the html email link to the author of the current comment.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Text to display instead of the comment author's email address. Default empty.","types":"string","variable":"$linktext","default":"''","required":"no"},{"content":" Text or HTML to display before the email link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Text or HTML to display after the email link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Comment ID or WP_Comment object. Default is the current comment.","types":"int|WP_Comment","variable":"$comment","default":"null","required":"no"}],"return":{"content":"HTML markup for the comment author email link. By default, the email address is obfuscated via the {@see 'comment_email'} filter with antispambot().","types":"string"}},{"name":"get_comment_author_link","desc":"<p>Both get_comment_author_url() and get_comment_author() rely on get_comment(), which falls back to the global comment variable if the $comment_ID argument is empty.</p>","summary":"Retrieve the HTML link to the URL of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to get the author's link. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}],"return":{"content":"The comment author name or HTML link for author's URL.","types":"string"}},{"name":"comment_author_link","desc":"","summary":"Display the html link to the url of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to print the author's link. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}]},{"name":"get_comment_author_IP","desc":"","summary":"Retrieve the IP address of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to get the author's IP address. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}],"return":{"content":"Comment author's IP address.","types":"string"}},{"name":"comment_author_IP","desc":"","summary":"Display the IP address of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to print the author's IP address. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}]},{"name":"get_comment_author_url","desc":"","summary":"Retrieve the url of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to get the author's URL. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}],"return":{"content":"Comment author URL.","types":"string"}},{"name":"comment_author_url","desc":"","summary":"Display the url of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or the ID of the comment for which to print the author's URL. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}]},{"name":"get_comment_author_url_link","desc":"<p>$linktext parameter is only used if the URL does not exist for the comment author. If the URL does exist then the URL will be used and the $linktext will be ignored.</p> <p>Encapsulate the HTML link between the $before and $after. So it will appear in the order of $before, link, and finally $after.</p>","summary":"Retrieves the HTML link of the url of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" The text to display instead of the comment author's email address. Default empty.","types":"string","variable":"$linktext","default":"''","required":"no"},{"content":" The text or HTML to display before the email link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" The text or HTML to display after the email link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Comment ID or WP_Comment object. Default is the current comment.","types":"int|WP_Comment","variable":"$comment","default":"0","required":"no"}],"return":{"content":"The HTML link between the $before and $after parameters.","types":"string"}},{"name":"comment_author_url_link","desc":"","summary":"Displays the HTML link of the url of the author of the current comment.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Text to display instead of the comment author's email address. Default empty.","types":"string","variable":"$linktext","default":"''","required":"no"},{"content":" Text or HTML to display before the email link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Text or HTML to display after the email link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Comment ID or WP_Comment object. Default is the current comment.","types":"int|WP_Comment","variable":"$comment","default":"0","required":"no"}]},{"name":"comment_class","desc":"","summary":"Generates semantic classes for each comment element.","type":"function","category":"Comments Loop","since":"4.4.0","param":[{"content":" One or more classes to add to the class list. Default empty.","types":"string|array","variable":"$class","default":"''","required":"no"},{"content":"Comment ID or WP_Comment object. Default current comment.","types":"int|WP_Comment","variable":"$comment","default":"null","required":"no"},{"content":"Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"no"},{"content":" Whether to cho or return the output. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"If <code>$echo</code> is false, the class will be returned. Void otherwise.","types":"string"}},{"name":"get_comment_class","desc":"","summary":"Returns the classes for the comment div as an array.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" One or more classes to add to the class list. Default empty.","types":"string|array","variable":"$class","default":"''","required":"no"},{"content":"Comment ID or WP_Comment object. Default current comment.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"no"},{"content":"Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"no"}],"return":{"content":"An array of classes.","types":"array"}},{"name":"get_comment_date","desc":"","summary":"Retrieve the comment date of the current comment.","type":"function","category":"Comments Loop","since":"4.4.0","param":[{"content":" The format of the date. Default user's setting.","types":"string","variable":"$d","default":"''","required":"no"},{"content":"WP_Comment or ID of the comment for which to get the date. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"yes"}],"return":{"content":"The comment's date.","types":"string"}},{"name":"comment_date","desc":"","summary":"Display the comment date of the current comment.","type":"function","category":"Comments Loop","since":"4.4.0","param":[{"content":" The format of the date. Default user's settings.","types":"string","variable":"$d","default":"''","required":"no"},{"content":"WP_Comment or ID of the comment for which to print the date. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"yes"}]},{"name":"get_comment_excerpt","desc":"<p>Will cut each word and only output the first 20 words with '…' at the end. If the word count is less than 20, then no truncating is done and no '…' will appear.</p>","summary":"Retrieve the excerpt of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"WP_Comment or ID of the comment for which to get the excerpt. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"yes"}],"return":{"content":"The maybe truncated comment with 20 words or less.","types":"string"}},{"name":"comment_excerpt","desc":"","summary":"Display the excerpt of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"WP_Comment or ID of the comment for which to print the excerpt. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"yes"}]},{"name":"get_comment_ID","desc":"","summary":"Retrieve the comment id of the current comment.","type":"function","category":"Uncategorised","since":"1.5.0","return":{"content":"The comment ID.","types":"int"}},{"name":"comment_ID","desc":"","summary":"Display the comment id of the current comment.","type":"function","category":"Comments Loop","since":"0.71"},{"name":"get_comment_link","desc":"","summary":"Retrieve the link to a given comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Comment to retrieve. Default current comment.","types":"WP_Comment|int|null","variable":"$comment","default":"null","required":"no"},{"content":"{ An array of optional arguments to override the defaults. @type string $type Passed to get_page_of_comment(). @type int $page Current page of comments, for calculating comment pagination. @type int $per_page Per-page value for comment pagination. @type int $max_depth Passed to get_page_of_comment(). @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. If provided, this value overrides any value calculated from <code>$page</code> and <code>$per_page</code>. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The permalink to the given comment.","types":"string"}},{"name":"get_comments_link","desc":"","summary":"Retrieves the link to the current post comments.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":" Post ID or WP_Post object. Default is global $post.","types":"int|WP_Post","variable":"$post_id","default":"0","required":"no"}],"return":{"content":"The link to the comments.","types":"string"}},{"name":"comments_link","desc":"","summary":"Display the link to the current post comments.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Not Used.","types":"string","variable":"$deprecated","default":"''","required":"no"},{"content":"Not Used.","types":"string","variable":"$deprecated_2","default":"''","required":"no"}]},{"name":"get_comments_number","desc":"","summary":"Retrieves the amount of comments a post has.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":" Post ID or WP_Post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$post_id","default":"0","required":"no"}],"return":{"content":"If the post exists, a numeric string representing the number of comments the post has, otherwise 0.","types":"string|int"}},{"name":"comments_number","desc":"","summary":"Display the language string for the number of comments the current post has.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" Text for no comments. Default false.","types":"string","variable":"$zero","default":"false","required":"no"},{"content":" Text for one comment. Default false.","types":"string","variable":"$one","default":"false","required":"no"},{"content":" Text for more than one comment. Default false.","types":"string","variable":"$more","default":"false","required":"no"},{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"}]},{"name":"get_comments_number_text","desc":"","summary":"Display the language string for the number of comments the current post has.","type":"function","category":"Uncategorised","since":"4.0.0","param":[{"content":" Text for no comments. Default false.","types":"string","variable":"$zero","default":"false","required":"no"},{"content":" Text for one comment. Default false.","types":"string","variable":"$one","default":"false","required":"no"},{"content":" Text for more than one comment. Default false.","types":"string","variable":"$more","default":"false","required":"no"}]},{"name":"get_comment_text","desc":"","summary":"Retrieve the text of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"WP_Comment or ID of the comment for which to get the text. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"yes"},{"content":" An array of arguments. Default empty.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The comment content.","types":"string"}},{"name":"comment_text","desc":"","summary":"Display the text of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"WP_Comment or ID of the comment for which to print the text. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"yes"},{"content":" An array of arguments. Default empty array. Default empty.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"get_comment_time","desc":"","summary":"Retrieve the comment time of the current comment.","type":"function","category":"Comments Loop","since":"1.5.0","param":[{"content":" The format of the time. Default user's settings.","types":"string","variable":"$d","default":"''","required":"no"},{"content":" Whether to use the GMT date. Default false.","types":"bool","variable":"$gmt","default":"false","required":"no"},{"content":" Whether to translate the time (for use in feeds). Default true.","types":"bool","variable":"$translate","default":"true","required":"no"}],"return":{"content":"The formatted time.","types":"string"}},{"name":"comment_time","desc":"","summary":"Display the comment time of the current comment.","type":"function","category":"Comments Loop","since":"0.71","param":[{"content":" The format of the time. Default user's settings.","types":"string","variable":"$d","default":"''","required":"no"}]},{"name":"get_comment_type","desc":"","summary":"Retrieve the comment type of the current comment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" WP_Comment or ID of the comment for which to get the type. Default current comment.","types":"int|WP_Comment","variable":"$comment_ID","default":"0","required":"no"}],"return":{"content":"The comment type.","types":"string"}},{"name":"comment_type","desc":"","summary":"Display the comment type of the current comment.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" String to display for comment type. Default false.","types":"string","variable":"$commenttxt","default":"false","required":"no"},{"content":" String to display for trackback type. Default false.","types":"string","variable":"$trackbacktxt","default":"false","required":"no"},{"content":" String to display for pingback type. Default false.","types":"string","variable":"$pingbacktxt","default":"false","required":"no"}]},{"name":"get_trackback_url","desc":"<p>There is a check to see if permalink's have been enabled and if so, will retrieve the pretty path. If permalinks weren't enabled, the ID of the current post is used and appended to the correct page to go to.</p>","summary":"Retrieve The current post's trackback URL.","type":"function","category":"Uncategorised","since":"1.5.0","return":{"content":"The trackback URL after being filtered.","types":"string"}},{"name":"trackback_url","desc":"","summary":"Display the current post's trackback URL.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Not used.","types":"bool","variable":"$deprecated_echo","default":"true","required":"no"}],"return":{"content":"Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.","types":"void|string"}},{"name":"trackback_rdf","desc":"<p>Deprecated in 3.0.0, and restored in 3.0.1.</p>","summary":"Generate and display the RDF for the trackback information of current post.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Not used (Was $timezone = 0).","types":"int","variable":"$deprecated","default":"''","required":"no"}]},{"name":"comments_open","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the current post is open for comments.","type":"function","category":"Conditional Tags Index","since":"1.5.0","param":[{"content":"Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"no"}],"return":{"content":"True if the comments are open.","types":"bool"}},{"name":"pings_open","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the current post is open for pings.","type":"function","category":"Conditional Tags Index","since":"1.5.0","param":[{"content":"Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"no"}],"return":{"content":"True if pings are accepted","types":"bool"}},{"name":"wp_comment_form_unfiltered_html_nonce","desc":"<p>Will only display nonce token if the current user has permissions for unfiltered html. Won't display the token for other users.</p> <p>The function was backported to 2.0.10 and was added to versions 2.1.3 and above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.</p> <p>Backported to 2.0.10.</p>","summary":"Display form token for unfiltered comments.","type":"function","category":"Uncategorised","since":"2.1.3"},{"name":"comments_template","desc":"<p>Will not display the comments template if not on single post or page, or if the post does not have comments.</p> <p>Uses the WordPress database object to query for the comments. The comments are passed through the {@see 'comments_array'} filter hook with the list of comments and the post ID respectively.</p> <p>The <code>$file</code> path is passed through a filter hook called {@see 'comments_template'}, which includes the TEMPLATEPATH and $file combined. Tries the $filtered path first and if it fails it will require the default comment template from the default theme. If either does not exist, then the WordPress process will be halted. It is advised for that reason, that the default theme is not deleted.</p> <p>Will not try to get the comments if the post has none.</p>","summary":"Load the comment template specified in $file.","type":"function","category":"Include functions","since":"1.5.0","param":[{"content":" The file to load. Default '/comments.php'.","types":"string","variable":"$file","default":"'/comments.php'","required":"no"},{"content":" Whether to separate the comments by comment type. Default false.","types":"bool","variable":"$separate_comments","default":"false","required":"no"}]},{"name":"comments_popup_link","desc":"","summary":"Displays the link to the comments for the current post ID.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" String to display when no comments. Default false.","types":"false|string","variable":"$zero","default":"false","required":"no"},{"content":" String to display when only one comment is available. Default false.","types":"false|string","variable":"$one","default":"false","required":"no"},{"content":" String to display when there are more than one comment. Default false.","types":"false|string","variable":"$more","default":"false","required":"no"},{"content":" CSS class to use for comments. Default empty.","types":"string","variable":"$css_class","default":"''","required":"no"},{"content":" String to display when comments have been turned off. Default false.","types":"false|string","variable":"$none","default":"false","required":"no"}]},{"name":"get_comment_reply_link","desc":"","summary":"Retrieve HTML content for reply to comment link.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"{ Optional. Override default arguments. @type string $add_below The first part of the selector used to identify the comment to respond below. The resulting value is passed as the first parameter to addComment.moveForm(), concatenated as $add_below-$comment->comment_ID. Default 'comment'. @type string $respond_id The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(), and appended to the link URL as a hash value. Default 'respond'. @type string $reply_text The text of the Reply link. Default 'Reply'. @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'. @type int $max_depth The max depth of the comment tree. Default 0. @type int $depth The depth of the new comment. Must be greater than 0 and less than the value of the 'thread_comments_depth' option set in Settings > Discussion. Default 0. @type string $before The text or HTML to add before the reply link. Default empty. @type string $after The text or HTML to add after the reply link. Default empty. }","types":"array","variable":"$args","default":"array()","required":"no"},{"content":"Comment being replied to. Default current comment.","types":"int|WP_Comment","variable":"$comment","default":"null","required":"no"},{"content":"Post ID or WP_Post object the comment is going to be displayed on. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Link to show comment form, if successful. False, if comments are closed.","types":"void|false|string"}},{"name":"comment_reply_link","desc":"","summary":"Displays the HTML content for reply to comment link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Override default options.","types":"array","variable":"$args","default":"array()","required":"no"},{"content":"Comment being replied to. Default current comment.","types":"int","variable":"$comment","default":"null","required":"no"},{"content":"Post ID or WP_Post object the comment is going to be displayed on. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Link to show comment form, if successful. False, if comments are closed.","types":"mixed"}},{"name":"get_post_reply_link","desc":"","summary":"Retrieve HTML content for reply to post link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"{ Optional. Override default arguments. @type string $add_below The first part of the selector used to identify the comment to respond below. The resulting value is passed as the first parameter to addComment.moveForm(), concatenated as $add_below-$comment->comment_ID. Default is 'post'. @type string $respond_id The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(), and appended to the link URL as a hash value. Default 'respond'. @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'. @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'. @type string $before Text or HTML to add before the reply link. Default empty. @type string $after Text or HTML to add after the reply link. Default empty. }","types":"array","variable":"$args","default":"array()","required":"no"},{"content":" Post ID or WP_Post object the comment is going to be displayed on. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Link to show comment form, if successful. False, if comments are closed.","types":"false|null|string"}},{"name":"post_reply_link","desc":"","summary":"Displays the HTML content for reply to post link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Override default options,","types":"array","variable":"$args","default":"array()","required":"no"},{"content":"Post ID or WP_Post object the comment is going to be displayed on. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Link to show comment form, if successful. False, if comments are closed.","types":"string|bool|null"}},{"name":"get_cancel_comment_reply_link","desc":"","summary":"Retrieve HTML content for cancel comment reply link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Text to display for cancel reply link. Default empty.","types":"string","variable":"$text","default":"''","required":"no"}],"return":{"content":"","types":"string"}},{"name":"cancel_comment_reply_link","desc":"","summary":"Display HTML content for cancel comment reply link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Text to display for cancel reply link. Default empty.","types":"string","variable":"$text","default":"''","required":"no"}]},{"name":"get_comment_id_fields","desc":"","summary":"Retrieve hidden input HTML for replying to comments.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":" Post ID. Default current post ID.","types":"int","variable":"$id","default":"0","required":"no"}],"return":{"content":"Hidden input HTML for replying to comments","types":"string"}},{"name":"comment_id_fields","desc":"","summary":"Output hidden input HTML for replying to comments.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Post ID. Default current post ID.","types":"int","variable":"$id","default":"0","required":"no"}]},{"name":"comment_form_title","desc":"<p>Only affects users with JavaScript disabled.</p>","summary":"Display text based on comment reply status.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Text to display when not replying to a comment. Default false.","types":"string","variable":"$noreplytext","default":"false","required":"no"},{"content":" Text to display when replying to a comment. Default false. Accepts "%s" for the author of the comment being replied to.","types":"string","variable":"$replytext","default":"false","required":"no"},{"content":" Boolean to control making the author's name a link to their comment. Default true.","types":"string","variable":"$linktoparent","default":"true","required":"no"}]},{"name":"wp_list_comments","desc":"<p>Used in the comments.php template to list comments for a particular post.</p>","summary":"List comments.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"{ Optional. Formatting options. @type object $walker Instance of a Walker class to list comments. Default null. @type int $max_depth The maximum comments depth. Default empty. @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'. @type string $callback Callback function to use. Default null. @type string $end-callback Callback function to use at the end. Default null. @type string $type Type of comments to list. Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'. @type int $page Page ID to list comments for. Default empty. @type int $per_page Number of comments to list per page. Default empty. @type int $avatar_size Height and width dimensions of the avatar size. Default 32. @type bool $reverse_top_level Ordering of the listed comments. If true, will display newest comments first. @type bool $reverse_children Whether to reverse child comments in the list. Default null. @type string $format How to format the comments list. Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'. @type bool $short_ping Whether to output short pings. Default false. @type bool $echo Whether to echo the output or return it. Default true. }","types":"string|array","variable":"$args","default":"array()","required":"no"},{"content":" Array of WP_Comment objects.","types":"array","variable":"$comments","default":"null","required":"no"}]},{"name":"comment_form","desc":"<p>Most strings and form fields may be controlled through the $args array passed into the function, while you may also choose to use the {@see 'comment_form_default_fields'} filter to modify the array of default fields if you'd just like to add a new one or remove a single field. All fields are also individually passed through a filter of the {@see 'comment_form<em>field</em>$name'} where $name is the key used in the array of fields.</p>","summary":"Outputs a complete commenting form for use within a template.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"{ Optional. Default arguments and form fields to override. @type array $fields { Default comment fields, filterable by default via the {@see 'comment_form_default_fields'} hook. @type string $author Comment author field HTML. @type string $email Comment author email field HTML. @type string $url Comment author URL field HTML. @type string $cookies Comment cookie opt-in field HTML. } @type string $comment_field The comment textarea field HTML. @type string $must_log_in HTML element for a 'must be logged in to comment' message. @type string $logged_in_as HTML element for a 'logged in as [user]' message. @type string $comment_notes_before HTML element for a message displayed before the comment fields if the user is not logged in. Default 'Your email address will not be published.'. @type string $comment_notes_after HTML element for a message displayed after the textarea field. @type string $action The comment form element action attribute. Default '/wp-comments-post.php'. @type string $id_form The comment form element id attribute. Default 'commentform'. @type string $id_submit The comment submit element id attribute. Default 'submit'. @type string $class_form The comment form element class attribute. Default 'comment-form'. @type string $class_submit The comment submit element class attribute. Default 'submit'. @type string $name_submit The comment submit element name attribute. Default 'submit'. @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'. @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s', where %s is the author of the comment being replied to. @type string $title_reply_before HTML displayed before the comment form title. Default: '<h3 id=\"reply-title\" class=\"comment-reply-title\">'. @type string $title_reply_after HTML displayed after the comment form title. Default: '</h3>'. @type string $cancel_reply_before HTML displayed before the cancel reply link. @type string $cancel_reply_after HTML displayed after the cancel reply link. @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'. @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'. @type string $submit_button HTML format for the Submit button. Default: '<input name=\"%1$s\" type=\"submit\" id=\"%2$s\" class=\"%3$s\" value=\"%4$s\" />'. @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden fields. Default: '<p class=\"form-submit\">%1$s %2$s</p>', where %1$s is the submit button markup and %2$s is the comment hidden fields. @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'. }","types":"array","variable":"$args","default":"array()","required":"no"},{"content":"Post ID or WP_Post object to generate the form for. Default current post.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"no"}]},{"name":"check_comment","desc":"<p>If manual comment moderation is set in the administration, then all checks, regardless of their type and whitelist, will fail and the function will return false.</p> <p>If the number of links exceeds the amount in the administration, then the check fails. If any of the parameter contents match the blacklist of words, then the check fails.</p> <p>If the comment author was approved before, then the comment is automatically whitelisted.</p> <p>If all checks pass, the function will return true.</p>","summary":"Check whether a comment passes internal checks to be allowed to add.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"Comment author name.","types":"string","variable":"$author","default":"null","required":"yes"},{"content":"Comment author email.","types":"string","variable":"$email","default":"null","required":"yes"},{"content":"Comment author URL.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"Content of the comment.","types":"string","variable":"$comment","default":"null","required":"yes"},{"content":"Comment author IP address.","types":"string","variable":"$user_ip","default":"null","required":"yes"},{"content":"Comment author User-Agent.","types":"string","variable":"$user_agent","default":"null","required":"yes"},{"content":"Comment type, either user-submitted comment, trackback, or pingback.","types":"string","variable":"$comment_type","default":"null","required":"yes"}],"return":{"content":"If all checks pass, true, otherwise false.","types":"bool"}},{"name":"get_approved_comments","desc":"","summary":"Retrieve the approved comments for post $post_id.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":"The ID of the post.","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":" See WP_Comment_Query::__construct() for information on accepted arguments.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"$comments The approved comments, or number of comments if <code>$count</code> argument is true.","types":"int|array"}},{"name":"get_comment","desc":"<p>If an object is passed then the comment data will be cached and then returned after being passed through a filter. If the comment is empty, then the global comment variable will be used, if it is set.</p>","summary":"Retrieves comment data given a comment ID or comment object.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"Comment to retrieve.","types":"WP_Comment|string|int","variable":"$comment","default":"null","required":"no"},{"content":" The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Comment object, an associative array, or a numeric array, respectively. Default OBJECT.","types":"string","variable":"$output","default":"OBJECT","required":"no"}],"return":{"content":"Depends on $output value.","types":"WP_Comment|array|null"}},{"name":"get_comments","desc":"<p>The comment list can be for the blog as a whole or for an individual post.</p>","summary":"Retrieve a list of comments.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Array or string of arguments. See WP_Comment_Query::__construct() for information on accepted arguments. Default empty.","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"List of comments or number of found comments if <code>$count</code> argument is true.","types":"int|array"}},{"name":"get_comment_statuses","desc":"<p>Comments have a limited set of valid status values, this provides the comment status values and descriptions.</p>","summary":"Retrieve all of the WordPress supported comment statuses.","type":"function","category":"Uncategorised","since":"2.7.0","return":{"content":"List of comment statuses.","types":"array"}},{"name":"get_default_comment_status","desc":"","summary":"Gets the default comment status for a post type.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":" Post type. Default 'post'.","types":"string","variable":"$post_type","default":"'post'","required":"no"},{"content":" Comment type. Default 'comment'.","types":"string","variable":"$comment_type","default":"'comment'","required":"no"}],"return":{"content":"Expected return value is 'open' or 'closed'.","types":"string"}},{"name":"get_lastcommentmodified","desc":"","summary":"The date the last comment was modified.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Which timezone to use in reference to 'gmt', 'blog', or 'server' locations.","types":"string","variable":"$timezone","default":"'server'","required":"no"}],"return":{"content":"Last comment modified date on success, false on failure.","types":"string|false"}},{"name":"get_comment_count","desc":"<p>A lot like wp_count_comments(), in that they both return comment stats (albeit with different types). The wp_count_comments() actually caches, but this function does not.</p>","summary":"The amount of comments in a post or total comments.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":" Comment amount in post if > 0, else total comments blog wide.","types":"int","variable":"$post_id","default":"0","required":"no"}],"return":{"content":"The amount of spam, approved, awaiting moderation, and total comments.","types":"array"}},{"name":"add_comment_meta","desc":"","summary":"Add meta data field to a comment.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID.","types":"int","variable":"$comment_id","default":"null","required":"yes"},{"content":"Metadata name.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":" default is false. Whether the same key should not be added.","types":"bool","variable":"$unique","default":"false","required":"no"}],"return":{"content":"Meta ID on success, false on failure.","types":"int|bool"}},{"name":"delete_comment_meta","desc":"<p>You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.</p>","summary":"Remove metadata matching criteria from a comment.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"comment ID","types":"int","variable":"$comment_id","default":"null","required":"yes"},{"content":"Metadata name.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":" Metadata value.","types":"mixed","variable":"$meta_value","default":"''","required":"no"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"get_comment_meta","desc":"","summary":"Retrieve comment meta field for a comment.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID.","types":"int","variable":"$comment_id","default":"null","required":"yes"},{"content":" The meta key to retrieve. By default, returns data for all keys.","types":"string","variable":"$key","default":"''","required":"no"},{"content":"Whether to return a single value.","types":"bool","variable":"$single","default":"false","required":"no"}],"return":{"content":"Will be an array if $single is false. Will be value of meta data field if $single is true.","types":"mixed"}},{"name":"update_comment_meta","desc":"<p>Use the $prev_value parameter to differentiate between meta fields with the same key and comment ID.</p> <p>If the meta field for the comment does not exist, it will be added.</p>","summary":"Update comment meta field based on comment ID.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID.","types":"int","variable":"$comment_id","default":"null","required":"yes"},{"content":"Metadata key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":" Previous value to check before removing.","types":"mixed","variable":"$prev_value","default":"''","required":"no"}],"return":{"content":"Meta ID if the key didn't exist, true on successful update, false on failure.","types":"int|bool"}},{"name":"wp_queue_comments_for_comment_meta_lazyload","desc":"","summary":"Queues comments for metadata lazy-loading.","type":"function","category":"Uncategorised","since":"4.5.0","param":[{"content":"Array of comment objects.","types":"WP_Comment[]","variable":"$comments","default":"null","required":"yes"}]},{"name":"wp_set_comment_cookies","desc":"","summary":"Sets the cookies used to store an unauthenticated commentator's identity. Typically used to recall previous comments by this commentator that are still held in moderation.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"Comment object.","types":"WP_Comment","variable":"$comment","default":"null","required":"yes"},{"content":"Comment author's user object. The user may not exist.","types":"WP_User","variable":"$user","default":"null","required":"yes"},{"content":" Comment author's consent to store cookies. Default true.","types":"boolean","variable":"$cookies_consent","default":"true","required":"no"}]},{"name":"sanitize_comment_cookies","desc":"<p>Will only do anything if the cookies have already been created for the user. Mostly used after cookies had been sent to use elsewhere.</p>","summary":"Sanitizes the cookies sent to the user already.","type":"function","category":"Uncategorised","since":"2.0.4"},{"name":"wp_allow_comment","desc":"","summary":"Validates whether this comment is allowed to be made.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Contains information on the comment.","types":"array","variable":"$commentdata","default":"null","required":"yes"},{"content":"When true, a disallowed comment will result in the function returning a WP_Error object, rather than executing wp_die(). Default false.","types":"bool","variable":"$avoid_die","default":"false","required":"no"}],"return":{"content":"Allowed comments return the approval status (0|1|'spam'). If <code>$avoid_die</code> is true, disallowed comments return a WP_Error.","types":"int|string|WP_Error"}},{"name":"check_comment_flood_db","desc":"<p>This wrapper maintains backward compatibility with plugins that expect to be able to unhook the legacy check_comment_flood_db() function from 'check_comment_flood' using remove_action().</p>","summary":"Hooks WP's native database-based comment-flood check.","type":"function","category":"Uncategorised","since":"4.7.0"},{"name":"wp_check_comment_flood","desc":"<p>Won't run, if current user can manage options, so to not block administrators.</p>","summary":"Checks whether comment flooding is occurring.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Is a comment flooding occurring?","types":"bool","variable":"$is_flood","default":"null","required":"yes"},{"content":"Comment author's IP address.","types":"string","variable":"$ip","default":"null","required":"yes"},{"content":"Comment author's email address.","types":"string","variable":"$email","default":"null","required":"yes"},{"content":"MySQL time string.","types":"string","variable":"$date","default":"null","required":"yes"},{"content":"When true, a disallowed comment will result in the function returning a WP_Error object, rather than executing wp_die(). Default false.","types":"bool","variable":"$avoid_die","default":"false","required":"no"}],"return":{"content":"Whether comment flooding is occurring.","types":"bool"}},{"name":"separate_comments","desc":"","summary":"Separates an array of comments into an array keyed by comment_type.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Array of comments","types":"WP_Comment[]","variable":"$comments","default":"null","required":"yes"}],"return":{"content":"Array of comments keyed by comment_type.","types":"WP_Comment[]"}},{"name":"get_comment_pages_count","desc":"","summary":"Calculate the total number of comment pages.","type":"function","category":"Comments Pagination","since":"2.7.0","param":[{"content":" Array of WP_Comment objects. Defaults to $wp_query->comments.","types":"WP_Comment[]","variable":"$comments","default":"null","required":"no"},{"content":" Comments per page.","types":"int","variable":"$per_page","default":"null","required":"no"},{"content":" Control over flat or threaded comments.","types":"bool","variable":"$threaded","default":"null","required":"no"}],"return":{"content":"Number of comment pages.","types":"int"}},{"name":"get_page_of_comment","desc":"","summary":"Calculate what page number a comment will appear on for comment paging.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Comment ID.","types":"int","variable":"$comment_ID","default":"null","required":"yes"},{"content":"{ Array of optional arguments. @type string $type Limit paginated comments to those matching a given type. Accepts 'comment', 'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'. Default is 'all'. @type int $per_page Per-page count to use when calculating pagination. Defaults to the value of the 'comments_per_page' option. @type int|string $max_depth If greater than 1, comment page will be determined for the top-level parent of <code>$comment_ID</code>. Defaults to the value of the 'thread_comments_depth' option. } *","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Comment page number or null on error.","types":"int|null"}},{"name":"wp_get_comment_fields_max_lengths","desc":"","summary":"Retrieves the maximum character lengths for the comment form fields.","type":"function","category":"Uncategorised","since":"4.5.0","return":{"content":"Maximum character length for the comment form fields.","types":"array"}},{"name":"wp_check_comment_data_max_lengths","desc":"","summary":"Compares the lengths of comment data against the maximum character limits.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Array of arguments for inserting a comment.","types":"array","variable":"$comment_data","default":"null","required":"yes"}],"return":{"content":"WP_Error when a comment field exceeds the limit, otherwise true.","types":"WP_Error|true"}},{"name":"wp_blacklist_check","desc":"","summary":"Does comment contain blacklisted characters or words.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"The author of the comment","types":"string","variable":"$author","default":"null","required":"yes"},{"content":"The email of the comment","types":"string","variable":"$email","default":"null","required":"yes"},{"content":"The url used in the comment","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"The comment content","types":"string","variable":"$comment","default":"null","required":"yes"},{"content":"The comment author's IP address","types":"string","variable":"$user_ip","default":"null","required":"yes"},{"content":"The author's browser user agent","types":"string","variable":"$user_agent","default":"null","required":"yes"}],"return":{"content":"True if comment contains blacklisted content, false if comment does not","types":"bool"}},{"name":"wp_count_comments","desc":"<p>The properties of the returned object contain the 'moderated', 'approved', and spam comments for either the entire blog or single post. Those properties contain the amount of comments that match the status. The 'total_comments' property contains the integer of total comments.</p> <p>The comment stats are cached and then retrieved, if they already exist in the cache.</p>","summary":"Retrieve total comments for blog or single post.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Post ID.","types":"int","variable":"$post_id","default":"0","required":"no"}],"return":{"content":"Comment stats.","types":"object|array"}},{"name":"wp_delete_comment","desc":"<p>The comment is moved to trash instead of permanently deleted unless trash is disabled, item is already in the trash, or $force_delete is true.</p> <p>The post comment count will be updated if the comment was approved and has a post ID available.</p>","summary":"Trashes or deletes a comment.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"},{"content":"Whether to bypass trash and force deletion. Default is false.","types":"bool","variable":"$force_delete","default":"false","required":"no"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_trash_comment","desc":"<p>If trash is disabled, comment is permanently deleted.</p>","summary":"Moves a comment to the Trash","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_untrash_comment","desc":"","summary":"Removes a comment from the Trash","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_spam_comment","desc":"","summary":"Marks a comment as Spam","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_unspam_comment","desc":"","summary":"Removes a comment from the Spam","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_get_comment_status","desc":"","summary":"The status of a comment by ID.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Comment ID or WP_Comment object","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"}],"return":{"content":"Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure.","types":"false|string"}},{"name":"wp_transition_comment_status","desc":"<p>Calls hooks for comment status transitions. If the new comment status is not the same as the previous comment status, then two hooks will be ran, the first is {@see 'transition_comment<em>status'} with new status, old status, and comment data. The next action called is {@see comment</em>$old_status<em>to</em>$new_status'}. It has the comment data.</p> <p>The final action will run whether or not the comment statuses are the same. The action is named {@see 'comment_$new<em>status</em>$comment->comment_type'}.</p>","summary":"Call hooks for when a comment status transition occurs.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"New comment status.","types":"string","variable":"$new_status","default":"null","required":"yes"},{"content":"Previous comment status.","types":"string","variable":"$old_status","default":"null","required":"yes"},{"content":"Comment data.","types":"object","variable":"$comment","default":"null","required":"yes"}]},{"name":"_clear_modified_cache_on_transition_comment_status","desc":"<p>Deletes the lastcommentmodified cache key when a comment enters or leaves 'approved' status.</p>","summary":"Clear the lastcommentmodified cached value when a comment status is changed.","type":"function","category":"Uncategorised","since":"4.7.0","access":"private","param":[{"content":"The new comment status.","types":"string","variable":"$new_status","default":"null","required":"yes"},{"content":"The old comment status.","types":"string","variable":"$old_status","default":"null","required":"yes"}]},{"name":"wp_get_current_commenter","desc":"<p>Expects cookies content to already be sanitized. User of this function might wish to recheck the returned array for validity.</p>","summary":"Get current commenter's name, email, and URL.","type":"function","category":"Uncategorised","since":"2.0.4","return":{"content":"Comment author, email, url respectively.","types":"array"}},{"name":"wp_get_unapproved_comment_author_email","desc":"<p>Used to allow the commenter to see their pending comment.</p>","summary":"Get unapproved comment author's email.","type":"function","category":"Uncategorised","since":"5.1.0","return":{"content":"The unapproved comment author's email (when supplied).","types":"string"}},{"name":"wp_insert_comment","desc":"","summary":"Inserts a comment into the database.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"{ Array of arguments for inserting a new comment. @type string $comment_agent The HTTP user agent of the <code>$comment_author</code> when the comment was submitted. Default empty. @type int|string $comment_approved Whether the comment has been approved. Default 1. @type string $comment_author The name of the author of the comment. Default empty. @type string $comment_author_email The email address of the <code>$comment_author</code>. Default empty. @type string $comment_author_IP The IP address of the <code>$comment_author</code>. Default empty. @type string $comment_author_url The URL address of the <code>$comment_author</code>. Default empty. @type string $comment_content The content of the comment. Default empty. @type string $comment_date The date the comment was submitted. To set the date manually, <code>$comment_date_gmt</code> must also be specified. Default is the current time. @type string $comment_date_gmt The date the comment was submitted in the GMT timezone. Default is <code>$comment_date</code> in the site's GMT timezone. @type int $comment_karma The karma of the comment. Default 0. @type int $comment_parent ID of this comment's parent, if any. Default 0. @type int $comment_post_ID ID of the post that relates to the comment, if any. Default 0. @type string $comment_type Comment type. Default empty. @type array $comment_meta Optional. Array of key/value pairs to be stored in commentmeta for the new comment. @type int $user_id ID of the user who submitted the comment. Default 0. }","types":"array","variable":"$commentdata","default":"null","required":"yes"}],"return":{"content":"The new comment's ID on success, false on failure.","types":"int|false"}},{"name":"wp_filter_comment","desc":"<p>Sets the comment data 'filtered' field to true when finished. This can be checked as to whether the comment should be filtered and to keep from filtering the same comment more than once.</p>","summary":"Filters and sanitizes comment data.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"Contains information on the comment.","types":"array","variable":"$commentdata","default":"null","required":"yes"}],"return":{"content":"Parsed comment information.","types":"array"}},{"name":"wp_throttle_comment_flood","desc":"","summary":"Whether a comment should be blocked because of comment flood.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"Whether plugin has already blocked comment.","types":"bool","variable":"$block","default":"null","required":"yes"},{"content":"Timestamp for last comment.","types":"int","variable":"$time_lastcomment","default":"null","required":"yes"},{"content":"Timestamp for new comment.","types":"int","variable":"$time_newcomment","default":"null","required":"yes"}],"return":{"content":"Whether comment should be blocked.","types":"bool"}},{"name":"wp_new_comment","desc":"<p>Filters new comment to ensure that the fields are sanitized and valid before inserting comment into database. Calls {@see 'comment_post'} action with comment ID and whether comment is approved by WordPress. Also has {@see 'preprocess_comment'} filter for processing the comment data before the function handles it.</p> <p>We use <code>REMOTE_ADDR</code> here directly. If you are behind a proxy, you should ensure that it is properly set, such as in wp-config.php, for your environment.</p> <p>See {@link <a href=\"https://core.trac.wordpress.org/ticket/9235\">https://core.trac.wordpress.org/ticket/9235</a>}</p>","summary":"Adds a new comment to the database.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"{ Comment data. @type string $comment_author The name of the comment author. @type string $comment_author_email The comment author email address. @type string $comment_author_url The comment author URL. @type string $comment_content The content of the comment. @type string $comment_date The date the comment was submitted. Default is the current time. @type string $comment_date_gmt The date the comment was submitted in the GMT timezone. Default is <code>$comment_date</code> in the GMT timezone. @type int $comment_parent The ID of this comment's parent, if any. Default 0. @type int $comment_post_ID The ID of the post that relates to the comment. @type int $user_id The ID of the user who submitted the comment. Default 0. @type int $user_ID Kept for backward-compatibility. Use <code>$user_id</code> instead. @type string $comment_agent Comment author user agent. Default is the value of 'HTTP_USER_AGENT' in the <code>$_SERVER</code> superglobal sent in the original request. @type string $comment_author_IP Comment author IP address in IPv4 format. Default is the value of 'REMOTE_ADDR' in the <code>$_SERVER</code> superglobal sent in the original request. }","types":"array","variable":"$commentdata","default":"null","required":"yes"},{"content":"Should errors be returned as WP_Error objects instead of executing wp_die()? Default false.","types":"bool","variable":"$avoid_die","default":"false","required":"no"}],"return":{"content":"The ID of the comment on success, false or WP_Error on failure.","types":"int|false|WP_Error"}},{"name":"wp_new_comment_notify_moderator","desc":"","summary":"Send a comment moderation notification to the comment moderator.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"ID of the comment.","types":"int","variable":"$comment_ID","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_new_comment_notify_postauthor","desc":"","summary":"Send a notification of a new comment to the post author.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Comment ID.","types":"int","variable":"$comment_ID","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_set_comment_status","desc":"<p>The {@see 'wp_set_comment_status'} action is called after the comment is handled. If the comment status is not in the list, then false is returned.</p>","summary":"Sets the status of a comment.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"yes"},{"content":"New comment status, either 'hold', 'approve', 'spam', or 'trash'.","types":"string","variable":"$comment_status","default":"null","required":"yes"},{"content":"Whether to return a WP_Error object if there is a failure. Default is false.","types":"bool","variable":"$wp_error","default":"false","required":"no"}],"return":{"content":"True on success, false or WP_Error on failure.","types":"bool|WP_Error"}},{"name":"wp_update_comment","desc":"<p>Filters the comment and makes sure certain fields are valid before updating.</p>","summary":"Updates an existing comment in the database.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"Contains information on the comment.","types":"array","variable":"$commentarr","default":"null","required":"yes"}],"return":{"content":"Comment was updated if value is 1, or was not updated if value is 0.","types":"int"}},{"name":"wp_defer_comment_counting","desc":"<p>When setting $defer to true, all post comment counts will not be updated until $defer is set to false. When $defer is set to false, then all previously deferred updated post comment counts will then be automatically updated without having to call wp_update_comment_count() after.</p>","summary":"Whether to defer comment counting.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"","types":"bool","variable":"$defer","default":"null","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"wp_update_comment_count","desc":"<p>When $do_deferred is false (is by default) and the comments have been set to be deferred, the post_id will be added to a queue, which will be updated at a later date and only updated once per post ID.</p> <p>If the comments have not be set up to be deferred, then the post will be updated. When $do_deferred is set to true, then all previous deferred post IDs will be updated along with the current $post_id.</p>","summary":"Updates the comment count for post(s).","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"Post ID.","types":"int|null","variable":"$post_id","default":"null","required":"yes"},{"content":" Whether to process previously deferred post comment counts. Default false.","types":"bool","variable":"$do_deferred","default":"false","required":"no"}],"return":{"content":"True on success, false on failure or if post with ID does not exist.","types":"bool|void"}},{"name":"wp_update_comment_count_now","desc":"","summary":"Updates the comment count for the post.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Post ID","types":"int","variable":"$post_id","default":"null","required":"yes"}],"return":{"content":"True on success, false on '0' $post_id or if post with ID does not exist.","types":"bool"}},{"name":"discover_pingback_server_uri","desc":"<p>Checks the HTML for the rel="pingback" link and x-pingback headers. It does a check for the x-pingback headers first and returns that, if available. The check for the rel="pingback" has more overhead than just the header.</p>","summary":"Finds a pingback server URI based on the given URL.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"URL to ping.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"Not Used.","types":"int","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"False on failure, string containing URI on success.","types":"false|string"}},{"name":"do_all_pings","desc":"","summary":"Perform all pingbacks, enclosures, trackbacks, and send to pingback services.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"do_trackbacks","desc":"","summary":"Perform trackbacks.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Post object or ID to do trackbacks on.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"yes"}]},{"name":"generic_ping","desc":"","summary":"Sends pings to all of the ping site services.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"Post ID.","types":"int","variable":"$post_id","default":"0","required":"yes"}],"return":{"content":"Same as Post ID from parameter","types":"int"}},{"name":"pingback","desc":"","summary":"Pings back the links found in a post.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Post content to check for links. If empty will retrieve from post.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"Post Object or ID.","types":"int|WP_Post","variable":"$post_id","default":"null","required":"yes"}]},{"name":"privacy_ping_filter","desc":"","summary":"Check whether blog is public before returning sites.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"Will return if blog is public, will not return if not public.","types":"mixed","variable":"$sites","default":"null","required":"yes"}],"return":{"content":"Empty string if blog is not public, returns $sites, if site is public.","types":"mixed"}},{"name":"trackback","desc":"<p>Updates database when sending trackback to prevent duplicates.</p>","summary":"Send a Trackback.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"URL to send trackbacks.","types":"string","variable":"$trackback_url","default":"null","required":"yes"},{"content":"Title of post.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":"Excerpt of post.","types":"string","variable":"$excerpt","default":"null","required":"yes"},{"content":"Post ID.","types":"int","variable":"$ID","default":"null","required":"yes"}],"return":{"content":"Database query from update.","types":"int|false|void"}},{"name":"weblog_ping","desc":"","summary":"Send a pingback.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"Host of blog to connect to.","types":"string","variable":"$server","default":"''","required":"no"},{"content":"Path to send the ping.","types":"string","variable":"$path","default":"''","required":"no"}]},{"name":"pingback_ping_source_uri","desc":"","summary":"Default filter attached to pingback_ping_source_uri to validate the pingback's Source URI","type":"function","category":"Uncategorised","since":"3.5.1","param":[{"content":"","types":"string","variable":"$source_uri","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"xmlrpc_pingback_error","desc":"<p>Returns a generic pingback error code unless the error code is 48, which reports that the pingback is already registered.</p>","summary":"Default filter attached to xmlrpc_pingback_error.","type":"function","category":"Uncategorised","since":"3.5.1","param":[{"content":"","types":"IXR_Error","variable":"$ixr_error","default":"null","required":"yes"}],"return":{"content":"","types":"IXR_Error"}},{"name":"clean_comment_cache","desc":"","summary":"Removes a comment from the object cache.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Comment ID or an array of comment IDs to remove from cache.","types":"int|array","variable":"$ids","default":"null","required":"yes"}]},{"name":"update_comment_cache","desc":"<p>Will add the comments in $comments to the cache. If comment ID already exists in the comment cache then it will not be updated. The comment is added to the cache using the comment group with the key using the ID of the comments.</p>","summary":"Updates the comment cache of given comments.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Array of comment objects","types":"WP_Comment[]","variable":"$comments","default":"null","required":"yes"},{"content":"Whether to update commentmeta cache. Default true.","types":"bool","variable":"$update_meta_cache","default":"true","required":"no"}]},{"name":"_prime_comment_caches","desc":"","summary":"Adds any comments from the given IDs to the cache that do not already exist in cache.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private","param":[{"content":"Array of comment IDs.","types":"int[]","variable":"$comment_ids","default":"null","required":"yes"},{"content":" Whether to update the meta cache. Default true.","types":"bool","variable":"$update_meta_cache","default":"true","required":"no"}]},{"name":"_close_comments_for_old_posts","desc":"","summary":"Close comments on old posts on the fly, without any extra DB queries. Hooked to the_posts.","type":"function","category":"Uncategorised","access":"private","since":"2.7.0","param":[{"content":"Post data object.","types":"WP_Post","variable":"$posts","default":"null","required":"yes"},{"content":"Query object.","types":"WP_Query","variable":"$query","default":"null","required":"yes"}],"return":{"content":"","types":"array"}},{"name":"_close_comments_for_old_post","desc":"","summary":"Close comments on an old post. Hooked to comments_open and pings_open.","type":"function","category":"Uncategorised","access":"private","since":"2.7.0","param":[{"content":"Comments open or closed","types":"bool","variable":"$open","default":"null","required":"yes"},{"content":"Post ID","types":"int","variable":"$post_id","default":"null","required":"yes"}],"return":{"content":"$open","types":"bool"}},{"name":"wp_handle_comment_submission","desc":"<p>This function expects unslashed data, as opposed to functions such as <code>wp_new_comment()</code> which expect slashed data.</p>","summary":"Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"{ Comment data. @type string|int $comment_post_ID The ID of the post that relates to the comment. @type string $author The name of the comment author. @type string $email The comment author email address. @type string $url The comment author URL. @type string $comment The content of the comment. @type string|int $comment_parent The ID of this comment's parent, if any. Default 0. @type string $_wp_unfiltered_html_comment The nonce value for allowing unfiltered HTML. }","types":"array","variable":"$comment_data","default":"null","required":"yes"}],"return":{"content":"A WP_Comment object on success, a WP_Error object on failure.","types":"WP_Comment|WP_Error"}},{"name":"wp_register_comment_personal_data_exporter","desc":"","summary":"Registers the personal data exporter for comments.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"An array of personal data exporters.","types":"array","variable":"$exporters","default":"null","required":"yes"}],"return":{"content":"$exporters An array of personal data exporters.","types":"array"}},{"name":"wp_comments_personal_data_exporter","desc":"","summary":"Finds and exports personal data associated with an email address from the comments table.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The comment author email address.","types":"string","variable":"$email_address","default":"null","required":"yes"},{"content":"Comment page.","types":"int","variable":"$page","default":"1","required":"no"}],"return":{"content":"$return An array of personal data.","types":"array"}},{"name":"wp_register_comment_personal_data_eraser","desc":"","summary":"Registers the personal data eraser for comments.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"An array of personal data erasers.","types":"array","variable":"$erasers","default":"null","required":"yes"}],"return":{"content":"$erasers An array of personal data erasers.","types":"array"}},{"name":"wp_comments_personal_data_eraser","desc":"","summary":"Erases personal data associated with an email address from the comments table.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The comment author email address.","types":"string","variable":"$email_address","default":"null","required":"yes"},{"content":"Comment page.","types":"int","variable":"$page","default":"1","required":"no"}],"return":{"content":"","types":"array"}},{"name":"wp_cache_set_comments_last_changed","desc":"","summary":"Sets the last changed time for the 'comment' cache group.","type":"function","category":"Uncategorised","since":"5.0.0"},{"name":"_","desc":"","summary":"","type":"function","category":"Uncategorised"},{"name":"_wp_can_use_pcre_u","desc":"","summary":"Returns whether PCRE/u (PCRE_UTF8 modifier) is available for use.","type":"function","category":"Uncategorised","since":"4.2.2","access":"private","param":[{"content":"- Used for testing only null : default - get PCRE/u capability false : Used for testing - return false for future calls to this function 'reset': Used for testing - restore default behavior of this function","types":"bool","variable":"$set","default":"null","required":"no"}]},{"name":"mb_substr","desc":"","summary":"Compat function to mimic mb_substr().","type":"function","category":"Uncategorised","since":"3.2.0","param":[{"content":"The string to extract the substring from.","types":"string","variable":"$str","default":"null","required":"yes"},{"content":"Position to being extraction from in <code>$str</code>.","types":"int","variable":"$start","default":"null","required":"yes"},{"content":" Maximum number of characters to extract from <code>$str</code>. Default null.","types":"int|null","variable":"$length","default":"null","required":"no"},{"content":" Character encoding to use. Default null.","types":"string|null","variable":"$encoding","default":"null","required":"no"}],"return":{"content":"Extracted substring.","types":"string"}},{"name":"_mb_substr","desc":"<p>Only understands UTF-8 and 8bit. All other character sets will be treated as 8bit. For $encoding === UTF-8, the $str input is expected to be a valid UTF-8 byte sequence. The behavior of this function for invalid inputs is undefined.</p>","summary":"Internal compat function to mimic mb_substr().","type":"function","category":"Uncategorised","since":"3.2.0","param":[{"content":"The string to extract the substring from.","types":"string","variable":"$str","default":"null","required":"yes"},{"content":"Position to being extraction from in <code>$str</code>.","types":"int","variable":"$start","default":"null","required":"yes"},{"content":" Maximum number of characters to extract from <code>$str</code>. Default null.","types":"int|null","variable":"$length","default":"null","required":"no"},{"content":" Character encoding to use. Default null.","types":"string|null","variable":"$encoding","default":"null","required":"no"}],"return":{"content":"Extracted substring.","types":"string"}},{"name":"mb_strlen","desc":"","summary":"Compat function to mimic mb_strlen().","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The string to retrieve the character length from.","types":"string","variable":"$str","default":"null","required":"yes"},{"content":" Character encoding to use. Default null.","types":"string|null","variable":"$encoding","default":"null","required":"no"}],"return":{"content":"String length of <code>$str</code>.","types":"int"}},{"name":"_mb_strlen","desc":"<p>Only understands UTF-8 and 8bit. All other character sets will be treated as 8bit. For $encoding === UTF-8, the <code>$str</code> input is expected to be a valid UTF-8 byte sequence. The behavior of this function for invalid inputs is undefined.</p>","summary":"Internal compat function to mimic mb_strlen().","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The string to retrieve the character length from.","types":"string","variable":"$str","default":"null","required":"yes"},{"content":" Character encoding to use. Default null.","types":"string|null","variable":"$encoding","default":"null","required":"no"}],"return":{"content":"String length of <code>$str</code>.","types":"int"}},{"name":"hash_hmac","desc":"","summary":"Compat function to mimic hash_hmac().","type":"function","category":"Uncategorised","since":"3.2.0","param":[{"content":"Hash algorithm. Accepts 'md5' or 'sha1'.","types":"string","variable":"$algo","default":"null","required":"yes"},{"content":"Data to be hashed.","types":"string","variable":"$data","default":"null","required":"yes"},{"content":"Secret key to use for generating the hash.","types":"string","variable":"$key","default":"null","required":"yes"},{"content":" Whether to output raw binary data (true), or lowercase hexits (false). Default false.","types":"bool","variable":"$raw_output","default":"false","required":"no"}],"return":{"content":"The hash in output determined by <code>$raw_output</code>. False if <code>$algo</code> is unknown or invalid.","types":"string|false"}},{"name":"_hash_hmac","desc":"","summary":"Internal compat function to mimic hash_hmac().","type":"function","category":"Uncategorised","since":"3.2.0","param":[{"content":"Hash algorithm. Accepts 'md5' or 'sha1'.","types":"string","variable":"$algo","default":"null","required":"yes"},{"content":"Data to be hashed.","types":"string","variable":"$data","default":"null","required":"yes"},{"content":"Secret key to use for generating the hash.","types":"string","variable":"$key","default":"null","required":"yes"},{"content":" Whether to output raw binary data (true), or lowercase hexits (false). Default false.","types":"bool","variable":"$raw_output","default":"false","required":"no"}],"return":{"content":"The hash in output determined by <code>$raw_output</code>. False if <code>$algo</code> is unknown or invalid.","types":"string|false"}},{"name":"json_encode","desc":"","summary":"","type":"function","category":"Uncategorised"},{"name":"json_decode","desc":"","summary":"","type":"function","category":"Uncategorised","param":[{"content":"","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"","types":"bool","variable":"$assoc_array","default":"false","required":"no"}],"return":{"content":"","types":"object|array"}},{"name":"_json_decode_object_helper","desc":"","summary":"","type":"function","category":"Uncategorised","param":[{"content":"","types":"object","variable":"$data","default":"null","required":"yes"}],"return":{"content":"","types":"array"}},{"name":"hash_equals","desc":"<p>Compares two strings using the same time whether they're equal or not.</p> <p>This function was added in PHP 5.6.</p> <p>Note: It can leak the length of a string when arguments of differing length are supplied.</p>","summary":"Timing attack safe string comparison","type":"function","category":"Uncategorised","since":"3.9.2","param":[{"content":"Expected string.","types":"string","variable":"$a","default":"null","required":"yes"},{"content":"Actual, user supplied, string.","types":"string","variable":"$b","default":"null","required":"yes"}],"return":{"content":"Whether strings are equal.","types":"bool"}},{"name":"json_last_error_msg","desc":"","summary":"Retrieves the error string of the last json_encode() or json_decode() call.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"Returns the error message on success, "No Error" if no error has occurred, or false on failure.","types":"bool|string"}},{"name":"array_replace_recursive","desc":"<p>The array_replace_recursive() function is a PHP 5.3 function. WordPress currently supports down to PHP 5.2, so this method is a workaround for PHP 5.2.</p> <p>Note: array_replace_recursive() supports infinite arguments, but for our use- case, we only need to support two arguments.</p> <p>Subject to removal once WordPress makes PHP 5.3.0 the minimum requirement.</p>","summary":"PHP-agnostic version of {@link array_replace_recursive()}.","type":"function","category":"Uncategorised","since":"4.5.3","param":[{"content":"Array with keys needing to be replaced.","types":"array","variable":"$base","default":"array()","required":"no"},{"content":"Array with the replaced keys.","types":"array","variable":"$replacements","default":"array()","required":"no"}],"return":{"content":"","types":"array"}},{"name":"is_countable","desc":"<p>Verify that the content of a variable is an array or an object implementing the Countable interface.</p>","summary":"Polyfill for is_countable() function added in PHP 7.3.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The value to check.","types":"mixed","variable":"$var","default":"null","required":"yes"}],"return":{"content":"True if <code>$var</code> is countable, false otherwise.","types":"bool"}},{"name":"is_iterable","desc":"<p>Verify that the content of a variable is an array or an object implementing the Traversable interface.</p>","summary":"Polyfill for is_iterable() function added in PHP 7.1.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The value to check.","types":"mixed","variable":"$var","default":"null","required":"yes"}],"return":{"content":"True if <code>$var</code> is iterable, false otherwise.","types":"bool"}},{"name":"wp_schedule_single_event","desc":"<p>Schedules a hook which will be triggered by WordPress at the specified time. The action will trigger when someone visits your WordPress site if the scheduled time has passed.</p> <p>Note that scheduling an event to occur within 10 minutes of an existing event with the same action hook will be ignored unless you pass unique <code>$args</code> values for each scheduled event.</p> <p>Use wp_next_scheduled() to prevent duplicate events.</p> <p>Use wp_schedule_event() to schedule a recurring event.</p>","summary":"Schedules an event to run only once.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":"Unix timestamp (UTC) for when to next run the event.","types":"int","variable":"$timestamp","default":"null","required":"yes"},{"content":"Action hook to execute when the event is run.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Array containing each separate argument to pass to the hook's callback function.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"True if event successfully scheduled. False for failure.","types":"bool"}},{"name":"wp_schedule_event","desc":"<p>Schedules a hook which will be triggered by WordPress at the specified interval. The action will trigger when someone visits your WordPress site if the scheduled time has passed.</p> <p>Valid values for the recurrence are 'hourly', 'daily', and 'twicedaily'. These can be extended using the {@see 'cron_schedules'} filter in wp_get_schedules().</p> <p>Note that scheduling an event to occur within 10 minutes of an existing event with the same action hook will be ignored unless you pass unique <code>$args</code> values for each scheduled event.</p> <p>Use wp_next_scheduled() to prevent duplicate events.</p> <p>Use wp_schedule_single_event() to schedule a non-recurring event.</p>","summary":"Schedules a recurring event.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":"Unix timestamp (UTC) for when to next run the event.","types":"int","variable":"$timestamp","default":"null","required":"yes"},{"content":"How often the event should subsequently recur. See wp_get_schedules() for accepted values.","types":"string","variable":"$recurrence","default":"null","required":"yes"},{"content":"Action hook to execute when the event is run.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Array containing each separate argument to pass to the hook's callback function.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"True if event successfully scheduled. False for failure.","types":"bool"}},{"name":"wp_reschedule_event","desc":"<p>Mainly for internal use, this takes the time stamp of a previously run recurring event and reschedules it for its next run.</p> <p>To change upcoming scheduled events, use wp_schedule_event() to change the recurrence frequency.</p>","summary":"Reschedules a recurring event.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":"Unix timestamp (UTC) for when the event was scheduled.","types":"int","variable":"$timestamp","default":"null","required":"yes"},{"content":"How often the event should subsequently recur. See wp_get_schedules() for accepted values.","types":"string","variable":"$recurrence","default":"null","required":"yes"},{"content":"Action hook to execute when the event is run.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Array containing each separate argument to pass to the hook's callback function.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"True if event successfully rescheduled. False for failure.","types":"bool"}},{"name":"wp_unschedule_event","desc":"<p>The $timestamp and $hook parameters are required so that the event can be identified.</p>","summary":"Unschedule a previously scheduled event.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":"Unix timestamp (UTC) of the event.","types":"int","variable":"$timestamp","default":"null","required":"yes"},{"content":"Action hook of the event.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Array containing each separate argument to pass to the hook's callback function. Although not passed to a callback, these arguments are used to uniquely identify the event, so they should be the same as those used when originally scheduling the event.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"True if event successfully unscheduled. False for failure.","types":"bool"}},{"name":"wp_clear_scheduled_hook","desc":"<p>Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. For information about casting to booleans see the {@link <a href=\"https://php.net/manual/en/language.types.boolean.php\">https://php.net/manual/en/language.types.boolean.php</a> PHP documentation}. Use the <code>===</code> operator for testing the return value of this function.</p>","summary":"Unschedules all events attached to the hook with the specified arguments.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":"Action hook, the execution of which will be unscheduled.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Arguments that were to be passed to the hook's callback function.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"On success an integer indicating number of events unscheduled (0 indicates no events were registered with the hook and arguments combination), false if unscheduling one or more events fail.","types":"bool|int"}},{"name":"wp_unschedule_hook","desc":"<p>Can be useful for plugins when deactivating to clean up the cron queue.</p> <p>Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. For information about casting to booleans see the {@link <a href=\"https://php.net/manual/en/language.types.boolean.php\">https://php.net/manual/en/language.types.boolean.php</a> PHP documentation}. Use the <code>===</code> operator for testing the return value of this function.</p>","summary":"Unschedules all events attached to the hook.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Action hook, the execution of which will be unscheduled.","types":"string","variable":"$hook","default":"null","required":"yes"}],"return":{"content":"On success an integer indicating number of events unscheduled (0 indicates no events were registered on the hook), false if unscheduling fails.","types":"bool|int"}},{"name":"wp_get_scheduled_event","desc":"<p>Retrieve the full event object for a given event, if no timestamp is specified the next scheduled event is returned.</p>","summary":"Retrieve a scheduled event.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Action hook of the event.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Array containing each separate argument to pass to the hook's callback function. Although not passed to a callback, these arguments are used to uniquely identify the event, so they should be the same as those used when originally scheduling the event.","types":"array","variable":"$args","default":"array()","required":"no"},{"content":" Unix timestamp (UTC) of the event. If not specified, the next scheduled event is returned.","types":"int|null","variable":"$timestamp","default":"null","required":"no"}],"return":{"content":"The event object. False if the event does not exist.","types":"bool|object"}},{"name":"wp_next_scheduled","desc":"","summary":"Retrieve the next timestamp for an event.","type":"function","category":"Cron (Scheduling)","since":"2.1.0","param":[{"content":"Action hook of the event.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Array containing each separate argument to pass to the hook's callback function. Although not passed to a callback, these arguments are used to uniquely identify the event, so they should be the same as those used when originally scheduling the event.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The Unix timestamp of the next time the event will occur. False if the event doesn't exist.","types":"false|int"}},{"name":"spawn_cron","desc":"","summary":"Sends a request to run cron through HTTP request that doesn't halt page loading.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":" Unix timestamp (UTC). Default 0 (current time is used).","types":"int","variable":"$gmt_time","default":"0","required":"no"}],"return":{"content":"True if spawned, false if no events spawned.","types":"bool"}},{"name":"wp_cron","desc":"<p>Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. For information about casting to booleans see the {@link <a href=\"https://php.net/manual/en/language.types.boolean.php\">https://php.net/manual/en/language.types.boolean.php</a> PHP documentation}. Use the <code>===</code> operator for testing the return value of this function.</p>","summary":"Run scheduled callbacks or spawn cron for all scheduled events.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","return":{"content":"On success an integer indicating number of events spawned (0 indicates no events needed to be spawned), false if spawning fails for one or more events.","types":"bool|int"}},{"name":"wp_get_schedules","desc":"<p>The default supported recurrences are 'hourly', 'twicedaily', and 'daily'. A plugin may add more by hooking into the {@see 'cron_schedules'} filter. The filter accepts an array of arrays. The outer array has a key that is the name of the schedule or for example 'weekly'. The value is an array with two keys, one is 'interval' and the other is 'display'.</p> <p>The 'interval' is a number in seconds of when the cron job should run. So for 'hourly', the time is 3600 or 60<em>60. For weekly, the value would be 60</em>60<em>24</em>7 or 604800. The value of 'interval' would then be 604800.</p> <p>The 'display' is the description. For the 'weekly' key, the 'display' would be <code>__( 'Once Weekly' )</code>.</p> <p>For your plugin, you will be passed an array. you can easily add your schedule by doing the following.</p> <pre><code>// Filter parameter variable name is 'array'.\n$array['weekly'] = array(\n 'interval' => 604800,\n 'display' => __( 'Once Weekly' )\n);</code></pre>","summary":"Retrieve supported event recurrence schedules.","type":"function","category":"Cron (Scheduling)","since":"2.1.0","return":{"content":"","types":"array"}},{"name":"wp_get_schedule","desc":"","summary":"Retrieve the recurrence schedule for an event.","type":"function","category":"Cron (Scheduling)","since":"5.1.0","param":[{"content":"Action hook to identify the event.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":" Arguments passed to the event's callback function.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"False, if no schedule. Schedule name on success.","types":"string|false"}},{"name":"wp_get_ready_cron_jobs","desc":"<p>Returns the results of _get_cron_array() limited to events ready to be run, ie, with a timestamp in the past.</p>","summary":"Retrieve cron jobs ready to be run.","type":"function","category":"Uncategorised","since":"5.1.0","return":{"content":"Cron jobs ready to be run.","types":"array"}},{"name":"_get_cron_array","desc":"","summary":"Retrieve cron info array option.","type":"function","category":"Uncategorised","since":"2.1.0","access":"private","return":{"content":"CRON info array.","types":"false|array"}},{"name":"_set_cron_array","desc":"","summary":"Updates the CRON option with the new CRON array.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","param":[{"content":"Cron info array from _get_cron_array().","types":"array","variable":"$cron","default":"null","required":"yes"}],"return":{"content":"True if cron array updated, false on failure.","types":"bool"}},{"name":"_upgrade_cron_array","desc":"<p>This function upgrades the Cron info array to version 2.</p>","summary":"Upgrade a Cron info array.","type":"function","category":"Uncategorised","since":"2.1.0","access":"private","param":[{"content":"Cron info array from _get_cron_array().","types":"array","variable":"$cron","default":"null","required":"yes"}],"return":{"content":"An upgraded Cron info array.","types":"array"}},{"name":"wp_initial_constants","desc":"","summary":"Defines initial WordPress constants","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_plugin_directory_constants","desc":"<p>Defines must-use plugin directory constants, which may be overridden in the sunrise.php drop-in</p>","summary":"Defines plugin directory WordPress constants","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_cookie_constants","desc":"<p>Defines constants after multisite is loaded.</p>","summary":"Defines cookie related WordPress constants","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_ssl_constants","desc":"","summary":"Defines SSL-related WordPress constants.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_functionality_constants","desc":"","summary":"Defines functionality related WordPress constants","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_templating_constants","desc":"","summary":"Defines templating related WordPress constants","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"get_postdata","desc":"","summary":"Retrieves all post data for a given post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"1.5.1","desc":"Use get_post()"},"param":[{"content":"Post ID.","types":"int","variable":"$postid","default":"null","required":"yes"}],"return":{"content":"Post data.","types":"array"}},{"name":"start_wp","desc":"<p>Use The Loop instead.</p>","summary":"Sets up the WordPress Loop.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"1.5.0","desc":"null"}},{"name":"the_category_ID","desc":"","summary":"Returns or prints a category ID.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"0.71","desc":"Use get_the_category()"},"param":[{"content":" Whether to echo the output. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"Category ID.","types":"int"}},{"name":"the_category_head","desc":"","summary":"Prints a category with optional text before and after.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"0.71","desc":"Use get_the_category_by_ID()"},"param":[{"content":" Text to display before the category. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Text to display after the category. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"previous_post","desc":"","summary":"Prints a link to the previous post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use previous_post_link()"},"param":[{"content":"","types":"string","variable":"$format","default":"'%'","required":"no"},{"content":"","types":"string","variable":"$previous","default":"'previous post: '","required":"no"},{"content":"","types":"string","variable":"$title","default":"'yes'","required":"no"},{"content":"","types":"string","variable":"$in_same_cat","default":"'no'","required":"no"},{"content":"","types":"int","variable":"$limitprev","default":"1","required":"no"},{"content":"","types":"string","variable":"$excluded_categories","default":"''","required":"no"}]},{"name":"next_post","desc":"","summary":"Prints link to the next post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.0.0","desc":"Use next_post_link()"},"param":[{"content":"","types":"string","variable":"$format","default":"'%'","required":"no"},{"content":"","types":"string","variable":"$next","default":"'next post: '","required":"no"},{"content":"","types":"string","variable":"$title","default":"'yes'","required":"no"},{"content":"","types":"string","variable":"$in_same_cat","default":"'no'","required":"no"},{"content":"","types":"int","variable":"$limitnext","default":"1","required":"no"},{"content":"","types":"string","variable":"$excluded_categories","default":"''","required":"no"}]},{"name":"user_can_create_post","desc":"","summary":"Whether user can create a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"},{"content":"Not Used","types":"int","variable":"$category_id","default":"'None'","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"user_can_create_draft","desc":"","summary":"Whether user can create a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"},{"content":"Not Used","types":"int","variable":"$category_id","default":"'None'","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"user_can_edit_post","desc":"","summary":"Whether user can edit a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"user_can_delete_post","desc":"","summary":"Whether user can delete a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"user_can_set_post_date","desc":"","summary":"Whether user can set new posts' dates.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"},{"content":"Not Used","types":"int","variable":"$category_id","default":"'None'","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"user_can_edit_post_date","desc":"","summary":"Whether user can delete a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"}],"return":{"content":"returns true if $user_id can edit $post_id's date","types":"bool"}},{"name":"user_can_edit_post_comments","desc":"","summary":"Whether user can delete a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"}],"return":{"content":"returns true if $user_id can edit $post_id's comments","types":"bool"}},{"name":"user_can_delete_post_comments","desc":"","summary":"Whether user can delete a post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":"Not Used","types":"int","variable":"$blog_id","default":"1","required":"no"}],"return":{"content":"returns true if $user_id can delete $post_id's comments","types":"bool"}},{"name":"user_can_edit_user","desc":"","summary":"Can user can edit other user.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.0.0","desc":"Use current_user_can()"},"param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$other_user","default":"null","required":"yes"}],"return":{"content":"","types":"bool"}},{"name":"get_linksbyname","desc":"","summary":"Gets the links associated with category $cat_name.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use get_bookmarks()"},"param":[{"content":" The category name to use. If no match is found uses all.","types":"string","variable":"$cat_name","default":"\"noname\"","required":"no"},{"content":" The html to output before the link.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" The html to output after the link.","types":"string","variable":"$after","default":"'<br />'","required":"no"},{"content":" The html to output between the link/image and its description. Not used if no image or $show_images is true.","types":"string","variable":"$between","default":"\" \"","required":"no"},{"content":" Whether to show images (if defined).","types":"bool","variable":"$show_images","default":"true","required":"no"},{"content":" The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner. \tIf 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 \trandom order.","types":"string","variable":"$orderby","default":"'id'","required":"no"},{"content":" Whether to show the description if show_images=false/not defined.","types":"bool","variable":"$show_description","default":"true","required":"no"},{"content":" Show rating stars/chars.","types":"bool","variable":"$show_rating","default":"false","required":"no"},{"content":" Limit to X entries. If not specified, all entries are shown.","types":"int","variable":"$limit","default":"-1","required":"no"},{"content":" Whether to show last updated timestamp","types":"int","variable":"$show_updated","default":"0","required":"no"}]},{"name":"wp_get_linksbyname","desc":"","summary":"Gets the links associated with the named category.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use wp_list_bookmarks()"},"param":[{"content":"The category to use.","types":"string","variable":"$category","default":"null","required":"yes"},{"content":"","types":"string","variable":"$args","default":"''","required":"no"}],"return":{"content":"","types":"string|null"}},{"name":"get_linkobjectsbyname","desc":"<p>$links = get_linkobjectsbyname( 'fred' ); foreach ( $links as $link ) { echo '<li>' . $link->link_name . '</li>'; }</p>","summary":"Gets an array of link objects associated with category $cat_name.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use get_bookmarks()"},"param":[{"content":"The category name to use. If no match is found uses all.","types":"string","variable":"$cat_name","default":"\"noname\"","required":"no"},{"content":"The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'. \tOr maybe owner. If you start the name with an underscore the order will be reversed. You can also \tspecify 'rand' as the order which will return links in a random order.","types":"string","variable":"$orderby","default":"'name'","required":"no"},{"content":"Limit to X entries. If not specified, all entries are shown.","types":"int","variable":"$limit","default":"-1","required":"no"}],"return":{"content":"","types":"array"}},{"name":"get_linkobjects","desc":"<p>Usage:</p> <pre><code>$links = get_linkobjects(1);\nif ($links) {\n foreach ($links as $link) {\n echo '<li>'.$link->link_name.'<br />'.$link->link_description.'</li>';\n }\n}</code></pre> <p>Fields are:</p> <ul> <li>link_id</li> <li>link_url</li> <li>link_name</li> <li>link_image</li> <li>link_target</li> <li>link_category</li> <li>link_description</li> <li>link_visible</li> <li>link_owner</li> <li>link_rating</li> <li>link_updated</li> <li>link_rel</li> <li>link_notes</li> </ul>","summary":"Gets an array of link objects associated with category n.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use get_bookmarks()"},"param":[{"content":"The category to use. If no category supplied uses all","types":"int","variable":"$category","default":"0","required":"yes"},{"content":"the order to output the links. E.g. 'id', 'name', 'url', \t'description', or 'rating'. Or maybe owner. If you start the name with an \tunderscore the order will be reversed. You can also specify 'rand' as the \torder which will return links in a random order.","types":"string","variable":"$orderby","default":"'name'","required":"no"},{"content":"Limit to X entries. If not specified, all entries are shown.","types":"int","variable":"$limit","default":"0","required":"yes"}],"return":{"content":"","types":"array"}},{"name":"get_linksbyname_withrating","desc":"","summary":"Gets the links associated with category 'cat_name' and display rating stars/chars.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use get_bookmarks()"},"param":[{"content":"The category name to use. If no match is found uses all","types":"string","variable":"$cat_name","default":"\"noname\"","required":"no"},{"content":"The html to output before the link","types":"string","variable":"$before","default":"''","required":"no"},{"content":"The html to output after the link","types":"string","variable":"$after","default":"'<br />'","required":"no"},{"content":"The html to output between the link/image and its description. Not used if no image or show_images is true","types":"string","variable":"$between","default":"\" \"","required":"no"},{"content":"Whether to show images (if defined).","types":"bool","variable":"$show_images","default":"true","required":"no"},{"content":"the order to output the links. E.g. 'id', 'name', 'url', \t'description', or 'rating'. Or maybe owner. If you start the name with an \tunderscore the order will be reversed. You can also specify 'rand' as the \torder which will return links in a random order.","types":"string","variable":"$orderby","default":"'id'","required":"no"},{"content":"Whether to show the description if show_images=false/not defined","types":"bool","variable":"$show_description","default":"true","required":"no"},{"content":"Limit to X entries. If not specified, all entries are shown.","types":"int","variable":"$limit","default":"-1","required":"no"},{"content":"Whether to show last updated timestamp","types":"int","variable":"$show_updated","default":"0","required":"yes"}]},{"name":"get_links_withrating","desc":"","summary":"Gets the links associated with category n and display rating stars/chars.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use get_bookmarks()"},"param":[{"content":"The category to use. If no category supplied uses all","types":"int","variable":"$category","default":"-1","required":"no"},{"content":"The html to output before the link","types":"string","variable":"$before","default":"''","required":"no"},{"content":"The html to output after the link","types":"string","variable":"$after","default":"'<br />'","required":"no"},{"content":"The html to output between the link/image and its description. Not used if no image or show_images == true","types":"string","variable":"$between","default":"\" \"","required":"no"},{"content":"Whether to show images (if defined).","types":"bool","variable":"$show_images","default":"true","required":"no"},{"content":"The order to output the links. E.g. 'id', 'name', 'url', \t'description', or 'rating'. Or maybe owner. If you start the name with an \tunderscore the order will be reversed. You can also specify 'rand' as the \torder which will return links in a random order.","types":"string","variable":"$orderby","default":"'id'","required":"no"},{"content":"Whether to show the description if show_images=false/not defined.","types":"bool","variable":"$show_description","default":"true","required":"no"},{"content":"Limit to X entries. If not specified, all entries are shown.","types":"int","variable":"$limit","default":"-1","required":"no"},{"content":"Whether to show last updated timestamp","types":"int","variable":"$show_updated","default":"0","required":"yes"}]},{"name":"get_autotoggle","desc":"","summary":"Gets the auto_toggle setting.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"null"},"param":[{"content":"The category to get. If no category supplied uses 0","types":"int","variable":"$id","default":"0","required":"yes"}],"return":{"content":"Only returns 0.","types":"int"}},{"name":"list_cats","desc":"","summary":"Lists categories.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use wp_list_categories()"},"param":[{"content":"","types":"int","variable":"$optionall","default":"1","required":"no"},{"content":"","types":"string","variable":"$all","default":"'All'","required":"no"},{"content":"","types":"string","variable":"$sort_column","default":"'ID'","required":"no"},{"content":"","types":"string","variable":"$sort_order","default":"'asc'","required":"no"},{"content":"","types":"string","variable":"$file","default":"''","required":"no"},{"content":"","types":"bool","variable":"$list","default":"true","required":"no"},{"content":"","types":"int","variable":"$optiondates","default":"0","required":"yes"},{"content":"","types":"int","variable":"$optioncount","default":"0","required":"yes"},{"content":"","types":"int","variable":"$hide_empty","default":"1","required":"no"},{"content":"","types":"int","variable":"$use_desc_for_title","default":"1","required":"no"},{"content":"","types":"bool","variable":"$children","default":"false","required":"no"},{"content":"","types":"int","variable":"$child_of","default":"0","required":"yes"},{"content":"","types":"int","variable":"$categories","default":"0","required":"yes"},{"content":"","types":"int","variable":"$recurse","default":"0","required":"yes"},{"content":"","types":"string","variable":"$feed","default":"''","required":"no"},{"content":"","types":"string","variable":"$feed_image","default":"''","required":"no"},{"content":"","types":"string","variable":"$exclude","default":"''","required":"no"},{"content":"","types":"bool","variable":"$hierarchical","default":"false","required":"no"}],"return":{"content":"","types":"false|null"}},{"name":"wp_list_cats","desc":"","summary":"Lists categories.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.1.0","desc":"Use wp_list_categories()"},"param":[{"content":"","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"","types":"false|null|string"}},{"name":"dropdown_cats","desc":"","summary":"Deprecated method for generating a drop-down of categories.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use wp_dropdown_categories()"},"param":[{"content":"","types":"int","variable":"$optionall","default":"1","required":"no"},{"content":"","types":"string","variable":"$all","default":"'All'","required":"no"},{"content":"","types":"string","variable":"$orderby","default":"'ID'","required":"no"},{"content":"","types":"string","variable":"$order","default":"'asc'","required":"no"},{"content":"","types":"int","variable":"$show_last_update","default":"0","required":"yes"},{"content":"","types":"int","variable":"$show_count","default":"0","required":"yes"},{"content":"","types":"int","variable":"$hide_empty","default":"1","required":"no"},{"content":"","types":"bool","variable":"$optionnone","default":"false","required":"no"},{"content":"","types":"int","variable":"$selected","default":"0","required":"yes"},{"content":"","types":"int","variable":"$exclude","default":"0","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"list_authors","desc":"","summary":"Lists authors.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.1.0","desc":"Use wp_list_authors()"},"param":[{"content":"","types":"bool","variable":"$optioncount","default":"false","required":"no"},{"content":"","types":"bool","variable":"$exclude_admin","default":"true","required":"no"},{"content":"","types":"bool","variable":"$show_fullname","default":"false","required":"no"},{"content":"","types":"bool","variable":"$hide_empty","default":"true","required":"no"},{"content":"","types":"string","variable":"$feed","default":"''","required":"no"},{"content":"","types":"string","variable":"$feed_image","default":"''","required":"no"}],"return":{"content":"","types":"null|string"}},{"name":"wp_get_post_cats","desc":"","summary":"Retrieves a list of post categories.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use wp_get_post_categories()"},"param":[{"content":"Not Used","types":"int","variable":"$blogid","default":"'1'","required":"no"},{"content":"","types":"int","variable":"$post_ID","default":"0","required":"yes"}],"return":{"content":"","types":"array"}},{"name":"wp_set_post_cats","desc":"","summary":"Sets the categories that the post id belongs to.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"Use wp_set_post_categories()","desc":"Use wp_set_post_categories()"},"param":[{"content":"Not used","types":"int","variable":"$blogid","default":"'1'","required":"no"},{"content":"","types":"int","variable":"$post_ID","default":"0","required":"yes"},{"content":"","types":"array","variable":"$post_categories","default":"array()","required":"no"}],"return":{"content":"","types":"bool|mixed"}},{"name":"get_archives","desc":"","summary":"Retrieves a list of archives.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use wp_get_archives()"},"param":[{"content":"","types":"string","variable":"$type","default":"''","required":"no"},{"content":"","types":"string","variable":"$limit","default":"''","required":"no"},{"content":"","types":"string","variable":"$format","default":"'html'","required":"no"},{"content":"","types":"string","variable":"$before","default":"''","required":"no"},{"content":"","types":"string","variable":"$after","default":"''","required":"no"},{"content":"","types":"bool","variable":"$show_post_count","default":"false","required":"no"}],"return":{"content":"","types":"string|null"}},{"name":"get_author_link","desc":"","summary":"Returns or Prints link to the author's posts.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.1.0","desc":"Use get_author_posts_url()"},"param":[{"content":"","types":"bool","variable":"$echo","default":"null","required":"yes"},{"content":"","types":"int","variable":"$author_id","default":"null","required":"yes"},{"content":"","types":"string","variable":"$author_nicename","default":"''","required":"no"}],"return":{"content":"","types":"string|null"}},{"name":"link_pages","desc":"","summary":"Print list of pages based on arguments.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use wp_link_pages()"},"param":[{"content":"","types":"string","variable":"$before","default":"'<br />'","required":"no"},{"content":"","types":"string","variable":"$after","default":"'<br />'","required":"no"},{"content":"","types":"string","variable":"$next_or_number","default":"'number'","required":"no"},{"content":"","types":"string","variable":"$nextpagelink","default":"'next page'","required":"no"},{"content":"","types":"string","variable":"$previouspagelink","default":"'previous page'","required":"no"},{"content":"","types":"string","variable":"$pagelink","default":"'%'","required":"no"},{"content":"","types":"string","variable":"$more_file","default":"''","required":"no"}],"return":{"content":"","types":"string"}},{"name":"get_settings","desc":"","summary":"Get value based on option.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use get_option()"},"param":[{"content":"","types":"string","variable":"$option","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"permalink_link","desc":"","summary":"Print the permalink of the current post in the loop.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"1.2.0","desc":"Use the_permalink()"}},{"name":"permalink_single_rss","desc":"","summary":"Print the permalink to the RSS feed.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.3.0","desc":"Use the_permalink_rss()"},"param":[{"content":"","types":"string","variable":"$deprecated","default":"''","required":"no"}]},{"name":"wp_get_links","desc":"","summary":"Gets the links associated with category.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use wp_list_bookmarks()"},"param":[{"content":"a query string","types":"string","variable":"$args","default":"''","required":"no"}],"return":{"content":"","types":"null|string"}},{"name":"get_links","desc":"","summary":"Gets the links associated with category by id.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use get_bookmarks()"},"param":[{"content":"The category to use. If no category supplied uses all","types":"int","variable":"$category","default":"-1","required":"no"},{"content":"the html to output before the link","types":"string","variable":"$before","default":"''","required":"no"},{"content":"the html to output after the link","types":"string","variable":"$after","default":"'<br />'","required":"no"},{"content":"the html to output between the link/image and its description. \tNot used if no image or show_images == true","types":"string","variable":"$between","default":"' '","required":"no"},{"content":"whether to show images (if defined).","types":"bool","variable":"$show_images","default":"true","required":"no"},{"content":"the order to output the links. E.g. 'id', 'name', 'url', \t'description', or 'rating'. Or maybe owner. If you start the name with an \tunderscore the order will be reversed. You can also specify 'rand' as the order \twhich will return links in a random order.","types":"string","variable":"$orderby","default":"'name'","required":"no"},{"content":"whether to show the description if show_images=false/not defined.","types":"bool","variable":"$show_description","default":"true","required":"no"},{"content":"show rating stars/chars","types":"bool","variable":"$show_rating","default":"false","required":"no"},{"content":"Limit to X entries. If not specified, all entries are shown.","types":"int","variable":"$limit","default":"-1","required":"no"},{"content":"whether to show last updated timestamp","types":"int","variable":"$show_updated","default":"1","required":"no"},{"content":"whether to echo the results, or return them instead","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"","types":"null|string"}},{"name":"get_links_list","desc":"<p>Output a list of all links, listed by category, using the settings in $wpdb->linkcategories and output it as a nested HTML unordered list.</p>","summary":"Output entire list of links by category.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use wp_list_bookmarks()"},"param":[{"content":"Sort link categories by 'name' or 'id'","types":"string","variable":"$order","default":"'name'","required":"no"}]},{"name":"links_popup_script","desc":"","summary":"Show the link to the links popup and the number of links.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"null"},"param":[{"content":"the text of the link","types":"string","variable":"$text","default":"'Links'","required":"no"},{"content":"the width of the popup window","types":"int","variable":"$width","default":"400","required":"no"},{"content":"the height of the popup window","types":"int","variable":"$height","default":"400","required":"no"},{"content":"the page to open in the popup window","types":"string","variable":"$file","default":"'links.all.php'","required":"no"},{"content":"the number of links in the db","types":"bool","variable":"$count","default":"true","required":"no"}]},{"name":"get_linkrating","desc":"","summary":"Legacy function that retrieved the value of a link's link_rating field.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.1.0","desc":"Use sanitize_bookmark_field()"},"param":[{"content":"Link object.","types":"object","variable":"$link","default":"null","required":"yes"}],"return":{"content":"Value of the 'link_rating' field, false otherwise.","types":"mixed"}},{"name":"get_linkcatname","desc":"","summary":"Gets the name of category by id.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.1.0","desc":"Use get_category()"},"param":[{"content":"The category to get. If no category supplied uses 0","types":"int","variable":"$id","default":"0","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"comments_rss_link","desc":"","summary":"Print RSS comment feed link.","type":"function","category":"Uncategorised","since":"1.0.1","deprecated":{"content":"2.5.0","desc":"Use post_comments_feed_link()"},"param":[{"content":"","types":"string","variable":"$link_text","default":"'Comments RSS'","required":"no"}]},{"name":"get_category_rss_link","desc":"","summary":"Print/Return link to category RSS2 feed.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.5.0","desc":"Use get_category_feed_link()"},"param":[{"content":"","types":"bool","variable":"$echo","default":"false","required":"no"},{"content":"","types":"int","variable":"$cat_ID","default":"1","required":"no"}],"return":{"content":"","types":"string"}},{"name":"get_author_rss_link","desc":"","summary":"Print/Return link to author RSS feed.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.5.0","desc":"Use get_author_feed_link()"},"param":[{"content":"","types":"bool","variable":"$echo","default":"false","required":"no"},{"content":"","types":"int","variable":"$author_id","default":"1","required":"no"}],"return":{"content":"","types":"string"}},{"name":"comments_rss","desc":"","summary":"Return link to the post RSS feed.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.2.0","desc":"Use get_post_comments_feed_link()"},"return":{"content":"","types":"string"}},{"name":"create_user","desc":"","summary":"An alias of wp_create_user().","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"2.0.0","desc":"Use wp_create_user()"},"param":[{"content":"The user's username.","types":"string","variable":"$username","default":"null","required":"yes"},{"content":"The user's password.","types":"string","variable":"$password","default":"null","required":"yes"},{"content":"The user's email.","types":"string","variable":"$email","default":"null","required":"yes"}],"return":{"content":"The new user's ID.","types":"int"}},{"name":"gzip_compression","desc":"","summary":"Unused function.","type":"function","category":"Uncategorised","deprecated":{"content":"2.5.0","desc":"null"}},{"name":"get_commentdata","desc":"","summary":"Retrieve an array of comment data about comment $comment_ID.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.7.0","desc":"Use get_comment()"},"param":[{"content":"The ID of the comment","types":"int","variable":"$comment_ID","default":"null","required":"yes"},{"content":"Whether to use the cache (cast to bool)","types":"int","variable":"$no_cache","default":"0","required":"yes"},{"content":"Whether to include unapproved comments","types":"bool","variable":"$include_unapproved","default":"false","required":"no"}],"return":{"content":"The comment data","types":"array"}},{"name":"get_catname","desc":"","summary":"Retrieve the category name by the category ID.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use get_cat_name()"},"param":[{"content":"Category ID","types":"int","variable":"$cat_ID","default":"null","required":"yes"}],"return":{"content":"category name","types":"string"}},{"name":"get_category_children","desc":"","summary":"Retrieve category children list separated before and after the term IDs.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.8.0","desc":"Use get_term_children()"},"param":[{"content":"Category ID to retrieve children.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":" Prepend before category term ID.","types":"string","variable":"$before","default":"'/'","required":"no"},{"content":" default is empty string. Append after category term ID.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Category Term IDs that have already been added.","types":"array","variable":"$visited","default":"array()","required":"no"}],"return":{"content":"","types":"string"}},{"name":"get_all_category_ids","desc":"","summary":"Retrieves all category IDs.","type":"function","category":"Categories","since":"2.0.0","deprecated":{"content":"4.0.0","desc":"Use get_terms()"},"return":{"content":"List of all of the category IDs.","types":"object"}},{"name":"get_the_author_description","desc":"","summary":"Retrieve the description of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's description.","types":"string"}},{"name":"the_author_description","desc":"","summary":"Display the description of the author of the current post.","type":"function","category":"Uncategorised","since":"1.0.0","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_login","desc":"","summary":"Retrieve the login name of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's login name (username).","types":"string"}},{"name":"the_author_login","desc":"","summary":"Display the login name of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_firstname","desc":"","summary":"Retrieve the first name of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's first name.","types":"string"}},{"name":"the_author_firstname","desc":"","summary":"Display the first name of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_lastname","desc":"","summary":"Retrieve the last name of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's last name.","types":"string"}},{"name":"the_author_lastname","desc":"","summary":"Display the last name of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_nickname","desc":"","summary":"Retrieve the nickname of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's nickname.","types":"string"}},{"name":"the_author_nickname","desc":"","summary":"Display the nickname of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_email","desc":"","summary":"Retrieve the email of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's username.","types":"string"}},{"name":"the_author_email","desc":"","summary":"Display the email of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_icq","desc":"","summary":"Retrieve the ICQ number of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's ICQ number.","types":"string"}},{"name":"the_author_icq","desc":"","summary":"Display the ICQ number of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_yim","desc":"","summary":"Retrieve the Yahoo! IM name of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's Yahoo! IM name.","types":"string"}},{"name":"the_author_yim","desc":"","summary":"Display the Yahoo! IM name of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_msn","desc":"","summary":"Retrieve the MSN address of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's MSN address.","types":"string"}},{"name":"the_author_msn","desc":"","summary":"Display the MSN address of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_aim","desc":"","summary":"Retrieve the AIM address of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's AIM address.","types":"string"}},{"name":"the_author_aim","desc":"","summary":"Display the AIM address of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta('aim')"}},{"name":"get_author_name","desc":"","summary":"Retrieve the specified author's preferred display name.","type":"function","category":"Uncategorised","since":"1.0.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"param":[{"content":"The ID of the author.","types":"int","variable":"$auth_id","default":"false","required":"no"}],"return":{"content":"The author's display name.","types":"string"}},{"name":"get_the_author_url","desc":"","summary":"Retrieve the URL to the home page of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The URL to the author's page.","types":"string"}},{"name":"the_author_url","desc":"","summary":"Display the URL to the home page of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"get_the_author_ID","desc":"","summary":"Retrieve the ID of the author of the current post.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"2.8.0","desc":"Use get_the_author_meta()"},"return":{"content":"The author's ID.","types":"string|int"}},{"name":"the_author_ID","desc":"","summary":"Display the ID of the author of the current post.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.8.0","desc":"Use the_author_meta()"}},{"name":"the_content_rss","desc":"<p>For encoding the html or the $encode_html parameter, there are three possible values. '0' will make urls footnotes and use make_url_footnote(). '1' will encode special characters and automatically display all of the content. The value of '2' will strip all HTML tags from the content.</p> <p>Also note that you cannot set the amount of words and not set the html encoding. If that is the case, then the html encoding will default to 2, which will strip all HTML tags.</p> <p>To restrict the amount of words of the content, you can use the cut parameter. If the content is less than the amount, then there won't be any dots added to the end. If there is content left over, then dots will be added and the rest of the content will be removed.</p>","summary":"Display the post content for the feed.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"2.9.0","desc":"Use the_content_feed()"},"param":[{"content":" Text to display when more content is available but not displayed.","types":"string","variable":"$more_link_text","default":"'(more...)'","required":"no"},{"content":" Default is 0.","types":"int","variable":"$stripteaser","default":"0","required":"no"},{"content":"","types":"string","variable":"$more_file","default":"''","required":"no"},{"content":" Amount of words to keep for the content.","types":"int","variable":"$cut","default":"0","required":"no"},{"content":" How to encode the content.","types":"int","variable":"$encode_html","default":"0","required":"no"}]},{"name":"make_url_footnote","desc":"<p>Searches for all of the links, strips them out of the content, and places them at the bottom of the content with numbers.</p>","summary":"Strip HTML and put links at the bottom of stripped content.","type":"function","category":"Miscellaneous","since":"0.71","deprecated":{"content":"2.9.0","desc":"null"},"param":[{"content":"Content to get links","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"HTML stripped out of content with links at the bottom.","types":"string"}},{"name":"_c","desc":"<p>Quite a few times, there will be collisions with similar translatable text found in more than two places but with different translated context.</p> <p>In order to use the separate contexts, the _c() function is used and the translatable string uses a pipe ('|') which has the context the string is in.</p> <p>When the translated string is returned, it is everything before the pipe, not including the pipe character. If there is no pipe in the translated text then everything is returned.</p>","summary":"Retrieve translated string with vertical bar context","type":"function","category":"Uncategorised","since":"2.2.0","deprecated":{"content":"2.9.0","desc":"Use _x()"},"param":[{"content":"Text to translate","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Domain to retrieve the translated text","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated context string without pipe","types":"string"}},{"name":"translate_with_context","desc":"","summary":"Translates $text like translate(), but assumes that the text contains a context after its last vertical bar.","type":"function","category":"Uncategorised","since":"2.5.0","deprecated":{"content":"3.0.0","desc":"Use _x()"},"param":[{"content":"Text to translate","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Domain to retrieve the translated text","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text","types":"string"}},{"name":"_nc","desc":"<p>Strips everything from the translation after the last bar.</p>","summary":"Legacy version of _n(), which supports contexts.","type":"function","category":"Uncategorised","since":"2.7.0","deprecated":{"content":"3.0.0","desc":"Use _nx()"},"param":[{"content":"The text to be used if the number is singular.","types":"string","variable":"$single","default":"null","required":"yes"},{"content":"The text to be used if the number is plural.","types":"string","variable":"$plural","default":"null","required":"yes"},{"content":"The number to compare against to use either the singular or plural form.","types":"int","variable":"$number","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"The translated singular or plural form.","types":"string"}},{"name":"__ngettext","desc":"","summary":"Retrieve the plural or single form based on the amount.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"2.8.0","desc":"Use _n()"}},{"name":"__ngettext_noop","desc":"","summary":"Register plural strings in POT file, but don't translate them.","type":"function","category":"Uncategorised","since":"2.5.0","deprecated":{"content":"2.8.0","desc":"Use _n_noop()"}},{"name":"get_alloptions","desc":"","summary":"Retrieve all autoload options, or all options if no autoloaded ones exist.","type":"function","category":"Options","since":"1.0.0","deprecated":{"content":"3.0.0","desc":"Use wp_load_alloptions())"},"return":{"content":"List of all options.","types":"array"}},{"name":"get_the_attachment_link","desc":"","summary":"Retrieve HTML content of attachment image with link.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"2.5.0","desc":"Use wp_get_attachment_link()"},"param":[{"content":" Post ID.","types":"int","variable":"$id","default":"0","required":"no"},{"content":" default is false. Whether to use full size image.","types":"bool","variable":"$fullsize","default":"false","required":"no"},{"content":" Max image dimensions.","types":"array","variable":"$max_dims","default":"false","required":"no"},{"content":" default is false. Whether to include permalink to image.","types":"bool","variable":"$permalink","default":"false","required":"no"}],"return":{"content":"","types":"string"}},{"name":"get_attachment_icon_src","desc":"","summary":"Retrieve icon URL and Path.","type":"function","category":"Uncategorised","since":"2.1.0","deprecated":{"content":"2.5.0","desc":"Use wp_get_attachment_image_src()"},"param":[{"content":" Post ID.","types":"int","variable":"$id","default":"0","required":"no"},{"content":" default to false. Whether to have full image.","types":"bool","variable":"$fullsize","default":"false","required":"no"}],"return":{"content":"Icon URL and full path to file, respectively.","types":"array"}},{"name":"get_attachment_icon","desc":"","summary":"Retrieve HTML content of icon attachment image element.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"2.5.0","desc":"Use wp_get_attachment_image()"},"param":[{"content":" Post ID.","types":"int","variable":"$id","default":"0","required":"no"},{"content":" default to false. Whether to have full size image.","types":"bool","variable":"$fullsize","default":"false","required":"no"},{"content":" Dimensions of image.","types":"array","variable":"$max_dims","default":"false","required":"no"}],"return":{"content":"HTML content.","types":"false|string"}},{"name":"get_attachment_innerHTML","desc":"","summary":"Retrieve HTML content of image element.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"2.5.0","desc":"Use wp_get_attachment_image()"},"param":[{"content":" Post ID.","types":"int","variable":"$id","default":"0","required":"no"},{"content":" default to false. Whether to have full size image.","types":"bool","variable":"$fullsize","default":"false","required":"no"},{"content":" Dimensions of image.","types":"array","variable":"$max_dims","default":"false","required":"no"}],"return":{"content":"","types":"false|string"}},{"name":"get_link","desc":"","summary":"Retrieves bookmark data based on ID.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"2.1.0","desc":"Use get_bookmark()"},"param":[{"content":"ID of link","types":"int","variable":"$bookmark_id","default":"null","required":"yes"},{"content":" Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.","types":"string","variable":"$output","default":"OBJECT","required":"no"},{"content":" How to filter the link for output. Accepts 'raw', 'edit', 'attribute', 'js', 'db', or 'display'. Default 'raw'.","types":"string","variable":"$filter","default":"'raw'","required":"no"}],"return":{"content":"Bookmark object or array, depending on the type specified by <code>$output</code>.","types":"object|array"}},{"name":"sanitize_url","desc":"","summary":"Performs esc_url() for database or redirect usage.","type":"function","category":"Uncategorised","since":"2.3.1","deprecated":{"content":"2.8.0","desc":"Use esc_url_raw()"},"param":[{"content":"The URL to be cleaned.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"An array of acceptable protocols.","types":"array","variable":"$protocols","default":"null","required":"no"}],"return":{"content":"The cleaned URL.","types":"string"}},{"name":"clean_url","desc":"<p>A number of characters are removed from the URL. If the URL is for displaying (the default behaviour) ampersands are also replaced. The 'clean_url' filter is applied to the returned cleaned URL.</p>","summary":"Checks and cleans a URL.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"3.0.0","desc":"Use esc_url()"},"param":[{"content":"The URL to be cleaned.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" An array of acceptable protocols.","types":"array","variable":"$protocols","default":"null","required":"no"},{"content":" How the URL will be used. Default is 'display'.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"The cleaned $url after the {@see 'clean_url'} filter is applied.","types":"string"}},{"name":"js_escape","desc":"<p>The filter {@see 'js_escape'} is also applied by esc_js().</p>","summary":"Escape single quotes, specialchar double quotes, and fix line endings.","type":"function","category":"Uncategorised","since":"2.0.4","deprecated":{"content":"2.8.0","desc":"Use esc_js()"},"param":[{"content":"The text to be escaped.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Escaped text.","types":"string"}},{"name":"wp_specialchars","desc":"","summary":"Legacy escaping for HTML blocks.","type":"function","category":"Uncategorised","deprecated":{"content":"2.8.0","desc":"Use esc_html()"},"param":[{"content":"String to escape.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Unused.","types":"string","variable":"$quote_style","default":"ENT_NOQUOTES","required":"no"},{"content":"Unused.","types":"false|string","variable":"$charset","default":"false","required":"no"},{"content":"Whether to double encode. Unused.","types":"false","variable":"$double_encode","default":"false","required":"no"}],"return":{"content":"Escaped <code>$string</code>.","types":"string"}},{"name":"attribute_escape","desc":"","summary":"Escaping for HTML attributes.","type":"function","category":"Uncategorised","since":"2.0.6","deprecated":{"content":"2.8.0","desc":"Use esc_attr()"},"param":[{"content":"","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"register_sidebar_widget","desc":"<p>Allows $name to be an array that accepts either three elements to grab the first element and the third for the name or just uses the first element of the array for the name.</p> <p>Passes to wp_register_sidebar_widget() after argument list and backward compatibility is complete.</p>","summary":"Register widget for sidebar with backward compatibility.","type":"function","category":"Uncategorised","since":"2.2.0","deprecated":{"content":"2.8.0","desc":"Use wp_register_sidebar_widget()"},"param":[{"content":"Widget ID.","types":"string|int","variable":"$name","default":"null","required":"yes"},{"content":"Run when widget is called.","types":"callable","variable":"$output_callback","default":"null","required":"yes"},{"content":" Classname widget option. Default empty.","types":"string","variable":"$classname","default":"''","required":"no"},{"content":",... Widget parameters.","types":"mixed","variable":"$params","default":"null","required":"yes"}]},{"name":"unregister_sidebar_widget","desc":"","summary":"Serves as an alias of wp_unregister_sidebar_widget().","type":"function","category":"Uncategorised","since":"2.2.0","deprecated":{"content":"2.8.0","desc":"Use wp_unregister_sidebar_widget()"},"param":[{"content":"Widget ID.","types":"int|string","variable":"$id","default":"null","required":"yes"}]},{"name":"register_widget_control","desc":"<p>Allows $name to be an array that accepts either three elements to grab the first element and the third for the name or just uses the first element of the array for the name.</p> <p>Passes to wp_register_widget_control() after the argument list has been compiled.</p>","summary":"Registers widget control callback for customizing options.","type":"function","category":"Uncategorised","since":"2.2.0","deprecated":{"content":"2.8.0","desc":"Use wp_register_widget_control()"},"param":[{"content":"Sidebar ID.","types":"int|string","variable":"$name","default":"null","required":"yes"},{"content":"Widget control callback to display and process form.","types":"callable","variable":"$control_callback","default":"null","required":"yes"},{"content":"Widget width.","types":"int","variable":"$width","default":"''","required":"no"},{"content":"Widget height.","types":"int","variable":"$height","default":"''","required":"no"}]},{"name":"unregister_widget_control","desc":"","summary":"Alias of wp_unregister_widget_control().","type":"function","category":"Uncategorised","since":"2.2.0","deprecated":{"content":"2.8.0","desc":"Use wp_unregister_widget_control()"},"param":[{"content":"Widget ID.","types":"int|string","variable":"$id","default":"null","required":"yes"}]},{"name":"delete_usermeta","desc":"","summary":"Remove user meta data.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"3.0.0","desc":"Use delete_user_meta()"},"param":[{"content":"User ID.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"Metadata key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value.","types":"mixed","variable":"$meta_value","default":"''","required":"no"}],"return":{"content":"True deletion completed and false if user_id is not a number.","types":"bool"}},{"name":"get_usermeta","desc":"<p>If $user_id is not a number, then the function will fail over with a 'false' boolean return value. Other returned values depend on whether there is only one item to be returned, which be that single item type. If there is more than one metadata value, then it will be list of metadata values.</p>","summary":"Retrieve user metadata.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"3.0.0","desc":"Use get_user_meta()"},"param":[{"content":"User ID","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":" Metadata key.","types":"string","variable":"$meta_key","default":"''","required":"no"}],"return":{"content":"","types":"mixed"}},{"name":"update_usermeta","desc":"<p>There is no need to serialize values, they will be serialized if it is needed. The metadata key can only be a string with underscores. All else will be removed.</p> <p>Will remove the metadata, if the meta value is empty.</p>","summary":"Update metadata of user.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"3.0.0","desc":"Use update_user_meta()"},"param":[{"content":"User ID","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"Metadata key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"}],"return":{"content":"True on successful update, false on failure.","types":"bool"}},{"name":"get_users_of_blog","desc":"<p>For setups that use the multisite feature. Can be used outside of the multisite feature.</p>","summary":"Get users for the site.","type":"function","category":"Uncategorised","since":"2.2.0","deprecated":{"content":"3.1.0","desc":"Use get_users()"},"param":[{"content":"Site ID.","types":"int","variable":"$id","default":"''","required":"no"}],"return":{"content":"List of users that are part of that site ID","types":"array"}},{"name":"automatic_feed_links","desc":"","summary":"Enable/disable automatic general feed link outputting.","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.0.0","desc":"Use add_theme_support()"},"param":[{"content":" default is true. Add or remove links. Defaults to true.","types":"bool","variable":"$add","default":"true","required":"no"}]},{"name":"get_profile","desc":"","summary":"Retrieve user data based on field.","type":"function","category":"Users and Authors","since":"1.5.0","deprecated":{"content":"3.0.0","desc":"Use get_the_author_meta()"},"param":[{"content":"User meta field.","types":"string","variable":"$field","default":"null","required":"yes"},{"content":" User ID to retrieve the field for. Default false (current user).","types":"false|int","variable":"$user","default":"false","required":"no"}],"return":{"content":"The author's field from the current author's DB object.","types":"string"}},{"name":"get_usernumposts","desc":"","summary":"Retrieves the number of posts a user has written.","type":"function","category":"Users and Authors","since":"0.71","deprecated":{"content":"3.0.0","desc":"Use count_user_posts()"},"param":[{"content":"User to count posts for.","types":"int","variable":"$userid","default":"null","required":"yes"}],"return":{"content":"Number of posts the given user has written.","types":"int"}},{"name":"funky_javascript_callback","desc":"","summary":"Callback used to change %uXXXX to &#YYY; syntax","type":"function","category":"Uncategorised","since":"2.8.0","access":"private","deprecated":{"content":"3.0.0","desc":"null"},"param":[{"content":"Single Match","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"An HTML entity","types":"string"}},{"name":"funky_javascript_fix","desc":"<p>Converts unicode characters to HTML numbered entities.</p>","summary":"Fixes JavaScript bugs in browsers.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"3.0.0","desc":"null"},"param":[{"content":"Text to be made safe.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Fixed text.","types":"string"}},{"name":"is_taxonomy","desc":"","summary":"Checks that the taxonomy name exists.","type":"function","category":"Taxonomy","since":"2.3.0","deprecated":{"content":"3.0.0","desc":"Use taxonomy_exists()"},"param":[{"content":"Name of taxonomy object","types":"string","variable":"$taxonomy","default":"null","required":"yes"}],"return":{"content":"Whether the taxonomy exists.","types":"bool"}},{"name":"is_term","desc":"","summary":"Check if Term exists.","type":"function","category":"Taxonomy","since":"2.3.0","deprecated":{"content":"3.0.0","desc":"Use term_exists()"},"param":[{"content":"The term to check","types":"int|string","variable":"$term","default":"null","required":"yes"},{"content":"The taxonomy name to use","types":"string","variable":"$taxonomy","default":"''","required":"no"},{"content":"ID of parent term under which to confine the exists search.","types":"int","variable":"$parent","default":"0","required":"yes"}],"return":{"content":"Get the term id or Term Object, if exists.","types":"mixed"}},{"name":"is_plugin_page","desc":"<p>Use global $plugin_page and/or get_plugin_page_hookname() hooks.</p> <p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the current admin page is generated by a plugin.","type":"function","category":"Plugins","since":"1.5.0","deprecated":{"content":"3.1.0","desc":"null"},"return":{"content":"","types":"bool"}},{"name":"update_category_cache","desc":"<p>This function does not appear to be used anymore or does not appear to be needed. It might be a legacy function left over from when there was a need for updating the category cache.</p>","summary":"Update the categories cache.","type":"function","category":"Uncategorised","since":"1.5.0","deprecated":{"content":"3.1.0","desc":"null"},"return":{"content":"Always return True","types":"bool"}},{"name":"wp_timezone_supported","desc":"","summary":"Check for PHP timezone support","type":"function","category":"Uncategorised","since":"2.9.0","deprecated":{"content":"3.2.0","desc":"null"},"return":{"content":"","types":"bool"}},{"name":"the_editor","desc":"","summary":"Displays an editor: TinyMCE, HTML, or both.","type":"function","category":"Uncategorised","since":"2.1.0","deprecated":{"content":"3.3.0","desc":"Use wp_editor()"},"param":[{"content":"Textarea content.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":" HTML ID attribute value. Default 'content'.","types":"string","variable":"$id","default":"'content'","required":"no"},{"content":" Unused.","types":"string","variable":"$prev_id","default":"'title'","required":"no"},{"content":" Whether to display media buttons. Default true.","types":"bool","variable":"$media_buttons","default":"true","required":"no"},{"content":" Unused.","types":"int","variable":"$tab_index","default":"2","required":"no"},{"content":" Unused.","types":"bool","variable":"$extended","default":"true","required":"no"}]},{"name":"get_user_metavalues","desc":"","summary":"Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users","type":"function","category":"Uncategorised","since":"3.0.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":"User ID numbers list.","types":"array","variable":"$ids","default":"null","required":"yes"}],"return":{"content":"of arrays. The array is indexed by user_id, containing $metavalues object arrays.","types":"array"}},{"name":"sanitize_user_object","desc":"<p>If the context is 'raw', then the user object or array will get minimal santization of the int fields.</p>","summary":"Sanitize every user field.","type":"function","category":"Uncategorised","since":"2.3.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":"The User Object or Array","types":"object|array","variable":"$user","default":"null","required":"yes"},{"content":" default is 'display'. How to sanitize user fields.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"The now sanitized User Object or Array (will be the same type as $user)","types":"object|array"}},{"name":"get_boundary_post_rel_link","desc":"<p>Can either be start or end post relational link.</p>","summary":"Get boundary post relational link.","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":" Link title format.","types":"string","variable":"$title","default":"'%title'","required":"no"},{"content":" Whether link should be in a same category.","types":"bool","variable":"$in_same_cat","default":"false","required":"no"},{"content":" Excluded categories IDs.","types":"string","variable":"$excluded_categories","default":"''","required":"no"},{"content":" default is true. Whether to display link to first or last post.","types":"bool","variable":"$start","default":"true","required":"no"}],"return":{"content":"","types":"string"}},{"name":"start_post_rel_link","desc":"","summary":"Display relational link for the first post.","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":" Link title format.","types":"string","variable":"$title","default":"'%title'","required":"no"},{"content":" Whether link should be in a same category.","types":"bool","variable":"$in_same_cat","default":"false","required":"no"},{"content":" Excluded categories IDs.","types":"string","variable":"$excluded_categories","default":"''","required":"no"}]},{"name":"get_index_rel_link","desc":"","summary":"Get site index relational link.","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.3.0","desc":"null"},"return":{"content":"","types":"string"}},{"name":"index_rel_link","desc":"","summary":"Display relational link for the site index.","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.3.0","desc":"null"}},{"name":"get_parent_post_rel_link","desc":"","summary":"Get parent post relational link.","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":" Link title format. Default '%title'.","types":"string","variable":"$title","default":"'%title'","required":"no"}],"return":{"content":"","types":"string"}},{"name":"parent_post_rel_link","desc":"","summary":"Display relational link for parent item","type":"function","category":"Uncategorised","since":"2.8.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":" Link title format. Default '%title'.","types":"string","variable":"$title","default":"'%title'","required":"no"}]},{"name":"wp_admin_bar_dashboard_view_site_menu","desc":"","summary":"Add the \"Dashboard\"/\"Visit Site\" menu.","type":"function","category":"Uncategorised","since":"3.2.0","deprecated":{"content":"3.3.0","desc":"null"},"param":[{"content":"WP_Admin_Bar instance.","types":"WP_Admin_Bar","variable":"$wp_admin_bar","default":"null","required":"yes"}]},{"name":"is_blog_user","desc":"","summary":"Checks if the current user belong to a given site.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"3.3.0","desc":"Use is_user_member_of_blog()"},"param":[{"content":"Site ID","types":"int","variable":"$blog_id","default":"0","required":"yes"}],"return":{"content":"True if the current users belong to $blog_id, false if not.","types":"bool"}},{"name":"debug_fopen","desc":"","summary":"Open the file handle for debugging.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"3.4.0","desc":"Use error_log()"},"param":[{"content":"File name.","types":"string","variable":"$filename","default":"null","required":"yes"},{"content":"Type of access you required to the stream.","types":"string","variable":"$mode","default":"null","required":"yes"}],"return":{"content":"Always false.","types":"false"}},{"name":"debug_fwrite","desc":"","summary":"Write contents to the file used for debugging.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"3.4.0","desc":"Use error_log()"},"param":[{"content":"Unused.","types":"mixed","variable":"$fp","default":"null","required":"yes"},{"content":"Message to log.","types":"string","variable":"$string","default":"null","required":"yes"}]},{"name":"debug_fclose","desc":"","summary":"Close the debugging file handle.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"3.4.0","desc":"Use error_log()"},"param":[{"content":"Unused.","types":"mixed","variable":"$fp","default":"null","required":"yes"}]},{"name":"get_themes","desc":"<p>The theme is broken, if it doesn't have a parent theme and is missing either style.css and, or index.php. If the theme has a parent theme then it is broken, if it is missing style.css; index.php is optional.</p>","summary":"Retrieve list of themes with theme data in theme directory.","type":"function","category":"Other functions","since":"1.5.0","deprecated":{"content":"3.4.0","desc":"Use wp_get_themes()"},"return":{"content":"Theme list with theme data.","types":"array"}},{"name":"get_theme","desc":"","summary":"Retrieve theme data.","type":"function","category":"Other functions","since":"1.5.0","deprecated":{"content":"3.4.0","desc":"Use wp_get_theme()"},"param":[{"content":"Theme name.","types":"string","variable":"$theme","default":"null","required":"yes"}],"return":{"content":"Null, if theme name does not exist. Theme data, if exists.","types":"array|null"}},{"name":"get_current_theme","desc":"","summary":"Retrieve current theme name.","type":"function","category":"Other functions","since":"1.5.0","deprecated":{"content":"3.4.0","desc":"Use wp_get_theme()"},"return":{"content":"","types":"string"}},{"name":"clean_pre","desc":"<p>Ensures that the contents of a <code><pre>...</pre></code> HTML block are not converted into paragraphs or line-breaks.</p>","summary":"Accepts matches array from preg_replace_callback in wpautop() or a string.","type":"function","category":"Uncategorised","since":"1.2.0","deprecated":{"content":"3.4.0","desc":"null"},"param":[{"content":"The array or string","types":"array|string","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"The pre block without paragraph/line-break conversion.","types":"string"}},{"name":"add_custom_image_header","desc":"","summary":"Add callbacks for image header display.","type":"function","category":"Other functions","since":"2.1.0","deprecated":{"content":"3.4.0","desc":"Use add_theme_support()"},"param":[{"content":"Call on the {@see 'wp_head'} action.","types":"callable","variable":"$wp_head_callback","default":"null","required":"yes"},{"content":"Call on custom header administration screen.","types":"callable","variable":"$admin_head_callback","default":"null","required":"yes"},{"content":"Output a custom header image div on the custom header administration screen. Optional.","types":"callable","variable":"$admin_preview_callback","default":"''","required":"no"}]},{"name":"remove_custom_image_header","desc":"","summary":"Remove image header support.","type":"function","category":"Uncategorised","since":"3.1.0","deprecated":{"content":"3.4.0","desc":"Use remove_theme_support()"},"return":{"content":"Whether support was removed.","types":"null|bool"}},{"name":"add_custom_background","desc":"","summary":"Add callbacks for background image display.","type":"function","category":"Other functions","since":"3.0.0","deprecated":{"content":"3.4.0","desc":"Use add_theme_support()"},"param":[{"content":"Call on the {@see 'wp_head'} action.","types":"callable","variable":"$wp_head_callback","default":"''","required":"no"},{"content":"Call on custom background administration screen.","types":"callable","variable":"$admin_head_callback","default":"''","required":"no"},{"content":"Output a custom background image div on the custom background administration screen. Optional.","types":"callable","variable":"$admin_preview_callback","default":"''","required":"no"}]},{"name":"remove_custom_background","desc":"","summary":"Remove custom background support.","type":"function","category":"Uncategorised","since":"3.1.0","deprecated":{"content":"3.4.0","desc":"Use add_custom_background()"},"return":{"content":"Whether support was removed.","types":"null|bool"}},{"name":"get_theme_data","desc":"","summary":"Retrieve theme data from parsed theme file.","type":"function","category":"Other functions","since":"1.5.0","deprecated":{"content":"3.4.0","desc":"Use wp_get_theme()"},"param":[{"content":"Theme file path.","types":"string","variable":"$theme_file","default":"null","required":"yes"}],"return":{"content":"Theme data.","types":"array"}},{"name":"update_page_cache","desc":"","summary":"Alias of update_post_cache().","type":"function","category":"Uncategorised","since":"1.5.1","deprecated":{"content":"3.4.0","desc":"Use update_post_cache()"},"param":[{"content":"list of page objects","types":"array","variable":"$pages","default":"null","required":"yes"}]},{"name":"clean_page_cache","desc":"<p>Clean (read: delete) page from cache that matches $id. Will also clean cache associated with 'all_page_ids' and 'get_pages'.</p>","summary":"Will clean the page in the cache.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"3.4.0","desc":"Use clean_post_cache"},"param":[{"content":"Page ID to clean","types":"int","variable":"$id","default":"null","required":"yes"}]},{"name":"wp_explain_nonce","desc":"<p>Deprecated in 3.4.1 and 3.5.0. Backported to 3.3.3.</p>","summary":"Retrieve nonce action \"Are you sure\" message.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","deprecated":{"content":"3.4.1","desc":"Use wp_nonce_ays()"},"param":[{"content":"Nonce action.","types":"string","variable":"$action","default":"null","required":"yes"}],"return":{"content":"Are you sure message.","types":"string"}},{"name":"sticky_class","desc":"","summary":"Display \"sticky\" CSS class, if a post is sticky.","type":"function","category":"Uncategorised","since":"2.7.0","deprecated":{"content":"3.5.0","desc":"Use post_class()"},"param":[{"content":"An optional post ID.","types":"int","variable":"$post_id","default":"null","required":"no"}]},{"name":"_get_post_ancestors","desc":"<p>This is no longer needed as WP_Post lazy-loads the ancestors property with get_post_ancestors().</p>","summary":"Retrieve post ancestors.","type":"function","category":"Uncategorised","since":"2.3.4","deprecated":{"content":"3.5.0","desc":"Use get_post_ancestors()"},"param":[{"content":"Post object, passed by reference (unused).","types":"WP_Post","variable":"$post","default":"null","required":"yes"}]},{"name":"wp_load_image","desc":"","summary":"Load an image from a string, if PHP supports it.","type":"function","category":"Uncategorised","since":"2.1.0","deprecated":{"content":"3.5.0","desc":"Use wp_get_image_editor()"},"param":[{"content":"Filename of the image to load.","types":"string","variable":"$file","default":"null","required":"yes"}],"return":{"content":"The resulting image resource on success, Error string on failure.","types":"resource"}},{"name":"image_resize","desc":"<p>The PNG transparency will be preserved using the function, as well as the image type. If the file going in is PNG, then the resized image is going to be PNG. The only supported image types are PNG, GIF, and JPEG.</p> <p>Some functionality requires API to exist, so some PHP version may lose out support. This is not the fault of WordPress (where functionality is downgraded, not actual defects), but of your PHP version.</p>","summary":"Scale down an image to fit a particular size and save a new copy of the image.","type":"function","category":"Attachments","since":"2.5.0","deprecated":{"content":"3.5.0","desc":"Use wp_get_image_editor()"},"param":[{"content":"Image file path.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":"Maximum width to resize to.","types":"int","variable":"$max_w","default":"null","required":"yes"},{"content":"Maximum height to resize to.","types":"int","variable":"$max_h","default":"null","required":"yes"},{"content":" Whether to crop image or resize.","types":"bool","variable":"$crop","default":"false","required":"no"},{"content":" File suffix.","types":"string","variable":"$suffix","default":"null","required":"no"},{"content":" New image file path.","types":"string","variable":"$dest_path","default":"null","required":"no"},{"content":" default is 90. Image quality percentage.","types":"int","variable":"$jpeg_quality","default":"90","required":"no"}],"return":{"content":"WP_Error on failure. String with new destination path.","types":"mixed"}},{"name":"wp_get_single_post","desc":"<p>Has categories in 'post_category' property or key. Has tags in 'tags_input' property or key.</p>","summary":"Retrieve a single post, based on post ID.","type":"function","category":"Posts","since":"1.0.0","deprecated":{"content":"3.5.0","desc":"Use get_post()"},"param":[{"content":"Post ID.","types":"int","variable":"$postid","default":"0","required":"yes"},{"content":"How to return result, either OBJECT, ARRAY_N, or ARRAY_A.","types":"string","variable":"$mode","default":"OBJECT","required":"no"}],"return":{"content":"Post object or array holding post contents and information","types":"WP_Post|null"}},{"name":"user_pass_ok","desc":"","summary":"Check that the user login name and password is correct.","type":"function","category":"XMLRPC","since":"0.71","deprecated":{"content":"3.5.0","desc":"Use wp_authenticate()"},"param":[{"content":"User name.","types":"string","variable":"$user_login","default":"null","required":"yes"},{"content":"User password.","types":"string","variable":"$user_pass","default":"null","required":"yes"}],"return":{"content":"False if does not authenticate, true if username and password authenticates.","types":"bool"}},{"name":"_save_post_hook","desc":"","summary":"Callback formerly fired on the save_post hook. No longer needed.","type":"function","category":"Uncategorised","since":"2.3.0","deprecated":{"content":"3.5.0","desc":"null"}},{"name":"gd_edit_image_support","desc":"","summary":"Check if the installed version of GD supports particular image type","type":"function","category":"Uncategorised","since":"2.9.0","deprecated":{"content":"3.5.0","desc":"Use wp_image_editor_supports()"},"param":[{"content":"","types":"string","variable":"$mime_type","default":"null","required":"yes"}],"return":{"content":"","types":"bool"}},{"name":"wp_convert_bytes_to_hr","desc":"","summary":"Converts an integer byte value to a shorthand byte value.","type":"function","category":"Uncategorised","since":"2.3.0","deprecated":{"content":"3.6.0","desc":"Use size_format()"},"param":[{"content":"An integer byte value.","types":"int","variable":"$bytes","default":"null","required":"yes"}],"return":{"content":"A shorthand byte value.","types":"string"}},{"name":"_search_terms_tidy","desc":"","summary":"Formerly used internally to tidy up the search terms.","type":"function","category":"Uncategorised","since":"2.9.0","access":"private","deprecated":{"content":"3.7.0","desc":"null"},"param":[{"content":"Search terms to "tidy", e.g. trim.","types":"string","variable":"$t","default":"null","required":"yes"}],"return":{"content":"Trimmed search terms.","types":"string"}},{"name":"rich_edit_exists","desc":"<p>Checks to see if the user has deleted the tinymce files to slim down their WordPress installation.</p>","summary":"Determine if TinyMCE is available.","type":"function","category":"Uncategorised","since":"2.1.0","deprecated":{"content":"3.9.0","desc":"null"},"return":{"content":"Whether TinyMCE exists.","types":"bool"}},{"name":"default_topic_count_text","desc":"","summary":"Old callback for tag link tooltips.","type":"function","category":"Uncategorised","since":"2.7.0","access":"private","deprecated":{"content":"3.9.0","desc":"null"},"param":[{"content":"Number of topics.","types":"int","variable":"$count","default":"null","required":"yes"}],"return":{"content":"Number of topics.","types":"int"}},{"name":"format_to_post","desc":"<p>Has not performed this function for many, many years. Use wpdb::prepare() instead.</p>","summary":"Formerly used to escape strings before inserting into the DB.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"3.9.0","desc":"null"},"param":[{"content":"The text to format.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The very same text.","types":"string"}},{"name":"like_escape","desc":"","summary":"Formerly used to escape strings before searching the DB. It was poorly documented and never worked as described.","type":"function","category":"Uncategorised","since":"2.5.0","deprecated":{"content":"4.0.0","desc":"Use wpdb::esc_like()"},"param":[{"content":"The text to be escaped.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"text, safe for inclusion in LIKE query.","types":"string"}},{"name":"url_is_accessable_via_ssl","desc":"<p>Determines if the URL can be accessed over SSL by using the WordPress HTTP API to access the URL using https as the scheme.</p>","summary":"Determines if the URL can be accessed over SSL.","type":"function","category":"Uncategorised","since":"2.5.0","deprecated":{"content":"4.0.0","desc":"null"},"param":[{"content":"The URL to test.","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"Whether SSL access is available.","types":"bool"}},{"name":"preview_theme","desc":"<p>Will only perform task if the user has permissions and template and preview query variables exist.</p>","summary":"Start preview theme output buffer.","type":"function","category":"Other functions","since":"2.6.0","deprecated":{"content":"4.3.0","desc":"null"}},{"name":"_preview_theme_template_filter","desc":"","summary":"Private function to modify the current template when previewing a theme","type":"function","category":"Uncategorised","since":"2.9.0","deprecated":{"content":"4.3.0","desc":"null"},"access":"private","return":{"content":"","types":"string"}},{"name":"_preview_theme_stylesheet_filter","desc":"","summary":"Private function to modify the current stylesheet when previewing a theme","type":"function","category":"Uncategorised","since":"2.9.0","deprecated":{"content":"4.3.0","desc":"null"},"access":"private","return":{"content":"","types":"string"}},{"name":"preview_theme_ob_filter","desc":"","summary":"Callback function for ob_start() to capture all links in the theme.","type":"function","category":"Other functions","since":"2.6.0","deprecated":{"content":"4.3.0","desc":"null"},"access":"private","param":[{"content":"","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"preview_theme_ob_filter_callback","desc":"<p>Callback function for preg_replace_callback() to accept and filter matches.</p>","summary":"Manipulates preview theme links in order to control and maintain location.","type":"function","category":"Other functions","since":"2.6.0","deprecated":{"content":"4.3.0","desc":"null"},"access":"private","param":[{"content":"","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"wp_richedit_pre","desc":"<p>The {@see 'richedit_pre'} filter is applied here. If $text is empty the filter will be applied to an empty string.</p>","summary":"Formats text for the rich text editor.","type":"function","category":"Uncategorised","since":"2.0.0","deprecated":{"content":"4.3.0","desc":"Use format_for_editor()"},"param":[{"content":"The text to be formatted.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"The formatted text after filter is applied.","types":"string"}},{"name":"wp_htmledit_pre","desc":"<p>Unless $output is empty it will pass through htmlspecialchars before the {@see 'htmledit_pre'} filter is applied.</p>","summary":"Formats text for the HTML editor.","type":"function","category":"Uncategorised","since":"2.5.0","deprecated":{"content":"4.3.0","desc":"Use format_for_editor()"},"param":[{"content":"The text to be formatted.","types":"string","variable":"$output","default":"null","required":"yes"}],"return":{"content":"Formatted text after filter applied.","types":"string"}},{"name":"post_permalink","desc":"","summary":"Retrieve permalink from post ID.","type":"function","category":"Uncategorised","since":"1.0.0","deprecated":{"content":"4.4.0","desc":"Use get_permalink()"},"param":[{"content":" Post ID or WP_Post object. Default is global $post.","types":"int|WP_Post","variable":"$post_id","default":"0","required":"no"}],"return":{"content":"","types":"string|false"}},{"name":"wp_get_http","desc":"<p>If $file_path is a writable filename, this will do a GET request and write the file to that path.</p>","summary":"Perform a HTTP HEAD or GET request.","type":"function","category":"Uncategorised","since":"2.5.0","deprecated":{"content":"4.4.0","desc":"Use WP_Http"},"param":[{"content":"URL to fetch.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" File path to write request to. Default false.","types":"string|bool","variable":"$file_path","default":"false","required":"no"},{"content":" The number of Redirects followed, Upon 5 being hit, returns false. Default 1.","types":"int","variable":"$red","default":"1","required":"no"}],"return":{"content":"False on failure and string of headers if HEAD request.","types":"bool|string"}},{"name":"force_ssl_login","desc":"","summary":"Whether SSL login should be forced.","type":"function","category":"Uncategorised","since":"2.6.0","deprecated":{"content":"4.4.0","desc":"Use force_ssl_admin()"},"param":[{"content":"Whether to force SSL login. Default null.","types":"string|bool","variable":"$force","default":"null","required":"no"}],"return":{"content":"True if forced, false if not forced.","types":"bool"}},{"name":"get_comments_popup_template","desc":"","summary":"Retrieve path of comment popup template in current or parent template.","type":"function","category":"Other functions","since":"1.5.0","deprecated":{"content":"4.5.0","desc":"null"},"return":{"content":"Full path to comments popup template file.","types":"string"}},{"name":"is_comments_popup","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the current URL is within the comments popup window.","type":"function","category":"Conditional Tags Index","since":"1.5.0","deprecated":{"content":"4.5.0","desc":"null"},"return":{"content":"","types":"bool"}},{"name":"comments_popup_script","desc":"","summary":"Display the JS popup script to show a comment.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"4.5.0","desc":"null"}},{"name":"popuplinks","desc":"","summary":"Adds element attributes to open links in new tabs.","type":"function","category":"Uncategorised","since":"0.71","deprecated":{"content":"4.5.0","desc":"null"},"param":[{"content":"Content to replace links to open in a new tab.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Content that has filtered links.","types":"string"}},{"name":"wp_embed_handler_googlevideo","desc":"<p>Deprecated function that previously assisted in turning Google Video URLs into embeds but that service has since been shut down.</p>","summary":"The Google Video embed handler callback.","type":"function","category":"Uncategorised","since":"2.9.0","deprecated":{"content":"4.6.0","desc":"null"},"return":{"content":"An empty string.","types":"string"}},{"name":"get_paged_template","desc":"","summary":"Retrieve path of paged template in current or parent template.","type":"function","category":"Other functions","since":"1.5.0","deprecated":{"content":"4.7.0","desc":"The paged.php template is no longer part of the theme template hierarchy."},"return":{"content":"Full path to paged template file.","types":"string"}},{"name":"wp_kses_js_entities","desc":"<p>Previously, this function was pulled in from the original import of kses and removed a specific vulnerability only existent in early version of Netscape 4. However, this vulnerability never affected any other browsers and can be considered safe for the modern web.</p> <p>The regular expression which sanitized this vulnerability has been removed in consideration of the performance and energy demands it placed, now merely passing through its input to the return.</p>","summary":"Removes the HTML JavaScript entities found in early versions of Netscape 4.","type":"function","category":"Uncategorised","since":"1.0.0","deprecated":{"content":"4.7.0","desc":"Officially dropped security support for Netscape 4."},"param":[{"content":"","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"_usort_terms_by_ID","desc":"<p>Used by usort() as a callback, should not be used directly. Can actually be used to sort any term object.</p>","summary":"Sort categories by ID.","type":"function","category":"Uncategorised","since":"2.3.0","deprecated":{"content":"4.7.0","desc":"Use wp_list_sort()"},"access":"private","param":[{"content":"","types":"object","variable":"$a","default":"null","required":"yes"},{"content":"","types":"object","variable":"$b","default":"null","required":"yes"}],"return":{"content":"","types":"int"}},{"name":"_usort_terms_by_name","desc":"<p>Used by usort() as a callback, should not be used directly. Can actually be used to sort any term object.</p>","summary":"Sort categories by name.","type":"function","category":"Uncategorised","since":"2.3.0","deprecated":{"content":"4.7.0","desc":"Use wp_list_sort()"},"access":"private","param":[{"content":"","types":"object","variable":"$a","default":"null","required":"yes"},{"content":"","types":"object","variable":"$b","default":"null","required":"yes"}],"return":{"content":"","types":"int"}},{"name":"_sort_nav_menu_items","desc":"","summary":"Sort menu items by the desired key.","type":"function","category":"Uncategorised","since":"3.0.0","deprecated":{"content":"4.7.0","desc":"Use wp_list_sort()"},"access":"private","param":[{"content":"The first object to compare","types":"object","variable":"$a","default":"null","required":"yes"},{"content":"The second object to compare","types":"object","variable":"$b","default":"null","required":"yes"}],"return":{"content":"-1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b.","types":"int"}},{"name":"get_shortcut_link","desc":"","summary":"Retrieves the Press This bookmarklet link.","type":"function","category":"Uncategorised","since":"2.6.0","deprecated":{"content":"4.9.0","desc":"null"}},{"name":"wp_ajax_press_this_save_post","desc":"","summary":"Ajax handler for saving a post from Press This.","type":"function","category":"Uncategorised","since":"4.2.0","deprecated":{"content":"4.9.0","desc":"null"}},{"name":"wp_ajax_press_this_add_category","desc":"","summary":"Ajax handler for creating new category from Press This.","type":"function","category":"Uncategorised","since":"4.2.0","deprecated":{"content":"4.9.0","desc":"null"}},{"name":"wp_embed_register_handler","desc":"<p>Should probably only be used for sites that do not support oEmbed.</p>","summary":"Registers an embed handler.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"An internal ID/name for the handler. Needs to be unique.","types":"string","variable":"$id","default":"null","required":"yes"},{"content":"The regex that will be used to see if this handler should be used for a URL.","types":"string","variable":"$regex","default":"null","required":"yes"},{"content":"The callback function that will be called if the regex is matched.","types":"callable","variable":"$callback","default":"null","required":"yes"},{"content":" Used to specify the order in which the registered handlers will be tested. Default 10.","types":"int","variable":"$priority","default":"10","required":"no"}]},{"name":"wp_embed_unregister_handler","desc":"","summary":"Unregisters a previously-registered embed handler.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The handler ID that should be removed.","types":"string","variable":"$id","default":"null","required":"yes"},{"content":" The priority of the handler to be removed. Default 10.","types":"int","variable":"$priority","default":"10","required":"no"}]},{"name":"wp_embed_defaults","desc":"<p>The width defaults to the content width as specified by the theme. If the theme does not specify a content width, then 500px is used.</p> <p>The default height is 1.5 times the width, or 1000px, whichever is smaller.</p> <p>The {@see 'embed_defaults'} filter can be used to adjust either of these values.</p>","summary":"Creates default array of embed parameters.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":" The URL that should be embedded. Default empty.","types":"string","variable":"$url","default":"''","required":"no"}],"return":{"content":"Default embed parameters.","types":"array"}},{"name":"wp_oembed_get","desc":"","summary":"Attempts to fetch the embed HTML for a provided URL using oEmbed.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The URL that should be embedded.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Additional arguments and parameters for retrieving embed HTML. Default empty.","types":"array","variable":"$args","default":"''","required":"no"}],"return":{"content":"False on failure or the embed HTML on success.","types":"false|string"}},{"name":"_wp_oembed_get_object","desc":"","summary":"Returns the initialized WP_oEmbed object.","type":"function","category":"Uncategorised","since":"2.9.0","access":"private","return":{"content":"object.","types":"WP_oEmbed"}},{"name":"wp_oembed_add_provider","desc":"","summary":"Adds a URL format and oEmbed provider URL pair.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The format of URL that this provider can handle. You can use asterisks as wildcards.","types":"string","variable":"$format","default":"null","required":"yes"},{"content":"The URL to the oEmbed provider.","types":"string","variable":"$provider","default":"null","required":"yes"},{"content":" Whether the <code>$format</code> parameter is in a RegEx format. Default false.","types":"boolean","variable":"$regex","default":"false","required":"no"}]},{"name":"wp_oembed_remove_provider","desc":"","summary":"Removes an oEmbed provider.","type":"function","category":"Other functions","since":"3.5.0","param":[{"content":"The URL format for the oEmbed provider to remove.","types":"string","variable":"$format","default":"null","required":"yes"}],"return":{"content":"Was the provider removed successfully?","types":"bool"}},{"name":"wp_maybe_load_embeds","desc":"<p>Checks to make sure that the embeds library hasn't already been loaded. If it hasn't, then it will load the embeds library.</p>","summary":"Determines if default embed handlers should be loaded.","type":"function","category":"Uncategorised","since":"2.9.0"},{"name":"wp_embed_handler_youtube","desc":"<p>Catches YouTube iframe embed URLs that are not parsable by oEmbed but can be translated into a URL that is.</p>","summary":"YouTube iframe embed handler callback.","type":"function","category":"Uncategorised","since":"4.0.0","param":[{"content":"The RegEx matches from the provided regex when calling wp_embed_register_handler().","types":"array","variable":"$matches","default":"null","required":"yes"},{"content":"Embed attributes.","types":"array","variable":"$attr","default":"null","required":"yes"},{"content":"The original URL that was matched by the regex.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"The original unmodified attributes.","types":"array","variable":"$rawattr","default":"null","required":"yes"}],"return":{"content":"The embed HTML.","types":"string"}},{"name":"wp_embed_handler_audio","desc":"","summary":"Audio embed handler callback.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"The RegEx matches from the provided regex when calling wp_embed_register_handler().","types":"array","variable":"$matches","default":"null","required":"yes"},{"content":"Embed attributes.","types":"array","variable":"$attr","default":"null","required":"yes"},{"content":"The original URL that was matched by the regex.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"The original unmodified attributes.","types":"array","variable":"$rawattr","default":"null","required":"yes"}],"return":{"content":"The embed HTML.","types":"string"}},{"name":"wp_embed_handler_video","desc":"","summary":"Video embed handler callback.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"The RegEx matches from the provided regex when calling wp_embed_register_handler().","types":"array","variable":"$matches","default":"null","required":"yes"},{"content":"Embed attributes.","types":"array","variable":"$attr","default":"null","required":"yes"},{"content":"The original URL that was matched by the regex.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"The original unmodified attributes.","types":"array","variable":"$rawattr","default":"null","required":"yes"}],"return":{"content":"The embed HTML.","types":"string"}},{"name":"wp_oembed_register_route","desc":"","summary":"Registers the oEmbed REST API route.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"wp_oembed_add_discovery_links","desc":"","summary":"Adds oEmbed discovery links in the website <head>.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"wp_oembed_add_host_js","desc":"","summary":"Adds the necessary JavaScript to communicate with the embedded iframes.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"get_post_embed_url","desc":"","summary":"Retrieves the URL to embed a specific post in an iframe.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" Post ID or object. Defaults to the current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"The post embed URL on success, false if the post doesn't exist.","types":"string|false"}},{"name":"get_oembed_endpoint_url","desc":"<p>Pass an empty string as the first argument to get the endpoint base URL.</p>","summary":"Retrieves the oEmbed endpoint URL for a given permalink.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" The permalink used for the <code>url</code> query arg. Default empty.","types":"string","variable":"$permalink","default":"''","required":"no"},{"content":" The requested response format. Default 'json'.","types":"string","variable":"$format","default":"'json'","required":"no"}],"return":{"content":"The oEmbed endpoint URL.","types":"string"}},{"name":"get_post_embed_html","desc":"","summary":"Retrieves the embed code for a specific post.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The width for the response.","types":"int","variable":"$width","default":"null","required":"yes"},{"content":"The height for the response.","types":"int","variable":"$height","default":"null","required":"yes"},{"content":" Post ID or object. Default is global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Embed code on success, false if post doesn't exist.","types":"string|false"}},{"name":"get_oembed_response_data","desc":"","summary":"Retrieves the oEmbed response data for a given post.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Post object or ID.","types":"WP_Post|int","variable":"$post","default":"null","required":"yes"},{"content":"The requested width.","types":"int","variable":"$width","default":"null","required":"yes"}],"return":{"content":"Response data on success, false if post doesn't exist.","types":"array|false"}},{"name":"get_oembed_response_data_for_url","desc":"","summary":"Retrieves the oEmbed response data for a given URL.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"The URL that should be inspected for discovery <code><link></code> tags.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"oEmbed remote get arguments.","types":"array","variable":"$args","default":"null","required":"yes"}],"return":{"content":"oEmbed response data if the URL does belong to the current site. False otherwise.","types":"object|false"}},{"name":"get_oembed_response_data_rich","desc":"","summary":"Filters the oEmbed response data to return an iframe embed code.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The response data.","types":"array","variable":"$data","default":"null","required":"yes"},{"content":"The post object.","types":"WP_Post","variable":"$post","default":"null","required":"yes"},{"content":"The requested width.","types":"int","variable":"$width","default":"null","required":"yes"},{"content":"The calculated height.","types":"int","variable":"$height","default":"null","required":"yes"}],"return":{"content":"The modified response data.","types":"array"}},{"name":"wp_oembed_ensure_format","desc":"","summary":"Ensures that the specified format is either 'json' or 'xml'.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The oEmbed response format. Accepts 'json' or 'xml'.","types":"string","variable":"$format","default":"null","required":"yes"}],"return":{"content":"The format, either 'xml' or 'json'. Default 'json'.","types":"string"}},{"name":"_oembed_rest_pre_serve_request","desc":"<p>This is only done for the oEmbed API endpoint, which supports both formats.</p>","summary":"Hooks into the REST API output to print XML instead of JSON.","type":"function","category":"Uncategorised","access":"private","since":"4.4.0","param":[{"content":"Whether the request has already been served.","types":"bool","variable":"$served","default":"null","required":"yes"},{"content":"Result to send to the client. Usually a WP_REST_Response.","types":"WP_HTTP_ResponseInterface","variable":"$result","default":"null","required":"yes"},{"content":"Request used to generate the response.","types":"WP_REST_Request","variable":"$request","default":"null","required":"yes"},{"content":"Server instance.","types":"WP_REST_Server","variable":"$server","default":"null","required":"yes"}],"return":{"content":"","types":"true"}},{"name":"_oembed_create_xml","desc":"","summary":"Creates an XML string from a given array.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private","param":[{"content":"The original oEmbed response data.","types":"array","variable":"$data","default":"null","required":"yes"},{"content":" XML node to append the result to recursively.","types":"SimpleXMLElement","variable":"$node","default":"null","required":"no"}],"return":{"content":"XML string on success, false on error.","types":"string|false"}},{"name":"wp_filter_oembed_iframe_title_attribute","desc":"","summary":"Filters the given oEmbed HTML to make sure iframes have a title attribute.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"The oEmbed HTML result.","types":"string","variable":"$result","default":"null","required":"yes"},{"content":"A data object result from an oEmbed provider.","types":"object","variable":"$data","default":"null","required":"yes"},{"content":"The URL of the content to be embedded.","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"The filtered oEmbed result.","types":"string"}},{"name":"wp_filter_oembed_result","desc":"<p>If the <code>$url</code> isn't on the trusted providers list, we need to filter the HTML heavily for security.</p> <p>Only filters 'rich' and 'video' response types.</p>","summary":"Filters the given oEmbed HTML.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The oEmbed HTML result.","types":"string","variable":"$result","default":"null","required":"yes"},{"content":"A data object result from an oEmbed provider.","types":"object","variable":"$data","default":"null","required":"yes"},{"content":"The URL of the content to be embedded.","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"The filtered and sanitized oEmbed result.","types":"string"}},{"name":"wp_embed_excerpt_more","desc":"<p>Replaces '[...]' (appended to automatically generated excerpts) with an ellipsis and a "Continue reading" link in the embed template.</p>","summary":"Filters the string in the 'more' link displayed after a trimmed excerpt.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Default 'more' string.","types":"string","variable":"$more_string","default":"null","required":"yes"}],"return":{"content":"'Continue reading' link prepended with an ellipsis.","types":"string"}},{"name":"the_excerpt_embed","desc":"<p>Intended to be used in 'The Loop'.</p>","summary":"Displays the post excerpt for the embed template.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"wp_embed_excerpt_attachment","desc":"<p>Shows players for video and audio attachments.</p>","summary":"Filters the post excerpt for the embed template.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The current post excerpt.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The modified post excerpt.","types":"string"}},{"name":"enqueue_embed_scripts","desc":"<p>Enqueue PNG fallback CSS for embed iframe for legacy versions of IE.</p> <p>Allows plugins to queue scripts for the embed iframe end using wp_enqueue_script(). Runs first in oembed_head().</p>","summary":"Enqueue embed iframe default CSS and JS & fire do_action('enqueue_embed_scripts')","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"print_embed_styles","desc":"","summary":"Prints the CSS in the embed iframe header.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"print_embed_scripts","desc":"","summary":"Prints the JavaScript in the embed iframe header.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"_oembed_filter_feed_content","desc":"","summary":"Prepare the oembed HTML to be displayed in an RSS feed.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private","param":[{"content":"The content to filter.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The filtered content.","types":"string"}},{"name":"print_embed_comments_button","desc":"","summary":"Prints the necessary markup for the embed comments button.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"print_embed_sharing_button","desc":"","summary":"Prints the necessary markup for the embed sharing button.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"print_embed_sharing_dialog","desc":"","summary":"Prints the necessary markup for the embed sharing dialog.","type":"function","category":"Uncategorised","since":"4.4.0"},{"name":"the_embed_site_title","desc":"","summary":"Prints the necessary markup for the site title in an embed template.","type":"function","category":"Uncategorised","since":"4.5.0"},{"name":"wp_filter_pre_oembed_result","desc":"<p>If the URL belongs to the current site, the result is fetched directly instead of going through the oEmbed discovery process.</p>","summary":"Filters the oEmbed result before any HTTP requests are made.","type":"function","category":"Uncategorised","since":"4.5.3","param":[{"content":"The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null.","types":"null|string","variable":"$result","default":"null","required":"yes"},{"content":"The URL that should be inspected for discovery <code><link></code> tags.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"oEmbed remote get arguments.","types":"array","variable":"$args","default":"null","required":"yes"}],"return":{"content":"The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Null if the URL does not belong to the current site.","types":"null|string"}},{"name":"wp_paused_plugins","desc":"","summary":"Get the instance for storing paused plugins.","type":"function","category":"Uncategorised","return":{"content":"","types":"WP_Paused_Extensions_Storage"}},{"name":"wp_paused_themes","desc":"","summary":"Get the instance for storing paused extensions.","type":"function","category":"Uncategorised","return":{"content":"","types":"WP_Paused_Extensions_Storage"}},{"name":"wp_get_extension_error_description","desc":"","summary":"Get a human readable description of an extension's error.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"Error details {@see error_get_last()}","types":"array","variable":"$error","default":"null","required":"yes"}],"return":{"content":"Formatted error description.","types":"string"}},{"name":"wp_register_fatal_error_handler","desc":"<p>The handler will only be registered if {@see wp_is_fatal_error_handler_enabled()} returns true.</p>","summary":"Registers the shutdown handler for fatal errors.","type":"function","category":"Uncategorised","since":"5.2.0"},{"name":"wp_is_fatal_error_handler_enabled","desc":"<p>A constant <code>WP_DISABLE_FATAL_ERROR_HANDLER</code> can be set in <code>wp-config.php</code> to disable it, or alternatively the {@see 'wp_fatal_error_handler_enabled'} filter can be used to modify the return value.</p>","summary":"Checks whether the fatal error handler is enabled.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"True if the fatal error handler is enabled, false otherwise.","types":"bool"}},{"name":"wp_recovery_mode","desc":"","summary":"Access the WordPress Recovery Mode instance.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"","types":"WP_Recovery_Mode"}},{"name":"get_bloginfo_rss","desc":"<p>You can retrieve anything that you can using the get_bloginfo() function. Everything will be stripped of tags and characters converted, when the values are retrieved for use in the feeds.</p>","summary":"RSS container for the bloginfo function.","type":"function","category":"Uncategorised","since":"1.5.1","param":[{"content":"See get_bloginfo() for possible values.","types":"string","variable":"$show","default":"''","required":"no"}],"return":{"content":"","types":"string"}},{"name":"bloginfo_rss","desc":"<p>You can retrieve anything that you can using the get_bloginfo() function. Everything will be stripped of tags and characters converted, when the values are retrieved for use in the feeds.</p>","summary":"Display RSS container for the bloginfo function.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"See get_bloginfo() for possible values.","types":"string","variable":"$show","default":"''","required":"no"}]},{"name":"get_default_feed","desc":"<p>The default feed is 'rss2', unless a plugin changes it through the {@see 'default_feed'} filter.</p>","summary":"Retrieve the default feed.","type":"function","category":"Uncategorised","since":"2.5.0","return":{"content":"Default feed, or for example 'rss2', 'atom', etc.","types":"string"}},{"name":"get_wp_title_rss","desc":"","summary":"Retrieve the blog title for the feed title.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Unused..","types":"string","variable":"$deprecated","default":"'–'","required":"no"}],"return":{"content":"The document title.","types":"string"}},{"name":"wp_title_rss","desc":"","summary":"Display the blog title for display of the feed title.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Unused.","types":"string","variable":"$deprecated","default":"'–'","required":"no"}]},{"name":"get_the_title_rss","desc":"","summary":"Retrieve the current post title for the feed.","type":"function","category":"Uncategorised","since":"2.0.0","return":{"content":"Current post title.","types":"string"}},{"name":"the_title_rss","desc":"","summary":"Display the post title in the feed.","type":"function","category":"Uncategorised","since":"0.71"},{"name":"get_the_content_feed","desc":"","summary":"Retrieve the post content for feeds.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The type of feed. rss2 | atom | rss | rdf","types":"string","variable":"$feed_type","default":"null","required":"no"}],"return":{"content":"The filtered content.","types":"string"}},{"name":"the_content_feed","desc":"","summary":"Display the post content for feeds.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The type of feed. rss2 | atom | rss | rdf","types":"string","variable":"$feed_type","default":"null","required":"no"}]},{"name":"the_excerpt_rss","desc":"","summary":"Display the post excerpt for the feed.","type":"function","category":"Uncategorised","since":"0.71"},{"name":"the_permalink_rss","desc":"","summary":"Display the permalink to the post for use in feeds.","type":"function","category":"Uncategorised","since":"2.3.0"},{"name":"comments_link_feed","desc":"","summary":"Outputs the link to the comments for the current post in an xml safe way","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"","types":"none"}},{"name":"comment_guid","desc":"","summary":"Display the feed GUID for the current comment.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"comment object or id. Defaults to global comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"no"}]},{"name":"get_comment_guid","desc":"","summary":"Retrieve the feed GUID for the current comment.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"comment object or id. Defaults to global comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"null","required":"no"}],"return":{"content":"false on failure or guid for comment on success.","types":"false|string"}},{"name":"comment_link","desc":"","summary":"Display the link to the comments.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" Comment object or id. Defaults to global comment object.","types":"int|WP_Comment","variable":"$comment","default":"null","required":"no"}]},{"name":"get_comment_author_rss","desc":"","summary":"Retrieve the current comment author for use in the feeds.","type":"function","category":"Uncategorised","since":"2.0.0","return":{"content":"Comment Author","types":"string"}},{"name":"comment_author_rss","desc":"","summary":"Display the current comment author in the feed.","type":"function","category":"Uncategorised","since":"1.0.0"},{"name":"comment_text_rss","desc":"","summary":"Display the current comment content for use in the feeds.","type":"function","category":"Uncategorised","since":"1.0.0"},{"name":"get_the_category_rss","desc":"<p>All of the categories for the current post in the feed loop, will be retrieved and have feed markup added, so that they can easily be added to the RSS2, Atom, or RSS1 and RSS0.91 RDF feeds.</p>","summary":"Retrieve all of the post categories, formatted for use in feeds.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":" default is the type returned by get_default_feed().","types":"string","variable":"$type","default":"null","required":"no"}],"return":{"content":"All of the post categories for displaying in the feed.","types":"string"}},{"name":"the_category_rss","desc":"","summary":"Display the post categories in the feed.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" default is the type returned by get_default_feed().","types":"string","variable":"$type","default":"null","required":"no"}]},{"name":"html_type_rss","desc":"<p>The two possible values are either 'xhtml' or 'html'.</p>","summary":"Display the HTML type based on the blog setting.","type":"function","category":"Uncategorised","since":"2.2.0"},{"name":"rss_enclosure","desc":"<p>Uses the global $post to check whether the post requires a password and if the user has the password for the post. If not then it will return before displaying.</p> <p>Also uses the function get_post_custom() to get the post's 'enclosure' metadata field and parses the value to display the enclosure(s). The enclosure(s) consist of enclosure HTML tag(s) with a URI and other attributes.</p>","summary":"Display the rss enclosure for the current post.","type":"function","category":"Uncategorised","since":"1.5.0"},{"name":"atom_enclosure","desc":"<p>Uses the global $post to check whether the post requires a password and if the user has the password for the post. If not then it will return before displaying.</p> <p>Also uses the function get_post_custom() to get the post's 'enclosure' metadata field and parses the value to display the enclosure(s). The enclosure(s) consist of link HTML tag(s) with a URI and other attributes.</p>","summary":"Display the atom enclosure for the current post.","type":"function","category":"Uncategorised","since":"2.2.0"},{"name":"prep_atom_text_construct","desc":"<p>Tell whether the type is text, html, or xhtml, per RFC 4287 section 3.1.</p> <p>In the case of WordPress, text is defined as containing no markup, xhtml is defined as "well formed", and html as tag soup (i.e., the rest).</p> <p>Container div tags are added to xhtml values, per section 3.1.1.3.</p>","summary":"Determine the type of a string of data with the data formatted.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Input string","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"array(type, value)","types":"array"}},{"name":"atom_site_icon","desc":"","summary":"Displays Site Icon in atom feeds.","type":"function","category":"Uncategorised","since":"4.3.0"},{"name":"rss2_site_icon","desc":"","summary":"Displays Site Icon in RSS2.","type":"function","category":"Uncategorised","since":"4.3.0"},{"name":"self_link","desc":"<p>Generate a correct link for the atom:self element.</p>","summary":"Display the link for the currently displayed feed in a XSS safe way.","type":"function","category":"Uncategorised","since":"2.5.0"},{"name":"get_feed_build_date","desc":"","summary":"","type":"function","category":"Uncategorised"},{"name":"feed_content_type","desc":"","summary":"Return the content type for specified feed type.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'.","types":"string","variable":"$type","default":"''","required":"no"}]},{"name":"fetch_feed","desc":"","summary":"Build SimplePie object based on RSS or Atom feed from URL.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"URL of feed to retrieve. If an array of URLs, the feeds are merged using SimplePie's multifeed feature. See also {@link <a href=\"http://simplepie.org/wiki/faq/typical_multifeed_gotchas\">http://simplepie.org/wiki/faq/typical_multifeed_gotchas</a>}","types":"mixed","variable":"$url","default":"null","required":"yes"}],"return":{"content":"WP_Error object on failure or SimplePie object on success","types":"WP_Error|SimplePie"}},{"name":"wptexturize","desc":"<p>As an example,</p> <pre><code>'cause today's effort makes it worth tomorrow's \"holiday\" ...</code></pre>\n<p>Becomes:</p>\n<pre><code>&#8217;cause today&#8217;s effort makes it worth tomorrow&#8217;s &#8220;holiday&#8221; &#8230;</code></pre> <p>Code within certain html blocks are skipped.</p> <p>Do not use this function before the {@see 'init'} action hook; everything will break.</p>","summary":"Replaces common plain text characters into formatted entities","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"The text to be formatted","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Set to true for unit testing. Translated patterns will reset.","types":"bool","variable":"$reset","default":"false","required":"no"}],"return":{"content":"The string replaced with html entities","types":"string"}},{"name":"wptexturize_primes","desc":"","summary":"Implements a logic tree to determine whether or not \"7'.\" represents seven feet, then converts the special char into either a prime char or a closing quote char.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":"The plain text to be searched.","types":"string","variable":"$haystack","default":"null","required":"yes"},{"content":"The character to search for such as ' or ".","types":"string","variable":"$needle","default":"null","required":"yes"},{"content":"The prime char to use for replacement.","types":"string","variable":"$prime","default":"null","required":"yes"},{"content":"The opening quote char. Opening quote replacement must be accomplished already.","types":"string","variable":"$open_quote","default":"null","required":"yes"},{"content":"The closing quote char to use for replacement.","types":"string","variable":"$close_quote","default":"null","required":"yes"}],"return":{"content":"The $haystack value after primes and quotes replacements.","types":"string"}},{"name":"_wptexturize_pushpop_element","desc":"<p>Assumes first char of $text is tag opening and last char is tag closing. Assumes second char of $text is optionally '/' to indicate closing as in </html>.</p>","summary":"Search for disabled element tags. Push element to stack on tag open and pop on tag close.","type":"function","category":"Uncategorised","since":"2.9.0","access":"private","param":[{"content":"Text to check. Must be a tag like <code><html></code> or <code>[shortcode]</code>.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"List of open tag elements.","types":"array","variable":"$stack","default":"null","required":"yes"},{"content":"The tag names to match against. Spaces are not allowed in tag names.","types":"array","variable":"$disabled_elements","default":"null","required":"yes"}]},{"name":"wpautop","desc":"<p>A group of regex replaces used to identify text formatted with newlines and replace double line-breaks with HTML paragraph tags. The remaining line-breaks after conversion become <<br />> tags, unless $br is set to '0' or 'false'.</p>","summary":"Replaces double line-breaks with paragraph elements.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"The text which has to be formatted.","types":"string","variable":"$pee","default":"null","required":"yes"},{"content":" If set, this will convert all remaining line-breaks after paragraphing. Default true.","types":"bool","variable":"$br","default":"true","required":"no"}],"return":{"content":"Text which has been converted into correct paragraph tags.","types":"string"}},{"name":"wp_html_split","desc":"","summary":"Separate HTML elements and comments from the text.","type":"function","category":"Uncategorised","since":"4.2.4","param":[{"content":"The text which has to be formatted.","types":"string","variable":"$input","default":"null","required":"yes"}],"return":{"content":"The formatted text.","types":"array"}},{"name":"get_html_split_regex","desc":"","summary":"Retrieve the regular expression for an HTML element.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"The regular expression","types":"string"}},{"name":"_get_wptexturize_split_regex","desc":"","summary":"Retrieve the combined regular expression for HTML and shortcodes.","type":"function","category":"Uncategorised","access":"private","since":"4.4.0","param":[{"content":"The result from _get_wptexturize_shortcode_regex(). Optional.","types":"string","variable":"$shortcode_regex","default":"''","required":"no"}],"return":{"content":"The regular expression","types":"string"}},{"name":"_get_wptexturize_shortcode_regex","desc":"","summary":"Retrieve the regular expression for shortcodes.","type":"function","category":"Uncategorised","access":"private","since":"4.4.0","param":[{"content":"List of shortcodes to find.","types":"array","variable":"$tagnames","default":"null","required":"yes"}],"return":{"content":"The regular expression","types":"string"}},{"name":"wp_replace_in_html_tags","desc":"","summary":"Replace characters or phrases within HTML elements only.","type":"function","category":"Uncategorised","since":"4.2.3","param":[{"content":"The text which has to be formatted.","types":"string","variable":"$haystack","default":"null","required":"yes"},{"content":"In the form array('from' => 'to', ...).","types":"array","variable":"$replace_pairs","default":"null","required":"yes"}],"return":{"content":"The formatted text.","types":"string"}},{"name":"_autop_newline_preservation_helper","desc":"","summary":"Newline preservation help function for wpautop","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"preg_replace_callback matches array","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"shortcode_unautop","desc":"<p>Ensures that shortcodes are not wrapped in <code><p>...</p></code>.</p>","summary":"Don't auto-p wrap shortcodes that stand alone","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The content.","types":"string","variable":"$pee","default":"null","required":"yes"}],"return":{"content":"The filtered content.","types":"string"}},{"name":"seems_utf8","desc":"<p>NOTE: This function checks for 5-Byte sequences, UTF8 has Bytes Sequences with a maximum length of 4.</p>","summary":"Checks to see if a string is utf8 encoded.","type":"function","category":"Uncategorised","since":"1.2.1","param":[{"content":"The string to be checked","types":"string","variable":"$str","default":"null","required":"yes"}],"return":{"content":"True if $str fits a UTF-8 model, false otherwise.","types":"bool"}},{"name":"_wp_specialchars","desc":"<p>Specifically deals with: &, <, >, ", and '.</p> <p>$quote_style can be set to ENT_COMPAT to encode " to ", or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.</p>","summary":"Converts a number of special characters into their HTML entities.","type":"function","category":"Uncategorised","since":"1.2.2","access":"private","param":[{"content":"The text which is to be encoded.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":" 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.","types":"int|string","variable":"$quote_style","default":"ENT_NOQUOTES","required":"no"},{"content":" The character encoding of the string. Default is false.","types":"string","variable":"$charset","default":"false","required":"no"},{"content":" Whether to encode existing html entities. Default is false.","types":"bool","variable":"$double_encode","default":"false","required":"no"}],"return":{"content":"The encoded text with HTML entities.","types":"string"}},{"name":"wp_specialchars_decode","desc":"<p>Specifically deals with: &, <, >, ", and '.</p> <p>$quote_style can be set to ENT_COMPAT to decode " entities, or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.</p>","summary":"Converts a number of HTML entities into their special characters.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"The text which is to be decoded.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":" 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.","types":"string|int","variable":"$quote_style","default":"ENT_NOQUOTES","required":"no"}],"return":{"content":"The decoded text without HTML entities.","types":"string"}},{"name":"wp_check_invalid_utf8","desc":"","summary":"Checks for invalid UTF8 in a string.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"The text which is to be checked.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":" Whether to attempt to strip out invalid UTF8. Default is false.","types":"bool","variable":"$strip","default":"false","required":"no"}],"return":{"content":"The checked text.","types":"string"}},{"name":"utf8_uri_encode","desc":"","summary":"Encode the Unicode values to be used in the URI.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"","types":"string","variable":"$utf8_string","default":"null","required":"yes"},{"content":"Max length of the string","types":"int","variable":"$length","default":"0","required":"yes"}],"return":{"content":"String with Unicode encoded for URI.","types":"string"}},{"name":"remove_accents","desc":"<p>If there are no accent characters, then the string given is just returned.</p> <p><strong>Accent characters converted:</strong></p> <p>Currency signs:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+00A3</td> <td>\u00a3</td> <td>(empty)</td> <td>British Pound sign</td> </tr> <tr> <td>U+20AC</td> <td>\u20ac</td> <td>E</td> <td>Euro sign</td> </tr> </tbody> </table> <p>Decompositions for Latin-1 Supplement:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+00AA</td> <td>\u00aa</td> <td>a</td> <td>Feminine ordinal indicator</td> </tr> <tr> <td>U+00BA</td> <td>\u00ba</td> <td>o</td> <td>Masculine ordinal indicator</td> </tr> <tr> <td>U+00C0</td> <td>\u00c0</td> <td>A</td> <td>Latin capital letter A with grave</td> </tr> <tr> <td>U+00C1</td> <td>\u00c1</td> <td>A</td> <td>Latin capital letter A with acute</td> </tr> <tr> <td>U+00C2</td> <td>\u00c2</td> <td>A</td> <td>Latin capital letter A with circumflex</td> </tr> <tr> <td>U+00C3</td> <td>\u00c3</td> <td>A</td> <td>Latin capital letter A with tilde</td> </tr> <tr> <td>U+00C4</td> <td>\u00c4</td> <td>A</td> <td>Latin capital letter A with diaeresis</td> </tr> <tr> <td>U+00C5</td> <td>\u00c5</td> <td>A</td> <td>Latin capital letter A with ring above</td> </tr> <tr> <td>U+00C6</td> <td>\u00c6</td> <td>AE</td> <td>Latin capital letter AE</td> </tr> <tr> <td>U+00C7</td> <td>\u00c7</td> <td>C</td> <td>Latin capital letter C with cedilla</td> </tr> <tr> <td>U+00C8</td> <td>\u00c8</td> <td>E</td> <td>Latin capital letter E with grave</td> </tr> <tr> <td>U+00C9</td> <td>\u00c9</td> <td>E</td> <td>Latin capital letter E with acute</td> </tr> <tr> <td>U+00CA</td> <td>\u00ca</td> <td>E</td> <td>Latin capital letter E with circumflex</td> </tr> <tr> <td>U+00CB</td> <td>\u00cb</td> <td>E</td> <td>Latin capital letter E with diaeresis</td> </tr> <tr> <td>U+00CC</td> <td>\u00cc</td> <td>I</td> <td>Latin capital letter I with grave</td> </tr> <tr> <td>U+00CD</td> <td>\u00cd</td> <td>I</td> <td>Latin capital letter I with acute</td> </tr> <tr> <td>U+00CE</td> <td>\u00ce</td> <td>I</td> <td>Latin capital letter I with circumflex</td> </tr> <tr> <td>U+00CF</td> <td>\u00cf</td> <td>I</td> <td>Latin capital letter I with diaeresis</td> </tr> <tr> <td>U+00D0</td> <td>\u00d0</td> <td>D</td> <td>Latin capital letter Eth</td> </tr> <tr> <td>U+00D1</td> <td>\u00d1</td> <td>N</td> <td>Latin capital letter N with tilde</td> </tr> <tr> <td>U+00D2</td> <td>\u00d2</td> <td>O</td> <td>Latin capital letter O with grave</td> </tr> <tr> <td>U+00D3</td> <td>\u00d3</td> <td>O</td> <td>Latin capital letter O with acute</td> </tr> <tr> <td>U+00D4</td> <td>\u00d4</td> <td>O</td> <td>Latin capital letter O with circumflex</td> </tr> <tr> <td>U+00D5</td> <td>\u00d5</td> <td>O</td> <td>Latin capital letter O with tilde</td> </tr> <tr> <td>U+00D6</td> <td>\u00d6</td> <td>O</td> <td>Latin capital letter O with diaeresis</td> </tr> <tr> <td>U+00D8</td> <td>\u00d8</td> <td>O</td> <td>Latin capital letter O with stroke</td> </tr> <tr> <td>U+00D9</td> <td>\u00d9</td> <td>U</td> <td>Latin capital letter U with grave</td> </tr> <tr> <td>U+00DA</td> <td>\u00da</td> <td>U</td> <td>Latin capital letter U with acute</td> </tr> <tr> <td>U+00DB</td> <td>\u00db</td> <td>U</td> <td>Latin capital letter U with circumflex</td> </tr> <tr> <td>U+00DC</td> <td>\u00dc</td> <td>U</td> <td>Latin capital letter U with diaeresis</td> </tr> <tr> <td>U+00DD</td> <td>\u00dd</td> <td>Y</td> <td>Latin capital letter Y with acute</td> </tr> <tr> <td>U+00DE</td> <td>\u00de</td> <td>TH</td> <td>Latin capital letter Thorn</td> </tr> <tr> <td>U+00DF</td> <td>\u00df</td> <td>s</td> <td>Latin small letter sharp s</td> </tr> <tr> <td>U+00E0</td> <td>\u00e0</td> <td>a</td> <td>Latin small letter a with grave</td> </tr> <tr> <td>U+00E1</td> <td>\u00e1</td> <td>a</td> <td>Latin small letter a with acute</td> </tr> <tr> <td>U+00E2</td> <td>\u00e2</td> <td>a</td> <td>Latin small letter a with circumflex</td> </tr> <tr> <td>U+00E3</td> <td>\u00e3</td> <td>a</td> <td>Latin small letter a with tilde</td> </tr> <tr> <td>U+00E4</td> <td>\u00e4</td> <td>a</td> <td>Latin small letter a with diaeresis</td> </tr> <tr> <td>U+00E5</td> <td>\u00e5</td> <td>a</td> <td>Latin small letter a with ring above</td> </tr> <tr> <td>U+00E6</td> <td>\u00e6</td> <td>ae</td> <td>Latin small letter ae</td> </tr> <tr> <td>U+00E7</td> <td>\u00e7</td> <td>c</td> <td>Latin small letter c with cedilla</td> </tr> <tr> <td>U+00E8</td> <td>\u00e8</td> <td>e</td> <td>Latin small letter e with grave</td> </tr> <tr> <td>U+00E9</td> <td>\u00e9</td> <td>e</td> <td>Latin small letter e with acute</td> </tr> <tr> <td>U+00EA</td> <td>\u00ea</td> <td>e</td> <td>Latin small letter e with circumflex</td> </tr> <tr> <td>U+00EB</td> <td>\u00eb</td> <td>e</td> <td>Latin small letter e with diaeresis</td> </tr> <tr> <td>U+00EC</td> <td>\u00ec</td> <td>i</td> <td>Latin small letter i with grave</td> </tr> <tr> <td>U+00ED</td> <td>\u00ed</td> <td>i</td> <td>Latin small letter i with acute</td> </tr> <tr> <td>U+00EE</td> <td>\u00ee</td> <td>i</td> <td>Latin small letter i with circumflex</td> </tr> <tr> <td>U+00EF</td> <td>\u00ef</td> <td>i</td> <td>Latin small letter i with diaeresis</td> </tr> <tr> <td>U+00F0</td> <td>\u00f0</td> <td>d</td> <td>Latin small letter Eth</td> </tr> <tr> <td>U+00F1</td> <td>\u00f1</td> <td>n</td> <td>Latin small letter n with tilde</td> </tr> <tr> <td>U+00F2</td> <td>\u00f2</td> <td>o</td> <td>Latin small letter o with grave</td> </tr> <tr> <td>U+00F3</td> <td>\u00f3</td> <td>o</td> <td>Latin small letter o with acute</td> </tr> <tr> <td>U+00F4</td> <td>\u00f4</td> <td>o</td> <td>Latin small letter o with circumflex</td> </tr> <tr> <td>U+00F5</td> <td>\u00f5</td> <td>o</td> <td>Latin small letter o with tilde</td> </tr> <tr> <td>U+00F6</td> <td>\u00f6</td> <td>o</td> <td>Latin small letter o with diaeresis</td> </tr> <tr> <td>U+00F8</td> <td>\u00f8</td> <td>o</td> <td>Latin small letter o with stroke</td> </tr> <tr> <td>U+00F9</td> <td>\u00f9</td> <td>u</td> <td>Latin small letter u with grave</td> </tr> <tr> <td>U+00FA</td> <td>\u00fa</td> <td>u</td> <td>Latin small letter u with acute</td> </tr> <tr> <td>U+00FB</td> <td>\u00fb</td> <td>u</td> <td>Latin small letter u with circumflex</td> </tr> <tr> <td>U+00FC</td> <td>\u00fc</td> <td>u</td> <td>Latin small letter u with diaeresis</td> </tr> <tr> <td>U+00FD</td> <td>\u00fd</td> <td>y</td> <td>Latin small letter y with acute</td> </tr> <tr> <td>U+00FE</td> <td>\u00fe</td> <td>th</td> <td>Latin small letter Thorn</td> </tr> <tr> <td>U+00FF</td> <td>\u00ff</td> <td>y</td> <td>Latin small letter y with diaeresis</td> </tr> </tbody> </table> <p>Decompositions for Latin Extended-A:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+0100</td> <td>\u0100</td> <td>A</td> <td>Latin capital letter A with macron</td> </tr> <tr> <td>U+0101</td> <td>\u0101</td> <td>a</td> <td>Latin small letter a with macron</td> </tr> <tr> <td>U+0102</td> <td>\u0102</td> <td>A</td> <td>Latin capital letter A with breve</td> </tr> <tr> <td>U+0103</td> <td>\u0103</td> <td>a</td> <td>Latin small letter a with breve</td> </tr> <tr> <td>U+0104</td> <td>\u0104</td> <td>A</td> <td>Latin capital letter A with ogonek</td> </tr> <tr> <td>U+0105</td> <td>\u0105</td> <td>a</td> <td>Latin small letter a with ogonek</td> </tr> <tr> <td>U+01006</td> <td>\u0106</td> <td>C</td> <td>Latin capital letter C with acute</td> </tr> <tr> <td>U+0107</td> <td>\u0107</td> <td>c</td> <td>Latin small letter c with acute</td> </tr> <tr> <td>U+0108</td> <td>\u0108</td> <td>C</td> <td>Latin capital letter C with circumflex</td> </tr> <tr> <td>U+0109</td> <td>\u0109</td> <td>c</td> <td>Latin small letter c with circumflex</td> </tr> <tr> <td>U+010A</td> <td>\u010a</td> <td>C</td> <td>Latin capital letter C with dot above</td> </tr> <tr> <td>U+010B</td> <td>\u010b</td> <td>c</td> <td>Latin small letter c with dot above</td> </tr> <tr> <td>U+010C</td> <td>\u010c</td> <td>C</td> <td>Latin capital letter C with caron</td> </tr> <tr> <td>U+010D</td> <td>\u010d</td> <td>c</td> <td>Latin small letter c with caron</td> </tr> <tr> <td>U+010E</td> <td>\u010e</td> <td>D</td> <td>Latin capital letter D with caron</td> </tr> <tr> <td>U+010F</td> <td>\u010f</td> <td>d</td> <td>Latin small letter d with caron</td> </tr> <tr> <td>U+0110</td> <td>\u0110</td> <td>D</td> <td>Latin capital letter D with stroke</td> </tr> <tr> <td>U+0111</td> <td>\u0111</td> <td>d</td> <td>Latin small letter d with stroke</td> </tr> <tr> <td>U+0112</td> <td>\u0112</td> <td>E</td> <td>Latin capital letter E with macron</td> </tr> <tr> <td>U+0113</td> <td>\u0113</td> <td>e</td> <td>Latin small letter e with macron</td> </tr> <tr> <td>U+0114</td> <td>\u0114</td> <td>E</td> <td>Latin capital letter E with breve</td> </tr> <tr> <td>U+0115</td> <td>\u0115</td> <td>e</td> <td>Latin small letter e with breve</td> </tr> <tr> <td>U+0116</td> <td>\u0116</td> <td>E</td> <td>Latin capital letter E with dot above</td> </tr> <tr> <td>U+0117</td> <td>\u0117</td> <td>e</td> <td>Latin small letter e with dot above</td> </tr> <tr> <td>U+0118</td> <td>\u0118</td> <td>E</td> <td>Latin capital letter E with ogonek</td> </tr> <tr> <td>U+0119</td> <td>\u0119</td> <td>e</td> <td>Latin small letter e with ogonek</td> </tr> <tr> <td>U+011A</td> <td>\u011a</td> <td>E</td> <td>Latin capital letter E with caron</td> </tr> <tr> <td>U+011B</td> <td>\u011b</td> <td>e</td> <td>Latin small letter e with caron</td> </tr> <tr> <td>U+011C</td> <td>\u011c</td> <td>G</td> <td>Latin capital letter G with circumflex</td> </tr> <tr> <td>U+011D</td> <td>\u011d</td> <td>g</td> <td>Latin small letter g with circumflex</td> </tr> <tr> <td>U+011E</td> <td>\u011e</td> <td>G</td> <td>Latin capital letter G with breve</td> </tr> <tr> <td>U+011F</td> <td>\u011f</td> <td>g</td> <td>Latin small letter g with breve</td> </tr> <tr> <td>U+0120</td> <td>\u0120</td> <td>G</td> <td>Latin capital letter G with dot above</td> </tr> <tr> <td>U+0121</td> <td>\u0121</td> <td>g</td> <td>Latin small letter g with dot above</td> </tr> <tr> <td>U+0122</td> <td>\u0122</td> <td>G</td> <td>Latin capital letter G with cedilla</td> </tr> <tr> <td>U+0123</td> <td>\u0123</td> <td>g</td> <td>Latin small letter g with cedilla</td> </tr> <tr> <td>U+0124</td> <td>\u0124</td> <td>H</td> <td>Latin capital letter H with circumflex</td> </tr> <tr> <td>U+0125</td> <td>\u0125</td> <td>h</td> <td>Latin small letter h with circumflex</td> </tr> <tr> <td>U+0126</td> <td>\u0126</td> <td>H</td> <td>Latin capital letter H with stroke</td> </tr> <tr> <td>U+0127</td> <td>\u0127</td> <td>h</td> <td>Latin small letter h with stroke</td> </tr> <tr> <td>U+0128</td> <td>\u0128</td> <td>I</td> <td>Latin capital letter I with tilde</td> </tr> <tr> <td>U+0129</td> <td>\u0129</td> <td>i</td> <td>Latin small letter i with tilde</td> </tr> <tr> <td>U+012A</td> <td>\u012a</td> <td>I</td> <td>Latin capital letter I with macron</td> </tr> <tr> <td>U+012B</td> <td>\u012b</td> <td>i</td> <td>Latin small letter i with macron</td> </tr> <tr> <td>U+012C</td> <td>\u012c</td> <td>I</td> <td>Latin capital letter I with breve</td> </tr> <tr> <td>U+012D</td> <td>\u012d</td> <td>i</td> <td>Latin small letter i with breve</td> </tr> <tr> <td>U+012E</td> <td>\u012e</td> <td>I</td> <td>Latin capital letter I with ogonek</td> </tr> <tr> <td>U+012F</td> <td>\u012f</td> <td>i</td> <td>Latin small letter i with ogonek</td> </tr> <tr> <td>U+0130</td> <td>\u0130</td> <td>I</td> <td>Latin capital letter I with dot above</td> </tr> <tr> <td>U+0131</td> <td>\u0131</td> <td>i</td> <td>Latin small letter dotless i</td> </tr> <tr> <td>U+0132</td> <td>\u0132</td> <td>IJ</td> <td>Latin capital ligature IJ</td> </tr> <tr> <td>U+0133</td> <td>\u0133</td> <td>ij</td> <td>Latin small ligature ij</td> </tr> <tr> <td>U+0134</td> <td>\u0134</td> <td>J</td> <td>Latin capital letter J with circumflex</td> </tr> <tr> <td>U+0135</td> <td>\u0135</td> <td>j</td> <td>Latin small letter j with circumflex</td> </tr> <tr> <td>U+0136</td> <td>\u0136</td> <td>K</td> <td>Latin capital letter K with cedilla</td> </tr> <tr> <td>U+0137</td> <td>\u0137</td> <td>k</td> <td>Latin small letter k with cedilla</td> </tr> <tr> <td>U+0138</td> <td>\u0138</td> <td>k</td> <td>Latin small letter Kra</td> </tr> <tr> <td>U+0139</td> <td>\u0139</td> <td>L</td> <td>Latin capital letter L with acute</td> </tr> <tr> <td>U+013A</td> <td>\u013a</td> <td>l</td> <td>Latin small letter l with acute</td> </tr> <tr> <td>U+013B</td> <td>\u013b</td> <td>L</td> <td>Latin capital letter L with cedilla</td> </tr> <tr> <td>U+013C</td> <td>\u013c</td> <td>l</td> <td>Latin small letter l with cedilla</td> </tr> <tr> <td>U+013D</td> <td>\u013d</td> <td>L</td> <td>Latin capital letter L with caron</td> </tr> <tr> <td>U+013E</td> <td>\u013e</td> <td>l</td> <td>Latin small letter l with caron</td> </tr> <tr> <td>U+013F</td> <td>\u013f</td> <td>L</td> <td>Latin capital letter L with middle dot</td> </tr> <tr> <td>U+0140</td> <td>\u0140</td> <td>l</td> <td>Latin small letter l with middle dot</td> </tr> <tr> <td>U+0141</td> <td>\u0141</td> <td>L</td> <td>Latin capital letter L with stroke</td> </tr> <tr> <td>U+0142</td> <td>\u0142</td> <td>l</td> <td>Latin small letter l with stroke</td> </tr> <tr> <td>U+0143</td> <td>\u0143</td> <td>N</td> <td>Latin capital letter N with acute</td> </tr> <tr> <td>U+0144</td> <td>\u0144</td> <td>n</td> <td>Latin small letter N with acute</td> </tr> <tr> <td>U+0145</td> <td>\u0145</td> <td>N</td> <td>Latin capital letter N with cedilla</td> </tr> <tr> <td>U+0146</td> <td>\u0146</td> <td>n</td> <td>Latin small letter n with cedilla</td> </tr> <tr> <td>U+0147</td> <td>\u0147</td> <td>N</td> <td>Latin capital letter N with caron</td> </tr> <tr> <td>U+0148</td> <td>\u0148</td> <td>n</td> <td>Latin small letter n with caron</td> </tr> <tr> <td>U+0149</td> <td>\u0149</td> <td>n</td> <td>Latin small letter n preceded by apostrophe</td> </tr> <tr> <td>U+014A</td> <td>\u014a</td> <td>N</td> <td>Latin capital letter Eng</td> </tr> <tr> <td>U+014B</td> <td>\u014b</td> <td>n</td> <td>Latin small letter Eng</td> </tr> <tr> <td>U+014C</td> <td>\u014c</td> <td>O</td> <td>Latin capital letter O with macron</td> </tr> <tr> <td>U+014D</td> <td>\u014d</td> <td>o</td> <td>Latin small letter o with macron</td> </tr> <tr> <td>U+014E</td> <td>\u014e</td> <td>O</td> <td>Latin capital letter O with breve</td> </tr> <tr> <td>U+014F</td> <td>\u014f</td> <td>o</td> <td>Latin small letter o with breve</td> </tr> <tr> <td>U+0150</td> <td>\u0150</td> <td>O</td> <td>Latin capital letter O with double acute</td> </tr> <tr> <td>U+0151</td> <td>\u0151</td> <td>o</td> <td>Latin small letter o with double acute</td> </tr> <tr> <td>U+0152</td> <td>\u0152</td> <td>OE</td> <td>Latin capital ligature OE</td> </tr> <tr> <td>U+0153</td> <td>\u0153</td> <td>oe</td> <td>Latin small ligature oe</td> </tr> <tr> <td>U+0154</td> <td>\u0154</td> <td>R</td> <td>Latin capital letter R with acute</td> </tr> <tr> <td>U+0155</td> <td>\u0155</td> <td>r</td> <td>Latin small letter r with acute</td> </tr> <tr> <td>U+0156</td> <td>\u0156</td> <td>R</td> <td>Latin capital letter R with cedilla</td> </tr> <tr> <td>U+0157</td> <td>\u0157</td> <td>r</td> <td>Latin small letter r with cedilla</td> </tr> <tr> <td>U+0158</td> <td>\u0158</td> <td>R</td> <td>Latin capital letter R with caron</td> </tr> <tr> <td>U+0159</td> <td>\u0159</td> <td>r</td> <td>Latin small letter r with caron</td> </tr> <tr> <td>U+015A</td> <td>\u015a</td> <td>S</td> <td>Latin capital letter S with acute</td> </tr> <tr> <td>U+015B</td> <td>\u015b</td> <td>s</td> <td>Latin small letter s with acute</td> </tr> <tr> <td>U+015C</td> <td>\u015c</td> <td>S</td> <td>Latin capital letter S with circumflex</td> </tr> <tr> <td>U+015D</td> <td>\u015d</td> <td>s</td> <td>Latin small letter s with circumflex</td> </tr> <tr> <td>U+015E</td> <td>\u015e</td> <td>S</td> <td>Latin capital letter S with cedilla</td> </tr> <tr> <td>U+015F</td> <td>\u015f</td> <td>s</td> <td>Latin small letter s with cedilla</td> </tr> <tr> <td>U+0160</td> <td>\u0160</td> <td>S</td> <td>Latin capital letter S with caron</td> </tr> <tr> <td>U+0161</td> <td>\u0161</td> <td>s</td> <td>Latin small letter s with caron</td> </tr> <tr> <td>U+0162</td> <td>\u0162</td> <td>T</td> <td>Latin capital letter T with cedilla</td> </tr> <tr> <td>U+0163</td> <td>\u0163</td> <td>t</td> <td>Latin small letter t with cedilla</td> </tr> <tr> <td>U+0164</td> <td>\u0164</td> <td>T</td> <td>Latin capital letter T with caron</td> </tr> <tr> <td>U+0165</td> <td>\u0165</td> <td>t</td> <td>Latin small letter t with caron</td> </tr> <tr> <td>U+0166</td> <td>\u0166</td> <td>T</td> <td>Latin capital letter T with stroke</td> </tr> <tr> <td>U+0167</td> <td>\u0167</td> <td>t</td> <td>Latin small letter t with stroke</td> </tr> <tr> <td>U+0168</td> <td>\u0168</td> <td>U</td> <td>Latin capital letter U with tilde</td> </tr> <tr> <td>U+0169</td> <td>\u0169</td> <td>u</td> <td>Latin small letter u with tilde</td> </tr> <tr> <td>U+016A</td> <td>\u016a</td> <td>U</td> <td>Latin capital letter U with macron</td> </tr> <tr> <td>U+016B</td> <td>\u016b</td> <td>u</td> <td>Latin small letter u with macron</td> </tr> <tr> <td>U+016C</td> <td>\u016c</td> <td>U</td> <td>Latin capital letter U with breve</td> </tr> <tr> <td>U+016D</td> <td>\u016d</td> <td>u</td> <td>Latin small letter u with breve</td> </tr> <tr> <td>U+016E</td> <td>\u016e</td> <td>U</td> <td>Latin capital letter U with ring above</td> </tr> <tr> <td>U+016F</td> <td>\u016f</td> <td>u</td> <td>Latin small letter u with ring above</td> </tr> <tr> <td>U+0170</td> <td>\u0170</td> <td>U</td> <td>Latin capital letter U with double acute</td> </tr> <tr> <td>U+0171</td> <td>\u0171</td> <td>u</td> <td>Latin small letter u with double acute</td> </tr> <tr> <td>U+0172</td> <td>\u0172</td> <td>U</td> <td>Latin capital letter U with ogonek</td> </tr> <tr> <td>U+0173</td> <td>\u0173</td> <td>u</td> <td>Latin small letter u with ogonek</td> </tr> <tr> <td>U+0174</td> <td>\u0174</td> <td>W</td> <td>Latin capital letter W with circumflex</td> </tr> <tr> <td>U+0175</td> <td>\u0175</td> <td>w</td> <td>Latin small letter w with circumflex</td> </tr> <tr> <td>U+0176</td> <td>\u0176</td> <td>Y</td> <td>Latin capital letter Y with circumflex</td> </tr> <tr> <td>U+0177</td> <td>\u0177</td> <td>y</td> <td>Latin small letter y with circumflex</td> </tr> <tr> <td>U+0178</td> <td>\u0178</td> <td>Y</td> <td>Latin capital letter Y with diaeresis</td> </tr> <tr> <td>U+0179</td> <td>\u0179</td> <td>Z</td> <td>Latin capital letter Z with acute</td> </tr> <tr> <td>U+017A</td> <td>\u017a</td> <td>z</td> <td>Latin small letter z with acute</td> </tr> <tr> <td>U+017B</td> <td>\u017b</td> <td>Z</td> <td>Latin capital letter Z with dot above</td> </tr> <tr> <td>U+017C</td> <td>\u017c</td> <td>z</td> <td>Latin small letter z with dot above</td> </tr> <tr> <td>U+017D</td> <td>\u017d</td> <td>Z</td> <td>Latin capital letter Z with caron</td> </tr> <tr> <td>U+017E</td> <td>\u017e</td> <td>z</td> <td>Latin small letter z with caron</td> </tr> <tr> <td>U+017F</td> <td>\u017f</td> <td>s</td> <td>Latin small letter long s</td> </tr> <tr> <td>U+01A0</td> <td>\u01a0</td> <td>O</td> <td>Latin capital letter O with horn</td> </tr> <tr> <td>U+01A1</td> <td>\u01a1</td> <td>o</td> <td>Latin small letter o with horn</td> </tr> <tr> <td>U+01AF</td> <td>\u01af</td> <td>U</td> <td>Latin capital letter U with horn</td> </tr> <tr> <td>U+01B0</td> <td>\u01b0</td> <td>u</td> <td>Latin small letter u with horn</td> </tr> <tr> <td>U+01CD</td> <td>\u01cd</td> <td>A</td> <td>Latin capital letter A with caron</td> </tr> <tr> <td>U+01CE</td> <td>\u01ce</td> <td>a</td> <td>Latin small letter a with caron</td> </tr> <tr> <td>U+01CF</td> <td>\u01cf</td> <td>I</td> <td>Latin capital letter I with caron</td> </tr> <tr> <td>U+01D0</td> <td>\u01d0</td> <td>i</td> <td>Latin small letter i with caron</td> </tr> <tr> <td>U+01D1</td> <td>\u01d1</td> <td>O</td> <td>Latin capital letter O with caron</td> </tr> <tr> <td>U+01D2</td> <td>\u01d2</td> <td>o</td> <td>Latin small letter o with caron</td> </tr> <tr> <td>U+01D3</td> <td>\u01d3</td> <td>U</td> <td>Latin capital letter U with caron</td> </tr> <tr> <td>U+01D4</td> <td>\u01d4</td> <td>u</td> <td>Latin small letter u with caron</td> </tr> <tr> <td>U+01D5</td> <td>\u01d5</td> <td>U</td> <td>Latin capital letter U with diaeresis and macron</td> </tr> <tr> <td>U+01D6</td> <td>\u01d6</td> <td>u</td> <td>Latin small letter u with diaeresis and macron</td> </tr> <tr> <td>U+01D7</td> <td>\u01d7</td> <td>U</td> <td>Latin capital letter U with diaeresis and acute</td> </tr> <tr> <td>U+01D8</td> <td>\u01d8</td> <td>u</td> <td>Latin small letter u with diaeresis and acute</td> </tr> <tr> <td>U+01D9</td> <td>\u01d9</td> <td>U</td> <td>Latin capital letter U with diaeresis and caron</td> </tr> <tr> <td>U+01DA</td> <td>\u01da</td> <td>u</td> <td>Latin small letter u with diaeresis and caron</td> </tr> <tr> <td>U+01DB</td> <td>\u01db</td> <td>U</td> <td>Latin capital letter U with diaeresis and grave</td> </tr> <tr> <td>U+01DC</td> <td>\u01dc</td> <td>u</td> <td>Latin small letter u with diaeresis and grave</td> </tr> </tbody> </table> <p>Decompositions for Latin Extended-B:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+0218</td> <td>\u0218</td> <td>S</td> <td>Latin capital letter S with comma below</td> </tr> <tr> <td>U+0219</td> <td>\u0219</td> <td>s</td> <td>Latin small letter s with comma below</td> </tr> <tr> <td>U+021A</td> <td>\u021a</td> <td>T</td> <td>Latin capital letter T with comma below</td> </tr> <tr> <td>U+021B</td> <td>\u021b</td> <td>t</td> <td>Latin small letter t with comma below</td> </tr> </tbody> </table> <p>Vowels with diacritic (Chinese, Hanyu Pinyin):</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+0251</td> <td>\u0251</td> <td>a</td> <td>Latin small letter alpha</td> </tr> <tr> <td>U+1EA0</td> <td>\u1ea0</td> <td>A</td> <td>Latin capital letter A with dot below</td> </tr> <tr> <td>U+1EA1</td> <td>\u1ea1</td> <td>a</td> <td>Latin small letter a with dot below</td> </tr> <tr> <td>U+1EA2</td> <td>\u1ea2</td> <td>A</td> <td>Latin capital letter A with hook above</td> </tr> <tr> <td>U+1EA3</td> <td>\u1ea3</td> <td>a</td> <td>Latin small letter a with hook above</td> </tr> <tr> <td>U+1EA4</td> <td>\u1ea4</td> <td>A</td> <td>Latin capital letter A with circumflex and acute</td> </tr> <tr> <td>U+1EA5</td> <td>\u1ea5</td> <td>a</td> <td>Latin small letter a with circumflex and acute</td> </tr> <tr> <td>U+1EA6</td> <td>\u1ea6</td> <td>A</td> <td>Latin capital letter A with circumflex and grave</td> </tr> <tr> <td>U+1EA7</td> <td>\u1ea7</td> <td>a</td> <td>Latin small letter a with circumflex and grave</td> </tr> <tr> <td>U+1EA8</td> <td>\u1ea8</td> <td>A</td> <td>Latin capital letter A with circumflex and hook above</td> </tr> <tr> <td>U+1EA9</td> <td>\u1ea9</td> <td>a</td> <td>Latin small letter a with circumflex and hook above</td> </tr> <tr> <td>U+1EAA</td> <td>\u1eaa</td> <td>A</td> <td>Latin capital letter A with circumflex and tilde</td> </tr> <tr> <td>U+1EAB</td> <td>\u1eab</td> <td>a</td> <td>Latin small letter a with circumflex and tilde</td> </tr> <tr> <td>U+1EA6</td> <td>\u1eac</td> <td>A</td> <td>Latin capital letter A with circumflex and dot below</td> </tr> <tr> <td>U+1EAD</td> <td>\u1ead</td> <td>a</td> <td>Latin small letter a with circumflex and dot below</td> </tr> <tr> <td>U+1EAE</td> <td>\u1eae</td> <td>A</td> <td>Latin capital letter A with breve and acute</td> </tr> <tr> <td>U+1EAF</td> <td>\u1eaf</td> <td>a</td> <td>Latin small letter a with breve and acute</td> </tr> <tr> <td>U+1EB0</td> <td>\u1eb0</td> <td>A</td> <td>Latin capital letter A with breve and grave</td> </tr> <tr> <td>U+1EB1</td> <td>\u1eb1</td> <td>a</td> <td>Latin small letter a with breve and grave</td> </tr> <tr> <td>U+1EB2</td> <td>\u1eb2</td> <td>A</td> <td>Latin capital letter A with breve and hook above</td> </tr> <tr> <td>U+1EB3</td> <td>\u1eb3</td> <td>a</td> <td>Latin small letter a with breve and hook above</td> </tr> <tr> <td>U+1EB4</td> <td>\u1eb4</td> <td>A</td> <td>Latin capital letter A with breve and tilde</td> </tr> <tr> <td>U+1EB5</td> <td>\u1eb5</td> <td>a</td> <td>Latin small letter a with breve and tilde</td> </tr> <tr> <td>U+1EB6</td> <td>\u1eb6</td> <td>A</td> <td>Latin capital letter A with breve and dot below</td> </tr> <tr> <td>U+1EB7</td> <td>\u1eb7</td> <td>a</td> <td>Latin small letter a with breve and dot below</td> </tr> <tr> <td>U+1EB8</td> <td>\u1eb8</td> <td>E</td> <td>Latin capital letter E with dot below</td> </tr> <tr> <td>U+1EB9</td> <td>\u1eb9</td> <td>e</td> <td>Latin small letter e with dot below</td> </tr> <tr> <td>U+1EBA</td> <td>\u1eba</td> <td>E</td> <td>Latin capital letter E with hook above</td> </tr> <tr> <td>U+1EBB</td> <td>\u1ebb</td> <td>e</td> <td>Latin small letter e with hook above</td> </tr> <tr> <td>U+1EBC</td> <td>\u1ebc</td> <td>E</td> <td>Latin capital letter E with tilde</td> </tr> <tr> <td>U+1EBD</td> <td>\u1ebd</td> <td>e</td> <td>Latin small letter e with tilde</td> </tr> <tr> <td>U+1EBE</td> <td>\u1ebe</td> <td>E</td> <td>Latin capital letter E with circumflex and acute</td> </tr> <tr> <td>U+1EBF</td> <td>\u1ebf</td> <td>e</td> <td>Latin small letter e with circumflex and acute</td> </tr> <tr> <td>U+1EC0</td> <td>\u1ec0</td> <td>E</td> <td>Latin capital letter E with circumflex and grave</td> </tr> <tr> <td>U+1EC1</td> <td>\u1ec1</td> <td>e</td> <td>Latin small letter e with circumflex and grave</td> </tr> <tr> <td>U+1EC2</td> <td>\u1ec2</td> <td>E</td> <td>Latin capital letter E with circumflex and hook above</td> </tr> <tr> <td>U+1EC3</td> <td>\u1ec3</td> <td>e</td> <td>Latin small letter e with circumflex and hook above</td> </tr> <tr> <td>U+1EC4</td> <td>\u1ec4</td> <td>E</td> <td>Latin capital letter E with circumflex and tilde</td> </tr> <tr> <td>U+1EC5</td> <td>\u1ec5</td> <td>e</td> <td>Latin small letter e with circumflex and tilde</td> </tr> <tr> <td>U+1EC6</td> <td>\u1ec6</td> <td>E</td> <td>Latin capital letter E with circumflex and dot below</td> </tr> <tr> <td>U+1EC7</td> <td>\u1ec7</td> <td>e</td> <td>Latin small letter e with circumflex and dot below</td> </tr> <tr> <td>U+1EC8</td> <td>\u1ec8</td> <td>I</td> <td>Latin capital letter I with hook above</td> </tr> <tr> <td>U+1EC9</td> <td>\u1ec9</td> <td>i</td> <td>Latin small letter i with hook above</td> </tr> <tr> <td>U+1ECA</td> <td>\u1eca</td> <td>I</td> <td>Latin capital letter I with dot below</td> </tr> <tr> <td>U+1ECB</td> <td>\u1ecb</td> <td>i</td> <td>Latin small letter i with dot below</td> </tr> <tr> <td>U+1ECC</td> <td>\u1ecc</td> <td>O</td> <td>Latin capital letter O with dot below</td> </tr> <tr> <td>U+1ECD</td> <td>\u1ecd</td> <td>o</td> <td>Latin small letter o with dot below</td> </tr> <tr> <td>U+1ECE</td> <td>\u1ece</td> <td>O</td> <td>Latin capital letter O with hook above</td> </tr> <tr> <td>U+1ECF</td> <td>\u1ecf</td> <td>o</td> <td>Latin small letter o with hook above</td> </tr> <tr> <td>U+1ED0</td> <td>\u1ed0</td> <td>O</td> <td>Latin capital letter O with circumflex and acute</td> </tr> <tr> <td>U+1ED1</td> <td>\u1ed1</td> <td>o</td> <td>Latin small letter o with circumflex and acute</td> </tr> <tr> <td>U+1ED2</td> <td>\u1ed2</td> <td>O</td> <td>Latin capital letter O with circumflex and grave</td> </tr> <tr> <td>U+1ED3</td> <td>\u1ed3</td> <td>o</td> <td>Latin small letter o with circumflex and grave</td> </tr> <tr> <td>U+1ED4</td> <td>\u1ed4</td> <td>O</td> <td>Latin capital letter O with circumflex and hook above</td> </tr> <tr> <td>U+1ED5</td> <td>\u1ed5</td> <td>o</td> <td>Latin small letter o with circumflex and hook above</td> </tr> <tr> <td>U+1ED6</td> <td>\u1ed6</td> <td>O</td> <td>Latin capital letter O with circumflex and tilde</td> </tr> <tr> <td>U+1ED7</td> <td>\u1ed7</td> <td>o</td> <td>Latin small letter o with circumflex and tilde</td> </tr> <tr> <td>U+1ED8</td> <td>\u1ed8</td> <td>O</td> <td>Latin capital letter O with circumflex and dot below</td> </tr> <tr> <td>U+1ED9</td> <td>\u1ed9</td> <td>o</td> <td>Latin small letter o with circumflex and dot below</td> </tr> <tr> <td>U+1EDA</td> <td>\u1eda</td> <td>O</td> <td>Latin capital letter O with horn and acute</td> </tr> <tr> <td>U+1EDB</td> <td>\u1edb</td> <td>o</td> <td>Latin small letter o with horn and acute</td> </tr> <tr> <td>U+1EDC</td> <td>\u1edc</td> <td>O</td> <td>Latin capital letter O with horn and grave</td> </tr> <tr> <td>U+1EDD</td> <td>\u1edd</td> <td>o</td> <td>Latin small letter o with horn and grave</td> </tr> <tr> <td>U+1EDE</td> <td>\u1ede</td> <td>O</td> <td>Latin capital letter O with horn and hook above</td> </tr> <tr> <td>U+1EDF</td> <td>\u1edf</td> <td>o</td> <td>Latin small letter o with horn and hook above</td> </tr> <tr> <td>U+1EE0</td> <td>\u1ee0</td> <td>O</td> <td>Latin capital letter O with horn and tilde</td> </tr> <tr> <td>U+1EE1</td> <td>\u1ee1</td> <td>o</td> <td>Latin small letter o with horn and tilde</td> </tr> <tr> <td>U+1EE2</td> <td>\u1ee2</td> <td>O</td> <td>Latin capital letter O with horn and dot below</td> </tr> <tr> <td>U+1EE3</td> <td>\u1ee3</td> <td>o</td> <td>Latin small letter o with horn and dot below</td> </tr> <tr> <td>U+1EE4</td> <td>\u1ee4</td> <td>U</td> <td>Latin capital letter U with dot below</td> </tr> <tr> <td>U+1EE5</td> <td>\u1ee5</td> <td>u</td> <td>Latin small letter u with dot below</td> </tr> <tr> <td>U+1EE6</td> <td>\u1ee6</td> <td>U</td> <td>Latin capital letter U with hook above</td> </tr> <tr> <td>U+1EE7</td> <td>\u1ee7</td> <td>u</td> <td>Latin small letter u with hook above</td> </tr> <tr> <td>U+1EE8</td> <td>\u1ee8</td> <td>U</td> <td>Latin capital letter U with horn and acute</td> </tr> <tr> <td>U+1EE9</td> <td>\u1ee9</td> <td>u</td> <td>Latin small letter u with horn and acute</td> </tr> <tr> <td>U+1EEA</td> <td>\u1eea</td> <td>U</td> <td>Latin capital letter U with horn and grave</td> </tr> <tr> <td>U+1EEB</td> <td>\u1eeb</td> <td>u</td> <td>Latin small letter u with horn and grave</td> </tr> <tr> <td>U+1EEC</td> <td>\u1eec</td> <td>U</td> <td>Latin capital letter U with horn and hook above</td> </tr> <tr> <td>U+1EED</td> <td>\u1eed</td> <td>u</td> <td>Latin small letter u with horn and hook above</td> </tr> <tr> <td>U+1EEE</td> <td>\u1eee</td> <td>U</td> <td>Latin capital letter U with horn and tilde</td> </tr> <tr> <td>U+1EEF</td> <td>\u1eef</td> <td>u</td> <td>Latin small letter u with horn and tilde</td> </tr> <tr> <td>U+1EF0</td> <td>\u1ef0</td> <td>U</td> <td>Latin capital letter U with horn and dot below</td> </tr> <tr> <td>U+1EF1</td> <td>\u1ef1</td> <td>u</td> <td>Latin small letter u with horn and dot below</td> </tr> <tr> <td>U+1EF2</td> <td>\u1ef2</td> <td>Y</td> <td>Latin capital letter Y with grave</td> </tr> <tr> <td>U+1EF3</td> <td>\u1ef3</td> <td>y</td> <td>Latin small letter y with grave</td> </tr> <tr> <td>U+1EF4</td> <td>\u1ef4</td> <td>Y</td> <td>Latin capital letter Y with dot below</td> </tr> <tr> <td>U+1EF5</td> <td>\u1ef5</td> <td>y</td> <td>Latin small letter y with dot below</td> </tr> <tr> <td>U+1EF6</td> <td>\u1ef6</td> <td>Y</td> <td>Latin capital letter Y with hook above</td> </tr> <tr> <td>U+1EF7</td> <td>\u1ef7</td> <td>y</td> <td>Latin small letter y with hook above</td> </tr> <tr> <td>U+1EF8</td> <td>\u1ef8</td> <td>Y</td> <td>Latin capital letter Y with tilde</td> </tr> <tr> <td>U+1EF9</td> <td>\u1ef9</td> <td>y</td> <td>Latin small letter y with tilde</td> </tr> </tbody> </table> <p>German (<code>de_DE</code>), German formal (<code>de_DE_formal</code>), German (Switzerland) formal (<code>de_CH</code>), and German (Switzerland) informal (<code>de_CH_informal</code>) locales:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+00C4</td> <td>\u00c4</td> <td>Ae</td> <td>Latin capital letter A with diaeresis</td> </tr> <tr> <td>U+00E4</td> <td>\u00e4</td> <td>ae</td> <td>Latin small letter a with diaeresis</td> </tr> <tr> <td>U+00D6</td> <td>\u00d6</td> <td>Oe</td> <td>Latin capital letter O with diaeresis</td> </tr> <tr> <td>U+00F6</td> <td>\u00f6</td> <td>oe</td> <td>Latin small letter o with diaeresis</td> </tr> <tr> <td>U+00DC</td> <td>\u00dc</td> <td>Ue</td> <td>Latin capital letter U with diaeresis</td> </tr> <tr> <td>U+00FC</td> <td>\u00fc</td> <td>ue</td> <td>Latin small letter u with diaeresis</td> </tr> <tr> <td>U+00DF</td> <td>\u00df</td> <td>ss</td> <td>Latin small letter sharp s</td> </tr> </tbody> </table> <p>Danish (<code>da_DK</code>) locale:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+00C6</td> <td>\u00c6</td> <td>Ae</td> <td>Latin capital letter AE</td> </tr> <tr> <td>U+00E6</td> <td>\u00e6</td> <td>ae</td> <td>Latin small letter ae</td> </tr> <tr> <td>U+00D8</td> <td>\u00d8</td> <td>Oe</td> <td>Latin capital letter O with stroke</td> </tr> <tr> <td>U+00F8</td> <td>\u00f8</td> <td>oe</td> <td>Latin small letter o with stroke</td> </tr> <tr> <td>U+00C5</td> <td>\u00c5</td> <td>Aa</td> <td>Latin capital letter A with ring above</td> </tr> <tr> <td>U+00E5</td> <td>\u00e5</td> <td>aa</td> <td>Latin small letter a with ring above</td> </tr> </tbody> </table> <p>Catalan (<code>ca</code>) locale:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+00B7</td> <td>l\u00b7l</td> <td>ll</td> <td>Flown dot (between two Ls)</td> </tr> </tbody> </table> <p>Serbian (<code>sr_RS</code>) and Bosnian (<code>bs_BA</code>) locales:</p> <table> <thead> <tr> <th>Code</th> <th>Glyph</th> <th>Replacement</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>U+0110</td> <td>\u0110</td> <td>DJ</td> <td>Latin capital letter D with stroke</td> </tr> <tr> <td>U+0111</td> <td>\u0111</td> <td>dj</td> <td>Latin small letter d with stroke</td> </tr> </tbody> </table>","summary":"Converts all accent characters to ASCII characters.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"Text that might have accent characters","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"Filtered string with replaced "nice" characters.","types":"string"}},{"name":"sanitize_file_name","desc":"<p>Removes special characters that are illegal in filenames on certain operating systems and special characters requiring special escaping to manipulate at the command line. Replaces spaces and consecutive dashes with a single dash. Trims period, dash and underscore from beginning and end of filename. It is not guaranteed that this function will return a filename that is allowed to be uploaded.</p>","summary":"Sanitizes a filename, replacing whitespace with dashes.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"The filename to be sanitized","types":"string","variable":"$filename","default":"null","required":"yes"}],"return":{"content":"The sanitized filename","types":"string"}},{"name":"sanitize_user","desc":"<p>Removes tags, octets, entities, and if strict is enabled, will only keep alphanumeric, _, space, ., -, @. After sanitizing, it passes the username, raw username (the username in the parameter), and the value of $strict as parameters for the {@see 'sanitize_user'} filter.</p>","summary":"Sanitizes a username, stripping out unsafe characters.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"The username to be sanitized.","types":"string","variable":"$username","default":"null","required":"yes"},{"content":"If set limits $username to specific characters. Default false.","types":"bool","variable":"$strict","default":"false","required":"no"}],"return":{"content":"The sanitized username, after passing through filters.","types":"string"}},{"name":"sanitize_key","desc":"<p>Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.</p>","summary":"Sanitizes a string key.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"String key","types":"string","variable":"$key","default":"null","required":"yes"}],"return":{"content":"Sanitized key","types":"string"}},{"name":"sanitize_title","desc":"<p>Specifically, HTML and PHP tags are stripped. Further actions can be added via the plugin API. If $title is empty and $fallback_title is set, the latter will be used.</p>","summary":"Sanitizes a title, or returns a fallback title.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"The string to be sanitized.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":" A title to use if $title is empty.","types":"string","variable":"$fallback_title","default":"''","required":"no"},{"content":" The operation for which the string is sanitized","types":"string","variable":"$context","default":"'save'","required":"no"}],"return":{"content":"The sanitized string.","types":"string"}},{"name":"sanitize_title_for_query","desc":"<p>Used for querying the database for a value from URL.</p>","summary":"Sanitizes a title with the 'query' context.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"The string to be sanitized.","types":"string","variable":"$title","default":"null","required":"yes"}],"return":{"content":"The sanitized string.","types":"string"}},{"name":"sanitize_title_with_dashes","desc":"<p>Limits the output to alphanumeric characters, underscore (_) and dash (-). Whitespace becomes a dash.</p>","summary":"Sanitizes a title, replacing whitespace and a few other characters with dashes.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"The title to be sanitized.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":" Not used.","types":"string","variable":"$raw_title","default":"''","required":"no"},{"content":" The operation for which the string is sanitized.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"The sanitized title.","types":"string"}},{"name":"sanitize_sql_orderby","desc":"<p>Accepts one or more columns, with or without a sort order (ASC / DESC). e.g. 'column_1', 'column_1, column_2', 'column_1 ASC, column_2 DESC' etc.</p> <p>Also accepts 'RAND()'.</p>","summary":"Ensures a string is a valid SQL 'order by' clause.","type":"function","category":"Uncategorised","since":"2.5.1","param":[{"content":"Order by clause to be validated.","types":"string","variable":"$orderby","default":"null","required":"yes"}],"return":{"content":"Returns $orderby if valid, false otherwise.","types":"string|false"}},{"name":"sanitize_html_class","desc":"<p>Strips the string down to A-Z,a-z,0-9,_,-. If this results in an empty string then it will return the alternative value supplied.</p>","summary":"Sanitizes an HTML classname to ensure it only contains valid characters.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"The classname to be sanitized","types":"string","variable":"$class","default":"null","required":"yes"},{"content":" The value to return if the sanitization ends up as an empty string. Defaults to an empty string.","types":"string","variable":"$fallback","default":"''","required":"no"}],"return":{"content":"The sanitized value","types":"string"}},{"name":"convert_chars","desc":"","summary":"Converts lone & characters into `&` (a.k.a. `&`)","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"String of characters to be converted.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"Converted string.","types":"string"}},{"name":"convert_invalid_entities","desc":"","summary":"Converts invalid Unicode references range to valid range.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":"String with entities that need converting.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"Converted string.","types":"string"}},{"name":"balanceTags","desc":"","summary":"Balances tags if forced to, or if the 'use_balanceTags' option is set to true.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Text to be balanced","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"If true, forces balancing, ignoring the value of the option. Default false.","types":"bool","variable":"$force","default":"false","required":"no"}],"return":{"content":"Balanced text","types":"string"}},{"name":"force_balance_tags","desc":"","summary":"Balances tags of string using a modified stack.","type":"function","category":"Uncategorised","since":"2.0.4","param":[{"content":"Text to be balanced.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Balanced text.","types":"string"}},{"name":"format_to_edit","desc":"<p>The $content is run through esc_textarea(), which uses htmlspecialchars() to convert special characters to HTML entities. If <code>$richedit</code> is set to true, it is simply a holder for the {@see 'format_to_edit'} filter.</p>","summary":"Acts on text which is about to be edited.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The text about to be edited.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":" Whether <code>$content</code> should be considered rich text, in which case it would not be passed through esc_textarea(). Default false.","types":"bool","variable":"$rich_text","default":"false","required":"no"}],"return":{"content":"The text after the filter (and possibly htmlspecialchars()) has been run.","types":"string"}},{"name":"zeroise","desc":"<p>If you set the threshold to '4' and the number is '10', then you will get back '0010'. If you set the threshold to '4' and the number is '5000', then you will get back '5000'.</p> <p>Uses sprintf to append the amount of zeros based on the $threshold parameter and the size of the number. If the number is large enough, then no zeros will be appended.</p>","summary":"Add leading zeros when necessary.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Number to append zeros to if not greater than threshold.","types":"int","variable":"$number","default":"null","required":"yes"},{"content":"Digit places number needs to be to not have zeros added.","types":"int","variable":"$threshold","default":"null","required":"yes"}],"return":{"content":"Adds leading zeros to number if needed.","types":"string"}},{"name":"backslashit","desc":"","summary":"Adds backslashes before letters and before a number at the start of a string.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Value to which backslashes will be added.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"String with backslashes inserted.","types":"string"}},{"name":"trailingslashit","desc":"<p>Will remove trailing forward and backslashes if it exists already before adding a trailing forward slash. This prevents double slashing a string or path.</p> <p>The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support.</p>","summary":"Appends a trailing slash.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"What to add the trailing slash to.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"String with trailing slash added.","types":"string"}},{"name":"untrailingslashit","desc":"<p>The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support.</p>","summary":"Removes trailing forward slashes and backslashes if they exist.","type":"function","category":"Uncategorised","since":"2.2.0","param":[{"content":"What to remove the trailing slashes from.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"String without the trailing slashes.","types":"string"}},{"name":"addslashes_gpc","desc":"<p>Slashes will first be removed if magic_quotes_gpc is set, see {@link <a href=\"https://secure.php.net/magic_quotes\">https://secure.php.net/magic_quotes</a>} for more details.</p>","summary":"Adds slashes to escape strings.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"The string returned from HTTP request data.","types":"string","variable":"$gpc","default":"null","required":"yes"}],"return":{"content":"Returns a string escaped with slashes.","types":"string"}},{"name":"stripslashes_deep","desc":"","summary":"Navigates through an array, object, or scalar, and removes slashes from the values.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"The value to be stripped.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"Stripped value.","types":"mixed"}},{"name":"stripslashes_from_strings_only","desc":"","summary":"Callback function for `stripslashes_deep()` which strips slashes from strings.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The array or string to be stripped.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"$value The stripped value.","types":"mixed"}},{"name":"urlencode_deep","desc":"","summary":"Navigates through an array, object, or scalar, and encodes the values to be used in a URL.","type":"function","category":"Uncategorised","since":"2.2.0","param":[{"content":"The array or string to be encoded.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"$value The encoded value.","types":"mixed"}},{"name":"rawurlencode_deep","desc":"","summary":"Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"The array or string to be encoded.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"$value The encoded value.","types":"mixed"}},{"name":"urldecode_deep","desc":"","summary":"Navigates through an array, object, or scalar, and decodes URL-encoded values","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The array or string to be decoded.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"$value The decoded value.","types":"mixed"}},{"name":"antispambot","desc":"","summary":"Converts email addresses characters to HTML entities to block spam bots.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Email address.","types":"string","variable":"$email_address","default":"null","required":"yes"},{"content":" Set to 1 to enable hex encoding.","types":"int","variable":"$hex_encoding","default":"0","required":"no"}],"return":{"content":"Converted email address.","types":"string"}},{"name":"_make_url_clickable_cb","desc":"<p>This function was backported from 2.5.0 to 2.3.2. Regex callback for make_clickable().</p>","summary":"Callback to convert URI match to HTML A element.","type":"function","category":"Uncategorised","since":"2.3.2","access":"private","param":[{"content":"Single Regex Match.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"HTML A element with URI address.","types":"string"}},{"name":"_make_web_ftp_clickable_cb","desc":"<p>This function was backported from 2.5.0 to 2.3.2. Regex callback for make_clickable().</p>","summary":"Callback to convert URL match to HTML A element.","type":"function","category":"Uncategorised","since":"2.3.2","access":"private","param":[{"content":"Single Regex Match.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"HTML A element with URL address.","types":"string"}},{"name":"_make_email_clickable_cb","desc":"<p>This function was backported from 2.5.0 to 2.3.2. Regex callback for make_clickable().</p>","summary":"Callback to convert email address match to HTML A element.","type":"function","category":"Uncategorised","since":"2.3.2","access":"private","param":[{"content":"Single Regex Match.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"HTML A element with email address.","types":"string"}},{"name":"make_clickable","desc":"<p>Converts URI, www and ftp, and email addresses. Finishes by fixing links within links.</p>","summary":"Convert plaintext URI to HTML links.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Content to convert URIs.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Content with converted URIs.","types":"string"}},{"name":"_split_str_by_whitespace","desc":"<p>The length of each returned chunk is as close to the specified length goal as possible, with the caveat that each chunk includes its trailing delimiter. Chunks longer than the goal are guaranteed to not have any inner whitespace.</p> <p>Joining the returned chunks with empty delimiters reconstructs the input string losslessly.</p> <p>Input string must have no null characters (or eventual transformations on output chunks must not care about null characters)</p> <pre><code>_split_str_by_whitespace( \"1234 67890 1234 67890a cd 1234 890 123456789 1234567890a 45678 1 3 5 7 90 \", 10 ) ==\narray (\n 0 => '1234 67890 ', // 11 characters: Perfect split\n 1 => '1234 ', // 5 characters: '1234 67890a' was too long\n 2 => '67890a cd ', // 10 characters: '67890a cd 1234' was too long\n 3 => '1234 890 ', // 11 characters: Perfect split\n 4 => '123456789 ', // 10 characters: '123456789 1234567890a' was too long\n 5 => '1234567890a ', // 12 characters: Too long, but no inner whitespace on which to split\n 6 => ' 45678 ', // 11 characters: Perfect split\n 7 => '1 3 5 7 90 ', // 11 characters: End of $string\n);</code></pre>","summary":"Breaks a string into chunks by splitting at whitespace characters.","type":"function","category":"Uncategorised","since":"3.4.0","access":"private","param":[{"content":"The string to split.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"The desired chunk length.","types":"int","variable":"$goal","default":"null","required":"yes"}],"return":{"content":"Numeric array of chunks.","types":"array"}},{"name":"wp_rel_nofollow","desc":"","summary":"Adds rel nofollow string to all HTML A elements in content.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"Content that may contain HTML A elements.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Converted content.","types":"string"}},{"name":"wp_rel_nofollow_callback","desc":"<p>Will remove already existing rel="nofollow" and rel='nofollow' from the string to prevent from invalidating (X)HTML.</p>","summary":"Callback to add rel=nofollow string to HTML A element.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Single Match","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"HTML A Element with rel nofollow.","types":"string"}},{"name":"wp_targeted_link_rel","desc":"","summary":"Adds rel noreferrer and noopener to all HTML A elements that have a target.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Content that may contain HTML A elements.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Converted content.","types":"string"}},{"name":"wp_targeted_link_rel_callback","desc":"<p>Will not duplicate existing noreferrer and noopener values to prevent from invalidating the HTML.</p>","summary":"Callback to add rel=\"noreferrer noopener\" string to HTML A element.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Single Match","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"HTML A Element with rel noreferrer noopener in addition to any existing values","types":"string"}},{"name":"wp_init_targeted_link_rel_filters","desc":"","summary":"Adds all filters modifying the rel attribute of targeted links.","type":"function","category":"Uncategorised","since":"5.1.0"},{"name":"wp_remove_targeted_link_rel_filters","desc":"","summary":"Removes all filters modifying the rel attribute of targeted links.","type":"function","category":"Uncategorised","since":"5.1.0"},{"name":"translate_smiley","desc":"<p>Callback handler for convert_smilies().</p> <p>Looks up one smiley code in the $wpsmiliestrans global array and returns an <code><img></code> string for that smiley.</p>","summary":"Convert one smiley code to the icon graphic file equivalent.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Single match. Smiley code to convert to image.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"Image string for smiley.","types":"string"}},{"name":"convert_smilies","desc":"<p>Will only convert smilies if the option 'use_smilies' is true and the global used in the function isn't empty.</p>","summary":"Convert text equivalent of smilies to images.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Content to convert smilies from text.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Converted content with text smilies replaced with images.","types":"string"}},{"name":"is_email","desc":"<p>Does not grok i18n domains. Not RFC compliant.</p>","summary":"Verifies that an email is valid.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Email address to verify.","types":"string","variable":"$email","default":"null","required":"yes"},{"content":"Deprecated.","types":"bool","variable":"$deprecated","default":"false","required":"no"}],"return":{"content":"Either false or the valid email address.","types":"string|bool"}},{"name":"wp_iso_descrambler","desc":"","summary":"Convert to ASCII from email subjects.","type":"function","category":"Uncategorised","since":"1.2.0","param":[{"content":"Subject line","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"Converted string to ASCII","types":"string"}},{"name":"_wp_iso_convert","desc":"","summary":"Helper function to convert hex encoded chars to ASCII","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"The preg_replace_callback matches array","types":"array","variable":"$match","default":"null","required":"yes"}],"return":{"content":"Converted chars","types":"string"}},{"name":"get_gmt_from_date","desc":"<p>Requires and returns a date in the Y-m-d H:i:s format. If there is a timezone_string available, the date is assumed to be in that timezone, otherwise it simply subtracts the value of the 'gmt_offset' option. Return format can be overridden using the $format parameter.</p>","summary":"Returns a date in the GMT equivalent.","type":"function","category":"Time/Date Functions","since":"1.2.0","param":[{"content":"The date to be converted.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"The format string for the returned date (default is Y-m-d H:i:s)","types":"string","variable":"$format","default":"'Y-m-d H:i:s'","required":"no"}],"return":{"content":"GMT version of the date provided.","types":"string"}},{"name":"get_date_from_gmt","desc":"<p>Requires and returns a date in the Y-m-d H:i:s format. If there is a timezone_string available, the returned date is in that timezone, otherwise it simply adds the value of gmt_offset. Return format can be overridden using the $format parameter</p>","summary":"Converts a GMT date into the correct format for the blog.","type":"function","category":"Time/Date Functions","since":"1.2.0","param":[{"content":"The date to be converted.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"The format string for the returned date (default is Y-m-d H:i:s)","types":"string","variable":"$format","default":"'Y-m-d H:i:s'","required":"no"}],"return":{"content":"Formatted date relative to the timezone / GMT offset.","types":"string"}},{"name":"iso8601_timezone_to_offset","desc":"","summary":"Computes an offset in seconds from an iso8601 timezone.","type":"function","category":"Time/Date Functions","since":"1.5.0","param":[{"content":"Either 'Z' for 0 offset or '\u00b1hhmm'.","types":"string","variable":"$timezone","default":"null","required":"yes"}],"return":{"content":"The offset in seconds.","types":"int|float"}},{"name":"iso8601_to_datetime","desc":"","summary":"Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].","type":"function","category":"Time/Date Functions","since":"1.5.0","param":[{"content":"Date and time in ISO 8601 format {@link <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">https://en.wikipedia.org/wiki/ISO_8601</a>}.","types":"string","variable":"$date_string","default":"null","required":"yes"},{"content":" If set to GMT returns the time minus gmt_offset. Default is 'user'.","types":"string","variable":"$timezone","default":"'user'","required":"no"}],"return":{"content":"The date and time in MySQL DateTime format - Y-m-d H:i:s.","types":"string"}},{"name":"sanitize_email","desc":"","summary":"Strips out all characters that are not allowable in an email.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"Email address to filter.","types":"string","variable":"$email","default":"null","required":"yes"}],"return":{"content":"Filtered email address.","types":"string"}},{"name":"human_time_diff","desc":"<p>The difference is returned in a human readable format such as "1 hour", "5 mins", "2 days".</p>","summary":"Determines the difference between two timestamps.","type":"function","category":"Time/Date Functions","since":"1.5.0","param":[{"content":"Unix timestamp from which the difference begins.","types":"int","variable":"$from","default":"null","required":"yes"},{"content":" Unix timestamp to end the time difference. Default becomes time() if not set.","types":"int","variable":"$to","default":"''","required":"no"}],"return":{"content":"Human readable time difference.","types":"string"}},{"name":"wp_trim_excerpt","desc":"<p>The excerpt word amount will be 55 words and if the amount is greater than that, then the string ' […]' will be appended to the excerpt. If the string is less than 55 words, then the content will be returned as is.</p> <p>The 55 word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter The ' […]' string can be modified by plugins/themes using the {@see 'excerpt_more'} filter</p>","summary":"Generates an excerpt from the content, if needed.","type":"function","category":"Others","since":"5.2.0","param":[{"content":" The excerpt. If set to empty, an excerpt is generated.","types":"string","variable":"$text","default":"''","required":"no"},{"content":" WP_Post instance or Post ID/object. Default is null.","types":"WP_Post|object|int","variable":"$post","default":"null","required":"no"}],"return":{"content":"The excerpt.","types":"string"}},{"name":"wp_trim_words","desc":"<p>This function is localized. For languages that count 'words' by the individual character (such as East Asian languages), the $num_words argument will apply to the number of individual characters.</p>","summary":"Trims text to a certain number of words.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"Text to trim.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Number of words. Default 55.","types":"int","variable":"$num_words","default":"55","required":"no"},{"content":" What to append if $text needs to be trimmed. Default '…'.","types":"string","variable":"$more","default":"null","required":"no"}],"return":{"content":"Trimmed text.","types":"string"}},{"name":"ent2ncr","desc":"","summary":"Converts named entities into numbered entities.","type":"function","category":"Uncategorised","since":"1.5.1","param":[{"content":"The text within which entities will be converted.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Text with converted entities.","types":"string"}},{"name":"format_for_editor","desc":"<p>Generally the browsers treat everything inside a textarea as text, but it is still a good idea to HTML entity encode <code><</code>, <code>></code> and <code>&</code> in the content.</p> <p>The filter {@see 'format_for_editor'} is applied here. If <code>$text</code> is empty the filter will be applied to an empty string.</p>","summary":"Formats text for the editor.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":"The text to be formatted.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"The default editor for the current user. It is usually either 'html' or 'tinymce'.","types":"string","variable":"$default_editor","default":"null","required":"no"}],"return":{"content":"The formatted text after filter is applied.","types":"string"}},{"name":"_deep_replace","desc":"<p>Repeats the replacement operation until it no longer replaces anything so as to remove "nested" values e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that str_replace would return</p>","summary":"Perform a deep string replace operation to ensure the values in $search are no longer present","type":"function","category":"Uncategorised","since":"2.8.1","access":"private","param":[{"content":"The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.","types":"string|array","variable":"$search","default":"null","required":"yes"},{"content":"The string being searched and replaced on, otherwise known as the haystack.","types":"string","variable":"$subject","default":"null","required":"yes"}],"return":{"content":"The string with the replaced values.","types":"string"}},{"name":"esc_sql","desc":"<p>Usually you should prepare queries using wpdb::prepare(). Sometimes, spot-escaping is required or useful. One example is preparing an array for use in an IN clause.</p> <p>NOTE: Since 4.8.3, '%' characters will be replaced with a placeholder string, this prevents certain SQLi attacks from taking place. This change in behaviour may cause issues for code that expects the return value of esc_sql() to be useable for other purposes.</p>","summary":"Escapes data for use in a MySQL query.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Unescaped data","types":"string|array","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Escaped data","types":"string|array"}},{"name":"esc_url","desc":"<p>A number of characters are removed from the URL. If the URL is for displaying (the default behaviour) ampersands are also replaced. The {@see 'clean_url'} filter is applied to the returned cleaned URL.</p>","summary":"Checks and cleans a URL.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"The URL to be cleaned.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" An array of acceptable protocols. Defaults to return value of wp_allowed_protocols()","types":"array","variable":"$protocols","default":"null","required":"no"},{"content":"Private. Use esc_url_raw() for database usage.","types":"string","variable":"$_context","default":"'display'","required":"no"}],"return":{"content":"The cleaned $url after the {@see 'clean_url'} filter is applied.","types":"string"}},{"name":"esc_url_raw","desc":"","summary":"Performs esc_url() for database usage.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"The URL to be cleaned.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"An array of acceptable protocols.","types":"array","variable":"$protocols","default":"null","required":"no"}],"return":{"content":"The cleaned URL.","types":"string"}},{"name":"htmlentities2","desc":"","summary":"Convert entities, while preserving already-encoded entities.","type":"function","category":"Uncategorised","since":"1.2.2","param":[{"content":"The text to be converted.","types":"string","variable":"$myHTML","default":"null","required":"yes"}],"return":{"content":"Converted text.","types":"string"}},{"name":"esc_js","desc":"<p>Escapes text strings for echoing in JS. It is intended to be used for inline JS (in a tag attribute, for example onclick="..."). Note that the strings have to be in single quotes. The {@see 'js_escape'} filter is also applied here.</p>","summary":"Escape single quotes, htmlspecialchar \" < > &, and fix line endings.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"The text to be escaped.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Escaped text.","types":"string"}},{"name":"esc_html","desc":"","summary":"Escaping for HTML blocks.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"esc_attr","desc":"","summary":"Escaping for HTML attributes.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"esc_textarea","desc":"","summary":"Escaping for textarea values.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"tag_escape","desc":"","summary":"Escape an HTML tag name.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"","types":"string","variable":"$tag_name","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"wp_make_link_relative","desc":"<p>Removes the http or https protocols and the domain. Keeps the path '/' at the beginning, so it isn't a true relative link, but from the web root base.</p>","summary":"Convert full URL paths to absolute paths.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":"Full URL path.","types":"string","variable":"$link","default":"null","required":"yes"}],"return":{"content":"Absolute path.","types":"string"}},{"name":"sanitize_option","desc":"<p>This is basically a switch statement which will pass $value through a number of functions depending on the $option.</p>","summary":"Sanitises various option values based on the nature of the option.","type":"function","category":"Uncategorised","since":"2.0.5","param":[{"content":"The name of the option.","types":"string","variable":"$option","default":"null","required":"yes"},{"content":"The unsanitised value.","types":"string","variable":"$value","default":"null","required":"yes"}],"return":{"content":"Sanitized value.","types":"string"}},{"name":"map_deep","desc":"<p>This is similar to <code>array_walk_recursive()</code> but acts upon objects too.</p>","summary":"Maps a function to all non-iterable elements of an array or an object.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The array, object, or scalar.","types":"mixed","variable":"$value","default":"null","required":"yes"},{"content":"The function to map onto $value.","types":"callable","variable":"$callback","default":"null","required":"yes"}],"return":{"content":"The value with the callback applied to all non-arrays and non-objects inside it.","types":"mixed"}},{"name":"wp_parse_str","desc":"<p>Uses {@link <a href=\"https://secure.php.net/parse_str\">https://secure.php.net/parse_str</a> parse_str()} and stripslashes if {@link <a href=\"https://secure.php.net/magic_quotes\">https://secure.php.net/magic_quotes</a> magic_quotes_gpc} is on.</p>","summary":"Parses a string into variables to be stored in an array.","type":"function","category":"Uncategorised","since":"2.2.1","param":[{"content":"The string to be parsed.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Variables will be stored in this array.","types":"array","variable":"$array","default":"null","required":"yes"}]},{"name":"wp_pre_kses_less_than","desc":"<p>KSES already converts lone greater than signs.</p>","summary":"Convert lone less than signs.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Text to be converted.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"Converted text.","types":"string"}},{"name":"wp_pre_kses_less_than_callback","desc":"","summary":"Callback function used by preg_replace.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Populated by matches to preg_replace.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"The text returned after esc_html if needed.","types":"string"}},{"name":"wp_sprintf","desc":"","summary":"WordPress implementation of PHP sprintf() with filters.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"The string which formatted args are inserted.","types":"string","variable":"$pattern","default":"null","required":"yes"},{"content":",... Arguments to be formatted into the $pattern string.","types":"mixed","variable":"$args","default":"null","required":"yes"}],"return":{"content":"The formatted string.","types":"string"}},{"name":"wp_sprintf_l","desc":"<p>The '%l' must be at the first characters can then contain the rest of the content. The list items will have ', ', ', and', and ' and ' added depending on the amount of list items in the $args parameter.</p>","summary":"Localize list items before the rest of the content.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Content containing '%l' at the beginning.","types":"string","variable":"$pattern","default":"null","required":"yes"},{"content":"List items to prepend to the content and replace '%l'.","types":"array","variable":"$args","default":"null","required":"yes"}],"return":{"content":"Localized list items and rest of the content.","types":"string"}},{"name":"wp_html_excerpt","desc":"<p>UTF-8, tags and entities safe prefix extraction. Entities inside will <em>NOT</em> be counted as one character. For example & will be counted as 4, < as 3, etc.</p>","summary":"Safely extracts not more than the first $count characters from html string.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"String to get the excerpt from.","types":"string","variable":"$str","default":"null","required":"yes"},{"content":"Maximum number of characters to take.","types":"int","variable":"$count","default":"null","required":"yes"},{"content":" What to append if $str needs to be trimmed. Defaults to empty string.","types":"string","variable":"$more","default":"null","required":"no"}],"return":{"content":"The excerpt.","types":"string"}},{"name":"links_add_base_url","desc":"<p>By default it supports the 'src' and 'href' attributes. However this can be changed via the 3rd param.</p>","summary":"Add a Base url to relative links in passed content.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"String to search for links in.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"The base URL to prefix to links.","types":"string","variable":"$base","default":"null","required":"yes"},{"content":"The attributes which should be processed.","types":"array","variable":"$attrs","default":"array('src', 'href')","required":"no"}],"return":{"content":"The processed content.","types":"string"}},{"name":"_links_add_base","desc":"","summary":"Callback to add a base url to relative links in passed content.","type":"function","category":"Uncategorised","since":"2.7.0","access":"private","param":[{"content":"The matched link.","types":"string","variable":"$m","default":"null","required":"yes"}],"return":{"content":"The processed link.","types":"string"}},{"name":"links_add_target","desc":"<p>This function by default only applies to <code><a></code> tags, however this can be modified by the 3rd param.</p> <p><em>NOTE:</em> Any current target attributed will be stripped and replaced.</p>","summary":"Adds a Target attribute to all links in passed content.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"String to search for links in.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"The Target to add to the links.","types":"string","variable":"$target","default":"'_blank'","required":"no"},{"content":"An array of tags to apply to.","types":"array","variable":"$tags","default":"array('a')","required":"no"}],"return":{"content":"The processed content.","types":"string"}},{"name":"_links_add_target","desc":"","summary":"Callback to add a target attribute to all links in passed content.","type":"function","category":"Uncategorised","since":"2.7.0","access":"private","param":[{"content":"The matched link.","types":"string","variable":"$m","default":"null","required":"yes"}],"return":{"content":"The processed link.","types":"string"}},{"name":"normalize_whitespace","desc":"","summary":"Normalize EOL characters and strip duplicate whitespace.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"The string to normalize.","types":"string","variable":"$str","default":"null","required":"yes"}],"return":{"content":"The normalized string.","types":"string"}},{"name":"wp_strip_all_tags","desc":"<p>This differs from strip_tags() because it removes the contents of the <code><script></code> and <code><style></code> tags. E.g. <code>strip_tags( '<script>something</script>' )</code> will return 'something'. wp_strip_all_tags will return ''</p>","summary":"Properly strip all HTML tags including script and style","type":"function","category":"Miscellaneous","since":"2.9.0","param":[{"content":"String containing HTML tags","types":"string","variable":"$string","default":"null","required":"yes"},{"content":" Whether to remove left over line breaks and white space chars","types":"bool","variable":"$remove_breaks","default":"false","required":"no"}],"return":{"content":"The processed string.","types":"string"}},{"name":"sanitize_text_field","desc":"<ul> <li>Checks for invalid UTF-8,</li> <li>Converts single <code><</code> characters to entities</li> <li>Strips all tags</li> <li>Removes line breaks, tabs, and extra whitespace</li> <li>Strips octets</li> </ul>","summary":"Sanitizes a string from user input or from the database.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"String to sanitize.","types":"string","variable":"$str","default":"null","required":"yes"}],"return":{"content":"Sanitized string.","types":"string"}},{"name":"sanitize_textarea_field","desc":"<p>The function is like sanitize_text_field(), but preserves new lines (\\n) and other whitespace, which are legitimate input in textarea elements.</p>","summary":"Sanitizes a multiline string from user input or from the database.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"String to sanitize.","types":"string","variable":"$str","default":"null","required":"yes"}],"return":{"content":"Sanitized string.","types":"string"}},{"name":"_sanitize_text_fields","desc":"","summary":"Internal helper function to sanitize a string from user input or from the db","type":"function","category":"Uncategorised","since":"4.7.0","access":"private","param":[{"content":"String to sanitize.","types":"string","variable":"$str","default":"null","required":"yes"},{"content":"Whether to keep newlines. Default: false.","types":"bool","variable":"$keep_newlines","default":"false","required":"no"}],"return":{"content":"Sanitized string.","types":"string"}},{"name":"wp_basename","desc":"","summary":"i18n friendly version of basename()","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"A path.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"If the filename ends in suffix this will also be cut off.","types":"string","variable":"$suffix","default":"''","required":"no"}],"return":{"content":"","types":"string"}},{"name":"capital_P_dangit","desc":"<p>Violating our coding standards for a good function name.</p>","summary":"Forever eliminate \"Wordpress\" from the planet (or at least the little bit we can influence).","type":"function","category":"Miscellaneous","since":"3.0.0","param":[{"content":"The text to be modified.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"The modified text.","types":"string"}},{"name":"sanitize_mime_type","desc":"","summary":"Sanitize a mime type","type":"function","category":"Uncategorised","since":"3.1.3","param":[{"content":"Mime type","types":"string","variable":"$mime_type","default":"null","required":"yes"}],"return":{"content":"Sanitized mime type","types":"string"}},{"name":"sanitize_trackback_urls","desc":"","summary":"Sanitize space or carriage return separated URLs that are used to send trackbacks.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"Space or carriage return separated URLs","types":"string","variable":"$to_ping","default":"null","required":"yes"}],"return":{"content":"URLs starting with the http or https protocol, separated by a carriage return.","types":"string"}},{"name":"wp_slash","desc":"<p>This should be used when preparing data for core API that expects slashed data. This should not be used to escape data going directly into an SQL query.</p>","summary":"Add slashes to a string or array of strings.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"String or array of strings to slash.","types":"string|array","variable":"$value","default":"null","required":"yes"}],"return":{"content":"Slashed $value","types":"string|array"}},{"name":"wp_unslash","desc":"<p>This should be used to remove slashes from data passed to core API that expects data to be unslashed.</p>","summary":"Remove slashes from a string or array of strings.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"String or array of strings to unslash.","types":"string|array","variable":"$value","default":"null","required":"yes"}],"return":{"content":"Unslashed $value","types":"string|array"}},{"name":"get_url_in_content","desc":"","summary":"Extract and return the first URL from passed content.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"A string which might contain a URL.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The found URL.","types":"string|false"}},{"name":"wp_spaces_regexp","desc":"<p>By default, spaces include new lines, tabs, nbsp entities, and the UTF-8 nbsp. This is designed to replace the PCRE \\s sequence. In ticket #22692, that sequence was found to be unreliable due to random inclusion of the A0 byte.</p>","summary":"Returns the regexp for common whitespace characters.","type":"function","category":"Uncategorised","since":"4.0.0","return":{"content":"The spaces regexp.","types":"string"}},{"name":"print_emoji_styles","desc":"","summary":"Print the important emoji-related styles.","type":"function","category":"Uncategorised","since":"4.2.0"},{"name":"print_emoji_detection_script","desc":"","summary":"Print the inline Emoji detection script if it is not already printed.","type":"function","category":"Uncategorised","since":"4.2.0"},{"name":"_print_emoji_detection_script","desc":"","summary":"Prints inline Emoji dection script","type":"function","category":"Uncategorised","since":"4.6.0","access":"private"},{"name":"wp_encode_emoji","desc":"<p>This allows us to store emoji in a DB using the utf8 character set.</p>","summary":"Convert emoji characters to their equivalent HTML entity.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The content to encode.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"The encoded content.","types":"string"}},{"name":"wp_staticize_emoji","desc":"","summary":"Convert emoji to a static img element.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The content to encode.","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"The encoded content.","types":"string"}},{"name":"wp_staticize_emoji_for_email","desc":"","summary":"Convert emoji in emails into static images.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The email data array.","types":"array","variable":"$mail","default":"null","required":"yes"}],"return":{"content":"The email data array, with emoji in the message staticized.","types":"array"}},{"name":"_wp_emoji_list","desc":"<p>These arrays are automatically built from the regex in twemoji.js - if they need to be updated, you should update the regex there, then run the <code>grunt precommit:emoji</code> job.</p>","summary":"Returns arrays of emoji data.","type":"function","category":"Uncategorised","since":"4.9.0","access":"private","param":[{"content":" Which array type to return. Accepts 'partials' or 'entities', default 'entities'.","types":"string","variable":"$type","default":"'entities'","required":"no"}],"return":{"content":"An array to match all emoji that WordPress recognises.","types":"array"}},{"name":"url_shorten","desc":"","summary":"Shorten a URL, to be used as link text.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"URL to shorten.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Maximum length of the shortened URL. Default 35 characters.","types":"int","variable":"$length","default":"35","required":"no"}],"return":{"content":"Shortened URL.","types":"string"}},{"name":"sanitize_hex_color","desc":"<p>Returns either '', a 3 or 6 digit hex color (with #), or nothing. For sanitizing values without a #, see sanitize_hex_color_no_hash().</p>","summary":"Sanitizes a hex color.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"","types":"string","variable":"$color","default":"null","required":"yes"}],"return":{"content":"","types":"string|void"}},{"name":"sanitize_hex_color_no_hash","desc":"<p>Saving hex colors without a hash puts the burden of adding the hash on the UI, which makes it difficult to use or upgrade to other color types such as rgba, hsl, rgb, and html color names.</p> <p>Returns either '', a 3 or 6 digit hex color (without a #), or null.</p>","summary":"Sanitizes a hex color without a hash. Use sanitize_hex_color() when possible.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"","types":"string","variable":"$color","default":"null","required":"yes"}],"return":{"content":"","types":"string|null"}},{"name":"maybe_hash_hex_color","desc":"<p>Otherwise, returns value untouched.</p> <p>This method should only be necessary if using sanitize_hex_color_no_hash().</p>","summary":"Ensures that any hex color is properly hashed.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"","types":"string","variable":"$color","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"mysql2date","desc":"<p>$format should be either a PHP date format string, e.g. 'U' for a Unix timestamp, or 'G' for a Unix timestamp assuming that $date is GMT.</p> <p>If $translate is true then the given date and format string will be passed to date_i18n() for translation.</p>","summary":"Convert given date string into a different format.","type":"function","category":"Time/Date Functions","since":"0.71","param":[{"content":"Format of the date to return.","types":"string","variable":"$format","default":"null","required":"yes"},{"content":"Date string to convert.","types":"string","variable":"$date","default":"null","required":"yes"},{"content":"Whether the return date should be translated. Default true.","types":"bool","variable":"$translate","default":"true","required":"no"}],"return":{"content":"Formatted date string or Unix timestamp. False if $date is empty.","types":"string|int|bool"}},{"name":"current_time","desc":"<p>The 'mysql' type will return the time in the format for MySQL DATETIME field. The 'timestamp' type will return the current timestamp. Other strings will be interpreted as PHP date formats (e.g. 'Y-m-d').</p> <p>If $gmt is set to either '1' or 'true', then both types will use GMT time. if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.</p>","summary":"Retrieve the current time based on specified type.","type":"function","category":"Time/Date Functions","since":"1.0.0","param":[{"content":"Type of time to retrieve. Accepts 'mysql', 'timestamp', or PHP date format string (e.g. 'Y-m-d').","types":"string","variable":"$type","default":"null","required":"yes"},{"content":" Whether to use GMT timezone. Default false.","types":"int|bool","variable":"$gmt","default":"0","required":"no"}],"return":{"content":"Integer if $type is 'timestamp', string otherwise.","types":"int|string"}},{"name":"date_i18n","desc":"<p>If the locale specifies the locale month and weekday, then the locale will take over the format for the date. If it isn't, then the date format string will be used instead.</p>","summary":"Retrieve the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.","type":"function","category":"Time/Date Functions","since":"0.71","param":[{"content":"Format to display the date.","types":"string","variable":"$dateformatstring","default":"null","required":"yes"},{"content":" A sum of Unix timestamp and timezone offset in seconds. Default false.","types":"int|bool","variable":"$timestamp_with_offset","default":"false","required":"no"},{"content":" Whether to use GMT timezone. Only applies if timestamp is not provided. Default false.","types":"bool","variable":"$gmt","default":"false","required":"no"}],"return":{"content":"The date, translated if locale specifies it.","types":"string"}},{"name":"wp_maybe_decline_date","desc":"<p>If the locale specifies that month names require a genitive case in certain formats (like 'j F Y'), the month name will be replaced with a correct form.</p>","summary":"Determines if the date should be declined.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Formatted date string.","types":"string","variable":"$date","default":"null","required":"yes"}],"return":{"content":"The date, declined if locale specifies it.","types":"string"}},{"name":"number_format_i18n","desc":"","summary":"Convert float number to format based on the locale.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"The number to convert based on locale.","types":"float","variable":"$number","default":"null","required":"yes"},{"content":" Precision of the number of decimal places. Default 0.","types":"int","variable":"$decimals","default":"0","required":"no"}],"return":{"content":"Converted number in string format.","types":"string"}},{"name":"size_format","desc":"<p>It is easier to read 1 KB than 1024 bytes and 1 MB than 1048576 bytes. Converts number of bytes to human readable number by taking the number of that unit that the bytes will go into it. Supports TB value.</p> <p>Please note that integers in PHP are limited to 32 bits, unless they are on 64 bit architecture, then they have 64 bit size. If you need to place the larger size then what PHP integer type will hold, then use a string. It will be converted to a double, which should always have 64 bit length.</p> <p>Technically the correct unit names for powers of 1024 are KiB, MiB etc.</p>","summary":"Convert number of bytes largest unit bytes will fit into.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Number of bytes. Note max integer size for integers.","types":"int|string","variable":"$bytes","default":"null","required":"yes"},{"content":" Precision of number of decimal places. Default 0.","types":"int","variable":"$decimals","default":"0","required":"no"}],"return":{"content":"False on failure. Number string on success.","types":"string|false"}},{"name":"human_readable_duration","desc":"","summary":"Convert a duration to human readable format.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Duration will be in string format (HH:ii:ss) OR (ii:ss), with a possible prepended negative sign (-).","types":"string","variable":"$duration","default":"''","required":"no"}],"return":{"content":"A human readable duration string, false on failure.","types":"string|false"}},{"name":"get_weekstartend","desc":"","summary":"Get the week start and end from the datetime or date string from MySQL.","type":"function","category":"Time/Date Functions","since":"0.71","param":[{"content":"Date or datetime field type from MySQL.","types":"string","variable":"$mysqlstring","default":"null","required":"yes"},{"content":" Start of the week as an integer. Default empty string.","types":"int|string","variable":"$start_of_week","default":"''","required":"no"}],"return":{"content":"Keys are 'start' and 'end'.","types":"array"}},{"name":"maybe_unserialize","desc":"","summary":"Unserialize value only if it was serialized.","type":"function","category":"Serialization","since":"2.0.0","param":[{"content":"Maybe unserialized original, if is needed.","types":"string","variable":"$original","default":"null","required":"yes"}],"return":{"content":"Unserialized data can be any type.","types":"mixed"}},{"name":"is_serialized","desc":"<p>If $data is not an string, then returned value will always be false. Serialized data is always a string.</p>","summary":"Check value to find if it was serialized.","type":"function","category":"Serialization","since":"2.0.5","param":[{"content":"Value to check to see if was serialized.","types":"string","variable":"$data","default":"null","required":"yes"},{"content":" Whether to be strict about the end of the string. Default true.","types":"bool","variable":"$strict","default":"true","required":"no"}],"return":{"content":"False if not serialized and true if it was.","types":"bool"}},{"name":"is_serialized_string","desc":"","summary":"Check whether serialized data is of string type.","type":"function","category":"Serialization","since":"2.0.5","param":[{"content":"Serialized data.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"False if not a serialized string, true if it is.","types":"bool"}},{"name":"maybe_serialize","desc":"","summary":"Serialize data, if needed.","type":"function","category":"Serialization","since":"2.0.5","param":[{"content":"Data that might be serialized.","types":"string|array|object","variable":"$data","default":"null","required":"yes"}],"return":{"content":"A scalar data","types":"mixed"}},{"name":"xmlrpc_getposttitle","desc":"<p>If the title element is not part of the XML, then the default post title from the $post_default_title will be used instead.</p>","summary":"Retrieve post title from XMLRPC XML.","type":"function","category":"XMLRPC","since":"0.71","param":[{"content":"XMLRPC XML Request content","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"Post title","types":"string"}},{"name":"xmlrpc_getpostcategory","desc":"<p>If the category element is not found, then the default post category will be used. The return type then would be what $post_default_category. If the category is found, then it will always be an array.</p>","summary":"Retrieve the post category or categories from XMLRPC XML.","type":"function","category":"XMLRPC","since":"0.71","param":[{"content":"XMLRPC XML Request content","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"List of categories or category name.","types":"string|array"}},{"name":"xmlrpc_removepostdata","desc":"","summary":"XMLRPC XML content without title and category elements.","type":"function","category":"XMLRPC","since":"0.71","param":[{"content":"XML-RPC XML Request content.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"XMLRPC XML Request content without title and category elements.","types":"string"}},{"name":"wp_extract_urls","desc":"","summary":"Use RegEx to extract URLs from arbitrary content.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":"Content to extract URLs from.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"URLs found in passed string.","types":"array"}},{"name":"do_enclose","desc":"<p>Will not add enclosures that have already been added and will remove enclosures that are no longer in the post. This is called as pingbacks and trackbacks.</p>","summary":"Check content for video and audio links to add as enclosures.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"Post Content.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"Post ID.","types":"int","variable":"$post_ID","default":"null","required":"yes"}]},{"name":"wp_get_http_headers","desc":"","summary":"Retrieve HTTP Headers from URL.","type":"function","category":"Uncategorised","since":"1.5.1","param":[{"content":"URL to retrieve HTTP headers from.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"Not Used.","types":"bool","variable":"$deprecated","default":"false","required":"no"}],"return":{"content":"False on failure, headers on success.","types":"bool|string"}},{"name":"is_new_day","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the publish date of the current post in the loop is different from the publish date of the previous post in the loop.","type":"function","category":"Time/Date Functions","since":"0.71","return":{"content":"1 when new day, 0 if not a new day.","types":"int"}},{"name":"build_query","desc":"<p>This is a convenient function for easily building url queries. It sets the separator to '&' and uses _http_build_query() function.</p>","summary":"Build URL query based on an associative and, or indexed array.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"URL-encode key/value pairs.","types":"array","variable":"$data","default":"null","required":"yes"}],"return":{"content":"URL-encoded string.","types":"string"}},{"name":"_http_build_query","desc":"","summary":"From php.net (modified by Mark Jaquith to behave like the native PHP5 function).","type":"function","category":"Uncategorised","since":"3.2.0","access":"private","param":[{"content":"An array or object of data. Converted to array.","types":"array|object","variable":"$data","default":"null","required":"yes"},{"content":" Numeric index. If set, start parameter numbering with it. Default null.","types":"string","variable":"$prefix","default":"null","required":"no"},{"content":" Argument separator; defaults to 'arg_separator.output'. Default null.","types":"string","variable":"$sep","default":"null","required":"no"},{"content":" Used to prefix key name. Default empty.","types":"string","variable":"$key","default":"''","required":"no"},{"content":" Whether to use urlencode() in the result. Default true.","types":"bool","variable":"$urlencode","default":"true","required":"no"}],"return":{"content":"The query string.","types":"string"}},{"name":"add_query_arg","desc":"<p>You can rebuild the URL and append query variables to the URL query by using this function. There are two ways to use this function; either a single key and value, or an associative array.</p> <p>Using a single key and value:</p> <pre><code>add_query_arg( 'key', 'value', 'http://example.com' );</code></pre>\n<p>Using an associative array:</p>\n<pre><code>add_query_arg( array(\n 'key1' => 'value1',\n 'key2' => 'value2',\n), 'http://example.com' );</code></pre> <p>Omitting the URL from either use results in the current URL being used (the value of <code>$_SERVER['REQUEST_URI']</code>).</p> <p>Values are expected to be encoded appropriately with urlencode() or rawurlencode().</p> <p>Setting any query variable's value to boolean false removes the key (see remove_query_arg()).</p> <p>Important: The return value of add_query_arg() is not escaped by default. Output should be late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting (XSS) attacks.</p>","summary":"Retrieves a modified URL query string.","type":"function","category":"Miscellaneous","since":"1.5.0","param":[{"content":"Either a query variable key, or an associative array of query variables.","types":"string|array","variable":"$key","default":"null","required":"yes"},{"content":" Either a query variable value, or a URL to act upon.","types":"string","variable":"$value","default":"null","required":"no"},{"content":" A URL to act upon.","types":"string","variable":"$url","default":"null","required":"no"}],"return":{"content":"New URL query string (unescaped).","types":"string"}},{"name":"remove_query_arg","desc":"","summary":"Removes an item or items from a query string.","type":"function","category":"Miscellaneous","since":"1.5.0","param":[{"content":"Query key or keys to remove.","types":"string|array","variable":"$key","default":"null","required":"yes"},{"content":" When false uses the current URL. Default false.","types":"bool|string","variable":"$query","default":"false","required":"no"}],"return":{"content":"New URL query string.","types":"string"}},{"name":"wp_removable_query_args","desc":"","summary":"Returns an array of single-use query variable names that can be removed from a URL.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"An array of parameters to remove from the URL.","types":"array"}},{"name":"add_magic_quotes","desc":"","summary":"Walks the array while sanitizing the contents.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Array to walk while sanitizing contents.","types":"array","variable":"$array","default":"null","required":"yes"}],"return":{"content":"Sanitized $array.","types":"array"}},{"name":"wp_remote_fopen","desc":"","summary":"HTTP request for URI to retrieve content.","type":"function","category":"Uncategorised","since":"1.5.1","param":[{"content":"URI/URL of web page to retrieve.","types":"string","variable":"$uri","default":"null","required":"yes"}],"return":{"content":"HTTP content. False on failure.","types":"false|string"}},{"name":"wp","desc":"","summary":"Set up the WordPress query.","type":"function","category":"Miscellaneous","since":"2.0.0","param":[{"content":"Default WP_Query arguments.","types":"string|array","variable":"$query_vars","default":"''","required":"no"}]},{"name":"get_status_header_desc","desc":"","summary":"Retrieve the description for the HTTP status.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"HTTP status code.","types":"int","variable":"$code","default":"null","required":"yes"}],"return":{"content":"Empty string if not found, or description if found.","types":"string"}},{"name":"status_header","desc":"","summary":"Set HTTP status header.","type":"function","category":"Miscellaneous","since":"4.4.0","param":[{"content":"HTTP status code.","types":"int","variable":"$code","default":"null","required":"yes"},{"content":" A custom description for the HTTP status.","types":"string","variable":"$description","default":"''","required":"no"}]},{"name":"wp_get_nocache_headers","desc":"<p>The several different headers cover the different ways cache prevention is handled by different browsers</p>","summary":"Get the header information to prevent caching.","type":"function","category":"Uncategorised","since":"2.8.0","return":{"content":"The associative array of header names and field values.","types":"array"}},{"name":"nocache_headers","desc":"<p>Different browsers support different nocache headers, so several headers must be sent so that all of them get the point that no caching should occur.</p>","summary":"Set the headers to prevent caching for the different browsers.","type":"function","category":"Miscellaneous","since":"2.0.0"},{"name":"cache_javascript_headers","desc":"","summary":"Set the headers for caching for 10 days with JavaScript content type.","type":"function","category":"Miscellaneous","since":"2.1.0"},{"name":"get_num_queries","desc":"","summary":"Retrieve the number of database queries during the WordPress execution.","type":"function","category":"Miscellaneous","since":"2.0.0","return":{"content":"Number of database queries.","types":"int"}},{"name":"bool_from_yn","desc":"<p>Must be 'y' to be true.</p>","summary":"Whether input is yes or no.","type":"function","category":"Miscellaneous","since":"1.0.0","param":[{"content":"Character string containing either 'y' (yes) or 'n' (no).","types":"string","variable":"$yn","default":"null","required":"yes"}],"return":{"content":"True if yes, false on anything else.","types":"bool"}},{"name":"do_feed","desc":"<p>If the feed action does not have a hook, then the function will die with a message telling the visitor that the feed is not valid.</p> <p>It is better to only have one hook for each feed.</p>","summary":"Load the feed template from the use of an action hook.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"do_feed_rdf","desc":"","summary":"Load the RDF RSS 0.91 Feed template.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"do_feed_rss","desc":"","summary":"Load the RSS 1.0 Feed Template.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"do_feed_rss2","desc":"","summary":"Load either the RSS2 comment feed or the RSS2 posts feed.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"True for the comment feed, false for normal feed.","types":"bool","variable":"$for_comments","default":"null","required":"yes"}]},{"name":"do_feed_atom","desc":"","summary":"Load either Atom comment feed or Atom posts feed.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"True for the comment feed, false for normal feed.","types":"bool","variable":"$for_comments","default":"null","required":"yes"}]},{"name":"do_robots","desc":"<p>The echo content should be with usage of the permalinks or for creating the robots.txt file.</p>","summary":"Display the robots.txt file content.","type":"function","category":"Miscellaneous","since":"2.1.0"},{"name":"is_blog_installed","desc":"<p>The cache will be checked first. If you have a cache plugin, which saves the cache values, then this will work. If you use the default WordPress cache, and the database goes away, then you might have problems.</p> <p>Checks for the 'siteurl' option for whether WordPress is installed.</p> <p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether WordPress is already installed.","type":"function","category":"Miscellaneous","since":"2.1.0","return":{"content":"Whether the site is already installed.","types":"bool"}},{"name":"wp_nonce_url","desc":"","summary":"Retrieve URL with nonce added to URL query.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","param":[{"content":"URL to add nonce action.","types":"string","variable":"$actionurl","default":"null","required":"yes"},{"content":" Nonce action name. Default -1.","types":"int|string","variable":"$action","default":"-1","required":"no"},{"content":" Nonce name. Default '_wpnonce'.","types":"string","variable":"$name","default":"'_wpnonce'","required":"no"}],"return":{"content":"Escaped URL with nonce action added.","types":"string"}},{"name":"wp_nonce_field","desc":"<p>The nonce field is used to validate that the contents of the form came from the location on the current site and not somewhere else. The nonce does not offer absolute protection, but should protect against most cases. It is very important to use nonce field in forms.</p> <p>The $action and $name are optional, but if you want to have better security, it is strongly suggested to set those two parameters. It is easier to just call the function without any parameters, because validation of the nonce doesn't require any parameters, but since crackers know what the default is it won't be difficult for them to find a way around your nonce and cause damage.</p> <p>The input name will be whatever $name value you gave. The input value will be the nonce creation value.</p>","summary":"Retrieve or display nonce hidden field for forms.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","param":[{"content":" Action name. Default -1.","types":"int|string","variable":"$action","default":"-1","required":"no"},{"content":" Nonce name. Default '_wpnonce'.","types":"string","variable":"$name","default":"'_wpnonce'","required":"no"},{"content":" Whether to set the referer field for validation. Default true.","types":"bool","variable":"$referer","default":"true","required":"no"},{"content":" Whether to display or return hidden form field. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"Nonce field HTML markup.","types":"string"}},{"name":"wp_referer_field","desc":"<p>The referer link is the current Request URI from the server super global. The input name is '_wp_http_referer', in case you wanted to check manually.</p>","summary":"Retrieve or display referer hidden field for forms.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","param":[{"content":" Whether to echo or return the referer field. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"Referer field HTML markup.","types":"string"}},{"name":"wp_original_referer_field","desc":"<p>The input name is '_wp_original_http_referer' and will be either the same value of wp_referer_field(), if that was posted already or it will be the current page, if it doesn't exist.</p>","summary":"Retrieve or display original referer hidden field for forms.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","param":[{"content":" Whether to echo the original http referer. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"},{"content":" Can be 'previous' or page you want to jump back to. Default 'current'.","types":"string","variable":"$jump_back_to","default":"'current'","required":"no"}],"return":{"content":"Original referer field.","types":"string"}},{"name":"wp_get_referer","desc":"<p>If it's the same as the current request URL, will return false.</p>","summary":"Retrieve referer from '_wp_http_referer' or HTTP referer.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","return":{"content":"False on failure. Referer URL on success.","types":"false|string"}},{"name":"wp_get_raw_referer","desc":"<p>Do not use for redirects, use wp_get_referer() instead.</p>","summary":"Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.","type":"function","category":"Uncategorised","since":"4.5.0","return":{"content":"Referer URL on success, false on failure.","types":"string|false"}},{"name":"wp_get_original_referer","desc":"","summary":"Retrieve original referer that was posted, if it exists.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","return":{"content":"False if no original referer or original referer if set.","types":"string|false"}},{"name":"wp_mkdir_p","desc":"<p>Will attempt to set permissions on folders.</p>","summary":"Recursive directory creation based on full path.","type":"function","category":"Miscellaneous","since":"2.0.1","param":[{"content":"Full path to attempt to create.","types":"string","variable":"$target","default":"null","required":"yes"}],"return":{"content":"Whether the path was created. True if path already exists.","types":"bool"}},{"name":"path_is_absolute","desc":"<p>For example, '/foo/bar', or 'c:\\windows'.</p>","summary":"Test if a given filesystem path is absolute.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"File path.","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"True if path is absolute, false is not absolute.","types":"bool"}},{"name":"path_join","desc":"<p>For example, 'give me $path relative to $base'. If the $path is absolute, then it the full path is returned.</p>","summary":"Join two filesystem paths together.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Base path.","types":"string","variable":"$base","default":"null","required":"yes"},{"content":"Path relative to $base.","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"The path with the base or absolute path.","types":"string"}},{"name":"wp_normalize_path","desc":"<p>On windows systems, replaces backslashes with forward slashes and forces upper-case drive letters. Allows for two leading slashes for Windows network shares, but ensures that all other duplicate slashes are reduced to a single.</p>","summary":"Normalize a filesystem path.","type":"function","category":"Uncategorised","since":"4.9.7","param":[{"content":"Path to normalize.","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"Normalized path.","types":"string"}},{"name":"get_temp_dir","desc":"<p>Function's preference is the return value of sys_get_temp_dir(), followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR, before finally defaulting to /tmp/</p> <p>In the event that this function does not find a writable location, It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file.</p>","summary":"Determine a writable directory for temporary files.","type":"function","category":"Uncategorised","since":"2.5.0","return":{"content":"Writable temporary directory.","types":"string"}},{"name":"wp_is_writable","desc":"<p>This function is used to work around certain ACL issues in PHP primarily affecting Windows Servers.</p>","summary":"Determine if a directory is writable.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Path to check for write-ability.","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"Whether the path is writable.","types":"bool"}},{"name":"win_is_writable","desc":"<p>PHP has issues with Windows ACL's for determine if a directory is writable or not, this works around them by checking the ability to open files rather than relying upon PHP to interprate the OS ACL.</p>","summary":"Workaround for Windows bug in is_writable() function","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Windows path to check for write-ability.","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"Whether the path is writable.","types":"bool"}},{"name":"wp_get_upload_dir","desc":"<p>Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory. Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases when not uploading files.</p>","summary":"Retrieves uploads directory information.","type":"function","category":"Uncategorised","since":"4.5.0","return":{"content":"See wp_upload_dir() for description.","types":"array"}},{"name":"wp_upload_dir","desc":"<p>Checks the 'upload_path' option, which should be from the web root folder, and if it isn't empty it will be used. If it is empty, then the path will be 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.</p> <p>The upload URL path is set either by the 'upload_url_path' option or by using the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.</p> <p>If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in the administration settings panel), then the time will be used. The format will be year first and then month.</p> <p>If the path couldn't be created, then an error will be returned with the key 'error' containing the error message. The error suggests that the parent directory is not writable by the server.</p> <p>On success, the returned array will have many indices: 'path' - base directory and sub directory or full path to upload directory. 'url' - base url and sub directory or absolute URL to upload directory. 'subdir' - sub directory if uploads use year/month folders option is on. 'basedir' - path without subdir. 'baseurl' - URL path without subdir. 'error' - false or error message.</p>","summary":"Get an array containing the current upload directory's path and url.","type":"function","category":"Miscellaneous","since":"2.0.0","param":[{"content":" Time formatted in 'yyyy/mm'. Default null.","types":"string","variable":"$time","default":"null","required":"no"},{"content":" Whether to check and create the uploads directory. Default true for backward compatibility.","types":"bool","variable":"$create_dir","default":"true","required":"no"},{"content":" Whether to refresh the cache. Default false.","types":"bool","variable":"$refresh_cache","default":"false","required":"no"}],"return":{"content":"See above for description.","types":"array"}},{"name":"_wp_upload_dir","desc":"","summary":"A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.","type":"function","category":"Uncategorised","since":"4.5.0","access":"private","param":[{"content":" Time formatted in 'yyyy/mm'. Default null.","types":"string","variable":"$time","default":"null","required":"no"}],"return":{"content":"See wp_upload_dir()","types":"array"}},{"name":"wp_unique_filename","desc":"<p>If the filename is not unique, then a number will be added to the filename before the extension, and will continue adding numbers until the filename is unique.</p> <p>The callback is passed three parameters, the first one is the directory, the second is the filename, and the third is the extension.</p>","summary":"Get a filename that is sanitized and unique for the given directory.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Directory.","types":"string","variable":"$dir","default":"null","required":"yes"},{"content":"File name.","types":"string","variable":"$filename","default":"null","required":"yes"},{"content":"Callback. Default null.","types":"callable","variable":"$unique_filename_callback","default":"null","required":"no"}],"return":{"content":"New filename, if given wasn't unique.","types":"string"}},{"name":"wp_upload_bits","desc":"<p>If there is an error, then the key 'error' will exist with the error message. If success, then the key 'file' will have the unique file path, the 'url' key will have the link to the new file. and the 'error' key will be set to false.</p> <p>This function will not move an uploaded file to the upload folder. It will create a new file with the content in $bits parameter. If you move the upload file, read the content of the uploaded file, and then you can give the filename and content to this function, which will add it to the upload folder.</p> <p>The permissions will be set on the new file automatically by this function.</p>","summary":"Create a file in the upload folder with given content.","type":"function","category":"Miscellaneous","since":"2.0.0","param":[{"content":"Filename.","types":"string","variable":"$name","default":"null","required":"yes"},{"content":"Never used. Set to null.","types":"null|string","variable":"$deprecated","default":"null","required":"yes"},{"content":"File content","types":"mixed","variable":"$bits","default":"null","required":"yes"},{"content":" Time formatted in 'yyyy/mm'. Default null.","types":"string","variable":"$time","default":"null","required":"no"}],"return":{"content":"","types":"array"}},{"name":"wp_ext2type","desc":"","summary":"Retrieve the file type based on the extension name.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"The extension to search.","types":"string","variable":"$ext","default":"null","required":"yes"}],"return":{"content":"The file type, example: audio, video, document, spreadsheet, etc.","types":"string|void"}},{"name":"wp_check_filetype","desc":"<p>You can optionally define the mime array, if needed.</p>","summary":"Retrieve the file type from the file name.","type":"function","category":"Miscellaneous","since":"2.0.4","param":[{"content":"File name or path.","types":"string","variable":"$filename","default":"null","required":"yes"},{"content":" Key is the file extension with value as the mime type.","types":"array","variable":"$mimes","default":"null","required":"no"}],"return":{"content":"Values with extension first and mime type.","types":"array"}},{"name":"wp_check_filetype_and_ext","desc":"<p>If unable to, the file name extension will be used to determine type.</p> <p>If it's determined that the extension does not match the file's real type, then the "proper_filename" value will be set with a proper filename and extension.</p> <p>Currently this function only supports renaming images validated via wp_get_image_mime().</p>","summary":"Attempt to determine the real file type of a file.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Full path to the file.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":"The name of the file (may differ from $file due to $file being in a tmp directory).","types":"string","variable":"$filename","default":"null","required":"yes"},{"content":" Key is the file extension with value as the mime type.","types":"array","variable":"$mimes","default":"null","required":"no"}],"return":{"content":"Values for the extension, MIME, and either a corrected filename or false if original $filename is valid.","types":"array"}},{"name":"wp_get_image_mime","desc":"<p>This depends on exif_imagetype() or getimagesize() to determine real mime types.</p>","summary":"Returns the real mime type of an image file.","type":"function","category":"Uncategorised","since":"4.7.1","param":[{"content":"Full path to the file.","types":"string","variable":"$file","default":"null","required":"yes"}],"return":{"content":"The actual mime type or false if the type cannot be determined.","types":"string|false"}},{"name":"wp_get_mime_types","desc":"","summary":"Retrieve list of mime types and file extensions.","type":"function","category":"Attachments","since":"4.2.0","return":{"content":"Array of mime types keyed by the file extension regex corresponding to those types.","types":"array"}},{"name":"wp_get_ext_types","desc":"","summary":"Retrieves the list of common file extensions and their types.","type":"function","category":"Uncategorised","since":"4.6.0","return":{"content":"Array of file extensions types keyed by the type of file.","types":"array"}},{"name":"get_allowed_mime_types","desc":"","summary":"Retrieve list of allowed mime types and file extensions.","type":"function","category":"Uncategorised","since":"2.8.6","param":[{"content":" User to check. Defaults to current user.","types":"int|WP_User","variable":"$user","default":"null","required":"no"}],"return":{"content":"Array of mime types keyed by the file extension regex corresponding to those types.","types":"array"}},{"name":"wp_nonce_ays","desc":"<p>If the action has the nonce explain message, then it will be displayed along with the "Are you sure?" message.</p>","summary":"Display \"Are You Sure\" message to confirm the action being taken.","type":"function","category":"Nonces and Referers (Security)","since":"2.0.4","param":[{"content":"The nonce action.","types":"string","variable":"$action","default":"null","required":"yes"}]},{"name":"wp_die","desc":"<p>This function complements the <code>die()</code> PHP function. The difference is that HTML will be displayed to the user. It is recommended to use this function only when the execution should not continue any further. It is not recommended to call this function very often, and try to handle as many errors as possible silently or more gracefully.</p> <p>As a shorthand, the desired HTTP response code may be passed as an integer to the <code>$title</code> parameter (the default title would apply) or the <code>$args</code> parameter.</p>","summary":"Kills WordPress execution and displays HTML page with an error message.","type":"function","category":"Miscellaneous","since":"5.1.0","param":[{"content":" Error message. If this is a WP_Error object, and not an Ajax or XML-RPC request, the error's messages are used. Default empty.","types":"string|WP_Error","variable":"$message","default":"''","required":"no"},{"content":" Error title. If <code>$message</code> is a <code>WP_Error</code> object, error data with the key 'title' may be used to specify the title. If <code>$title</code> is an integer, then it is treated as the response code. Default empty.","types":"string|int","variable":"$title","default":"''","required":"no"},{"content":"{ Optional. Arguments to control behavior. If <code>$args</code> is an integer, then it is treated as the response code. Default empty array. @type int $response The HTTP response code. Default 200 for Ajax requests, 500 otherwise. @type string $link_url A URL to include a link to. Only works in combination with $link_text. Default empty string. @type string $link_text A label for the link to include. Only works in combination with $link_url. Default empty string. @type bool $back_link Whether to include a link to go back. Default false. @type string $text_direction The text direction. This is only useful internally, when WordPress is still loading and the site's locale is not set up yet. Accepts 'rtl'. Default is the value of is_rtl(). @type string $code Error code to use. Default is 'wp_die', or the main error code if $message is a WP_Error. @type bool $exit Whether to exit the process after completion. Default true. }","types":"string|array|int","variable":"$args","default":"array()","required":"no"}]},{"name":"_default_wp_die_handler","desc":"<p>This is the default handler for wp_die(). If you want a custom one, you can override this using the {@see 'wp_die_handler'} filter in wp_die().</p>","summary":"Kills WordPress execution and displays HTML page with an error message.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private","param":[{"content":"Error message or WP_Error object.","types":"string|WP_Error","variable":"$message","default":"null","required":"yes"},{"content":" Error title. Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_ajax_wp_die_handler","desc":"<p>This is the handler for wp_die() when processing Ajax requests.</p>","summary":"Kills WordPress execution and displays Ajax response with an error message.","type":"function","category":"Uncategorised","since":"3.4.0","access":"private","param":[{"content":"Error message.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":" Error title (unused). Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_json_wp_die_handler","desc":"<p>This is the handler for wp_die() when processing JSON requests.</p>","summary":"Kills WordPress execution and displays JSON response with an error message.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","param":[{"content":"Error message.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":" Error title. Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_jsonp_wp_die_handler","desc":"<p>This is the handler for wp_die() when processing JSONP requests.</p>","summary":"Kills WordPress execution and displays JSONP response with an error message.","type":"function","category":"Uncategorised","since":"5.2.0","access":"private","param":[{"content":"Error message.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":" Error title. Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_xmlrpc_wp_die_handler","desc":"<p>This is the handler for wp_die() when processing XMLRPC requests.</p>","summary":"Kills WordPress execution and displays XML response with an error message.","type":"function","category":"Uncategorised","since":"3.2.0","access":"private","param":[{"content":"Error message.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":" Error title. Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_xml_wp_die_handler","desc":"<p>This is the handler for wp_die() when processing XML requests.</p>","summary":"Kills WordPress execution and displays XML response with an error message.","type":"function","category":"Uncategorised","since":"5.2.0","access":"private","param":[{"content":"Error message.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":" Error title. Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_scalar_wp_die_handler","desc":"<p>This is the handler for wp_die() when processing APP requests.</p>","summary":"Kills WordPress execution and displays an error message.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","param":[{"content":" Response to print. Default empty.","types":"string","variable":"$message","default":"''","required":"no"},{"content":" Error title (unused). Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}]},{"name":"_wp_die_process_input","desc":"","summary":"Processes arguments passed to wp_die() consistently for its handlers.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","param":[{"content":"Error message.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":" Error title. Default empty.","types":"string","variable":"$title","default":"''","required":"no"},{"content":" Arguments to control behavior. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"List of processed $message string, $title string, and $args array.","types":"array"}},{"name":"wp_json_encode","desc":"","summary":"Encode a variable into JSON, with some sanity checks.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":"Variable (usually an array or object) to encode as JSON.","types":"mixed","variable":"$data","default":"null","required":"yes"},{"content":" Options to be passed to json_encode(). Default 0.","types":"int","variable":"$options","default":"0","required":"no"},{"content":" Maximum depth to walk through $data. Must be greater than 0. Default 512.","types":"int","variable":"$depth","default":"512","required":"no"}],"return":{"content":"The JSON encoded string, or false if it cannot be encoded.","types":"string|false"}},{"name":"_wp_json_sanity_check","desc":"","summary":"Perform sanity checks on data that shall be encoded to JSON.","type":"function","category":"Uncategorised","since":"4.1.0","access":"private","param":[{"content":"Variable (usually an array or object) to encode as JSON.","types":"mixed","variable":"$data","default":"null","required":"yes"},{"content":"Maximum depth to walk through $data. Must be greater than 0.","types":"int","variable":"$depth","default":"null","required":"yes"}],"return":{"content":"The sanitized data that shall be encoded to JSON.","types":"mixed"}},{"name":"_wp_json_convert_string","desc":"","summary":"Convert a string to UTF-8, so that it can be safely encoded to JSON.","type":"function","category":"Uncategorised","since":"4.1.0","access":"private","param":[{"content":"The string which is to be converted.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"The checked string.","types":"string"}},{"name":"_wp_json_prepare_data","desc":"<p>This supports the JsonSerializable interface for PHP 5.2-5.3 as well.</p>","summary":"Prepares response data to be serialized to JSON.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private","param":[{"content":"Native representation.","types":"mixed","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Data ready for <code>json_encode()</code>.","types":"bool|int|float|null|string|array"}},{"name":"wp_send_json","desc":"","summary":"Send a JSON response back to an Ajax request.","type":"function","category":"Nonces and Referers (Security)","since":"4.7.0","param":[{"content":"Variable (usually an array or object) to encode as JSON, then print and die.","types":"mixed","variable":"$response","default":"null","required":"yes"},{"content":"The HTTP status code to output.","types":"int","variable":"$status_code","default":"null","required":"no"}]},{"name":"wp_send_json_success","desc":"","summary":"Send a JSON response back to an Ajax request, indicating success.","type":"function","category":"Nonces and Referers (Security)","since":"4.7.0","param":[{"content":"Data to encode as JSON, then print and die.","types":"mixed","variable":"$data","default":"null","required":"no"},{"content":"The HTTP status code to output.","types":"int","variable":"$status_code","default":"null","required":"no"}]},{"name":"wp_send_json_error","desc":"<p>If the <code>$data</code> parameter is a WP_Error object, the errors within the object are processed and output as an array of error codes and corresponding messages. All other types are output without further processing.</p>","summary":"Send a JSON response back to an Ajax request, indicating failure.","type":"function","category":"Nonces and Referers (Security)","since":"4.7.0","param":[{"content":"Data to encode as JSON, then print and die.","types":"mixed","variable":"$data","default":"null","required":"no"},{"content":"The HTTP status code to output.","types":"int","variable":"$status_code","default":"null","required":"no"}]},{"name":"wp_check_jsonp_callback","desc":"<p>Only allows alphanumeric characters and the dot character in callback function names. This helps to mitigate XSS attacks caused by directly outputting user input.</p>","summary":"Checks that a JSONP callback is a valid JavaScript callback.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"Supplied JSONP callback function.","types":"string","variable":"$callback","default":"null","required":"yes"}],"return":{"content":"True if valid callback, otherwise false.","types":"bool"}},{"name":"_config_wp_home","desc":"<p>If the constant named 'WP_HOME' exists, then it will be used and returned by the function. This can be used to counter the redirection on your local development environment.</p>","summary":"Retrieve the WordPress home page URL.","type":"function","category":"Uncategorised","since":"2.2.0","access":"private","param":[{"content":"URL for the home location.","types":"string","variable":"$url","default":"''","required":"no"}],"return":{"content":"Homepage location.","types":"string"}},{"name":"_config_wp_siteurl","desc":"<p>If the constant named 'WP_SITEURL' is defined, then the value in that constant will always be returned. This can be used for debugging a site on your localhost while not having to change the database to your URL.</p>","summary":"Retrieve the WordPress site URL.","type":"function","category":"Uncategorised","since":"2.2.0","access":"private","param":[{"content":"URL to set the WordPress site location.","types":"string","variable":"$url","default":"''","required":"no"}],"return":{"content":"The WordPress Site URL.","types":"string"}},{"name":"_delete_option_fresh_site","desc":"","summary":"Delete the fresh site option.","type":"function","category":"Uncategorised","since":"4.7.0","access":"private"},{"name":"_mce_set_direction","desc":"<p>Will only set the direction to 'rtl', if the WordPress locale has the text direction set to 'rtl'.</p> <p>Fills in the 'directionality' setting, enables the 'directionality' plugin, and adds the 'ltr' button to 'toolbar1', formerly 'theme_advanced_buttons1' array keys. These keys are then returned in the $mce_init (TinyMCE settings) array.</p>","summary":"Set the localized direction for MCE plugin.","type":"function","category":"Uncategorised","since":"2.1.0","access":"private","param":[{"content":"MCE settings array.","types":"array","variable":"$mce_init","default":"null","required":"yes"}],"return":{"content":"Direction set for 'rtl', if needed by locale.","types":"array"}},{"name":"smilies_init","desc":"<p>You can turn off smilies, by going to the write setting screen and unchecking the box, or by setting 'use_smilies' option to false or removing the option.</p> <p>Plugins may override the default smiley list by setting the $wpsmiliestrans to an array, with the key the code the blogger types in and the value the image file.</p> <p>The $wp_smiliessearch global is for the regular expression and is set each time the function is called.</p> <p>The full list of smilies can be found in the function and won't be listed in the description. Probably should create a Codex page for it, so that it is available.</p>","summary":"Convert smiley code to the icon graphic file equivalent.","type":"function","category":"Uncategorised","since":"2.2.0"},{"name":"wp_parse_args","desc":"<p>This function is used throughout WordPress to allow for both string or array to be merged into another array.</p>","summary":"Merge user defined arguments into defaults array.","type":"function","category":"Miscellaneous","since":"2.3.0","param":[{"content":"Value to merge with $defaults.","types":"string|array|object","variable":"$args","default":"null","required":"yes"},{"content":" Array that serves as the defaults. Default empty.","types":"array","variable":"$defaults","default":"''","required":"no"}],"return":{"content":"Merged user defined values with defaults.","types":"array"}},{"name":"wp_parse_list","desc":"","summary":"Cleans up an array, comma- or space-separated list of scalar values.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"List of values.","types":"array|string","variable":"$list","default":"null","required":"yes"}],"return":{"content":"Sanitized array of values.","types":"array"}},{"name":"wp_parse_id_list","desc":"","summary":"Clean up an array, comma- or space-separated list of IDs.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"List of ids.","types":"array|string","variable":"$list","default":"null","required":"yes"}],"return":{"content":"Sanitized array of IDs.","types":"array"}},{"name":"wp_parse_slug_list","desc":"","summary":"Clean up an array, comma- or space-separated list of slugs.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"List of slugs.","types":"array|string","variable":"$list","default":"null","required":"yes"}],"return":{"content":"Sanitized array of slugs.","types":"array"}},{"name":"wp_array_slice_assoc","desc":"","summary":"Extract a slice of an array, given a list of keys.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"The original array.","types":"array","variable":"$array","default":"null","required":"yes"},{"content":"The list of keys.","types":"array","variable":"$keys","default":"null","required":"yes"}],"return":{"content":"The array slice.","types":"array"}},{"name":"wp_is_numeric_array","desc":"","summary":"Determines if the variable is a numeric-indexed array.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Variable to check.","types":"mixed","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Whether the variable is a list.","types":"bool"}},{"name":"wp_filter_object_list","desc":"","summary":"Filters a list of objects, based on a set of key => value arguments.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"An array of objects to filter","types":"array","variable":"$list","default":"null","required":"yes"},{"content":" An array of key => value arguments to match against each object. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"},{"content":" The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match; 'not' means no elements may match. Default 'and'.","types":"string","variable":"$operator","default":"'and'","required":"no"},{"content":"A field from the object to place instead of the entire object. Default false.","types":"bool|string","variable":"$field","default":"false","required":"no"}],"return":{"content":"A list of objects or object fields.","types":"array"}},{"name":"wp_list_filter","desc":"","summary":"Filters a list of objects, based on a set of key => value arguments.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"An array of objects to filter.","types":"array","variable":"$list","default":"null","required":"yes"},{"content":" An array of key => value arguments to match against each object. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"},{"content":" 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. Default 'AND'.","types":"string","variable":"$operator","default":"'AND'","required":"no"}],"return":{"content":"Array of found values.","types":"array"}},{"name":"wp_list_pluck","desc":"<p>This has the same functionality and prototype of array_column() (PHP 5.5) but also supports objects.</p>","summary":"Pluck a certain field out of each object in a list.","type":"function","category":"Miscellaneous","since":"4.7.0","param":[{"content":"List of objects or arrays","types":"array","variable":"$list","default":"null","required":"yes"},{"content":"Field from the object to place instead of the entire object","types":"int|string","variable":"$field","default":"null","required":"yes"},{"content":" Field from the object to use as keys for the new array. Default null.","types":"int|string","variable":"$index_key","default":"null","required":"no"}],"return":{"content":"Array of found values. If <code>$index_key</code> is set, an array of found values with keys corresponding to <code>$index_key</code>. If <code>$index_key</code> is null, array keys from the original <code>$list</code> will be preserved in the results.","types":"array"}},{"name":"wp_list_sort","desc":"","summary":"Sorts a list of objects, based on one or more orderby arguments.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"An array of objects to sort.","types":"array","variable":"$list","default":"null","required":"yes"},{"content":" Either the field name to order by or an array of multiple orderby fields as $orderby => $order.","types":"string|array","variable":"$orderby","default":"array()","required":"no"},{"content":" Either 'ASC' or 'DESC'. Only used if $orderby is a string.","types":"string","variable":"$order","default":"'ASC'","required":"no"},{"content":" Whether to preserve keys. Default false.","types":"bool","variable":"$preserve_keys","default":"false","required":"no"}],"return":{"content":"The sorted array.","types":"array"}},{"name":"wp_maybe_load_widgets","desc":"<p>Checks to make sure that the widgets library hasn't already been loaded. If it hasn't, then it will load the widgets library and run an action hook.</p>","summary":"Determines if Widgets library should be loaded.","type":"function","category":"Uncategorised","since":"2.2.0"},{"name":"wp_widgets_add_menu","desc":"","summary":"Append the Widgets menu to the themes main menu.","type":"function","category":"Uncategorised","since":"2.2.0"},{"name":"wp_ob_end_flush_all","desc":"<p>Make sure all output buffers are flushed before our singletons are destroyed.</p>","summary":"Flush all output buffers for PHP 5.2.","type":"function","category":"Uncategorised","since":"2.2.0"},{"name":"dead_db","desc":"<p>If a file exists in the wp-content directory named db-error.php, then it will be loaded instead of displaying the WordPress DB error. If it is not found, then the WordPress DB error will be displayed instead.</p> <p>The WordPress DB error sets the HTTP status header to 500 to try to prevent search engines from caching the message. Custom DB messages should do the same.</p> <p>This function was backported to WordPress 2.3.2, but originally was added in WordPress 2.5.0.</p>","summary":"Load custom DB error or display WordPress DB error.","type":"function","category":"Uncategorised","since":"2.3.2"},{"name":"absint","desc":"","summary":"Convert a value to non-negative integer.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Data you wish to have converted to a non-negative integer.","types":"mixed","variable":"$maybeint","default":"null","required":"yes"}],"return":{"content":"A non-negative integer.","types":"int"}},{"name":"_deprecated_function","desc":"<p>There is a {@see 'hook deprecated_function_run'} that will be called that can be used to get the backtrace up to what file and function called the deprecated function.</p> <p>The current behavior is to trigger a user error if <code>WP_DEBUG</code> is true.</p> <p>This function is to be used in every function that is deprecated.</p>","summary":"Mark a function as deprecated and inform when it has been used.","type":"function","category":"Uncategorised","since":"2.5.0","access":"private","param":[{"content":"The function that was called.","types":"string","variable":"$function","default":"null","required":"yes"},{"content":"The version of WordPress that deprecated the function.","types":"string","variable":"$version","default":"null","required":"yes"},{"content":" The function that should have been called. Default null.","types":"string","variable":"$replacement","default":"null","required":"no"}]},{"name":"_deprecated_constructor","desc":"<p>Similar to _deprecated_function(), but with different strings. Used to remove PHP4 style constructors.</p> <p>The current behavior is to trigger a user error if <code>WP_DEBUG</code> is true.</p> <p>This function is to be used in every PHP4 style constructor method that is deprecated.</p>","summary":"Marks a constructor as deprecated and informs when it has been used.","type":"function","category":"Uncategorised","since":"4.5.0","access":"private","param":[{"content":"The class containing the deprecated constructor.","types":"string","variable":"$class","default":"null","required":"yes"},{"content":"The version of WordPress that deprecated the function.","types":"string","variable":"$version","default":"null","required":"yes"},{"content":" The parent class calling the deprecated constructor. Default empty string.","types":"string","variable":"$parent_class","default":"''","required":"no"}]},{"name":"_deprecated_file","desc":"<p>There is a hook {@see 'deprecated_file_included'} that will be called that can be used to get the backtrace up to what file and function included the deprecated file.</p> <p>The current behavior is to trigger a user error if <code>WP_DEBUG</code> is true.</p> <p>This function is to be used in every file that is deprecated.</p>","summary":"Mark a file as deprecated and inform when it has been used.","type":"function","category":"Uncategorised","since":"2.5.0","access":"private","param":[{"content":"The file that was included.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":"The version of WordPress that deprecated the file.","types":"string","variable":"$version","default":"null","required":"yes"},{"content":" The file that should have been included based on ABSPATH. Default null.","types":"string","variable":"$replacement","default":"null","required":"no"},{"content":" A message regarding the change. Default empty.","types":"string","variable":"$message","default":"''","required":"no"}]},{"name":"_deprecated_argument","desc":"<p>This function is to be used whenever a deprecated function argument is used. Before this function is called, the argument must be checked for whether it was used by comparing it to its default value or evaluating whether it is empty. For example:</p> <pre><code>if ( ! empty( $deprecated ) ) {\n _deprecated_argument( __FUNCTION__, '3.0.0' );\n}</code></pre> <p>There is a hook deprecated_argument_run that will be called that can be used to get the backtrace up to what file and function used the deprecated argument.</p> <p>The current behavior is to trigger a user error if WP_DEBUG is true.</p>","summary":"Mark a function argument as deprecated and inform when it has been used.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private","param":[{"content":"The function that was called.","types":"string","variable":"$function","default":"null","required":"yes"},{"content":"The version of WordPress that deprecated the argument used.","types":"string","variable":"$version","default":"null","required":"yes"},{"content":" A message regarding the change. Default null.","types":"string","variable":"$message","default":"null","required":"no"}]},{"name":"_deprecated_hook","desc":"<p>Use the {@see 'deprecated_hook_run'} action to get the backtrace describing where the deprecated hook was called.</p> <p>Default behavior is to trigger a user error if <code>WP_DEBUG</code> is true.</p> <p>This function is called by the do_action_deprecated() and apply_filters_deprecated() functions, and so generally does not need to be called directly.</p>","summary":"Marks a deprecated action or filter hook as deprecated and throws a notice.","type":"function","category":"Uncategorised","since":"4.6.0","access":"private","param":[{"content":"The hook that was used.","types":"string","variable":"$hook","default":"null","required":"yes"},{"content":"The version of WordPress that deprecated the hook.","types":"string","variable":"$version","default":"null","required":"yes"},{"content":" The hook that should have been used.","types":"string","variable":"$replacement","default":"null","required":"no"},{"content":" A message regarding the change.","types":"string","variable":"$message","default":"null","required":"no"}]},{"name":"_doing_it_wrong","desc":"<p>There is a hook {@see 'doing_it_wrong_run'} that will be called that can be used to get the backtrace up to what file and function called the deprecated function.</p> <p>The current behavior is to trigger a user error if <code>WP_DEBUG</code> is true.</p>","summary":"Mark something as being incorrectly called.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"The function that was called.","types":"string","variable":"$function","default":"null","required":"yes"},{"content":"A message explaining what has been done incorrectly.","types":"string","variable":"$message","default":"null","required":"yes"},{"content":"The version of WordPress where the message was added.","types":"string","variable":"$version","default":"null","required":"yes"}]},{"name":"is_lighttpd_before_150","desc":"","summary":"Is the server running earlier than 1.5.0 version of lighttpd?","type":"function","category":"Uncategorised","since":"2.5.0","return":{"content":"Whether the server is running lighttpd < 1.5.0.","types":"bool"}},{"name":"apache_mod_loaded","desc":"","summary":"Does the specified module exist in the Apache config?","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"The module, e.g. mod_rewrite.","types":"string","variable":"$mod","default":"null","required":"yes"},{"content":" The default return value if the module is not found. Default false.","types":"bool","variable":"$default","default":"false","required":"no"}],"return":{"content":"Whether the specified module is loaded.","types":"bool"}},{"name":"iis7_supports_permalinks","desc":"","summary":"Check if IIS 7+ supports pretty permalinks.","type":"function","category":"Uncategorised","since":"2.8.0","return":{"content":"Whether IIS7 supports permalinks.","types":"bool"}},{"name":"validate_file","desc":"<p>A return value of <code>1</code> means the file path contains directory traversal.</p> <p>A return value of <code>2</code> means the file path contains a Windows drive path.</p> <p>A return value of <code>3</code> means the file is not in the allowed files list.</p>","summary":"Validates a file name and path against an allowed set of rules.","type":"function","category":"Miscellaneous","since":"1.2.0","param":[{"content":"File path.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":" List of allowed files.","types":"array","variable":"$allowed_files","default":"array()","required":"no"}],"return":{"content":"0 means nothing is wrong, greater than 0 means something was wrong.","types":"int"}},{"name":"force_ssl_admin","desc":"","summary":"Whether to force SSL used for the Administration Screens.","type":"function","category":"Uncategorised","since":"2.6.0","param":[{"content":" Whether to force SSL in admin screens. Default null.","types":"string|bool","variable":"$force","default":"null","required":"no"}],"return":{"content":"True if forced, false if not forced.","types":"bool"}},{"name":"wp_guess_url","desc":"<p>Will remove wp-admin links to retrieve only return URLs not in the wp-admin directory.</p>","summary":"Guess the URL for the site.","type":"function","category":"Uncategorised","since":"2.6.0","return":{"content":"The guessed URL.","types":"string"}},{"name":"wp_suspend_cache_addition","desc":"<p>Stops more data being added to the cache, but still allows cache retrieval. This is useful for actions, such as imports, when a lot of data would otherwise be almost uselessly added to the cache.</p> <p>Suspension lasts for a single page load at most. Remember to call this function again if you wish to re-enable cache adds earlier.</p>","summary":"Temporarily suspend cache additions.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":" Suspends additions if true, re-enables them if false.","types":"bool","variable":"$suspend","default":"null","required":"no"}],"return":{"content":"The current suspend setting","types":"bool"}},{"name":"wp_suspend_cache_invalidation","desc":"<p>Turns cache invalidation on and off. Useful during imports where you don't want to do invalidations every time a post is inserted. Callers must be sure that what they are doing won't lead to an inconsistent cache when invalidation is suspended.</p>","summary":"Suspend cache invalidation.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Whether to suspend or enable cache invalidation. Default true.","types":"bool","variable":"$suspend","default":"true","required":"no"}],"return":{"content":"The current suspend setting.","types":"bool"}},{"name":"is_main_site","desc":"","summary":"Determine whether a site is the main site of the current network.","type":"function","category":"Miscellaneous","since":"4.9.0","param":[{"content":" Site ID to test. Defaults to current site.","types":"int","variable":"$site_id","default":"null","required":"no"},{"content":" Network ID of the network to check for. Defaults to current network.","types":"int","variable":"$network_id","default":"null","required":"no"}],"return":{"content":"True if $site_id is the main site of the network, or if not running Multisite.","types":"bool"}},{"name":"get_main_site_id","desc":"","summary":"Gets the main site ID.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":" The ID of the network for which to get the main site. Defaults to the current network.","types":"int","variable":"$network_id","default":"null","required":"no"}],"return":{"content":"The ID of the main site.","types":"int"}},{"name":"is_main_network","desc":"","summary":"Determine whether a network is the main network of the Multisite installation.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":" Network ID to test. Defaults to current network.","types":"int","variable":"$network_id","default":"null","required":"no"}],"return":{"content":"True if $network_id is the main network, or if not running Multisite.","types":"bool"}},{"name":"get_main_network_id","desc":"","summary":"Get the main network ID.","type":"function","category":"Uncategorised","since":"4.3.0","return":{"content":"The ID of the main network.","types":"int"}},{"name":"global_terms_enabled","desc":"","summary":"Determine whether global terms are enabled.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"True if multisite and global terms enabled.","types":"bool"}},{"name":"is_site_meta_supported","desc":"<p>This function checks whether the 'blogmeta' database table exists. The result is saved as a setting for the main network, making it essentially a global setting. Subsequent requests will refer to this setting instead of running the query.</p>","summary":"Determines whether site meta is enabled.","type":"function","category":"Uncategorised","since":"5.1.0","return":{"content":"True if site meta is supported, false otherwise.","types":"bool"}},{"name":"wp_timezone_override_offset","desc":"<p>Overrides the gmt_offset option if we have a timezone_string available.</p>","summary":"gmt_offset modification for smart timezone handling.","type":"function","category":"Uncategorised","since":"2.8.0","return":{"content":"Timezone GMT offset, false otherwise.","types":"float|false"}},{"name":"_wp_timezone_choice_usort_callback","desc":"","summary":"Sort-helper for timezones.","type":"function","category":"Uncategorised","since":"2.9.0","access":"private","param":[{"content":"","types":"array","variable":"$a","default":"null","required":"yes"},{"content":"","types":"array","variable":"$b","default":"null","required":"yes"}],"return":{"content":"","types":"int"}},{"name":"wp_timezone_choice","desc":"","summary":"Gives a nicely-formatted list of timezone strings.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Selected timezone.","types":"string","variable":"$selected_zone","default":"null","required":"yes"},{"content":" Locale to load the timezones in. Default current site locale.","types":"string","variable":"$locale","default":"null","required":"no"}],"return":{"content":"","types":"string"}},{"name":"_cleanup_header_comment","desc":"","summary":"Strip close comment and close php tags from file headers used by WP.","type":"function","category":"Uncategorised","since":"2.8.0","access":"private","param":[{"content":"Header comment to clean up.","types":"string","variable":"$str","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"wp_scheduled_delete","desc":"<p>The default value of <code>EMPTY_TRASH_DAYS</code> is 30 (days).</p>","summary":"Permanently delete comments or posts of any type that have held a status of 'trash' for the number of days defined in EMPTY_TRASH_DAYS.","type":"function","category":"Uncategorised","since":"2.9.0"},{"name":"get_file_data","desc":"<p>Searches for metadata in the first 8kiB of a file, such as a plugin or theme. Each piece of metadata must be on its own line. Fields can not span multiple lines, the value will get cut at the end of the first line.</p> <p>If the file data is not within that first 8kiB, then the author should correct their plugin file and move the data headers to the top.</p>","summary":"Retrieve metadata from a file.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Absolute path to the file.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":"List of headers, in the format <code>array('HeaderKey' => 'Header Name')</code>.","types":"array","variable":"$default_headers","default":"null","required":"yes"},{"content":" If specified adds filter hook {@see 'extra_$context_headers'}. Default empty.","types":"string","variable":"$context","default":"''","required":"no"}],"return":{"content":"Array of file headers in <code>HeaderKey => Header Value</code> format.","types":"array"}},{"name":"__return_true","desc":"<p>Useful for returning true to filters easily.</p>","summary":"Returns true.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"True.","types":"true"}},{"name":"__return_false","desc":"<p>Useful for returning false to filters easily.</p>","summary":"Returns false.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"False.","types":"false"}},{"name":"__return_zero","desc":"<p>Useful for returning 0 to filters easily.</p>","summary":"Returns 0.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"0.","types":"int"}},{"name":"__return_empty_array","desc":"<p>Useful for returning an empty array to filters easily.</p>","summary":"Returns an empty array.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"Empty array.","types":"array"}},{"name":"__return_null","desc":"<p>Useful for returning null to filters easily.</p>","summary":"Returns null.","type":"function","category":"Uncategorised","since":"3.4.0","return":{"content":"Null value.","types":"null"}},{"name":"__return_empty_string","desc":"<p>Useful for returning an empty string to filters easily.</p>","summary":"Returns an empty string.","type":"function","category":"Uncategorised","since":"3.7.0","return":{"content":"Empty string.","types":"string"}},{"name":"send_nosniff_header","desc":"","summary":"Send a HTTP header to disable content type sniffing in browsers which support it.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"_wp_mysql_week","desc":"","summary":"Return a MySQL expression for selecting the week number based on the start_of_week option.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Database column.","types":"string","variable":"$column","default":"null","required":"yes"}],"return":{"content":"SQL clause.","types":"string"}},{"name":"wp_find_hierarchy_loop","desc":"","summary":"Find hierarchy loops using a callback function that maps object IDs to parent IDs.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"Function that accepts ( ID, $callback_args ) and outputs parent_ID.","types":"callable","variable":"$callback","default":"null","required":"yes"},{"content":"The ID to start the loop check at.","types":"int","variable":"$start","default":"null","required":"yes"},{"content":"The parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback","types":"int","variable":"$start_parent","default":"null","required":"yes"},{"content":" Additional arguments to send to $callback.","types":"array","variable":"$callback_args","default":"array()","required":"no"}],"return":{"content":"IDs of all members of loop.","types":"array"}},{"name":"wp_find_hierarchy_loop_tortoise_hare","desc":"<p>For every step of the algorithm, the hare takes two steps and the tortoise one. If the hare ever laps the tortoise, there must be a loop.</p>","summary":"Use the \"The Tortoise and the Hare\" algorithm to detect loops.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","param":[{"content":"Function that accepts ( ID, callback_arg, ... ) and outputs parent_ID.","types":"callable","variable":"$callback","default":"null","required":"yes"},{"content":"The ID to start the loop check at.","types":"int","variable":"$start","default":"null","required":"yes"},{"content":" An array of ( ID => parent_ID, ... ) to use instead of $callback. Default empty array.","types":"array","variable":"$override","default":"array()","required":"no"},{"content":" Additional arguments to send to $callback. Default empty array.","types":"array","variable":"$callback_args","default":"array()","required":"no"},{"content":" 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). Default false.","types":"bool","variable":"$_return_loop","default":"false","required":"no"}],"return":{"content":"Scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop","types":"mixed"}},{"name":"send_frame_options_header","desc":"","summary":"Send a HTTP header to limit rendering of pages to same origin iframes.","type":"function","category":"Uncategorised","since":"3.1.3"},{"name":"wp_allowed_protocols","desc":"","summary":"Retrieve a list of protocols to allow in HTML attributes.","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"Array of allowed protocols. Defaults to an array containing 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp', 'webcal', and 'urn'. This covers all common link protocols, except for 'javascript' which should not be allowed for untrusted users.","types":"string[]"}},{"name":"wp_debug_backtrace_summary","desc":"","summary":"Return a comma-separated string of functions that have been called to get to the current point in code.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":" A class to ignore all function calls within - useful when you want to just give info about the callee. Default null.","types":"string","variable":"$ignore_class","default":"null","required":"no"},{"content":" A number of stack frames to skip - useful for unwinding back to the source of the issue. Default 0.","types":"int","variable":"$skip_frames","default":"0","required":"no"},{"content":" Whether or not you want a comma separated string or raw array returned. Default true.","types":"bool","variable":"$pretty","default":"true","required":"no"}],"return":{"content":"Either a string containing a reversed comma separated trace or an array of individual calls.","types":"string|array"}},{"name":"_get_non_cached_ids","desc":"","summary":"Retrieve IDs that are not already present in the cache.","type":"function","category":"Uncategorised","since":"3.4.0","access":"private","param":[{"content":"Array of IDs.","types":"int[]","variable":"$object_ids","default":"null","required":"yes"},{"content":"The cache bucket to check against.","types":"string","variable":"$cache_key","default":"null","required":"yes"}],"return":{"content":"Array of IDs not present in the cache.","types":"int[]"}},{"name":"_device_can_upload","desc":"","summary":"Test if the current device has the capability to upload files.","type":"function","category":"Uncategorised","since":"3.4.0","access":"private","return":{"content":"Whether the device is able to upload files.","types":"bool"}},{"name":"wp_is_stream","desc":"","summary":"Test if a given path is a stream URL","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":"The resource path or URL.","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"True if the path is a stream URL.","types":"bool"}},{"name":"wp_checkdate","desc":"","summary":"Test if the supplied date is valid for the Gregorian calendar.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":"Month number.","types":"int","variable":"$month","default":"null","required":"yes"},{"content":"Day number.","types":"int","variable":"$day","default":"null","required":"yes"},{"content":"Year number.","types":"int","variable":"$year","default":"null","required":"yes"},{"content":"The date to filter.","types":"string","variable":"$source_date","default":"null","required":"yes"}],"return":{"content":"True if valid date, false if not valid date.","types":"bool"}},{"name":"wp_auth_check_load","desc":"<p>Can be disabled with remove_action( 'admin_enqueue_scripts', 'wp_auth_check_load' );</p> <p>This is disabled for certain screens where a login screen could cause an inconvenient interruption. A filter called {@see 'wp_auth_check_load'} can be used for fine-grained control.</p>","summary":"Load the auth check for monitoring whether the user is still logged in.","type":"function","category":"Uncategorised","since":"3.6.0"},{"name":"wp_auth_check_html","desc":"","summary":"Output the HTML that shows the wp-login dialog when the user is no longer logged in.","type":"function","category":"Uncategorised","since":"3.6.0"},{"name":"wp_auth_check","desc":"<p>Send a result that shows a log-in box if the user is no longer logged in, or if their cookie is within the grace period.</p>","summary":"Check whether a user is still logged in, for the heartbeat.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"The Heartbeat response.","types":"array","variable":"$response","default":"null","required":"yes"}],"return":{"content":"$response The Heartbeat response with 'wp-auth-check' value set.","types":"array"}},{"name":"get_tag_regex","desc":"<p>Matches an opening HTML tag that:</p> <ol> <li>Is self-closing or</li> <li>Has no body but has a closing tag of the same name or</li> <li>Contains a body and a closing tag of the same name</li> </ol> <p>Note: this RegEx does not balance inner tags and does not attempt to produce valid HTML</p>","summary":"Return RegEx body to liberally match an opening HTML tag.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"An HTML tag name. Example: 'video'.","types":"string","variable":"$tag","default":"null","required":"yes"}],"return":{"content":"Tag RegEx.","types":"string"}},{"name":"_canonical_charset","desc":"","summary":"Retrieve a canonical form of the provided charset appropriate for passing to PHP functions such as htmlspecialchars() and charset html attributes.","type":"function","category":"Uncategorised","since":"3.6.0","access":"private","param":[{"content":"A charset name.","types":"string","variable":"$charset","default":"null","required":"yes"}],"return":{"content":"The canonical form of the charset.","types":"string"}},{"name":"mbstring_binary_safe_encoding","desc":"<p>When mbstring.func_overload is in use for multi-byte encodings, the results from strlen() and similar functions respect the utf8 characters, causing binary data to return incorrect lengths.</p> <p>This function overrides the mbstring encoding to a binary-safe encoding, and resets it to the users expected encoding afterwards through the <code>reset_mbstring_encoding</code> function.</p> <p>It is safe to recursively call this function, however each <code>mbstring_binary_safe_encoding()</code> call must be followed up with an equal number of <code>reset_mbstring_encoding()</code> calls.</p>","summary":"Set the mbstring internal encoding to a binary safe encoding when func_overload is enabled.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":" Whether to reset the encoding back to a previously-set encoding. Default false.","types":"bool","variable":"$reset","default":"false","required":"no"}]},{"name":"reset_mbstring_encoding","desc":"","summary":"Reset the mbstring internal encoding to a users previously set encoding.","type":"function","category":"Uncategorised","since":"3.7.0"},{"name":"wp_validate_boolean","desc":"<p>Alternative to <code>filter_var( $var, FILTER_VALIDATE_BOOLEAN )</code>.</p>","summary":"Filter/validate a variable as a boolean.","type":"function","category":"Uncategorised","since":"4.0.0","param":[{"content":"Boolean value to validate.","types":"mixed","variable":"$var","default":"null","required":"yes"}],"return":{"content":"Whether the value is validated.","types":"bool"}},{"name":"wp_delete_file","desc":"","summary":"Delete a file","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The path to the file to delete.","types":"string","variable":"$file","default":"null","required":"yes"}]},{"name":"wp_delete_file_from_directory","desc":"","summary":"Deletes a file if its path is within the given directory.","type":"function","category":"Uncategorised","since":"4.9.7","param":[{"content":"Absolute path to the file to delete.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":"Absolute path to a directory.","types":"string","variable":"$directory","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_post_preview_js","desc":"<p>This prevents reusing the same tab for a preview when the user has navigated away.</p>","summary":"Outputs a small JS snippet on preview tabs/windows to remove `window.name` on unload.","type":"function","category":"Uncategorised","since":"4.3.0"},{"name":"mysql_to_rfc3339","desc":"<p>Explicitly strips timezones, as datetimes are not saved with any timezone information. Including any information on the offset could be misleading.</p> <p>Despite historical function name, the output does not conform to RFC3339 format, which must contain timezone.</p>","summary":"Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601 (Y-m-d\\TH:i:s).","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Date string to parse and format.","types":"string","variable":"$date_string","default":"null","required":"yes"}],"return":{"content":"Date formatted for ISO8601 without time zone.","types":"string"}},{"name":"wp_raise_memory_limit","desc":"<p>Only allows raising the existing limit and prevents lowering it.</p>","summary":"Attempts to raise the PHP memory limit for memory intensive processes.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Context in which the function is called. Accepts either 'admin', 'image', or an arbitrary other context. If an arbitrary context is passed, the similarly arbitrary {@see '{$context}_memory_limit'} filter will be invoked. Default 'admin'.","types":"string","variable":"$context","default":"'admin'","required":"no"}],"return":{"content":"The limit that was set or false on failure.","types":"bool|int|string"}},{"name":"wp_generate_uuid4","desc":"","summary":"Generate a random UUID (version 4).","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"UUID.","types":"string"}},{"name":"wp_is_uuid","desc":"","summary":"Validates that a UUID is valid.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"UUID to check.","types":"mixed","variable":"$uuid","default":"null","required":"yes"},{"content":"Specify which version of UUID to check against. Default is none, to accept any UUID version. Otherwise, only version allowed is <code>4</code>.","types":"int","variable":"$version","default":"null","required":"no"}],"return":{"content":"The string is a valid UUID or false on failure.","types":"bool"}},{"name":"wp_unique_id","desc":"<p>This is a PHP implementation of Underscore's uniqueId method. A static variable contains an integer that is incremented with each call. This number is returned with the optional prefix. As such the returned value is not universally unique, but it is unique across the life of the PHP process.</p>","summary":"Get unique ID.","type":"function","category":"Uncategorised","since":"5.0.3","param":[{"content":"Prefix for the returned ID.","types":"string","variable":"$prefix","default":"''","required":"no"}],"return":{"content":"Unique ID.","types":"string"}},{"name":"wp_cache_get_last_changed","desc":"","summary":"Get last changed date for the specified cache group.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Where the cache contents are grouped.","types":"string","variable":"$group","default":"null","required":"yes"}],"return":{"content":"$last_changed UNIX timestamp with microseconds representing when the group was last changed.","types":"string"}},{"name":"wp_site_admin_email_change_notification","desc":"","summary":"Send an email to the old site admin email address when the site admin email address changes.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"The old site admin email address.","types":"string","variable":"$old_email","default":"null","required":"yes"},{"content":"The new site admin email address.","types":"string","variable":"$new_email","default":"null","required":"yes"},{"content":"The relevant database option name.","types":"string","variable":"$option_name","default":"null","required":"yes"}]},{"name":"wp_privacy_anonymize_ip","desc":"","summary":"Return an anonymized IPv4 or IPv6 address.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The IPv4 or IPv6 address to be anonymized.","types":"string","variable":"$ip_addr","default":"null","required":"yes"},{"content":" Whether to return the original IPv6 address if the needed functions to anonymize it are not present. Default false, return <code>::</code> (unspecified address).","types":"bool","variable":"$ipv6_fallback","default":"false","required":"no"}],"return":{"content":"The anonymized IP address.","types":"string"}},{"name":"wp_privacy_anonymize_data","desc":"","summary":"Return uniform \"anonymous\" data by type.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The type of data to be anonymized.","types":"string","variable":"$type","default":"null","required":"yes"},{"content":"The data to be anonymized.","types":"string","variable":"$data","default":"''","required":"no"}],"return":{"content":"The anonymous data for the requested type.","types":"string"}},{"name":"wp_privacy_exports_dir","desc":"","summary":"Returns the directory used to store personal data export files.","type":"function","category":"Uncategorised","since":"4.9.6","return":{"content":"Exports directory.","types":"string"}},{"name":"wp_privacy_exports_url","desc":"","summary":"Returns the URL of the directory used to store personal data export files.","type":"function","category":"Uncategorised","since":"4.9.6","return":{"content":"Exports directory URL.","types":"string"}},{"name":"wp_schedule_delete_old_privacy_export_files","desc":"","summary":"Schedule a `WP_Cron` job to delete expired export files.","type":"function","category":"Uncategorised","since":"4.9.6"},{"name":"wp_privacy_delete_old_export_files","desc":"<p>The export files are stored in <code>wp-content/uploads</code>, and are therefore publicly accessible. A CSPRN is appended to the filename to mitigate the risk of an unauthorized person downloading the file, but it is still possible. Deleting the file after the data subject has had a chance to delete it adds an additional layer of protection.</p>","summary":"Cleans up export files older than three days old.","type":"function","category":"Uncategorised","since":"4.9.6"},{"name":"wp_get_update_php_url","desc":"<p>This URL can be overridden by specifying an environment variable <code>WP_UPDATE_PHP_URL</code> or by using the {@see 'wp_update_php_url'} filter. Providing an empty string is not allowed and will result in the default URL being used. Furthermore the page the URL links to should preferably be localized in the site language.</p>","summary":"Gets the URL to learn more about updating the PHP version the site is running on.","type":"function","category":"Uncategorised","since":"5.1.0","return":{"content":"URL to learn more about updating PHP.","types":"string"}},{"name":"wp_get_default_update_php_url","desc":"<p>Do not use this function to retrieve this URL. Instead, use {@see wp_get_update_php_url()} when relying on the URL. This function does not allow modifying the returned URL, and is only used to compare the actually used URL with the default one.</p>","summary":"Gets the default URL to learn more about updating the PHP version the site is running on.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","return":{"content":"Default URL to learn more about updating PHP.","types":"string"}},{"name":"wp_update_php_annotation","desc":"<p>This function is to be used after {@see wp_get_update_php_url()} to display a consistent annotation if the web host has altered the default "Update PHP" page URL.</p>","summary":"Prints the default annotation for the web host altering the \"Update PHP\" page URL.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"Markup to output before the annotation. Default <code><p class=\"description\"></code>.","types":"string","variable":"$before","default":"'<p class=\"description\">'","required":"no"},{"content":"Markup to output after the annotation. Default <code></p></code>.","types":"string","variable":"$after","default":"'</p>'","required":"no"}]},{"name":"wp_get_update_php_annotation","desc":"<p>This function is to be used after {@see wp_get_update_php_url()} to return a consistent annotation if the web host has altered the default "Update PHP" page URL.</p>","summary":"Returns the default annotation for the web hosting altering the \"Update PHP\" page URL.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"$message Update PHP page annotation. An empty string if no custom URLs are provided.","types":"string"}},{"name":"wp_get_direct_php_update_url","desc":"<p>A URL will only be returned if the <code>WP_DIRECT_UPDATE_PHP_URL</code> environment variable is specified or by using the {@see 'wp_direct_php_update_url'} filter. This allows hosts to send users directly to the page where they can update PHP to a newer version.</p>","summary":"Gets the URL for directly updating the PHP version the site is running on.","type":"function","category":"Uncategorised","since":"5.1.1","return":{"content":"URL for directly updating PHP or empty string.","types":"string"}},{"name":"wp_direct_php_update_button","desc":"<p>This provides hosts with a way for users to be sent directly to their PHP update process.</p> <p>The button is only displayed if a URL is returned by <code>wp_get_direct_php_update_url()</code>.</p>","summary":"Display a button directly linking to a PHP update process.","type":"function","category":"Uncategorised","since":"5.1.1"},{"name":"get_dirsize","desc":"<p>A helper function that is used primarily to check whether a blog has exceeded its allowed upload space.</p>","summary":"Get the size of a directory.","type":"function","category":"Multisite Functions","since":"5.2.0","param":[{"content":"Full path of a directory.","types":"string","variable":"$directory","default":"null","required":"yes"},{"content":"Maximum time to run before giving up. In seconds. The timeout is global and is measured from the moment WordPress started to load.","types":"int","variable":"$max_execution_time","default":"null","required":"no"}],"return":{"content":"Size in bytes if a valid directory. False if not. Null if timeout.","types":"int|false|null"}},{"name":"recurse_dirsize","desc":"<p>Used by get_dirsize() to get a directory's size when it contains other directories.</p>","summary":"Get the size of a directory recursively.","type":"function","category":"Multisite Functions","since":"5.2.0","param":[{"content":"Full path of a directory.","types":"string","variable":"$directory","default":"null","required":"yes"},{"content":" Full path of a subdirectory to exclude from the total, or array of paths. Expected without trailing slash(es).","types":"string|array","variable":"$exclude","default":"null","required":"no"},{"content":"Maximum time to run before giving up. In seconds. The timeout is global and is measured from the moment WordPress started to load.","types":"int","variable":"$max_execution_time","default":"null","required":"no"}],"return":{"content":"Size in bytes if a valid directory. False if not. Null if timeout.","types":"int|false|null"}},{"name":"is_wp_version_compatible","desc":"","summary":"Checks compatibility with the current WordPress version.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"Minimum required WordPress version.","types":"string","variable":"$required","default":"null","required":"yes"}],"return":{"content":"True if required version is compatible or empty, false if not.","types":"bool"}},{"name":"is_php_version_compatible","desc":"","summary":"Checks compatibility with the current PHP version.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"Minimum required PHP version.","types":"string","variable":"$required","default":"null","required":"yes"}],"return":{"content":"True if required version is compatible or empty, false if not.","types":"bool"}},{"name":"wp_scripts","desc":"","summary":"Initialize $wp_scripts if it has not been set.","type":"function","category":"Uncategorised","since":"4.2.0","return":{"content":"WP_Scripts instance.","types":"WP_Scripts"}},{"name":"_wp_scripts_maybe_doing_it_wrong","desc":"","summary":"Helper function to output a _doing_it_wrong message when applicable.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"Function name.","types":"string","variable":"$function","default":"null","required":"yes"}]},{"name":"wp_print_scripts","desc":"<p>Called by admin-header.php and {@see 'wp_head'} hook. Since it is called by wp_head on every page load, the function does not instantiate the WP_Scripts object unless script names are explicitly passed. Makes use of already-instantiated $wp_scripts global if present. Use provided {@see 'wp_print_scripts'} hook to register/enqueue new scripts.</p>","summary":"Prints scripts in document head that are in the $handles queue.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":" Scripts to be printed. Default 'false'.","types":"string|bool|array","variable":"$handles","default":"false","required":"no"}],"return":{"content":"On success, a processed array of WP_Dependencies items; otherwise, an empty array.","types":"array"}},{"name":"wp_add_inline_script","desc":"<p>Code will only be added if the script is already in the queue. Accepts a string $data containing the Code. If two or more code blocks are added to the same script $handle, they will be printed in the order they were added, i.e. the latter added code can redeclare the previous.</p>","summary":"Adds extra code to a registered script.","type":"function","category":"Uncategorised","since":"4.5.0","param":[{"content":"Name of the script to add the inline script to.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"String containing the javascript to be added.","types":"string","variable":"$data","default":"null","required":"yes"},{"content":" Whether to add the inline script before the handle or after. Default 'after'.","types":"string","variable":"$position","default":"'after'","required":"no"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_register_script","desc":"<p>Registers a script to be enqueued later using the wp_enqueue_script() function.</p>","summary":"Register a new script.","type":"function","category":"Script and Style Registration","since":"4.3.0","param":[{"content":"Name of the script. Should be unique.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Full URL of the script, or path of the script relative to the WordPress root directory. If source is set to false, script is an alias of other scripts it depends on.","types":"string|bool","variable":"$src","default":"null","required":"yes"},{"content":" An array of registered script handles this script depends on. Default empty array.","types":"array","variable":"$deps","default":"array()","required":"no"},{"content":" String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added.","types":"string|bool|null","variable":"$ver","default":"false","required":"no"},{"content":" Whether to enqueue the script before </body> instead of in the <head>. Default 'false'.","types":"bool","variable":"$in_footer","default":"false","required":"no"}],"return":{"content":"Whether the script has been registered. True on success, false on failure.","types":"bool"}},{"name":"wp_localize_script","desc":"<p>Works only if the script has already been added.</p> <p>Accepts an associative array $l10n and creates a JavaScript object:</p> <pre><code>\"$object_name\" = {\n key: value,\n key: value,\n ...\n}</code></pre>","summary":"Localize a script.","type":"function","category":"Script and Style Registration","since":"2.2.0","param":[{"content":"Script handle the data will be attached to.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Name for the JavaScript object. Passed directly, so it should be qualified JS variable. Example: '/[a-zA-Z0-9_]+/'.","types":"string","variable":"$object_name","default":"null","required":"yes"},{"content":"The data itself. The data can be either a single or multi-dimensional array.","types":"array","variable":"$l10n","default":"null","required":"yes"}],"return":{"content":"True if the script was successfully localized, false otherwise.","types":"bool"}},{"name":"wp_set_script_translations","desc":"<p>Works only if the script has already been added.</p>","summary":"Sets translated strings for a script.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Script handle the textdomain will be attached to.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":" Text domain. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"},{"content":" The full file path to the directory containing translation files.","types":"string","variable":"$path","default":"null","required":"no"}],"return":{"content":"True if the text domain was successfully localized, false otherwise.","types":"bool"}},{"name":"wp_deregister_script","desc":"<p>Note: there are intentional safeguards in place to prevent critical admin scripts, such as jQuery core, from being unregistered.</p>","summary":"Remove a registered script.","type":"function","category":"Script and Style Registration","since":"2.1.0","param":[{"content":"Name of the script to be removed.","types":"string","variable":"$handle","default":"null","required":"yes"}]},{"name":"wp_enqueue_script","desc":"<p>Registers the script if $src provided (does NOT overwrite), and enqueues it.</p>","summary":"Enqueue a script.","type":"function","category":"Script and Style Registration","since":"2.1.0","param":[{"content":"Name of the script. Should be unique.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Full URL of the script, or path of the script relative to the WordPress root directory. Default empty.","types":"string","variable":"$src","default":"''","required":"no"},{"content":" An array of registered script handles this script depends on. Default empty array.","types":"array","variable":"$deps","default":"array()","required":"no"},{"content":" String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added.","types":"string|bool|null","variable":"$ver","default":"false","required":"no"},{"content":" Whether to enqueue the script before </body> instead of in the <head>. Default 'false'.","types":"bool","variable":"$in_footer","default":"false","required":"no"}]},{"name":"wp_dequeue_script","desc":"","summary":"Remove a previously enqueued script.","type":"function","category":"Script and Style Registration","since":"3.1.0","param":[{"content":"Name of the script to be removed.","types":"string","variable":"$handle","default":"null","required":"yes"}]},{"name":"wp_script_is","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether a script has been added to the queue.","type":"function","category":"Script and Style Registration","since":"3.5.0","param":[{"content":"Name of the script.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":" Status of the script to check. Default 'enqueued'. Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.","types":"string","variable":"$list","default":"'enqueued'","required":"no"}],"return":{"content":"Whether the script is queued.","types":"bool"}},{"name":"wp_script_add_data","desc":"<p>Works only if the script has already been added.</p> <p>Possible values for $key and $value: 'conditional' string Comments for IE 6, lte IE 7, etc.</p>","summary":"Add metadata to a script.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"Name of the script.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Name of data point for which we're storing a value.","types":"string","variable":"$key","default":"null","required":"yes"},{"content":"String containing the data to be added.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_styles","desc":"","summary":"Initialize $wp_styles if it has not been set.","type":"function","category":"Uncategorised","since":"4.2.0","return":{"content":"WP_Styles instance.","types":"WP_Styles"}},{"name":"wp_print_styles","desc":"<p>Passing an empty array to $handles prints the queue, passing an array with one string prints that style, and passing an array of strings prints those styles.</p>","summary":"Display styles that are in the $handles queue.","type":"function","category":"Uncategorised","since":"2.6.0","param":[{"content":"Styles to be printed. Default 'false'.","types":"string|bool|array","variable":"$handles","default":"false","required":"no"}],"return":{"content":"On success, a processed array of WP_Dependencies items; otherwise, an empty array.","types":"array"}},{"name":"wp_add_inline_style","desc":"<p>Styles will only be added if the stylesheet is already in the queue. Accepts a string $data containing the CSS. If two or more CSS code blocks are added to the same stylesheet $handle, they will be printed in the order they were added, i.e. the latter added styles can redeclare the previous.</p>","summary":"Add extra CSS styles to a registered stylesheet.","type":"function","category":"Other functions","since":"3.3.0","param":[{"content":"Name of the stylesheet to add the extra styles to.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"String containing the CSS styles to be added.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"wp_register_style","desc":"","summary":"Register a CSS stylesheet.","type":"function","category":"Script and Style Registration","since":"4.3.0","param":[{"content":"Name of the stylesheet. Should be unique.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory. If source is set to false, stylesheet is an alias of other stylesheets it depends on.","types":"string|bool","variable":"$src","default":"null","required":"yes"},{"content":" An array of registered stylesheet handles this stylesheet depends on. Default empty array.","types":"array","variable":"$deps","default":"array()","required":"no"},{"content":" String specifying stylesheet version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added.","types":"string|bool|null","variable":"$ver","default":"false","required":"no"},{"content":" The media for which this stylesheet has been defined. Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like '(orientation: portrait)' and '(max-width: 640px)'.","types":"string","variable":"$media","default":"'all'","required":"no"}],"return":{"content":"Whether the style has been registered. True on success, false on failure.","types":"bool"}},{"name":"wp_deregister_style","desc":"","summary":"Remove a registered stylesheet.","type":"function","category":"Script and Style Registration","since":"2.1.0","param":[{"content":"Name of the stylesheet to be removed.","types":"string","variable":"$handle","default":"null","required":"yes"}]},{"name":"wp_enqueue_style","desc":"<p>Registers the style if source provided (does NOT overwrite) and enqueues.</p>","summary":"Enqueue a CSS stylesheet.","type":"function","category":"Script and Style Registration","since":"2.6.0","param":[{"content":"Name of the stylesheet. Should be unique.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory. Default empty.","types":"string","variable":"$src","default":"''","required":"no"},{"content":" An array of registered stylesheet handles this stylesheet depends on. Default empty array.","types":"array","variable":"$deps","default":"array()","required":"no"},{"content":" String specifying stylesheet version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added.","types":"string|bool|null","variable":"$ver","default":"false","required":"no"},{"content":" The media for which this stylesheet has been defined. Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like '(orientation: portrait)' and '(max-width: 640px)'.","types":"string","variable":"$media","default":"'all'","required":"no"}]},{"name":"wp_dequeue_style","desc":"","summary":"Remove a previously enqueued CSS stylesheet.","type":"function","category":"Script and Style Registration","since":"3.1.0","param":[{"content":"Name of the stylesheet to be removed.","types":"string","variable":"$handle","default":"null","required":"yes"}]},{"name":"wp_style_is","desc":"","summary":"Check whether a CSS stylesheet has been added to the queue.","type":"function","category":"Script and Style Registration","since":"2.8.0","param":[{"content":"Name of the stylesheet.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":" Status of the stylesheet to check. Default 'enqueued'. Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.","types":"string","variable":"$list","default":"'enqueued'","required":"no"}],"return":{"content":"Whether style is queued.","types":"bool"}},{"name":"wp_style_add_data","desc":"<p>Works only if the stylesheet has already been added.</p> <p>Possible values for $key and $value: 'conditional' string Comments for IE 6, lte IE 7 etc. 'rtl' bool|string To declare an RTL stylesheet. 'suffix' string Optional suffix, used in combination with RTL. 'alt' bool For rel="alternate stylesheet". 'title' string For preferred/alternate stylesheets.</p>","summary":"Add metadata to a CSS stylesheet.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Name of the stylesheet.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"Name of data point for which we're storing a value. Accepts 'conditional', 'rtl' and 'suffix', 'alt' and 'title'.","types":"string","variable":"$key","default":"null","required":"yes"},{"content":"String containing the CSS data to be added.","types":"mixed","variable":"$value","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"get_header","desc":"<p>Includes the header template for a theme or if a name is specified then a specialised header will be included.</p> <p>For the parameter, if the file is called "header-special.php" then specify "special".</p>","summary":"Load header template.","type":"function","category":"Include functions","since":"1.5.0","param":[{"content":"The name of the specialised header.","types":"string","variable":"$name","default":"null","required":"no"}]},{"name":"get_footer","desc":"<p>Includes the footer template for a theme or if a name is specified then a specialised footer will be included.</p> <p>For the parameter, if the file is called "footer-special.php" then specify "special".</p>","summary":"Load footer template.","type":"function","category":"Include functions","since":"1.5.0","param":[{"content":"The name of the specialised footer.","types":"string","variable":"$name","default":"null","required":"no"}]},{"name":"get_sidebar","desc":"<p>Includes the sidebar template for a theme or if a name is specified then a specialised sidebar will be included.</p> <p>For the parameter, if the file is called "sidebar-special.php" then specify "special".</p>","summary":"Load sidebar template.","type":"function","category":"Include functions","since":"1.5.0","param":[{"content":"The name of the specialised sidebar.","types":"string","variable":"$name","default":"null","required":"no"}]},{"name":"get_template_part","desc":"<p>Provides a simple mechanism for child themes to overload reusable sections of code in the theme.</p> <p>Includes the named template part for a theme or if a name is specified then a specialised part will be included. If the theme contains no {slug}.php file then no template will be included.</p> <p>The template is included using require, not require_once, so you may include the same template part multiple times.</p> <p>For the $name parameter, if the file is called "{slug}-special.php" then specify "special".</p>","summary":"Loads a template part into a template.","type":"function","category":"Other functions","since":"3.0.0","param":[{"content":"The slug name for the generic template.","types":"string","variable":"$slug","default":"null","required":"yes"},{"content":"The name of the specialised template.","types":"string","variable":"$name","default":"null","required":"no"}]},{"name":"get_search_form","desc":"<p>Will first attempt to locate the searchform.php file in either the child or the parent, then load it. If it doesn't exist, then the default search form will be displayed. The default search form is HTML, which will be displayed. There is a filter applied to the search form HTML in order to edit or replace it. The filter is {@see 'get_search_form'}.</p> <p>This function is primarily used by themes which want to hardcode the search form into the sidebar and also by the search widget in WordPress.</p> <p>There is also an action that is called whenever the function is run called, {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the search relies on or various formatting that applies to the beginning of the search. To give a few examples of what it can be used for.</p>","summary":"Display search form.","type":"function","category":"Include functions","since":"5.2.0","param":[{"content":"{ Optional. Array of display arguments. @type bool $echo Whether to echo or return the form. Default true. @type string $aria_label ARIA label for the search form. Useful to distinguish multiple search forms on the same page and improve accessibility. Default empty. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"String when the $echo param is false.","types":"string|void"}},{"name":"wp_loginout","desc":"<p>Displays a link, which allows users to navigate to the Log In page to log in or log out depending on whether they are currently logged in.</p>","summary":"Display the Log In/Out link.","type":"function","category":"Login / Logout","since":"1.5.0","param":[{"content":"path to redirect to on login/logout.","types":"string","variable":"$redirect","default":"''","required":"no"},{"content":"Default to echo and not return the link.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"String when retrieving.","types":"string|void"}},{"name":"wp_logout_url","desc":"<p>Returns the URL that allows the user to log out of the site.</p>","summary":"Retrieves the logout URL.","type":"function","category":"Login / Logout","since":"2.7.0","param":[{"content":"Path to redirect to on logout.","types":"string","variable":"$redirect","default":"''","required":"no"}],"return":{"content":"The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().","types":"string"}},{"name":"wp_login_url","desc":"","summary":"Retrieves the login URL.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Path to redirect to on log in.","types":"string","variable":"$redirect","default":"''","required":"no"},{"content":"Whether to force reauthorization, even if a cookie is present. Default false.","types":"bool","variable":"$force_reauth","default":"false","required":"no"}],"return":{"content":"The login URL. Not HTML-encoded.","types":"string"}},{"name":"wp_registration_url","desc":"","summary":"Returns the URL that allows the user to register on the site.","type":"function","category":"Uncategorised","since":"3.6.0","return":{"content":"User registration URL.","types":"string"}},{"name":"wp_login_form","desc":"<p>The login format HTML is echoed by default. Pass a false value for <code>$echo</code> to return it instead.</p>","summary":"Provides a simple login form for use anywhere within WordPress.","type":"function","category":"Login / Logout","since":"3.0.0","param":[{"content":"{ Optional. Array of options to control the form output. Default empty array. @type bool $echo Whether to display the login form or return the form HTML code. Default true (echo). @type string $redirect URL to redirect to. Must be absolute, as in "<a href=\"https://example.com/mypage/\">https://example.com/mypage/</a>". Default is to redirect back to the request URI. @type string $form_id ID attribute value for the form. Default 'loginform'. @type string $label_username Label for the username or email address field. Default 'Username or Email Address'. @type string $label_password Label for the password field. Default 'Password'. @type string $label_remember Label for the remember field. Default 'Remember Me'. @type string $label_log_in Label for the submit button. Default 'Log In'. @type string $id_username ID attribute value for the username field. Default 'user_login'. @type string $id_password ID attribute value for the password field. Default 'user_pass'. @type string $id_remember ID attribute value for the remember field. Default 'rememberme'. @type string $id_submit ID attribute value for the submit button. Default 'wp-submit'. @type bool $remember Whether to display the "rememberme" checkbox in the form. @type string $value_username Default value for the username field. Default empty. @type bool $value_remember Whether the "Remember Me" checkbox should be checked by default. Default false (unchecked). }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"String when retrieving.","types":"string|void"}},{"name":"wp_lostpassword_url","desc":"","summary":"Returns the URL that allows the user to retrieve the lost password","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Path to redirect to on login.","types":"string","variable":"$redirect","default":"''","required":"no"}],"return":{"content":"Lost password URL.","types":"string"}},{"name":"wp_register","desc":"<p>Display a link which allows the user to navigate to the registration page if not logged in and registration is enabled or to the dashboard if logged in.</p>","summary":"Display the Registration or Admin link.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"Text to output before the link. Default <code><li></code>.","types":"string","variable":"$before","default":"'<li>'","required":"no"},{"content":"Text to output after the link. Default <code></li></code>.","types":"string","variable":"$after","default":"'</li>'","required":"no"},{"content":"Default to echo and not return the link.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"String when retrieving.","types":"string|void"}},{"name":"wp_meta","desc":"<p>The {@see 'wp_meta'} action can have several purposes, depending on how you use it, but one purpose might have been to allow for theme switching.</p>","summary":"Theme container function for the 'wp_meta' action.","type":"function","category":"Uncategorised","since":"1.5.0"},{"name":"bloginfo","desc":"","summary":"Displays information about the current site.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" Site information to display. Default empty.","types":"string","variable":"$show","default":"''","required":"no"}]},{"name":"get_bloginfo","desc":"<p>Possible values for <code>$show</code> include:</p> <ul> <li>'name' - Site title (set in Settings > General)</li> <li>'description' - Site tagline (set in Settings > General)</li> <li>'wpurl' - The WordPress address (URL) (set in Settings > General)</li> <li>'url' - The Site address (URL) (set in Settings > General)</li> <li>'admin_email' - Admin email (set in Settings > General)</li> <li>'charset' - The "Encoding for pages and feeds" (set in Settings > Reading)</li> <li>'version' - The current WordPress version</li> <li>'html_type' - The content-type (default: "text/html"). Themes and plugins can override the default value using the {@see 'pre_option_html_type'} filter</li> <li>'text_direction' - The text direction determined by the site's language. is_rtl() should be used instead</li> <li>'language' - Language code for the current site</li> <li>'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme will take precedence over this value</li> <li>'stylesheet_directory' - Directory path for the active theme. An active child theme will take precedence over this value</li> <li>'template_url' / 'template_directory' - URL of the active theme's directory. An active child theme will NOT take precedence over this value</li> <li>'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php)</li> <li>'atom_url' - The Atom feed URL (/feed/atom)</li> <li>'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rdf)</li> <li>'rss_url' - The RSS 0.92 feed URL (/feed/rss)</li> <li>'rss2_url' - The RSS 2.0 feed URL (/feed)</li> <li>'comments_atom_url' - The comments Atom feed URL (/comments/feed)</li> <li>'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed)</li> </ul> <p>Some <code>$show</code> values are deprecated and will be removed in future versions. These options will trigger the _deprecated_argument() function.</p> <p>Deprecated arguments include:</p> <ul> <li>'siteurl' - Use 'url' instead</li> <li>'home' - Use 'url' instead</li> </ul>","summary":"Retrieves information about the current site.","type":"function","category":"Miscellaneous","since":"0.71","param":[{"content":" Site info to retrieve. Default empty (site name).","types":"string","variable":"$show","default":"''","required":"no"},{"content":" How to filter what is retrieved. Default 'raw'.","types":"string","variable":"$filter","default":"'raw'","required":"no"}],"return":{"content":"Mostly string values, might be empty.","types":"string"}},{"name":"get_site_icon_url","desc":"","summary":"Returns the Site Icon URL.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":" Size of the site icon. Default 512 (pixels).","types":"int","variable":"$size","default":"512","required":"no"},{"content":" Fallback url if no site icon is found. Default empty.","types":"string","variable":"$url","default":"''","required":"no"},{"content":" ID of the blog to get the site icon for. Default current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}],"return":{"content":"Site Icon URL.","types":"string"}},{"name":"site_icon_url","desc":"","summary":"Displays the Site Icon URL.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":" Size of the site icon. Default 512 (pixels).","types":"int","variable":"$size","default":"512","required":"no"},{"content":" Fallback url if no site icon is found. Default empty.","types":"string","variable":"$url","default":"''","required":"no"},{"content":" ID of the blog to get the site icon for. Default current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}]},{"name":"has_site_icon","desc":"","summary":"Whether the site has a Site Icon.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":" ID of the blog in question. Default current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}],"return":{"content":"Whether the site has a site icon or not.","types":"bool"}},{"name":"has_custom_logo","desc":"","summary":"Determines whether the site has a custom logo.","type":"function","category":"Uncategorised","since":"4.5.0","param":[{"content":" ID of the blog in question. Default is the ID of the current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}],"return":{"content":"Whether the site has a custom logo or not.","types":"bool"}},{"name":"get_custom_logo","desc":"","summary":"Returns a custom logo, linked to home.","type":"function","category":"Uncategorised","since":"4.5.0","param":[{"content":" ID of the blog in question. Default is the ID of the current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}],"return":{"content":"Custom logo markup.","types":"string"}},{"name":"the_custom_logo","desc":"","summary":"Displays a custom logo, linked to home.","type":"function","category":"Uncategorised","since":"4.5.0","param":[{"content":" ID of the blog in question. Default is the ID of the current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}]},{"name":"wp_get_document_title","desc":"","summary":"Returns document title for the current page.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"Tag with the document title.","types":"string"}},{"name":"_wp_render_title_tag","desc":"","summary":"Displays title tag with content.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private"},{"name":"wp_title","desc":"<p>By default, the page title will display the separator before the page title, so that the blog title will be before the page title. This is not good for title display, since the blog title shows up on most tabs and not what is important, which is the page that the user is looking at.</p> <p>There are also SEO benefits to having the blog title after or to the 'right' of the page title. However, it is mostly common sense to have the blog title to the right with most browsers supporting tabs. You can achieve this by using the seplocation parameter and setting the value to 'right'. This change was introduced around 2.5.0, in case backward compatibility of themes is important.</p>","summary":"Display or retrieve page title for all areas of blog.","type":"function","category":"Other functions","since":"1.0.0","param":[{"content":" default is '»'. How to separate the various items within the page title.","types":"string","variable":"$sep","default":"'»'","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"},{"content":" Direction to display title, 'right'.","types":"string","variable":"$seplocation","default":"''","required":"no"}],"return":{"content":"String on retrieve, null when displaying.","types":"string|null"}},{"name":"single_post_title","desc":"<p>This is optimized for single.php template file for displaying the post title.</p> <p>It does not support placing the separator after the title, but by leaving the prefix parameter empty, you can set the title separator manually. The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.</p>","summary":"Display or retrieve page title for post.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" What to display before the title.","types":"string","variable":"$prefix","default":"''","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"Title when retrieving.","types":"string|void"}},{"name":"post_type_archive_title","desc":"<p>This is optimized for archive.php and archive-{$post_type}.php template files for displaying the title of the post type.</p>","summary":"Display or retrieve title for a post type archive.","type":"function","category":"Custom Post Type","since":"3.1.0","param":[{"content":" What to display before the title.","types":"string","variable":"$prefix","default":"''","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"Title when retrieving, null when displaying or failure.","types":"string|void"}},{"name":"single_cat_title","desc":"<p>Useful for category template files for displaying the category page title. The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.</p>","summary":"Display or retrieve page title for category archive.","type":"function","category":"Categories","since":"0.71","param":[{"content":" What to display before the title.","types":"string","variable":"$prefix","default":"''","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"Title when retrieving.","types":"string|void"}},{"name":"single_tag_title","desc":"<p>Useful for tag template files for displaying the tag page title. The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.</p>","summary":"Display or retrieve page title for tag post archive.","type":"function","category":"Tags","since":"2.3.0","param":[{"content":" What to display before the title.","types":"string","variable":"$prefix","default":"''","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"Title when retrieving.","types":"string|void"}},{"name":"single_term_title","desc":"<p>Useful for taxonomy term template files for displaying the taxonomy term page title. The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.</p>","summary":"Display or retrieve page title for taxonomy term archive.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":" What to display before the title.","types":"string","variable":"$prefix","default":"''","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"Title when retrieving.","types":"string|void"}},{"name":"single_month_title","desc":"<p>Useful for when the template only needs to display the month and year, if either are available. The prefix does not automatically place a space between the prefix, so if there should be a space, the parameter value will need to have it at the end.</p>","summary":"Display or retrieve page title for post archive based on date.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" What to display before the title.","types":"string","variable":"$prefix","default":"''","required":"no"},{"content":" default is true. Whether to display or retrieve title.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"Title when retrieving.","types":"string|void"}},{"name":"the_archive_title","desc":"","summary":"Display the archive title based on the queried object.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":" Content to prepend to the title. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Content to append to the title. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"get_the_archive_title","desc":"","summary":"Retrieve the archive title based on the queried object.","type":"function","category":"Uncategorised","since":"4.1.0","return":{"content":"Archive title.","types":"string"}},{"name":"the_archive_description","desc":"","summary":"Display category, tag, term, or author description.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":" Content to prepend to the description. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Content to append to the description. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"get_the_archive_description","desc":"","summary":"Retrieves the description for an author, post type, or term archive.","type":"function","category":"Uncategorised","since":"4.9.0","return":{"content":"Archive description.","types":"string"}},{"name":"get_the_post_type_description","desc":"","summary":"Retrieves the description for a post type archive.","type":"function","category":"Uncategorised","since":"4.9.0","return":{"content":"The post type description.","types":"string"}},{"name":"get_archives_link","desc":"<p>The format can be one of four styles. The 'link' for head element, 'option' for use in the select element, 'html' for use in list (either ol or ul HTML elements). Custom content is also supported using the before and after parameters.</p> <p>The 'link' format uses the <code><link></code> HTML element with the <strong>archives</strong> relationship. The before and after parameters are not used. The text parameter is used to describe the link.</p> <p>The 'option' format uses the option HTML element for use in select element. The value is the url parameter and the before and after parameters are used between the text description.</p> <p>The 'html' format, which is the default, uses the li HTML element for use in the list HTML elements. The before parameter is before the link and the after parameter is after the closing link.</p> <p>The custom format uses the before parameter before the link ('a' HTML element) and the after parameter after the closing link tag. If the above three values for the format are not used, then custom format is assumed.</p>","summary":"Retrieve archive link content based on predefined or custom code.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"URL to archive.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"Archive text description.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" default is 'html'. Can be 'link', 'option', 'html', or custom.","types":"string","variable":"$format","default":"'html'","required":"no"},{"content":" Content to prepend to the description. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Content to append to the description. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Set to true if the current page is the selected archive page.","types":"bool","variable":"$selected","default":"false","required":"no"}],"return":{"content":"HTML link content for archive.","types":"string"}},{"name":"wp_get_archives","desc":"","summary":"Display archive links based on type and format.","type":"function","category":"Other functions","since":"5.2.0","param":[{"content":"{ Default archive links arguments. Optional. @type string $type Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly', 'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha' display the same archive link list as well as post titles instead of displaying dates. The difference between the two is that 'alpha' will order by post title and 'postbypost' will order by post date. Default 'monthly'. @type string|int $limit Number of links to limit the query to. Default empty (no limit). @type string $format Format each link should take using the $before and $after args. Accepts 'link' (<code><link></code> tag), 'option' (<code><option></code> tag), 'html' (<code><li></code> tag), or a custom format, which generates a link anchor with $before preceding and $after succeeding. Default 'html'. @type string $before Markup to prepend to the beginning of each link. Default empty. @type string $after Markup to append to the end of each link. Default empty. @type bool $show_post_count Whether to display the post count alongside the link. Default false. @type bool|int $echo Whether to echo or return the links list. Default 1|true to echo. @type string $order Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'. Default 'DESC'. @type string $post_type Post type. Default 'post'. @type string $year Year. Default current year. @type string $monthnum Month number. Default current month number. @type string $day Day. Default current day. @type string $w Week. Default current week. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"String when retrieving.","types":"string|void"}},{"name":"calendar_week_mod","desc":"","summary":"Get number of days since the start of the week.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":"Number of day.","types":"int","variable":"$num","default":"null","required":"yes"}],"return":{"content":"Days since the start of the week.","types":"float"}},{"name":"get_calendar","desc":"<p>The calendar is cached, which will be retrieved, if it exists. If there are no posts for the month, then it will not be displayed.</p>","summary":"Display calendar with days that have posts as links.","type":"function","category":"Time/Date Functions","since":"1.0.0","param":[{"content":" default is true. Use initial calendar names.","types":"bool","variable":"$initial","default":"true","required":"no"},{"content":" default is true. Set to false for return.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"String when retrieving.","types":"string|void"}},{"name":"delete_get_calendar_cache","desc":"","summary":"Purge the cached results of get_calendar.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"allowed_tags","desc":"<p>This is useful for displaying in the comment area, which elements and attributes are supported. As well as any plugins which want to display it.</p>","summary":"Display all of the allowed tags in HTML format with attributes.","type":"function","category":"Uncategorised","since":"1.0.1","return":{"content":"HTML allowed tags entity encoded.","types":"string"}},{"name":"the_date_xml","desc":"","summary":"Outputs the date in iso8601 format for xml files.","type":"function","category":"Uncategorised","since":"1.0.0"},{"name":"the_date","desc":"<p>Will only output the date if the current post's date is different from the previous one output.</p> <p>i.e. Only one date listing will show per day worth of posts shown in the loop, even if the function is called several times for each post.</p> <p>HTML output can be filtered with 'the_date'. Date string output can be filtered with 'get_the_date'.</p>","summary":"Display or Retrieve the date the current post was written (once per date)","type":"function","category":"Time/Date Functions","since":"0.71","param":[{"content":" PHP date format defaults to the date_format option if not specified.","types":"string","variable":"$d","default":"''","required":"no"},{"content":" Output before the date.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Output after the date.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" default is display. Whether to echo the date or return it.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"String if retrieving.","types":"string|void"}},{"name":"get_the_date","desc":"<p>Unlike the_date() this function will always return the date. Modify output with the {@see 'get_the_date'} filter.</p>","summary":"Retrieve the date on which the post was written.","type":"function","category":"Time/Date Functions","since":"3.0.0","param":[{"content":" PHP date format defaults to the date_format option if not specified.","types":"string","variable":"$d","default":"''","required":"no"},{"content":" Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Date the current post was written. False on failure.","types":"false|string"}},{"name":"the_modified_date","desc":"","summary":"Display the date on which the post was last modified.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":" PHP date format defaults to the date_format option if not specified.","types":"string","variable":"$d","default":"''","required":"no"},{"content":" Output before the date.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Output after the date.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" default is display. Whether to echo the date or return it.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"String if retrieving.","types":"string|void"}},{"name":"get_the_modified_date","desc":"","summary":"Retrieve the date on which the post was last modified.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" PHP date format defaults to the date_format option if not specified.","types":"string","variable":"$d","default":"''","required":"no"},{"content":" Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Date the current post was modified. False on failure.","types":"false|string"}},{"name":"the_time","desc":"","summary":"Display the time at which the post was written.","type":"function","category":"Time/Date Functions","since":"0.71","param":[{"content":"Either 'G', 'U', or php date format.","types":"string","variable":"$d","default":"''","required":"no"}]},{"name":"get_the_time","desc":"","summary":"Retrieve the time at which the post was written.","type":"function","category":"Time/Date Functions","since":"1.5.0","param":[{"content":" Format to use for retrieving the time the post was written. Either 'G', 'U', or php date format defaults to the value specified in the time_format option. Default empty.","types":"string","variable":"$d","default":"''","required":"no"},{"content":"WP_Post object or ID. Default is global $post object.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Formatted date string or Unix timestamp if <code>$d</code> is 'U' or 'G'. False on failure.","types":"string|int|false"}},{"name":"get_post_time","desc":"","summary":"Retrieve the time at which the post was written.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":" Format to use for retrieving the time the post was written. Either 'G', 'U', or php date format. Default 'U'.","types":"string","variable":"$d","default":"'U'","required":"no"},{"content":" Whether to retrieve the GMT time. Default false.","types":"bool","variable":"$gmt","default":"false","required":"no"},{"content":"WP_Post object or ID. Default is global $post object.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"},{"content":"Whether to translate the time string. Default false.","types":"bool","variable":"$translate","default":"false","required":"no"}],"return":{"content":"Formatted date string or Unix timestamp if <code>$d</code> is 'U' or 'G'. False on failure.","types":"string|int|false"}},{"name":"the_modified_time","desc":"","summary":"Display the time at which the post was last modified.","type":"function","category":"Time/Date Functions","since":"2.0.0","param":[{"content":"Either 'G', 'U', or php date format defaults to the value specified in the time_format option.","types":"string","variable":"$d","default":"''","required":"no"}]},{"name":"get_the_modified_time","desc":"","summary":"Retrieve the time at which the post was last modified.","type":"function","category":"Time/Date Functions","since":"4.6.0","param":[{"content":" Format to use for retrieving the time the post was modified. Either 'G', 'U', or php date format defaults to the value specified in the time_format option. Default empty.","types":"string","variable":"$d","default":"''","required":"no"},{"content":" Post ID or WP_Post object. Default current post.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"Formatted date string or Unix timestamp. False on failure.","types":"false|string"}},{"name":"get_post_modified_time","desc":"","summary":"Retrieve the time at which the post was last modified.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":" Format to use for retrieving the time the post was modified. Either 'G', 'U', or php date format. Default 'U'.","types":"string","variable":"$d","default":"'U'","required":"no"},{"content":" Whether to retrieve the GMT time. Default false.","types":"bool","variable":"$gmt","default":"false","required":"no"},{"content":"WP_Post object or ID. Default is global $post object.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"},{"content":"Whether to translate the time string. Default false.","types":"bool","variable":"$translate","default":"false","required":"no"}],"return":{"content":"Formatted date string or Unix timestamp if <code>$d</code> is 'U' or 'G'. False on failure.","types":"string|int|false"}},{"name":"the_weekday","desc":"","summary":"Display the weekday on which the post was written.","type":"function","category":"Uncategorised","since":"0.71"},{"name":"the_weekday_date","desc":"<p>Will only output the weekday if the current post's weekday is different from the previous one output.</p>","summary":"Display the weekday on which the post was written.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Output before the date.","types":"string","variable":"$before","default":"''","required":"no"},{"content":"Output after the date.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"wp_head","desc":"<p>See {@see 'wp_head'}.</p>","summary":"Fire the wp_head action.","type":"function","category":"Miscellaneous","since":"1.2.0"},{"name":"wp_footer","desc":"<p>See {@see 'wp_footer'}.</p>","summary":"Fire the wp_footer action.","type":"function","category":"Miscellaneous","since":"1.5.1"},{"name":"wp_body_open","desc":"<ul> <li>See {@see 'wp_body_open'}.</li> </ul>","summary":"Fire the wp_body_open action.","type":"function","category":"Uncategorised","since":"5.2.0"},{"name":"feed_links","desc":"","summary":"Display the links to the general feeds.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"arguments.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"feed_links_extra","desc":"","summary":"Display the links to the extra feeds such as category feeds.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"arguments.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"rsd_link","desc":"","summary":"Display the link to the Really Simple Discovery service endpoint.","type":"function","category":"Uncategorised","since":"2.0.0"},{"name":"wlwmanifest_link","desc":"","summary":"Display the link to the Windows Live Writer manifest file.","type":"function","category":"Uncategorised","since":"2.3.1"},{"name":"noindex","desc":"<p>If a blog is marked as not being public then the noindex meta tag will be output to tell web robots not to index the page content. Add this to the {@see 'wp_head'} action.</p> <p>Typical usage is as a {@see 'wp_head'} callback:</p> <pre><code>add_action( 'wp_head', 'noindex' );</code></pre>","summary":"Displays a noindex meta tag if required by the blog configuration.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"wp_no_robots","desc":"<p>Outputs a noindex meta tag that tells web robots not to index the page content. Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_no_robots' );</p>","summary":"Display a noindex meta tag.","type":"function","category":"Uncategorised","since":"3.3.0"},{"name":"wp_sensitive_page_meta","desc":"<p>Outputs a noindex,noarchive meta tag that tells web robots not to index or cache the page content. Outputs a referrer origin-when-cross-origin meta tag that tells the browser not to send the full url as a referrer to other sites when cross-origin assets are loaded.</p> <p>Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_sensitive_page_meta' );</p>","summary":"Display a noindex,noarchive meta tag and referrer origin-when-cross-origin meta tag.","type":"function","category":"Uncategorised","since":"5.0.1"},{"name":"wp_site_icon","desc":"","summary":"Display site icon meta tags.","type":"function","category":"Uncategorised","since":"4.3.0"},{"name":"wp_resource_hints","desc":"<p>Gives hints to browsers to prefetch specific pages or render them in the background, to perform DNS lookups or to begin the connection handshake (DNS, TCP, TLS) in the background.</p> <p>These performance improving indicators work by using <code><link rel\"\u2026\"></code>.</p>","summary":"Prints resource hints to browsers for pre-fetching, pre-rendering and pre-connecting to web sites.","type":"function","category":"Uncategorised","since":"4.6.0"},{"name":"wp_dependencies_unique_hosts","desc":"","summary":"Retrieves a list of unique hosts of all enqueued scripts and styles.","type":"function","category":"Uncategorised","since":"4.6.0","return":{"content":"A list of unique hosts of enqueued scripts and styles.","types":"array"}},{"name":"user_can_richedit","desc":"<p>Checks if the user can access the visual editor and that it's supported by the user's browser.</p>","summary":"Whether the user can access the visual editor.","type":"function","category":"Uncategorised","since":"2.0.0","return":{"content":"True if the user can access the visual editor, false otherwise.","types":"bool"}},{"name":"wp_default_editor","desc":"<p>Works out which of the two editors to display as the current editor for a user. The 'html' setting is for the "Text" editor tab.</p>","summary":"Find out which editor should be displayed by default.","type":"function","category":"Uncategorised","since":"2.5.0","return":{"content":"Either 'tinymce', or 'html', or 'test'","types":"string"}},{"name":"wp_editor","desc":"<p>Using this function is the proper way to output all needed components for both TinyMCE and Quicktags. _WP_Editors should not be used directly. See <a href=\"https://core.trac.wordpress.org/ticket/17144\">https://core.trac.wordpress.org/ticket/17144</a>.</p> <p>NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason running wp_editor() inside of a meta box is not a good idea unless only Quicktags is used. On the post edit screen several actions can be used to include additional editors containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'. See <a href=\"https://core.trac.wordpress.org/ticket/19173\">https://core.trac.wordpress.org/ticket/19173</a> for more information.</p>","summary":"Renders an editor.","type":"function","category":"Miscellaneous","since":"3.3.0","param":[{"content":"Initial content for the editor.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/.","types":"string","variable":"$editor_id","default":"null","required":"yes"},{"content":"See _WP_Editors::editor().","types":"array","variable":"$settings","default":"array()","required":"no"}]},{"name":"wp_enqueue_editor","desc":"<p>The editor can be initialized when needed after page load. See wp.editor.initialize() in wp-admin/js/editor.js for initialization options.</p>","summary":"Outputs the editor scripts, stylesheets, and default settings.","type":"function","category":"Uncategorised","since":"4.8.0"},{"name":"wp_enqueue_code_editor","desc":"","summary":"Enqueue assets needed by the code editor for the given settings.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"{ Args. @type string $type The MIME type of the file to be edited. @type string $file Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to <code>$type</code> param. @type WP_Theme $theme Theme being edited when on theme editor. @type string $plugin Plugin being edited when on plugin editor. @type array $codemirror Additional CodeMirror setting overrides. @type array $csslint CSSLint rule overrides. @type array $jshint JSHint rule overrides. @type array $htmlhint JSHint rule overrides. }","types":"array","variable":"$args","default":"null","required":"yes"}],"return":{"content":"Settings for the enqueued code editor, or false if the editor was not enqueued.","types":"array|false"}},{"name":"wp_get_code_editor_settings","desc":"","summary":"Generate and return code editor settings.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"{ Args. @type string $type The MIME type of the file to be edited. @type string $file Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to <code>$type</code> param. @type WP_Theme $theme Theme being edited when on theme editor. @type string $plugin Plugin being edited when on plugin editor. @type array $codemirror Additional CodeMirror setting overrides. @type array $csslint CSSLint rule overrides. @type array $jshint JSHint rule overrides. @type array $htmlhint JSHint rule overrides. }","types":"array","variable":"$args","default":"null","required":"yes"}],"return":{"content":"Settings for the code editor.","types":"array|false"}},{"name":"get_search_query","desc":"<p>The search query string is passed through esc_attr() to ensure that it is safe for placing in an html attribute.</p>","summary":"Retrieves the contents of the search WordPress query variable.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Whether the result is escaped. Default true. Only use when you are later escaping it. Do not use unescaped.","types":"bool","variable":"$escaped","default":"true","required":"no"}],"return":{"content":"","types":"string"}},{"name":"the_search_query","desc":"<p>The search query string is passed through esc_attr() to ensure that it is safe for placing in an html attribute.</p>","summary":"Displays the contents of the search query variable.","type":"function","category":"Uncategorised","since":"2.1.0"},{"name":"get_language_attributes","desc":"<p>Builds up a set of html attributes containing the text direction and language information for the page.</p>","summary":"Gets the language attributes for the html tag.","type":"function","category":"Uncategorised","since":"4.3.0","param":[{"content":" The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.","types":"string","variable":"$doctype","default":"'html'","required":"no"}]},{"name":"language_attributes","desc":"<p>Builds up a set of html attributes containing the text direction and language information for the page.</p>","summary":"Displays the language attributes for the html tag.","type":"function","category":"Other functions","since":"4.3.0","param":[{"content":" The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.","types":"string","variable":"$doctype","default":"'html'","required":"no"}]},{"name":"paginate_links","desc":"<p>Technically, the function can be used to create paginated link list for any area. The 'base' argument is used to reference the url, which will be used to create the paginated links. The 'format' argument is then used for replacing the page number. It is however, most likely and by default, to be used on the archive post pages.</p> <p>The 'type' argument controls format of the returned value. The default is 'plain', which is just a string with the links separated by a newline character. The other possible values are either 'array' or 'list'. The 'array' value will return an array of the paginated link list to offer full control of display. The 'list' value will place all of the paginated links in an unordered HTML list.</p> <p>The 'total' argument is the total amount of pages and is an integer. The 'current' argument is the current page number and is also an integer.</p> <p>An example of the 'base' argument is "<a href=\"http://example.com/all_posts.php%_\">http://example.com/all_posts.php%_</a>%" and the '%<em>%' is required. The '%</em>%' will be replaced by the contents of in the 'format' argument. An example for the 'format' argument is "?page=%#%" and the '%#%' is also required. The '%#%' will be replaced with the page number.</p> <p>You can include the previous and next links in the list by setting the 'prev_next' argument to true, which it is by default. You can set the previous text, by using the 'prev_text' argument. You can set the next text by setting the 'next_text' argument.</p> <p>If the 'show_all' argument is set to true, then it will show all of the pages instead of a short list of the pages near the current page. By default, the 'show_all' is set to false and controlled by the 'end_size' and 'mid_size' arguments. The 'end_size' argument is how many numbers on either the start and the end list edges, by default is 1. The 'mid_size' argument is how many numbers to either side of current page, but not including current page.</p> <p>It is possible to add query vars to the link by using the 'add_args' argument and see add_query_arg() for more information.</p> <p>The 'before_page_number' and 'after_page_number' arguments allow users to augment the links themselves. Typically this might be to add context to the numbered links so that screen reader users understand what the links are for. The text strings are added before and after the page number - within the anchor tag.</p>","summary":"Retrieve paginated link for archive post pages.","type":"function","category":"Others","since":"4.9.0","param":[{"content":"{ Optional. Array or string of arguments for generating paginated links for archives. @type string $base Base of the paginated url. Default empty. @type string $format Format for the pagination structure. Default empty. @type int $total The total amount of pages. Default is the value WP_Query's <code>max_num_pages</code> or 1. @type int $current The current page number. Default is 'paged' query var or 1. @type string $aria_current The value for the aria-current attribute. Possible values are 'page', 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'. @type bool $show_all Whether to show all pages. Default false. @type int $end_size How many numbers on either the start and the end list edges. Default 1. @type int $mid_size How many numbers to either side of the current pages. Default 2. @type bool $prev_next Whether to include the previous and next links in the list. Default true. @type bool $prev_text The previous page text. Default '« Previous'. @type bool $next_text The next page text. Default 'Next »'. @type string $type Controls format of the returned value. Possible values are 'plain', 'array' and 'list'. Default is 'plain'. @type array $add_args An array of query args to add. Default false. @type string $add_fragment A string to append to each link. Default empty. @type string $before_page_number A string to appear before the page number. Default empty. @type string $after_page_number A string to append after the page number. Default empty. }","types":"string|array","variable":"$args","default":"''","required":"no"}],"return":{"content":"String of page links or array of page links.","types":"string|array|void"}},{"name":"wp_admin_css_color","desc":"<p>Allows a plugin to register a new admin color scheme. For example:</p> <pre><code>wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( \"css/colors-classic.css\" ), array(\n '#07273E', '#14568A', '#D54E21', '#2683AE'\n) );</code></pre>","summary":"Registers an admin color scheme css file.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"The unique key for this theme.","types":"string","variable":"$key","default":"null","required":"yes"},{"content":"The name of the theme.","types":"string","variable":"$name","default":"null","required":"yes"},{"content":"The URL of the CSS file containing the color scheme.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" An array of CSS color definition strings which are used to give the user a feel for the theme.","types":"array","variable":"$colors","default":"array()","required":"no"},{"content":"{ Optional. CSS color definitions used to color any SVG icons. @type string $base SVG icon base color. @type string $focus SVG icon color on focus. @type string $current SVG icon color of current admin menu link. }","types":"array","variable":"$icons","default":"array()","required":"no"}]},{"name":"register_admin_color_schemes","desc":"<p>Registers the initial set of eight color schemes in the Profile section of the dashboard which allows for styling the admin menu and toolbar.</p>","summary":"Registers the default admin color schemes.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_admin_css_uri","desc":"","summary":"Displays the URL of a WordPress admin CSS file.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"file relative to wp-admin/ without its ".css" extension.","types":"string","variable":"$file","default":"'wp-admin'","required":"no"}],"return":{"content":"","types":"string"}},{"name":"wp_admin_css","desc":"<p>"Intelligently" decides to enqueue or to print the CSS file. If the {@see 'wp_print_styles'} action has <em>not</em> yet been called, the CSS file will be enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will be printed. Printing may be forced by passing true as the $force_echo (second) parameter.</p> <p>For backward compatibility with WordPress 2.3 calling method: If the $file (first) parameter does not correspond to a registered CSS file, we assume $file is a file relative to wp-admin/ without its ".css" extension. A stylesheet link to that generated URL is printed.</p>","summary":"Enqueues or directly prints a stylesheet link to the specified CSS file.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":" Style handle name or file name (without ".css" extension) relative to wp-admin/. Defaults to 'wp-admin'.","types":"string","variable":"$file","default":"'wp-admin'","required":"no"},{"content":" Force the stylesheet link to be printed rather than enqueued.","types":"bool","variable":"$force_echo","default":"false","required":"no"}]},{"name":"add_thickbox","desc":"<p>If any of the settings need to be changed, this can be done with another js file similar to media-upload.js. That file should require array('thickbox') to ensure it is loaded after.</p>","summary":"Enqueues the default ThickBox js and css.","type":"function","category":"Uncategorised","since":"2.5.0"},{"name":"wp_generator","desc":"<p>See {@see 'wp_head'}.</p>","summary":"Displays the XHTML generator that is generated on the wp_head hook.","type":"function","category":"Uncategorised","since":"2.5.0"},{"name":"the_generator","desc":"<p>Returns the correct generator type for the requested output format. Allows for a plugin to filter generators overall the {@see 'the_generator'} filter.</p>","summary":"Display the generator XML or Comment for RSS, ATOM, etc.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).","types":"string","variable":"$type","default":"null","required":"yes"}]},{"name":"get_the_generator","desc":"<p>Returns the correct generator type for the requested output format. Allows for a plugin to filter generators on an individual basis using the {@see 'get_the<em>generator</em>$type'} filter.</p>","summary":"Creates the generator XML or Comment for RSS, ATOM, etc.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).","types":"string","variable":"$type","default":"''","required":"no"}],"return":{"content":"The HTML content for the generator.","types":"string|void"}},{"name":"checked","desc":"<p>Compares the first two arguments and if identical marks as checked</p>","summary":"Outputs the html checked attribute.","type":"function","category":"Form Helpers","since":"1.0.0","param":[{"content":"One of the values to compare","types":"mixed","variable":"$checked","default":"null","required":"yes"},{"content":"(true) The other value to compare if not just true","types":"mixed","variable":"$current","default":"true","required":"no"},{"content":"Whether to echo or just return the string","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"html attribute or empty string","types":"string"}},{"name":"selected","desc":"<p>Compares the first two arguments and if identical marks as selected</p>","summary":"Outputs the html selected attribute.","type":"function","category":"Form Helpers","since":"1.0.0","param":[{"content":"One of the values to compare","types":"mixed","variable":"$selected","default":"null","required":"yes"},{"content":"(true) The other value to compare if not just true","types":"mixed","variable":"$current","default":"true","required":"no"},{"content":"Whether to echo or just return the string","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"html attribute or empty string","types":"string"}},{"name":"disabled","desc":"<p>Compares the first two arguments and if identical marks as disabled</p>","summary":"Outputs the html disabled attribute.","type":"function","category":"Form Helpers","since":"3.0.0","param":[{"content":"One of the values to compare","types":"mixed","variable":"$disabled","default":"null","required":"yes"},{"content":"(true) The other value to compare if not just true","types":"mixed","variable":"$current","default":"true","required":"no"},{"content":"Whether to echo or just return the string","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"html attribute or empty string","types":"string"}},{"name":"readonly","desc":"<p>Compares the first two arguments and if identical marks as readonly</p>","summary":"Outputs the html readonly attribute.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"One of the values to compare","types":"mixed","variable":"$readonly","default":"null","required":"yes"},{"content":"(true) The other value to compare if not just true","types":"mixed","variable":"$current","default":"true","required":"no"},{"content":"Whether to echo or just return the string","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"html attribute or empty string","types":"string"}},{"name":"__checked_selected_helper","desc":"<p>Compares the first two arguments and if identical marks as $type</p>","summary":"Private helper function for checked, selected, disabled and readonly.","type":"function","category":"Uncategorised","since":"2.8.0","access":"private","param":[{"content":"One of the values to compare","types":"mixed","variable":"$helper","default":"null","required":"yes"},{"content":"(true) The other value to compare if not just true","types":"mixed","variable":"$current","default":"null","required":"yes"},{"content":"Whether to echo or just return the string","types":"bool","variable":"$echo","default":"null","required":"yes"},{"content":"The type of checked|selected|disabled|readonly we are doing","types":"string","variable":"$type","default":"null","required":"yes"}],"return":{"content":"html attribute or empty string","types":"string"}},{"name":"wp_heartbeat_settings","desc":"<p>Outputs the nonce used in the heartbeat XHR</p>","summary":"Default settings for heartbeat","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"","types":"array","variable":"$settings","default":"null","required":"yes"}],"return":{"content":"$settings","types":"array"}},{"name":"_wp_http_get_object","desc":"","summary":"Returns the initialized WP_Http Object","type":"function","category":"Uncategorised","since":"2.7.0","access":"private","return":{"content":"HTTP Transport object.","types":"WP_Http"}},{"name":"wp_safe_remote_request","desc":"<p>This function is ideal when the HTTP request is being made to an arbitrary URL. The URL is validated to avoid redirection and request forgery attacks.</p>","summary":"Retrieve the raw response from a safe HTTP request.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_safe_remote_get","desc":"<p>This function is ideal when the HTTP request is being made to an arbitrary URL. The URL is validated to avoid redirection and request forgery attacks.</p>","summary":"Retrieve the raw response from a safe HTTP request using the GET method.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_safe_remote_post","desc":"<p>This function is ideal when the HTTP request is being made to an arbitrary URL. The URL is validated to avoid redirection and request forgery attacks.</p>","summary":"Retrieve the raw response from a safe HTTP request using the POST method.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_safe_remote_head","desc":"<p>This function is ideal when the HTTP request is being made to an arbitrary URL. The URL is validated to avoid redirection and request forgery attacks.</p>","summary":"Retrieve the raw response from a safe HTTP request using the HEAD method.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_remote_request","desc":"<p>The array structure is a little complex:</p> <pre><code>$res = array(\n 'headers' => array(),\n 'response' => array(\n 'code' => int,\n 'message' => string\n )\n);</code></pre>\n<p>All of the headers in $res['headers'] are with the name as the key and the\nvalue as the value. So to get the User-Agent, you would do the following.</p>\n<pre><code>$user_agent = $res['headers']['user-agent'];</code></pre> <p>The body is the raw response content and can be retrieved from $res['body'].</p> <p>This function is called first to make the request and there are other API functions to abstract out the above convoluted setup.</p> <p>Request method defaults for helper functions:</p> <ul> <li>Default 'GET' for wp_remote_get()</li> <li>Default 'POST' for wp_remote_post()</li> <li>Default 'HEAD' for wp_remote_head()</li> </ul>","summary":"Retrieve the raw response from the HTTP request.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_remote_get","desc":"","summary":"Retrieve the raw response from the HTTP request using the GET method.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_remote_post","desc":"","summary":"Retrieve the raw response from the HTTP request using the POST method.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_remote_head","desc":"","summary":"Retrieve the raw response from the HTTP request using the HEAD method.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Site URL to retrieve.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Request arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The response or WP_Error on failure.","types":"WP_Error|array"}},{"name":"wp_remote_retrieve_headers","desc":"","summary":"Retrieve only the headers from the raw response.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"}],"return":{"content":"The headers of the response. Empty array if incorrect parameter given.","types":"array|Requests_Utility_CaseInsensitiveDictionary"}},{"name":"wp_remote_retrieve_header","desc":"","summary":"Retrieve a single header by name from the raw response.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"","types":"array","variable":"$response","default":"null","required":"yes"},{"content":"Header name to retrieve value from.","types":"string","variable":"$header","default":"null","required":"yes"}],"return":{"content":"The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.","types":"string"}},{"name":"wp_remote_retrieve_response_code","desc":"<p>Will return an empty array if incorrect parameter value is given.</p>","summary":"Retrieve only the response code from the raw response.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"}],"return":{"content":"The response code as an integer. Empty string on incorrect parameter given.","types":"int|string"}},{"name":"wp_remote_retrieve_response_message","desc":"<p>Will return an empty array if incorrect parameter value is given.</p>","summary":"Retrieve only the response message from the raw response.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"}],"return":{"content":"The response message. Empty string on incorrect parameter given.","types":"string"}},{"name":"wp_remote_retrieve_body","desc":"","summary":"Retrieve only the body from the raw response.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"}],"return":{"content":"The body of the response. Empty string if no body or incorrect parameter given.","types":"string"}},{"name":"wp_remote_retrieve_cookies","desc":"","summary":"Retrieve only the cookies from the raw response.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"}],"return":{"content":"An array of <code>WP_Http_Cookie</code> objects from the response. Empty array if there are none, or the response is a WP_Error.","types":"array"}},{"name":"wp_remote_retrieve_cookie","desc":"","summary":"Retrieve a single cookie by name from the raw response.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"},{"content":"The name of the cookie to retrieve.","types":"string","variable":"$name","default":"null","required":"yes"}],"return":{"content":"The <code>WP_Http_Cookie</code> object. Empty string if the cookie isn't present in the response.","types":"WP_Http_Cookie|string"}},{"name":"wp_remote_retrieve_cookie_value","desc":"","summary":"Retrieve a single cookie's value by name from the raw response.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"HTTP response.","types":"array","variable":"$response","default":"null","required":"yes"},{"content":"The name of the cookie to retrieve.","types":"string","variable":"$name","default":"null","required":"yes"}],"return":{"content":"The value of the cookie. Empty string if the cookie isn't present in the response.","types":"string"}},{"name":"wp_http_supports","desc":"","summary":"Determines if there is an HTTP Transport that can process this request.","type":"function","category":"Uncategorised","since":"3.2.0","param":[{"content":"Array of capabilities to test or a wp_remote_request() $args array.","types":"array","variable":"$capabilities","default":"array()","required":"no"},{"content":" If given, will check if the URL requires SSL and adds that requirement to the capabilities array.","types":"string","variable":"$url","default":"null","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"get_http_origin","desc":"","summary":"Get the HTTP Origin of the current request.","type":"function","category":"Uncategorised","since":"3.4.0","return":{"content":"URL of the origin. Empty string if no origin.","types":"string"}},{"name":"get_allowed_http_origins","desc":"","summary":"Retrieve list of allowed HTTP origins.","type":"function","category":"Uncategorised","since":"3.4.0","return":{"content":"Array of origin URLs.","types":"array"}},{"name":"is_allowed_http_origin","desc":"","summary":"Determines if the HTTP origin is an authorized one.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"Origin URL. If not provided, the value of get_http_origin() is used.","types":"null|string","variable":"$origin","default":"null","required":"no"}],"return":{"content":"Origin URL if allowed, empty string if not.","types":"string"}},{"name":"send_origin_headers","desc":"<p>If the request is an OPTIONS request, the script exits with either access control headers sent, or a 403 response if the origin is not allowed. For other request methods, you will receive a return value.</p>","summary":"Send Access-Control-Allow-Origin and related headers if the current request is from an allowed origin.","type":"function","category":"Uncategorised","since":"3.4.0","return":{"content":"Returns the origin URL if headers are sent. Returns false if headers are not sent.","types":"string|false"}},{"name":"wp_http_validate_url","desc":"","summary":"Validate a URL for safe use in the HTTP API.","type":"function","category":"Uncategorised","since":"3.5.2","param":[{"content":"","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"URL or false on failure.","types":"false|string"}},{"name":"allowed_http_request_hosts","desc":"<p>Attached to the {@see 'http_request_host_is_external'} filter.</p>","summary":"Whitelists allowed redirect hosts for safe HTTP requests as well.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"","types":"bool","variable":"$is_external","default":"null","required":"yes"},{"content":"","types":"string","variable":"$host","default":"null","required":"yes"}],"return":{"content":"","types":"bool"}},{"name":"ms_allowed_http_request_hosts","desc":"<p>Attached to the {@see 'http_request_host_is_external'} filter.</p>","summary":"Whitelists any domain in a multisite installation for safe HTTP requests.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"","types":"bool","variable":"$is_external","default":"null","required":"yes"},{"content":"","types":"string","variable":"$host","default":"null","required":"yes"}],"return":{"content":"","types":"bool"}},{"name":"wp_parse_url","desc":"<p>PHP 5.4.7 expanded parse_url()'s ability to handle non-absolute url's, including schemeless and relative url's with :// in the path. This function works around those limitations providing a standard output on PHP 5.2~5.4+.</p> <p>Secondly, across various PHP versions, schemeless URLs starting containing a ":" in the query are being handled inconsistently. This function works around those differences as well.</p> <p>Error suppression is used as prior to PHP 5.3.3, an E_WARNING would be generated when URL parsing failed.</p>","summary":"A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"The URL to parse.","types":"string","variable":"$url","default":"null","required":"yes"},{"content":"The specific component to retrieve. Use one of the PHP predefined constants to specify which one. Defaults to -1 (= return all parts as an array).","types":"int","variable":"$component","default":"-1","required":"no"}],"return":{"content":"False on parse failure; Array of URL components on success; When a specific component has been requested: null if the component doesn't exist in the given URL; a string or - in the case of PHP_URL_PORT - integer when it does. See parse_url()'s return values.","types":"mixed"}},{"name":"_get_component_from_parsed_url_array","desc":"","summary":"Retrieve a specific component from a parsed URL array.","type":"function","category":"Uncategorised","since":"4.7.0","access":"private","param":[{"content":"The parsed URL. Can be false if the URL failed to parse.","types":"array|false","variable":"$url_parts","default":"null","required":"yes"},{"content":"The specific component to retrieve. Use one of the PHP predefined constants to specify which one. Defaults to -1 (= return all parts as an array).","types":"int","variable":"$component","default":"-1","required":"no"}],"return":{"content":"False on parse failure; Array of URL components on success; When a specific component has been requested: null if the component doesn't exist in the given URL; a string or - in the case of PHP_URL_PORT - integer when it does. See parse_url()'s return values.","types":"mixed"}},{"name":"_wp_translate_php_url_constant_to_key","desc":"","summary":"Translate a PHP_URL_* constant to the named array keys PHP uses.","type":"function","category":"Uncategorised","since":"4.7.0","access":"private","param":[{"content":"PHP<em>URL</em>* constant.","types":"int","variable":"$constant","default":"null","required":"yes"}],"return":{"content":"The named key or false.","types":"string|bool"}},{"name":"get_file","desc":"","summary":"","type":"function","category":"Uncategorised"},{"name":"wp_kses","desc":"<p>This function makes sure that only the allowed HTML element names, attribute names, attribute values, and HTML entities will occur in the given text string.</p> <p>This function expects unslashed data.</p>","summary":"Filters text content and strips out disallowed HTML.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Text content to filter.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"An array of allowed HTML elements and attributes, or a context name such as 'post'.","types":"array[]|string","variable":"$allowed_html","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"array()","required":"no"}],"return":{"content":"Filtered content containing only the allowed HTML.","types":"string"}},{"name":"wp_kses_one_attr","desc":"<p>This function can escape data in some situations where <code>wp_kses()</code> must strip the whole attribute.</p>","summary":"Filters one HTML attribute and ensures its value is allowed.","type":"function","category":"Uncategorised","since":"4.2.3","param":[{"content":"The 'whole' attribute, including name and value.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"The HTML element name to which the attribute belongs.","types":"string","variable":"$element","default":"null","required":"yes"}],"return":{"content":"Filtered attribute.","types":"string"}},{"name":"wp_kses_allowed_html","desc":"","summary":"Returns an array of allowed HTML tags and attributes for a given context.","type":"function","category":"Uncategorised","since":"5.0.1","param":[{"content":"The context for which to retrieve tags. Allowed values are 'post', 'strip', 'data', 'entities', or the name of a field filter such as 'pre_user_description'.","types":"string|array","variable":"$context","default":"''","required":"no"}],"return":{"content":"Array of allowed HTML tags and their allowed attributes.","types":"array"}},{"name":"wp_kses_hook","desc":"<p>There is currently only one KSES WordPress hook, {@see 'pre_kses'}, and it is called here. All parameters are passed to the hooks and expected to receive a string.</p>","summary":"You add any KSES hooks here.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to filter through KSES.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"List of allowed HTML elements.","types":"array[]|string","variable":"$allowed_html","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Filtered content through {@see 'pre_kses'} hook.","types":"string"}},{"name":"wp_kses_version","desc":"","summary":"Returns the version number of KSES.","type":"function","category":"Uncategorised","since":"1.0.0","return":{"content":"KSES version number.","types":"string"}},{"name":"wp_kses_split","desc":"<p>It also matches stray <code>></code> characters.</p>","summary":"Searches for HTML tags, no matter how malformed.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to filter.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Allowed HTML elements.","types":"array","variable":"$allowed_html","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Content with fixed HTML tags","types":"string"}},{"name":"wp_kses_uri_attributes","desc":"<p>This function returns a list of all HTML attributes that must contain a URL according to the HTML specification.</p> <p>This list includes URI attributes both allowed and disallowed by KSES.</p>","summary":"Helper function listing HTML attributes containing a URL.","type":"function","category":"Uncategorised","since":"5.0.1","return":{"content":"HTML attributes that must include a URL.","types":"array"}},{"name":"_wp_kses_split_callback","desc":"","summary":"Callback for `wp_kses_split()`.","type":"function","category":"Uncategorised","since":"3.1.0","access":"private","return":{"content":"","types":"string"}},{"name":"wp_kses_split2","desc":"<p>This function does a lot of work. It rejects some very malformed things like <code><:::></code>. It returns an empty string, if the element isn't allowed (look ma, no <code>strip_tags()</code>!). Otherwise it splits the tag into an element and an attribute list.</p> <p>After the tag is split into an element and an attribute list, it is run through another filter which will remove illegal attributes and once that is completed, will be returned.</p>","summary":"Callback for `wp_kses_split()` for fixing malformed HTML tags.","type":"function","category":"Uncategorised","access":"private","since":"1.0.0","param":[{"content":"Content to filter.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Allowed HTML elements.","types":"array","variable":"$allowed_html","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Fixed HTML element","types":"string"}},{"name":"wp_kses_attr","desc":"<p>If some are allowed it calls <code>wp_kses_hair()</code> to split them further, and then it builds up new HTML code from the data that <code>kses_hair()</code> returns. It also removes <code><</code> and <code>></code> characters, if there are any left. One more thing it does is to check if the tag has a closing XHTML slash, and if it does, it puts one in the returned code as well.</p>","summary":"Removes all attributes, if none are allowed for this element.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"HTML element/tag.","types":"string","variable":"$element","default":"null","required":"yes"},{"content":"HTML attributes from HTML element to closing HTML element tag.","types":"string","variable":"$attr","default":"null","required":"yes"},{"content":"Allowed HTML elements.","types":"array","variable":"$allowed_html","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Sanitized HTML element.","types":"string"}},{"name":"wp_kses_attr_check","desc":"","summary":"Determines whether an attribute is allowed.","type":"function","category":"Uncategorised","since":"5.0.0","param":[{"content":"The attribute name. Passed by reference. Returns empty string when not allowed.","types":"string","variable":"$name","default":"null","required":"yes"},{"content":"The attribute value. Passed by reference. Returns a filtered value.","types":"string","variable":"$value","default":"null","required":"yes"},{"content":"The <code>name=value</code> input. Passed by reference. Returns filtered input.","types":"string","variable":"$whole","default":"null","required":"yes"},{"content":"Whether the attribute is valueless. Use 'y' or 'n'.","types":"string","variable":"$vless","default":"null","required":"yes"},{"content":"The name of the element to which this attribute belongs.","types":"string","variable":"$element","default":"null","required":"yes"},{"content":"The full list of allowed elements and attributes.","types":"array","variable":"$allowed_html","default":"null","required":"yes"}],"return":{"content":"Whether or not the attribute is allowed.","types":"bool"}},{"name":"wp_kses_hair","desc":"<p>This function does a lot of work. It parses an attribute list into an array with attribute data, and tries to do the right thing even if it gets weird input. It will add quotes around attribute values that don't have any quotes or apostrophes around them, to make it easier to produce HTML code that will conform to W3C's HTML specification. It will also remove bad URL protocols from attribute values. It also reduces duplicate attributes by using the attribute defined first (<code>foo='bar' foo='baz'</code> will result in <code>foo='bar'</code>).</p>","summary":"Builds an attribute list from string containing attributes.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Attribute list from HTML element to closing HTML element tag.","types":"string","variable":"$attr","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Array of attribute information after parsing.","types":"array[]"}},{"name":"wp_kses_attr_parse","desc":"<p>Does not modify input. May return "evil" output.</p> <p>Based on <code>wp_kses_split2()</code> and <code>wp_kses_attr()</code>.</p>","summary":"Finds all attributes of an HTML element.","type":"function","category":"Uncategorised","since":"4.2.3","param":[{"content":"HTML element.","types":"string","variable":"$element","default":"null","required":"yes"}],"return":{"content":"List of attributes found in the element. Returns false on failure.","types":"array|bool"}},{"name":"wp_kses_hair_parse","desc":"<p>Does not modify input. May return "evil" output. In case of unexpected input, returns false instead of stripping things.</p> <p>Based on <code>wp_kses_hair()</code> but does not return a multi-dimensional array.</p>","summary":"Builds an attribute list from string containing attributes.","type":"function","category":"Uncategorised","since":"4.2.3","param":[{"content":"Attribute list from HTML element to closing HTML element tag.","types":"string","variable":"$attr","default":"null","required":"yes"}],"return":{"content":"List of attributes found in $attr. Returns false on failure.","types":"array|bool"}},{"name":"wp_kses_check_attr_val","desc":"<p>The currently implemented checks are "maxlen", "minlen", "maxval", "minval", and "valueless".</p>","summary":"Performs different checks for attribute values.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Attribute value.","types":"string","variable":"$value","default":"null","required":"yes"},{"content":"Whether the attribute is valueless. Use 'y' or 'n'.","types":"string","variable":"$vless","default":"null","required":"yes"},{"content":"What $checkvalue is checking for.","types":"string","variable":"$checkname","default":"null","required":"yes"},{"content":"What constraint the value should pass.","types":"mixed","variable":"$checkvalue","default":"null","required":"yes"}],"return":{"content":"Whether check passes.","types":"bool"}},{"name":"wp_kses_bad_protocol","desc":"<p>This function removes all non-allowed protocols from the beginning of the string. It ignores whitespace and the case of the letters, and it does understand HTML entities. It does its work recursively, so it won't be fooled by a string like <code>javascript:javascript:alert(57)</code>.</p>","summary":"Sanitizes a string and removed disallowed URL protocols.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to filter bad protocols from.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Filtered content.","types":"string"}},{"name":"wp_kses_no_null","desc":"<p>Also removes any instance of the <code>\\0</code> string.</p>","summary":"Removes any invalid control characters in a text string.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to filter null characters from.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Set 'slash_zero' => 'keep' when '\\0' is allowed. Default is 'remove'.","types":"array","variable":"$options","default":"null","required":"no"}],"return":{"content":"Filtered content.","types":"string"}},{"name":"wp_kses_stripslashes","desc":"<p>This function changes the character sequence <code>\\\"</code> to just <code>\"</code>. It leaves all other slashes alone. The quoting from <code>preg_replace(//e)</code> requires this.</p>","summary":"Strips slashes from in front of quotes.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"String to strip slashes from.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"Fixed string with quoted slashes.","types":"string"}},{"name":"wp_kses_array_lc","desc":"","summary":"Converts the keys of an array to lowercase.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Unfiltered array.","types":"array","variable":"$inarray","default":"null","required":"yes"}],"return":{"content":"Fixed array with all lowercase keys.","types":"array"}},{"name":"wp_kses_html_error","desc":"<p>The general plan is to remove everything to and including some whitespace, but it deals with quotes and apostrophes as well.</p>","summary":"Handles parsing errors in `wp_kses_hair()`.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"wp_kses_bad_protocol_once","desc":"<p>This function searches for URL protocols at the beginning of the string, while handling whitespace and HTML entities.</p>","summary":"Sanitizes content from bad protocols and other characters.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to check for bad protocols.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Sanitized content.","types":"string"}},{"name":"wp_kses_bad_protocol_once2","desc":"<p>This function processes URL protocols, checks to see if they're in the whitelist or not, and returns different data depending on the answer.</p>","summary":"Callback for `wp_kses_bad_protocol_once()` regular expression.","type":"function","category":"Uncategorised","access":"private","since":"1.0.0","param":[{"content":"URI scheme to check against the whitelist.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":"Array of allowed URL protocols.","types":"string[]","variable":"$allowed_protocols","default":"null","required":"yes"}],"return":{"content":"Sanitized content.","types":"string"}},{"name":"wp_kses_normalize_entities","desc":"<p>This function normalizes HTML entities. It will convert <code>AT&T</code> to the correct <code>AT&amp;T</code>, <code>&#00058;</code> to <code>&#58;</code>, <code>&#XYZZY;</code> to <code>&amp;#XYZZY;</code> and so on.</p>","summary":"Converts and fixes HTML entities.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to normalize entities.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"Content with normalized entities.","types":"string"}},{"name":"wp_kses_named_entities","desc":"<p>This function only accepts valid named entity references, which are finite, case-sensitive, and highly scrutinized by HTML and XML validators.</p>","summary":"Callback for `wp_kses_normalize_entities()` regular expression.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"preg_replace_callback() matches array.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"Correctly encoded entity.","types":"string"}},{"name":"wp_kses_normalize_entities2","desc":"<p>This function helps <code>wp_kses_normalize_entities()</code> to only accept 16-bit values and nothing more for <code>&#number;</code> entities.</p>","summary":"Callback for `wp_kses_normalize_entities()` regular expression.","type":"function","category":"Uncategorised","access":"private","since":"1.0.0","param":[{"content":"<code>preg_replace_callback()</code> matches array.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"Correctly encoded entity.","types":"string"}},{"name":"wp_kses_normalize_entities3","desc":"<p>This function helps <code>wp_kses_normalize_entities()</code> to only accept valid Unicode numeric entities in hex form.</p>","summary":"Callback for `wp_kses_normalize_entities()` for regular expression.","type":"function","category":"Uncategorised","since":"2.7.0","access":"private","param":[{"content":"<code>preg_replace_callback()</code> matches array.","types":"array","variable":"$matches","default":"null","required":"yes"}],"return":{"content":"Correctly encoded entity.","types":"string"}},{"name":"valid_unicode","desc":"","summary":"Determines if a Unicode codepoint is valid.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Unicode codepoint.","types":"int","variable":"$i","default":"null","required":"yes"}],"return":{"content":"Whether or not the codepoint is a valid Unicode codepoint.","types":"bool"}},{"name":"wp_kses_decode_entities","desc":"<p>This function decodes numeric HTML entities (<code>&#65;</code> and <code>&#x41;</code>). It doesn't do anything with named entities like <code>&auml;</code>, but we don't need them in the URL protocol whitelisting system anyway.</p>","summary":"Converts all numeric HTML entities to their named counterparts.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to change entities.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"Content after decoded entities.","types":"string"}},{"name":"_wp_kses_decode_entities_chr","desc":"","summary":"Regex callback for `wp_kses_decode_entities()`.","type":"function","category":"Uncategorised","since":"2.9.0","access":"private","param":[{"content":"preg match","types":"array","variable":"$match","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"_wp_kses_decode_entities_chr_hexdec","desc":"","summary":"Regex callback for `wp_kses_decode_entities()`.","type":"function","category":"Uncategorised","since":"2.9.0","access":"private","param":[{"content":"preg match","types":"array","variable":"$match","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"wp_filter_kses","desc":"<p>This function expects slashed data.</p>","summary":"Sanitize content with allowed HTML KSES rules.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":"Content to filter, expected to be escaped with slashes.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Filtered content.","types":"string"}},{"name":"wp_kses_data","desc":"<p>This function expects unslashed data.</p>","summary":"Sanitize content with allowed HTML KSES rules.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Content to filter, expected to not be escaped.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Filtered content.","types":"string"}},{"name":"wp_filter_post_kses","desc":"<p>Post content refers to the page contents of the 'post' type and not <code>$_POST</code> data from forms.</p> <p>This function expects slashed data.</p>","summary":"Sanitizes content for allowed HTML tags for post content.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":"Post content to filter, expected to be escaped with slashes.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Filtered post content with allowed HTML tags and attributes intact.","types":"string"}},{"name":"wp_kses_post","desc":"<p>Post content refers to the page contents of the 'post' type and not <code>$_POST</code> data from forms.</p> <p>This function expects unslashed data.</p>","summary":"Sanitizes content for allowed HTML tags for post content.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Post content to filter.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Filtered post content with allowed HTML tags and attributes intact.","types":"string"}},{"name":"wp_kses_post_deep","desc":"","summary":"Navigates through an array, object, or scalar, and sanitizes content for allowed HTML tags for post content.","type":"function","category":"Uncategorised","since":"4.4.2","param":[{"content":"The array, object, or scalar value to inspect.","types":"mixed","variable":"$data","default":"null","required":"yes"}],"return":{"content":"The filtered content.","types":"mixed"}},{"name":"wp_filter_nohtml_kses","desc":"<p>This function expects slashed data.</p>","summary":"Strips all HTML from a text string.","type":"function","category":"Uncategorised","since":"2.1.0","param":[{"content":"Content to strip all HTML from.","types":"string","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Filtered content without any HTML.","types":"string"}},{"name":"kses_init_filters","desc":"<p>All hooks have default priority. The <code>wp_filter_kses()</code> function is added to the 'pre_comment_content' and 'title_save_pre' hooks.</p> <p>The <code>wp_filter_post_kses()</code> function is added to the 'content_save_pre', 'excerpt_save_pre', and 'content_filtered_save_pre' hooks.</p>","summary":"Adds all KSES input form content filters.","type":"function","category":"Uncategorised","since":"2.0.0"},{"name":"kses_remove_filters","desc":"<p>A quick procedural method to removing all of the filters that KSES uses for content in WordPress Loop.</p> <p>Does not remove the <code>kses_init()</code> function from {@see 'init'} hook (priority is default). Also does not remove <code>kses_init()</code> function from {@see 'set_current_user'} hook (priority is also default).</p>","summary":"Removes all KSES input form content filters.","type":"function","category":"Uncategorised","since":"2.0.6"},{"name":"kses_init","desc":"<p>First removes all of the KSES filters in case the current user does not need to have KSES filter the content. If the user does not have <code>unfiltered_html</code> capability, then KSES filters are added.</p>","summary":"Sets up most of the KSES filters for input form content.","type":"function","category":"Uncategorised","since":"2.0.0"},{"name":"safecss_filter_attr","desc":"","summary":"Filters an inline style attribute and removes disallowed rules.","type":"function","category":"Uncategorised","since":"2.8.1","param":[{"content":"A string of CSS rules.","types":"string","variable":"$css","default":"null","required":"yes"},{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"Filtered string of CSS rules.","types":"string"}},{"name":"_wp_add_global_attributes","desc":"","summary":"Helper function to add global attributes to a tag in the allowed html list.","type":"function","category":"Uncategorised","since":"5.0.0","access":"private","param":[{"content":"An array of attributes.","types":"array","variable":"$value","default":"null","required":"yes"}],"return":{"content":"The array of attributes with global attributes added.","types":"array"}},{"name":"get_locale","desc":"<p>If the locale is set, then it will filter the locale in the {@see 'locale'} filter hook and return the value.</p> <p>If the locale is not set already, then the WPLANG constant is used if it is defined. Then it is filtered through the {@see 'locale'} filter hook and the value for the locale global set and the locale is returned.</p> <p>The process to get the locale should only be done once, but the locale will always be filtered using the {@see 'locale'} hook.</p>","summary":"Retrieves the current locale.","type":"function","category":"Localization","since":"1.5.0","return":{"content":"The locale of the blog or from the {@see 'locale'} hook.","types":"string"}},{"name":"get_user_locale","desc":"<p>If the user has a locale set to a non-empty string then it will be returned. Otherwise it returns the locale of get_locale().</p>","summary":"Retrieves the locale of a user.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"User's ID or a WP_User object. Defaults to current user.","types":"int|WP_User","variable":"$user_id","default":"0","required":"yes"}],"return":{"content":"The locale of the user.","types":"string"}},{"name":"determine_locale","desc":"","summary":"Determine the current locale desired for the request.","type":"function","category":"Uncategorised","since":"5.0.0","return":{"content":"The determined locale.","types":"string"}},{"name":"translate","desc":"<p>If there is no translation, or the text domain isn't loaded, the original text is returned.</p> <p><em>Note:</em> Don't use translate() directly, use __() or related functions.</p>","summary":"Retrieve the translation of $text.","type":"function","category":"Uncategorised","since":"2.2.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text","types":"string"}},{"name":"before_last_bar","desc":"<p>Meant for removing the last item in a string, such as 'Role name|User role'. The original string will be returned if no pipe '|' characters are found in the string.</p>","summary":"Remove last item on a pipe-delimited string.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"A pipe-delimited string.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"Either $string or everything before the last pipe.","types":"string"}},{"name":"translate_with_gettext_context","desc":"<p>If there is no translation, or the text domain isn't loaded the original text is returned.</p> <p><em>Note:</em> Don't use translate_with_gettext_context() directly, use _x() or related functions.</p>","summary":"Retrieve the translation of $text in the context defined in $context.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text on success, original text on failure.","types":"string"}},{"name":"__","desc":"<p>If there is no translation, or the text domain isn't loaded, the original text is returned.</p>","summary":"Retrieve the translation of $text.","type":"function","category":"Localization","since":"2.1.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text.","types":"string"}},{"name":"esc_attr__","desc":"<p>If there is no translation, or the text domain isn't loaded, the original text is returned.</p>","summary":"Retrieve the translation of $text and escapes it for safe use in an attribute.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text on success, original text on failure.","types":"string"}},{"name":"esc_html__","desc":"<p>If there is no translation, or the text domain isn't loaded, the original text is escaped and returned.</p>","summary":"Retrieve the translation of $text and escapes it for safe use in HTML output.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text","types":"string"}},{"name":"_e","desc":"","summary":"Display translated text.","type":"function","category":"Localization","since":"1.2.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}]},{"name":"esc_attr_e","desc":"","summary":"Display translated text that has been escaped for safe use in an attribute.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}]},{"name":"esc_html_e","desc":"","summary":"Display translated text that has been escaped for safe use in HTML output.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}]},{"name":"_x","desc":"<p>Quite a few times, there will be collisions with similar translatable text found in more than two places, but with different translated context.</p> <p>By including the context in the pot file, translators can translate the two strings differently.</p>","summary":"Retrieve translated string with gettext context.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated context string without pipe.","types":"string"}},{"name":"_ex","desc":"","summary":"Display translated string with gettext context.","type":"function","category":"Localization","since":"3.0.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated context string without pipe.","types":"string"}},{"name":"esc_attr_x","desc":"","summary":"Translate string with gettext context, and escapes it for safe use in an attribute.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text","types":"string"}},{"name":"esc_html_x","desc":"","summary":"Translate string with gettext context, and escapes it for safe use in HTML output.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Text to translate.","types":"string","variable":"$text","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated text.","types":"string"}},{"name":"_n","desc":"<p>Used when you want to use the appropriate form of a string based on whether a number is singular or plural.</p> <p>Example:</p> <pre><code>printf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );</code></pre>","summary":"Translates and retrieves the singular or plural form based on the supplied number.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"The text to be used if the number is singular.","types":"string","variable":"$single","default":"null","required":"yes"},{"content":"The text to be used if the number is plural.","types":"string","variable":"$plural","default":"null","required":"yes"},{"content":"The number to compare against to use either the singular or plural form.","types":"int","variable":"$number","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"The translated singular or plural form.","types":"string"}},{"name":"_nx","desc":"<p>This is a hybrid of _n() and _x(). It supports context and plurals.</p> <p>Used when you want to use the appropriate form of a string with context based on whether a number is singular or plural.</p> <p>Example of a generic phrase which is disambiguated via the context parameter:</p> <pre><code>printf( _nx( '%s group', '%s groups', $people, 'group of people', 'text-domain' ), number_format_i18n( $people ) );\nprintf( _nx( '%s group', '%s groups', $animals, 'group of animals', 'text-domain' ), number_format_i18n( $animals ) );</code></pre>","summary":"Translates and retrieves the singular or plural form based on the supplied number, with gettext context.","type":"function","category":"Localization","since":"2.8.0","param":[{"content":"The text to be used if the number is singular.","types":"string","variable":"$single","default":"null","required":"yes"},{"content":"The text to be used if the number is plural.","types":"string","variable":"$plural","default":"null","required":"yes"},{"content":"The number to compare against to use either the singular or plural form.","types":"int","variable":"$number","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"The translated singular or plural form.","types":"string"}},{"name":"_n_noop","desc":"<p>Used when you want to keep structures with translatable plural strings and use them later when the number is known.</p> <p>Example:</p> <pre><code>$message = _n_noop( '%s post', '%s posts', 'text-domain' );\n...\nprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );</code></pre>","summary":"Registers plural strings in POT file, but does not translate them.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Singular form to be localized.","types":"string","variable":"$singular","default":"null","required":"yes"},{"content":"Plural form to be localized.","types":"string","variable":"$plural","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default null.","types":"string","variable":"$domain","default":"null","required":"no"}],"return":{"content":"{ Array of translation information for the strings. @type string $0 Singular form to be localized. No longer used. @type string $1 Plural form to be localized. No longer used. @type string $singular Singular form to be localized. @type string $plural Plural form to be localized. @type null $context Context information for the translators. @type string $domain Text domain. }","types":"array"}},{"name":"_nx_noop","desc":"<p>Used when you want to keep structures with translatable plural strings and use them later when the number is known.</p> <p>Example of a generic phrase which is disambiguated via the context parameter:</p> <pre><code>$messages = array(\n 'people' => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),\n 'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),\n);\n...\n$message = $messages[ $type ];\nprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );</code></pre>","summary":"Registers plural strings with gettext context in POT file, but does not translate them.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Singular form to be localized.","types":"string","variable":"$singular","default":"null","required":"yes"},{"content":"Plural form to be localized.","types":"string","variable":"$plural","default":"null","required":"yes"},{"content":"Context information for the translators.","types":"string","variable":"$context","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default null.","types":"string","variable":"$domain","default":"null","required":"no"}],"return":{"content":"{ Array of translation information for the strings. @type string $0 Singular form to be localized. No longer used. @type string $1 Plural form to be localized. No longer used. @type string $2 Context information for the translators. No longer used. @type string $singular Singular form to be localized. @type string $plural Plural form to be localized. @type string $context Context information for the translators. @type string $domain Text domain. }","types":"array"}},{"name":"translate_nooped_plural","desc":"<p>Used when you want to use a translatable plural string once the number is known.</p> <p>Example:</p> <pre><code>$message = _n_noop( '%s post', '%s posts', 'text-domain' );\n...\nprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );</code></pre>","summary":"Translates and retrieves the singular or plural form of a string that's been registered with _n_noop() or _nx_noop().","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"Array with singular, plural, and context keys, usually the result of _n_noop() or _nx_noop().","types":"array","variable":"$nooped_plural","default":"null","required":"yes"},{"content":"Number of objects.","types":"int","variable":"$count","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Either $single or $plural translated text.","types":"string"}},{"name":"load_textdomain","desc":"<p>If the text domain already exists, the translations will be merged. If both sets have the same string, the translation from the original value will be taken.</p> <p>On success, the .mo file will be placed in the $l10n global by $domain and will be a MO object.</p>","summary":"Load a .mo file into the text domain $domain.","type":"function","category":"Localization","since":"1.5.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"Path to the .mo file.","types":"string","variable":"$mofile","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"unload_textdomain","desc":"","summary":"Unload translations for a text domain.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"}],"return":{"content":"Whether textdomain was unloaded.","types":"bool"}},{"name":"load_default_textdomain","desc":"<p>Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The translated (.mo) file is named based on the locale.</p>","summary":"Load default translated strings based on locale.","type":"function","category":"Localization","since":"1.5.0","param":[{"content":" Locale to load. Default is the value of get_locale().","types":"string","variable":"$locale","default":"null","required":"no"}],"return":{"content":"Whether the textdomain was loaded.","types":"bool"}},{"name":"load_plugin_textdomain","desc":"<p>If the path is not given then it will be the root of the plugin directory.</p> <p>The .mo file should be named based on the text domain with a dash, and then the locale exactly.</p>","summary":"Loads a plugin's translated strings.","type":"function","category":"Localization","since":"4.6.0","param":[{"content":"Unique identifier for retrieving translated strings","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":" Deprecated. Use the $plugin_rel_path parameter instead. Default false.","types":"string|false","variable":"$deprecated","default":"false","required":"no"},{"content":" Relative path to WP_PLUGIN_DIR where the .mo file resides. Default false.","types":"string|false","variable":"$plugin_rel_path","default":"false","required":"no"}],"return":{"content":"True when textdomain is successfully loaded, false otherwise.","types":"bool"}},{"name":"load_muplugin_textdomain","desc":"","summary":"Load the translated strings for a plugin residing in the mu-plugins directory.","type":"function","category":"Localization","since":"4.6.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":" Relative to <code>WPMU_PLUGIN_DIR</code> directory in which the .mo file resides. Default empty string.","types":"string","variable":"$mu_plugin_rel_path","default":"''","required":"no"}],"return":{"content":"True when textdomain is successfully loaded, false otherwise.","types":"bool"}},{"name":"load_theme_textdomain","desc":"<p>If the current locale exists as a .mo file in the theme's root directory, it will be included in the translated strings by the $domain.</p> <p>The .mo files must be named based on the locale exactly.</p>","summary":"Load the theme's translated strings.","type":"function","category":"Localization","since":"4.6.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":" Path to the directory containing the .mo file. Default false.","types":"string","variable":"$path","default":"false","required":"no"}],"return":{"content":"True when textdomain is successfully loaded, false otherwise.","types":"bool"}},{"name":"load_child_theme_textdomain","desc":"<p>If the current locale exists as a .mo file in the child themes root directory, it will be included in the translated strings by the $domain.</p> <p>The .mo files must be named based on the locale exactly.</p>","summary":"Load the child themes translated strings.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":" Path to the directory containing the .mo file. Default false.","types":"string","variable":"$path","default":"false","required":"no"}],"return":{"content":"True when the theme textdomain is successfully loaded, false otherwise.","types":"bool"}},{"name":"load_script_textdomain","desc":"","summary":"Loads the script translated strings.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Name of the script to register a translation domain to.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":" Text domain. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"},{"content":" The full file path to the directory containing translation files.","types":"string","variable":"$path","default":"null","required":"no"}],"return":{"content":"False if the script textdomain could not be loaded, the translated strings in JSON encoding otherwise.","types":"false|string"}},{"name":"load_script_translations","desc":"","summary":"Loads the translation data for the given script handle and text domain.","type":"function","category":"Uncategorised","since":"5.0.2","param":[{"content":"Path to the translation file to load. False if there isn't one.","types":"string|false","variable":"$file","default":"null","required":"yes"},{"content":"Name of the script to register a translation domain to.","types":"string","variable":"$handle","default":"null","required":"yes"},{"content":"The text domain.","types":"string","variable":"$domain","default":"null","required":"yes"}],"return":{"content":"The JSON-encoded translated strings for the given script handle and text domain. False if there are none.","types":"string|false"}},{"name":"_load_textdomain_just_in_time","desc":"<p>When a textdomain is encountered for the first time, we try to load the translation file from <code>wp-content/languages</code>, removing the need to call load_plugin_texdomain() or load_theme_texdomain().</p>","summary":"Loads plugin and theme textdomains just-in-time.","type":"function","category":"Uncategorised","since":"4.6.0","access":"private","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"}],"return":{"content":"True when the textdomain is successfully loaded, false otherwise.","types":"bool"}},{"name":"_get_path_to_translation","desc":"<p>Caches the retrieved results internally.</p>","summary":"Gets the path to a translation file for loading a textdomain just in time.","type":"function","category":"Uncategorised","since":"4.7.0","access":"private","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"Whether to reset the internal cache. Used by the switch to locale functionality.","types":"bool","variable":"$reset","default":"false","required":"no"}],"return":{"content":"The path to the translation file or false if no translation file was found.","types":"string|false"}},{"name":"_get_path_to_translation_from_lang_dir","desc":"<p>Holds a cached list of available .mo files to improve performance.</p>","summary":"Gets the path to a translation file in the languages directory for the current locale.","type":"function","category":"Uncategorised","since":"4.7.0","access":"private","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"}],"return":{"content":"The path to the translation file or false if no translation file was found.","types":"string|false"}},{"name":"get_translations_for_domain","desc":"<p>If there isn't one, returns empty Translations instance.</p>","summary":"Return the Translations instance for a text domain.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"}],"return":{"content":"A Translations instance.","types":"Translations|NOOP_Translations"}},{"name":"is_textdomain_loaded","desc":"","summary":"Whether there are translations for the text domain.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Text domain. Unique identifier for retrieving translated strings.","types":"string","variable":"$domain","default":"null","required":"yes"}],"return":{"content":"Whether there are translations.","types":"bool"}},{"name":"translate_user_role","desc":"<p>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.</p> <p>The before_last_bar() call is needed, because older installations keep the roles using the old context format: 'Role name|User role' and just skipping the content after the last bar is easier than fixing them in the DB. New installations won't suffer from that problem.</p>","summary":"Translates role name.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"The role name.","types":"string","variable":"$name","default":"null","required":"yes"},{"content":" Text domain. Unique identifier for retrieving translated strings. Default 'default'.","types":"string","variable":"$domain","default":"'default'","required":"no"}],"return":{"content":"Translated role name on success, original name on failure.","types":"string"}},{"name":"get_available_languages","desc":"<p>The default directory is WP_LANG_DIR.</p>","summary":"Get all available languages based on the presence of *.mo files in a given directory.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"A directory to search for language files. Default WP_LANG_DIR.","types":"string","variable":"$dir","default":"null","required":"no"}],"return":{"content":"An 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.","types":"array"}},{"name":"wp_get_installed_translations","desc":"<p>Looks in the wp-content/languages directory for translations of plugins or themes.</p>","summary":"Get installed translations.","type":"function","category":"Miscellaneous","since":"3.7.0","param":[{"content":"What to search for. Accepts 'plugins', 'themes', 'core'.","types":"string","variable":"$type","default":"null","required":"yes"}],"return":{"content":"Array of language data.","types":"array"}},{"name":"wp_get_pomo_file_data","desc":"","summary":"Extract headers from a PO file.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":"Path to PO file.","types":"string","variable":"$po_file","default":"null","required":"yes"}],"return":{"content":"PO file headers.","types":"array"}},{"name":"wp_dropdown_languages","desc":"","summary":"Language selector.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"{ Optional. Array or string of arguments for outputting the language selector. @type string $id ID attribute of the select element. Default 'locale'. @type string $name Name attribute of the select element. Default 'locale'. @type array $languages List of installed languages, contain only the locales. Default empty array. @type array $translations List of available translations. Default result of wp_get_available_translations(). @type string $selected Language which should be selected. Default empty. @type bool|int $echo Whether to echo the generated markup. Accepts 0, 1, or their boolean equivalents. Default 1. @type bool $show_available_translations Whether to show available translations. Default true. @type bool $show_option_site_default Whether to show an option to fall back to the site's locale. Default false. @type bool $show_option_en_us Whether to show an option for English (United States). Default true. }","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"HTML content","types":"string"}},{"name":"is_rtl","desc":"<p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the current locale is right-to-left (RTL).","type":"function","category":"Localization","since":"3.0.0","return":{"content":"Whether locale is RTL.","types":"bool"}},{"name":"switch_to_locale","desc":"","summary":"Switches the translations according to the given locale.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"The locale.","types":"string","variable":"$locale","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"restore_previous_locale","desc":"","summary":"Restores the translations according to the previous locale.","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"Locale on success, false on error.","types":"string|false"}},{"name":"restore_current_locale","desc":"","summary":"Restores the translations according to the original locale.","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"Locale on success, false on error.","types":"string|false"}},{"name":"is_locale_switched","desc":"","summary":"Whether switch_to_locale() is in effect.","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"True if the locale has been switched, false otherwise.","types":"bool"}},{"name":"the_permalink","desc":"","summary":"Displays the permalink for the current post.","type":"function","category":"Posts","since":"4.4.0","param":[{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"}]},{"name":"user_trailingslashit","desc":"<p>Conditionally adds a trailing slash if the permalink structure has a trailing slash, strips the trailing slash if not. The string is passed through the {@see 'user_trailingslashit'} filter. Will remove trailing slash from string, if site is not set to have them.</p>","summary":"Retrieves a trailing-slashed string if the site is set for adding trailing slashes.","type":"function","category":"Uncategorised","since":"2.2.0","param":[{"content":"URL with or without a trailing slash.","types":"string","variable":"$string","default":"null","required":"yes"},{"content":" The type of URL being considered (e.g. single, category, etc) for use in the filter. Default empty string.","types":"string","variable":"$type_of_url","default":"''","required":"no"}],"return":{"content":"The URL with the trailing slash appended or stripped.","types":"string"}},{"name":"permalink_anchor","desc":"<p>The permalink mode title will use the post title for the 'a' element 'id' attribute. The id mode uses 'post-' with the post ID for the 'id' attribute.</p>","summary":"Displays the permalink anchor for the current post.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" Permalink mode. Accepts 'title' or 'id'. Default 'id'.","types":"string","variable":"$mode","default":"'id'","required":"no"}]},{"name":"get_the_permalink","desc":"<p>This function is an alias for get_permalink().</p>","summary":"Retrieves the full permalink for the current post or post ID.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"},{"content":" Whether to keep post name or page name. Default false.","types":"bool","variable":"$leavename","default":"false","required":"no"}],"return":{"content":"The permalink URL or false if post does not exist.","types":"string|false"}},{"name":"get_permalink","desc":"","summary":"Retrieves the full permalink for the current post or post ID.","type":"function","category":"Posts","since":"1.0.0","param":[{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"},{"content":" Whether to keep post name or page name. Default false.","types":"bool","variable":"$leavename","default":"false","required":"no"}],"return":{"content":"The permalink URL or false if post does not exist.","types":"string|false"}},{"name":"get_post_permalink","desc":"","summary":"Retrieves the permalink for a post of a custom post type.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$id","default":"0","required":"no"},{"content":" defaults to false. Whether to keep post name. Default false.","types":"bool","variable":"$leavename","default":"false","required":"no"},{"content":" defaults to false. Is it a sample permalink. Default false.","types":"bool","variable":"$sample","default":"false","required":"no"}],"return":{"content":"The post permalink.","types":"string|WP_Error"}},{"name":"get_page_link","desc":"<p>Respects page_on_front. Use this one.</p>","summary":"Retrieves the permalink for the current page or page ID.","type":"function","category":"Pages","since":"1.5.0","param":[{"content":" Post ID or object. Default uses the global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"false","required":"no"},{"content":" Whether to keep the page name. Default false.","types":"bool","variable":"$leavename","default":"false","required":"no"},{"content":" Whether it should be treated as a sample permalink. Default false.","types":"bool","variable":"$sample","default":"false","required":"no"}],"return":{"content":"The page permalink.","types":"string"}},{"name":"_get_page_link","desc":"<p>Ignores page_on_front. Internal use only.</p>","summary":"Retrieves the page permalink.","type":"function","category":"Uncategorised","since":"2.1.0","access":"private","param":[{"content":" Post ID or object. Default uses the global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"false","required":"no"},{"content":" Whether to keep the page name. Default false.","types":"bool","variable":"$leavename","default":"false","required":"no"},{"content":" Whether it should be treated as a sample permalink. Default false.","types":"bool","variable":"$sample","default":"false","required":"no"}],"return":{"content":"The page permalink.","types":"string"}},{"name":"get_attachment_link","desc":"<p>This can be used in the WordPress Loop or outside of it.</p>","summary":"Retrieves the permalink for an attachment.","type":"function","category":"Uncategorised","since":"2.0.0","param":[{"content":" Post ID or object. Default uses the global <code>$post</code>.","types":"int|object","variable":"$post","default":"null","required":"no"},{"content":" Whether to keep the page name. Default false.","types":"bool","variable":"$leavename","default":"false","required":"no"}],"return":{"content":"The attachment permalink.","types":"string"}},{"name":"get_year_link","desc":"","summary":"Retrieves the permalink for the year archives.","type":"function","category":"Time/Date Functions","since":"1.5.0","param":[{"content":"False for current year or year for permalink.","types":"int|bool","variable":"$year","default":"null","required":"yes"}],"return":{"content":"The permalink for the specified year archive.","types":"string"}},{"name":"get_month_link","desc":"","summary":"Retrieves the permalink for the month archives with year.","type":"function","category":"Time/Date Functions","since":"1.0.0","param":[{"content":"False for current year. Integer of year.","types":"bool|int","variable":"$year","default":"null","required":"yes"},{"content":"False for current month. Integer of month.","types":"bool|int","variable":"$month","default":"null","required":"yes"}],"return":{"content":"The permalink for the specified month and year archive.","types":"string"}},{"name":"get_day_link","desc":"","summary":"Retrieves the permalink for the day archives with year and month.","type":"function","category":"Time/Date Functions","since":"1.0.0","param":[{"content":"False for current year. Integer of year.","types":"bool|int","variable":"$year","default":"null","required":"yes"},{"content":"False for current month. Integer of month.","types":"bool|int","variable":"$month","default":"null","required":"yes"},{"content":"False for current day. Integer of day.","types":"bool|int","variable":"$day","default":"null","required":"yes"}],"return":{"content":"The permalink for the specified day, month, and year archive.","types":"string"}},{"name":"the_feed_link","desc":"","summary":"Displays the permalink for the feed type.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"The link's anchor text.","types":"string","variable":"$anchor","default":"null","required":"yes"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}]},{"name":"get_feed_link","desc":"","summary":"Retrieves the permalink for the feed type.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"The feed permalink.","types":"string"}},{"name":"get_post_comments_feed_link","desc":"","summary":"Retrieves the permalink for the post comments feed.","type":"function","category":"Uncategorised","since":"2.2.0","param":[{"content":" Post ID. Default is the ID of the global <code>$post</code>.","types":"int","variable":"$post_id","default":"0","required":"no"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"The permalink for the comments feed for the given post.","types":"string"}},{"name":"post_comments_feed_link","desc":"<p>Prints out the comment feed link for a post. Link text is placed in the anchor. If no link text is specified, default text is used. If no post ID is specified, the current post is used.</p>","summary":"Displays the comment feed link for a post.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Descriptive link text. Default 'Comments Feed'.","types":"string","variable":"$link_text","default":"''","required":"no"},{"content":" Post ID. Default is the ID of the global <code>$post</code>.","types":"int","variable":"$post_id","default":"''","required":"no"},{"content":" Feed format. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}]},{"name":"get_author_feed_link","desc":"<p>Returns a link to the feed for all posts by a given author. A specific feed can be requested or left blank to get the default feed.</p>","summary":"Retrieves the feed link for a given author.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Author ID.","types":"int","variable":"$author_id","default":"null","required":"yes"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"Link to the feed for the author specified by $author_id.","types":"string"}},{"name":"get_category_feed_link","desc":"<p>Returns a link to the feed for all posts in a given category. A specific feed can be requested or left blank to get the default feed.</p>","summary":"Retrieves the feed link for a category.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Category ID.","types":"int","variable":"$cat_id","default":"null","required":"yes"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"Link to the feed for the category specified by $cat_id.","types":"string"}},{"name":"get_term_feed_link","desc":"<p>Returns a link to the feed for all posts in a given term. A specific feed can be requested or left blank to get the default feed.</p>","summary":"Retrieves the feed link for a term.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Term ID.","types":"int","variable":"$term_id","default":"null","required":"yes"},{"content":" Taxonomy of <code>$term_id</code>. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"Link to the feed for the term specified by $term_id and $taxonomy.","types":"string|false"}},{"name":"get_tag_feed_link","desc":"","summary":"Retrieves the permalink for a tag feed.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":"Tag ID.","types":"int","variable":"$tag_id","default":"null","required":"yes"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"The feed permalink for the given tag.","types":"string"}},{"name":"get_edit_tag_link","desc":"","summary":"Retrieves the edit link for a tag.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":"Tag ID.","types":"int","variable":"$tag_id","default":"null","required":"yes"},{"content":" Taxonomy slug. Default 'post_tag'.","types":"string","variable":"$taxonomy","default":"'post_tag'","required":"no"}],"return":{"content":"The edit tag link URL for the given tag.","types":"string"}},{"name":"edit_tag_link","desc":"","summary":"Displays or retrieves the edit link for a tag with formatting.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Anchor text. Default empty.","types":"string","variable":"$link","default":"''","required":"no"},{"content":" Display before edit link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after edit link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Term object. If null, the queried object will be inspected. Default null.","types":"WP_Term","variable":"$tag","default":"null","required":"no"}]},{"name":"get_edit_term_link","desc":"","summary":"Retrieves the URL for editing a given term.","type":"function","category":"Taxonomy","since":"4.5.0","param":[{"content":"Term ID.","types":"int","variable":"$term_id","default":"null","required":"yes"},{"content":" Taxonomy. Defaults to the taxonomy of the term identified by <code>$term_id</code>.","types":"string","variable":"$taxonomy","default":"''","required":"no"},{"content":" The object type. Used to highlight the proper post type menu on the linked page. Defaults to the first object_type associated with the taxonomy.","types":"string","variable":"$object_type","default":"''","required":"no"}],"return":{"content":"The edit term link URL for the given term, or null on failure.","types":"string|null"}},{"name":"edit_term_link","desc":"","summary":"Displays or retrieves the edit term link with formatting.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":" Anchor text. Default empty.","types":"string","variable":"$link","default":"''","required":"no"},{"content":" Display before edit link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after edit link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Term object. If null, the queried object will be inspected. Default null.","types":"object","variable":"$term","default":"null","required":"no"},{"content":" Whether or not to echo the return. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"HTML content.","types":"string|void"}},{"name":"get_search_link","desc":"","summary":"Retrieves the permalink for a search.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":" The query string to use. If empty the current query is used. Default empty.","types":"string","variable":"$query","default":"''","required":"no"}],"return":{"content":"The search permalink.","types":"string"}},{"name":"get_search_feed_link","desc":"","summary":"Retrieves the permalink for the search results feed.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Search query. Default empty.","types":"string","variable":"$search_query","default":"''","required":"no"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"The search results feed permalink.","types":"string"}},{"name":"get_search_comments_feed_link","desc":"","summary":"Retrieves the permalink for the search results comments feed.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Search query. Default empty.","types":"string","variable":"$search_query","default":"''","required":"no"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"The comments feed search results permalink.","types":"string"}},{"name":"get_post_type_archive_link","desc":"","summary":"Retrieves the permalink for a post type archive.","type":"function","category":"Custom Post Type","since":"4.5.0","param":[{"content":"Post type.","types":"string","variable":"$post_type","default":"null","required":"yes"}],"return":{"content":"The post type archive permalink.","types":"string|false"}},{"name":"get_post_type_archive_feed_link","desc":"","summary":"Retrieves the permalink for a post type archive feed.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":"Post type","types":"string","variable":"$post_type","default":"null","required":"yes"},{"content":" Feed type. Default empty.","types":"string","variable":"$feed","default":"''","required":"no"}],"return":{"content":"The post type feed permalink.","types":"string|false"}},{"name":"get_preview_post_link","desc":"<p>Allows additional query args to be appended.</p>","summary":"Retrieves the URL used for the post preview.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" Post ID or <code>WP_Post</code> object. Defaults to global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"},{"content":" Array of additional query args to be appended to the link. Default empty array.","types":"array","variable":"$query_args","default":"array()","required":"no"},{"content":" Base preview link to be used if it should differ from the post permalink. Default empty.","types":"string","variable":"$preview_link","default":"''","required":"no"}],"return":{"content":"URL used for the post preview, or null if the post does not exist.","types":"string|null"}},{"name":"get_edit_post_link","desc":"<p>Can be used within the WordPress loop or outside of it. Can be used with pages, posts, attachments, and revisions.</p>","summary":"Retrieves the edit post link for post.","type":"function","category":"Posts","since":"2.3.0","param":[{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$id","default":"0","required":"no"},{"content":" How to output the '&' character. Default '&'.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"The edit post link for the given post. null if the post type is invalid or does not allow an editing UI.","types":"string|null"}},{"name":"edit_post_link","desc":"","summary":"Displays the edit post link for post.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" Anchor text. If null, default is 'Edit This'. Default null.","types":"string","variable":"$text","default":"null","required":"no"},{"content":" Display before edit link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after edit link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$id","default":"0","required":"no"},{"content":" Add custom class to link. Default 'post-edit-link'.","types":"string","variable":"$class","default":"'post-edit-link'","required":"no"}]},{"name":"get_delete_post_link","desc":"<p>Can be used within the WordPress loop or outside of it, with any post type.</p>","summary":"Retrieves the delete posts link for post.","type":"function","category":"Posts","since":"2.9.0","param":[{"content":" Post ID or post object. Default is the global <code>$post</code>.","types":"int|WP_Post","variable":"$id","default":"0","required":"no"},{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"},{"content":" Whether to bypass trash and force deletion. Default false.","types":"bool","variable":"$force_delete","default":"false","required":"no"}],"return":{"content":"The delete post link URL for the given post.","types":"string|void"}},{"name":"get_edit_comment_link","desc":"","summary":"Retrieves the edit comment link.","type":"function","category":"Uncategorised","since":"2.3.0","param":[{"content":" Comment ID or WP_Comment object.","types":"int|WP_Comment","variable":"$comment_id","default":"0","required":"no"}],"return":{"content":"The edit comment link URL for the given comment.","types":"string|void"}},{"name":"edit_comment_link","desc":"","summary":"Displays the edit comment link with formatting.","type":"function","category":"Uncategorised","since":"1.0.0","param":[{"content":" Anchor text. If null, default is 'Edit This'. Default null.","types":"string","variable":"$text","default":"null","required":"no"},{"content":" Display before edit link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after edit link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"get_edit_bookmark_link","desc":"","summary":"Displays the edit bookmark link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Bookmark ID. Default is the id of the current bookmark.","types":"int|stdClass","variable":"$link","default":"0","required":"no"}],"return":{"content":"The edit bookmark link URL.","types":"string|void"}},{"name":"edit_bookmark_link","desc":"","summary":"Displays the edit bookmark link anchor content.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Anchor text. Default empty.","types":"string","variable":"$link","default":"''","required":"no"},{"content":" Display before edit link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after edit link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"},{"content":" Bookmark ID. Default is the current bookmark.","types":"int","variable":"$bookmark","default":"null","required":"no"}]},{"name":"get_edit_user_link","desc":"","summary":"Retrieves the edit user link.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":" User ID. Defaults to the current user.","types":"int","variable":"$user_id","default":"null","required":"no"}],"return":{"content":"URL to edit user page or empty string.","types":"string"}},{"name":"get_previous_post","desc":"","summary":"Retrieves the previous post that is adjacent to the current post.","type":"function","category":"Posts","since":"1.5.0","param":[{"content":" Whether post should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.","types":"null|string|WP_Post"}},{"name":"get_next_post","desc":"","summary":"Retrieves the next post that is adjacent to the current post.","type":"function","category":"Posts","since":"1.5.0","param":[{"content":" Whether post should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.","types":"null|string|WP_Post"}},{"name":"get_adjacent_post","desc":"<p>Can either be next or previous post.</p>","summary":"Retrieves the adjacent post.","type":"function","category":"Posts","since":"2.5.0","param":[{"content":" Whether post should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Whether to retrieve previous post. Default true","types":"bool","variable":"$previous","default":"true","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.","types":"null|string|WP_Post"}},{"name":"get_adjacent_post_rel_link","desc":"<p>Can either be next or previous post relational link.</p>","summary":"Retrieves the adjacent post relational link.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":" Link title format. Default '%title'.","types":"string","variable":"$title","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Whether to display link to previous or next post. Default true.","types":"bool","variable":"$previous","default":"true","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"The adjacent post relational link URL.","types":"string|void"}},{"name":"adjacent_posts_rel_link","desc":"","summary":"Displays the relational links for the posts adjacent to the current post.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":" Link title format. Default '%title'.","types":"string","variable":"$title","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}]},{"name":"adjacent_posts_rel_link_wp_head","desc":"<p>This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.</p>","summary":"Displays relational links for the posts adjacent to the current post for single post pages.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"next_post_rel_link","desc":"","summary":"Displays the relational link for the next post adjacent to the current post.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":" Link title format. Default '%title'.","types":"string","variable":"$title","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}]},{"name":"prev_post_rel_link","desc":"","summary":"Displays the relational link for the previous post adjacent to the current post.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":" Link title format. Default '%title'.","types":"string","variable":"$title","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default true.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}]},{"name":"get_boundary_post","desc":"<p>Boundary being either the first or last post by publish date within the constraints specified by $in_same_term or $excluded_terms.</p>","summary":"Retrieves the boundary post.","type":"function","category":"Posts","since":"2.8.0","param":[{"content":" Whether returned post should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Whether to retrieve first or last post. Default true","types":"bool","variable":"$start","default":"true","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"Array containing the boundary post object if successful, null otherwise.","types":"null|array"}},{"name":"get_previous_post_link","desc":"","summary":"Retrieves the previous post link that is adjacent to the current post.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":" Link anchor format. Default '« %link'.","types":"string","variable":"$format","default":"'« %link'","required":"no"},{"content":" Link permalink format. Default '%title'.","types":"string","variable":"$link","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"The link URL of the previous post in relation to the current post.","types":"string"}},{"name":"previous_post_link","desc":"","summary":"Displays the previous post link that is adjacent to the current post.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":" Link anchor format. Default '« %link'.","types":"string","variable":"$format","default":"'« %link'","required":"no"},{"content":" Link permalink format. Default '%title'.","types":"string","variable":"$link","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}]},{"name":"get_next_post_link","desc":"","summary":"Retrieves the next post link that is adjacent to the current post.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":" Link anchor format. Default '« %link'.","types":"string","variable":"$format","default":"'%link »'","required":"no"},{"content":" Link permalink format. Default '%title'.","types":"string","variable":"$link","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"The link URL of the next post in relation to the current post.","types":"string"}},{"name":"next_post_link","desc":"","summary":"Displays the next post link that is adjacent to the current post.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":" Link anchor format. Default '« %link'.","types":"string","variable":"$format","default":"'%link »'","required":"no"},{"content":" Link permalink format. Default '%title'","types":"string","variable":"$link","default":"'%title'","required":"no"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded term IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}]},{"name":"get_adjacent_post_link","desc":"<p>Can be either next post link or previous.</p>","summary":"Retrieves the adjacent post link.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":"Link anchor format.","types":"string","variable":"$format","default":"null","required":"yes"},{"content":"Link permalink format.","types":"string","variable":"$link","default":"null","required":"yes"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded terms IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Whether to display link to previous or next post. Default true.","types":"bool","variable":"$previous","default":"true","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}],"return":{"content":"The link URL of the previous or next post in relation to the current post.","types":"string"}},{"name":"adjacent_post_link","desc":"<p>Can be either next post link or previous.</p>","summary":"Displays the adjacent post link.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Link anchor format.","types":"string","variable":"$format","default":"null","required":"yes"},{"content":"Link permalink format.","types":"string","variable":"$link","default":"null","required":"yes"},{"content":" Whether link should be in a same taxonomy term. Default false.","types":"bool","variable":"$in_same_term","default":"false","required":"no"},{"content":" Array or comma-separated list of excluded category IDs. Default empty.","types":"array|string","variable":"$excluded_terms","default":"''","required":"no"},{"content":" Whether to display link to previous or next post. Default true.","types":"bool","variable":"$previous","default":"true","required":"no"},{"content":" Taxonomy, if $in_same_term is true. Default 'category'.","types":"string","variable":"$taxonomy","default":"'category'","required":"no"}]},{"name":"get_pagenum_link","desc":"","summary":"Retrieves the link for a page number.","type":"function","category":"Uncategorised","since":"1.5.0","param":[{"content":" Page number. Default 1.","types":"int","variable":"$pagenum","default":"1","required":"no"},{"content":" Whether to escape the URL for display, with esc_url(). Defaults to true. Otherwise, prepares the URL with esc_url_raw().","types":"bool","variable":"$escape","default":"true","required":"no"}],"return":{"content":"The link URL for the given page number.","types":"string"}},{"name":"get_next_posts_page_link","desc":"<p>Backported from 2.1.3 to 2.0.10.</p>","summary":"Retrieves the next posts page link.","type":"function","category":"Uncategorised","since":"2.0.10","param":[{"content":" Max pages. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"}],"return":{"content":"The link URL for next posts page.","types":"string|void"}},{"name":"next_posts","desc":"","summary":"Displays or retrieves the next posts page link.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" Max pages. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"},{"content":" Whether to echo the link. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"The link URL for next posts page if <code>$echo = false</code>.","types":"string|void"}},{"name":"get_next_posts_link","desc":"","summary":"Retrieves the next posts page link.","type":"function","category":"Posts","since":"2.7.0","param":[{"content":"Content for link text.","types":"string","variable":"$label","default":"null","required":"no"},{"content":" Max pages. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"}],"return":{"content":"HTML-formatted next posts page link.","types":"string|void"}},{"name":"next_posts_link","desc":"","summary":"Displays the next posts page link.","type":"function","category":"Posts","since":"0.71","param":[{"content":"Content for link text.","types":"string","variable":"$label","default":"null","required":"no"},{"content":" Max pages. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"}]},{"name":"get_previous_posts_page_link","desc":"<p>Will only return string, if not on a single page or post.</p> <p>Backported to 2.0.10 from 2.1.3.</p>","summary":"Retrieves the previous posts page link.","type":"function","category":"Uncategorised","since":"2.0.10","return":{"content":"The link for the previous posts page.","types":"string|void"}},{"name":"previous_posts","desc":"","summary":"Displays or retrieves the previous posts page link.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" Whether to echo the link. Default true.","types":"bool","variable":"$echo","default":"true","required":"no"}],"return":{"content":"The previous posts page link if <code>$echo = false</code>.","types":"string|void"}},{"name":"get_previous_posts_link","desc":"","summary":"Retrieves the previous posts page link.","type":"function","category":"Posts","since":"2.7.0","param":[{"content":" Previous page link text.","types":"string","variable":"$label","default":"null","required":"no"}],"return":{"content":"HTML-formatted previous page link.","types":"string|void"}},{"name":"previous_posts_link","desc":"","summary":"Displays the previous posts page link.","type":"function","category":"Posts","since":"0.71","param":[{"content":" Previous page link text.","types":"string","variable":"$label","default":"null","required":"no"}]},{"name":"get_posts_nav_link","desc":"","summary":"Retrieves the post pages link navigation for previous and next pages.","type":"function","category":"Uncategorised","since":"2.8.0","param":[{"content":"{ Optional. Arguments to build the post pages link navigation. @type string $sep Separator character. Default '—'. @type string $prelabel Link text to display for the previous page link. Default '« Previous Page'. @type string $nxtlabel Link text to display for the next page link. Default 'Next Page »'. }","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The posts link navigation.","types":"string"}},{"name":"posts_nav_link","desc":"","summary":"Displays the post pages link navigation for previous and next pages.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":" Separator for posts navigation links. Default empty.","types":"string","variable":"$sep","default":"''","required":"no"},{"content":" Label for previous pages. Default empty.","types":"string","variable":"$prelabel","default":"''","required":"no"},{"content":"Label for next pages. Default empty.","types":"string","variable":"$nxtlabel","default":"''","required":"no"}]},{"name":"get_the_post_navigation","desc":"","summary":"Retrieves the navigation to next/previous post, when applicable.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"{ Optional. Default post navigation arguments. Default empty array. @type string $prev_text Anchor text to display in the previous post link. Default '%title'. @type string $next_text Anchor text to display in the next post link. Default '%title'. @type bool $in_same_term Whether link should be in a same taxonomy term. Default false. @type array|string $excluded_terms Array or comma-separated list of excluded term IDs. Default empty. @type string $taxonomy Taxonomy, if <code>$in_same_term</code> is true. Default 'category'. @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Markup for post links.","types":"string"}},{"name":"the_post_navigation","desc":"","summary":"Displays the navigation to next/previous post, when applicable.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":" See get_the_post_navigation() for available arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"get_the_posts_navigation","desc":"","summary":"Returns the navigation to next/previous set of posts, when applicable.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":"{ Optional. Default posts navigation arguments. Default empty array. @type string $prev_text Anchor text to display in the previous posts link. Default 'Older posts'. @type string $next_text Anchor text to display in the next posts link. Default 'Newer posts'. @type string $screen_reader_text Screen reader text for nav element. Default 'Posts navigation'. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Markup for posts links.","types":"string"}},{"name":"the_posts_navigation","desc":"","summary":"Displays the navigation to next/previous set of posts, when applicable.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":" See get_the_posts_navigation() for available arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"get_the_posts_pagination","desc":"","summary":"Retrieves a paginated navigation to next/previous set of posts, when applicable.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":"{ Optional. Default pagination arguments, see paginate_links(). @type string $screen_reader_text Screen reader text for navigation element. Default 'Posts navigation'. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Markup for pagination links.","types":"string"}},{"name":"the_posts_pagination","desc":"","summary":"Displays a paginated navigation to next/previous set of posts, when applicable.","type":"function","category":"Uncategorised","since":"4.1.0","param":[{"content":" See get_the_posts_pagination() for available arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"_navigation_markup","desc":"","summary":"Wraps passed links in navigational markup.","type":"function","category":"Uncategorised","since":"4.1.0","access":"private","param":[{"content":"Navigational links.","types":"string","variable":"$links","default":"null","required":"yes"},{"content":" Custom class for nav element. Default: 'posts-navigation'.","types":"string","variable":"$class","default":"'posts-navigation'","required":"no"},{"content":" Screen reader text for nav element. Default: 'Posts navigation'.","types":"string","variable":"$screen_reader_text","default":"''","required":"no"}],"return":{"content":"Navigation template tag.","types":"string"}},{"name":"get_comments_pagenum_link","desc":"","summary":"Retrieves the comments page number link.","type":"function","category":"Uncategorised","since":"2.7.0","param":[{"content":" Page number. Default 1.","types":"int","variable":"$pagenum","default":"1","required":"no"},{"content":" The maximum number of comment pages. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"}],"return":{"content":"The comments page number link URL.","types":"string"}},{"name":"get_next_comments_link","desc":"","summary":"Retrieves the link to the next comments page.","type":"function","category":"Uncategorised","since":"2.7.1","param":[{"content":" Label for link text. Default empty.","types":"string","variable":"$label","default":"''","required":"no"},{"content":" Max page. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"}],"return":{"content":"HTML-formatted link for the next page of comments.","types":"string|void"}},{"name":"next_comments_link","desc":"","summary":"Displays the link to the next comments page.","type":"function","category":"Comments Pagination","since":"2.7.0","param":[{"content":" Label for link text. Default empty.","types":"string","variable":"$label","default":"''","required":"no"},{"content":" Max page. Default 0.","types":"int","variable":"$max_page","default":"0","required":"no"}]},{"name":"get_previous_comments_link","desc":"","summary":"Retrieves the link to the previous comments page.","type":"function","category":"Uncategorised","since":"2.7.1","param":[{"content":" Label for comments link text. Default empty.","types":"string","variable":"$label","default":"''","required":"no"}],"return":{"content":"HTML-formatted link for the previous page of comments.","types":"string|void"}},{"name":"previous_comments_link","desc":"","summary":"Displays the link to the previous comments page.","type":"function","category":"Comments Pagination","since":"2.7.0","param":[{"content":" Label for comments link text. Default empty.","types":"string","variable":"$label","default":"''","required":"no"}]},{"name":"paginate_comments_links","desc":"","summary":"Displays or retrieves pagination links for the comments on the current post.","type":"function","category":"Comments Pagination","since":"2.7.0","param":[{"content":"args. See paginate_links(). Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Markup for comment page links or array of comment page links.","types":"string|array|void"}},{"name":"get_the_comments_navigation","desc":"","summary":"Retrieves navigation to next/previous set of comments, when applicable.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"{ Optional. Default comments navigation arguments. @type string $prev_text Anchor text to display in the previous comments link. Default 'Older comments'. @type string $next_text Anchor text to display in the next comments link. Default 'Newer comments'. @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Markup for comments links.","types":"string"}},{"name":"the_comments_navigation","desc":"","summary":"Displays navigation to next/previous set of comments, when applicable.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"See get_the_comments_navigation() for available arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"get_the_comments_pagination","desc":"","summary":"Retrieves a paginated navigation to next/previous set of comments, when applicable.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"{ Optional. Default pagination arguments. @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Markup for pagination links.","types":"string"}},{"name":"the_comments_pagination","desc":"","summary":"Displays a paginated navigation to next/previous set of comments, when applicable.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"See get_the_comments_pagination() for available arguments. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"home_url","desc":"<p>Returns the 'home' option with the appropriate protocol. The protocol will be 'https' if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. If <code>$scheme</code> is 'http' or 'https', is_ssl() is overridden.</p>","summary":"Retrieves the URL for the current site where the front end is accessible.","type":"function","category":"Miscellaneous","since":"3.0.0","param":[{"content":" Path relative to the home URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null. Default null.","types":"string|null","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Home URL link with optional path appended.","types":"string"}},{"name":"get_home_url","desc":"<p>Returns the 'home' option with the appropriate protocol. The protocol will be 'https' if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. If <code>$scheme</code> is 'http' or 'https', is_ssl() is overridden.</p>","summary":"Retrieves the URL for a given site where the front end is accessible.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":" Site ID. Default null (current site).","types":"int","variable":"$blog_id","default":"null","required":"no"},{"content":" Path relative to the home URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null. Default null.","types":"string|null","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Home URL link with optional path appended.","types":"string"}},{"name":"site_url","desc":"<p>Returns the 'site_url' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.</p>","summary":"Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.","type":"function","category":"Miscellaneous","since":"3.0.0","param":[{"content":" Path relative to the site URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the site URL context. See set_url_scheme().","types":"string","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Site URL link with optional path appended.","types":"string"}},{"name":"get_site_url","desc":"<p>Returns the 'site_url' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If <code>$scheme</code> is 'http' or 'https', <code>is_ssl()</code> is overridden.</p>","summary":"Retrieves the URL for a given site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.","type":"function","category":"Options","since":"3.0.0","param":[{"content":" Site ID. Default null (current site).","types":"int","variable":"$blog_id","default":"null","required":"no"},{"content":" Path relative to the site URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the site URL context. Accepts 'http', 'https', 'login', 'login_post', 'admin', or 'relative'. Default null.","types":"string","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Site URL link with optional path appended.","types":"string"}},{"name":"admin_url","desc":"","summary":"Retrieves the URL to the admin area for the current site.","type":"function","category":"Miscellaneous","since":"2.6.0","param":[{"content":"path relative to the admin URL.","types":"string","variable":"$path","default":"''","required":"no"},{"content":"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.","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Admin URL link with optional path appended.","types":"string"}},{"name":"get_admin_url","desc":"","summary":"Retrieves the URL to the admin area for a given site.","type":"function","category":"Options","since":"3.0.0","param":[{"content":" Site ID. Default null (current site).","types":"int","variable":"$blog_id","default":"null","required":"no"},{"content":" Path relative to the admin URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" The scheme to use. Accepts 'http' or 'https', to force those schemes. Default 'admin', which obeys force_ssl_admin() and is_ssl().","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Admin URL link with optional path appended.","types":"string"}},{"name":"includes_url","desc":"","summary":"Retrieves the URL to the includes directory.","type":"function","category":"Miscellaneous","since":"2.6.0","param":[{"content":" Path relative to the includes URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the includes URL context. Accepts 'http', 'https', or 'relative'. Default null.","types":"string","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Includes URL link with optional path appended.","types":"string"}},{"name":"content_url","desc":"","summary":"Retrieves the URL to the content directory.","type":"function","category":"Miscellaneous","since":"2.6.0","param":[{"content":" Path relative to the content URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"}],"return":{"content":"Content URL link with optional path appended.","types":"string"}},{"name":"plugins_url","desc":"<p>Defaults to the plugins directory URL if no arguments are supplied.</p>","summary":"Retrieves a URL within the plugins or mu-plugins directory.","type":"function","category":"Plugins","since":"2.6.0","param":[{"content":" Extra path appended to the end of the URL, including the relative directory if $plugin is supplied. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" A full path to a file inside a plugin or mu-plugin. The URL will be relative to its directory. Default empty. Typically this is done by passing <code>__FILE__</code> as the argument.","types":"string","variable":"$plugin","default":"''","required":"no"}],"return":{"content":"Plugins URL link with optional paths appended.","types":"string"}},{"name":"network_site_url","desc":"<p>Returns the site URL with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.</p>","summary":"Retrieves the site URL for the current network.","type":"function","category":"Miscellaneous","since":"3.0.0","param":[{"content":" Path relative to the site URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the site URL context. Accepts 'http', 'https', or 'relative'. Default null.","types":"string","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Site URL link with optional path appended.","types":"string"}},{"name":"network_home_url","desc":"<p>Returns the home URL with the appropriate protocol, 'https' is_ssl() and 'http' otherwise. If <code>$scheme</code> is 'http' or 'https', <code>is_ssl()</code> is overridden.</p>","summary":"Retrieves the home URL for the current network.","type":"function","category":"Miscellaneous","since":"3.0.0","param":[{"content":" Path relative to the home URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" Scheme to give the home URL context. Accepts 'http', 'https', or 'relative'. Default null.","types":"string","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"Home URL link with optional path appended.","types":"string"}},{"name":"network_admin_url","desc":"","summary":"Retrieves the URL to the admin area for the network.","type":"function","category":"Miscellaneous","since":"3.0.0","param":[{"content":"path relative to the admin URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" 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.","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Admin URL link with optional path appended.","types":"string"}},{"name":"user_admin_url","desc":"","summary":"Retrieves the URL to the admin area for the current user.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":" Path relative to the admin URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" 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.","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Admin URL link with optional path appended.","types":"string"}},{"name":"self_admin_url","desc":"","summary":"Retrieves the URL to the admin area for either the current site or the network depending on context.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":" Path relative to the admin URL. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":" 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.","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Admin URL link with optional path appended.","types":"string"}},{"name":"set_url_scheme","desc":"","summary":"Sets the scheme for a URL.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Absolute URL that includes a scheme","types":"string","variable":"$url","default":"null","required":"yes"},{"content":" Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null.","types":"string|null","variable":"$scheme","default":"null","required":"no"}],"return":{"content":"$url URL with chosen scheme.","types":"string"}},{"name":"get_dashboard_url","desc":"<p>If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site, the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's primary site is returned.</p>","summary":"Retrieves the URL to the user's dashboard.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":" User ID. Defaults to current user.","types":"int","variable":"$user_id","default":"0","required":"no"},{"content":"path relative to the dashboard. Use only paths known to both site and user admins. Default empty.","types":"string","variable":"$path","default":"''","required":"no"},{"content":"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.","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Dashboard URL link with optional path appended.","types":"string"}},{"name":"get_edit_profile_url","desc":"","summary":"Retrieves the URL to the user's profile editor.","type":"function","category":"Uncategorised","since":"3.1.0","param":[{"content":" User ID. Defaults to current user.","types":"int","variable":"$user_id","default":"0","required":"no"},{"content":" 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.","types":"string","variable":"$scheme","default":"'admin'","required":"no"}],"return":{"content":"Dashboard URL link with optional path appended.","types":"string"}},{"name":"wp_get_canonical_url","desc":"<p>When the post is the same as the current requested page the function will handle the pagination arguments too.</p>","summary":"Returns the canonical URL for a post.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Post ID or object. Default is global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"null","required":"no"}],"return":{"content":"The canonical URL, or false if the post does not exist or has not been published yet.","types":"string|false"}},{"name":"rel_canonical","desc":"","summary":"Outputs rel=canonical for singular queries.","type":"function","category":"Uncategorised","since":"4.6.0"},{"name":"wp_get_shortlink","desc":"<p>This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts. Plugins can short-circuit this function via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} filter.</p>","summary":"Returns a shortlink for a post, page, attachment, or site.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":" A post or site id. Default is 0, which means the current post or site.","types":"int","variable":"$id","default":"0","required":"no"},{"content":" Whether the id is a 'site' 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 'post'.","types":"string","variable":"$context","default":"'post'","required":"no"},{"content":" Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this. Default true.","types":"bool","variable":"$allow_slugs","default":"true","required":"no"}],"return":{"content":"A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.","types":"string"}},{"name":"wp_shortlink_wp_head","desc":"<p>Attached to the {@see 'wp_head'} action.</p>","summary":"Injects rel=shortlink into the head if a shortlink is defined for the current page.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_shortlink_header","desc":"<p>Attached to the {@see 'wp'} action.</p>","summary":"Sends a Link: rel=shortlink header if a shortlink is defined for the current page.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"the_shortlink","desc":"<p>Must be called from inside "The Loop"</p> <p>Call like the_shortlink( __( 'Shortlinkage FTW' ) )</p>","summary":"Displays the shortlink for a post.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"The link text or HTML to be displayed. Defaults to 'This is the short link.'","types":"string","variable":"$text","default":"''","required":"no"},{"content":"The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.","types":"string","variable":"$title","default":"''","required":"no"},{"content":"HTML to display before the link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":"HTML to display after the link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"get_avatar_url","desc":"","summary":"Retrieves the avatar URL.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.","types":"mixed","variable":"$id_or_email","default":"null","required":"yes"},{"content":"{ Optional. Arguments to return instead of the default arguments. @type int $size Height and width of the avatar in pixels. Default 96. @type string $default URL for the default image or a default type. Accepts '404' (return a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or 'gravatar_default' (the Gravatar logo). Default is the value of the 'avatar_default' option, with a fallback of 'mystery'. @type bool $force_default Whether to always show the default image, never the Gravatar. Default false. @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are judged in that order. Default is the value of the 'avatar_rating' option. @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. Default null. @type array $processed_args When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference. Default null. }","types":"array","variable":"$args","default":"null","required":"no"}],"return":{"content":"The URL of the avatar we found, or false if we couldn't find an avatar.","types":"false|string"}},{"name":"is_avatar_comment_type","desc":"","summary":"Check if this comment type allows avatars to be retrieved.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Comment type to check.","types":"string","variable":"$comment_type","default":"null","required":"yes"}],"return":{"content":"Whether the comment type is allowed for retrieving avatars.","types":"bool"}},{"name":"get_avatar_data","desc":"","summary":"Retrieves default data about the avatar.","type":"function","category":"Uncategorised","since":"4.2.0","param":[{"content":"The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.","types":"mixed","variable":"$id_or_email","default":"null","required":"yes"},{"content":"{ Optional. Arguments to return instead of the default arguments. @type int $size Height and width of the avatar image file in pixels. Default 96. @type int $height Display height of the avatar in pixels. Defaults to $size. @type int $width Display width of the avatar in pixels. Defaults to $size. @type string $default URL for the default image or a default type. Accepts '404' (return a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or 'gravatar_default' (the Gravatar logo). Default is the value of the 'avatar_default' option, with a fallback of 'mystery'. @type bool $force_default Whether to always show the default image, never the Gravatar. Default false. @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are judged in that order. Default is the value of the 'avatar_rating' option. @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. Default null. @type array $processed_args When the function returns, the value will be the processed/sanitized $args plus a "found_avatar" guess. Pass as a reference. Default null. @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty. }","types":"array","variable":"$args","default":"null","required":"no"}],"return":{"content":"$processed_args { Along with the arguments passed in <code>$args</code>, this will contain a couple of extra arguments. @type bool $found_avatar True if we were able to find an avatar for this user, false or not set if we couldn't. @type string $url The URL of the avatar we found. }","types":"array"}},{"name":"get_theme_file_uri","desc":"<p>Searches in the stylesheet directory before the template directory so themes which inherit from a parent theme can just override one file.</p>","summary":"Retrieves the URL of a file in the theme.","type":"function","category":"Other functions","since":"4.7.0","param":[{"content":" File to search for in the stylesheet directory.","types":"string","variable":"$file","default":"''","required":"no"}],"return":{"content":"The URL of the file.","types":"string"}},{"name":"get_parent_theme_file_uri","desc":"","summary":"Retrieves the URL of a file in the parent theme.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":" File to return the URL for in the template directory.","types":"string","variable":"$file","default":"''","required":"no"}],"return":{"content":"The URL of the file.","types":"string"}},{"name":"get_theme_file_path","desc":"<p>Searches in the stylesheet directory before the template directory so themes which inherit from a parent theme can just override one file.</p>","summary":"Retrieves the path of a file in the theme.","type":"function","category":"Other functions","since":"4.7.0","param":[{"content":" File to search for in the stylesheet directory.","types":"string","variable":"$file","default":"''","required":"no"}],"return":{"content":"The path of the file.","types":"string"}},{"name":"get_parent_theme_file_path","desc":"","summary":"Retrieves the path of a file in the parent theme.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":" File to return the path for in the template directory.","types":"string","variable":"$file","default":"''","required":"no"}],"return":{"content":"The path of the file.","types":"string"}},{"name":"get_privacy_policy_url","desc":"","summary":"Retrieves the URL to the privacy policy page.","type":"function","category":"Uncategorised","since":"4.9.6","return":{"content":"The URL to the privacy policy page. Empty string if it doesn't exist.","types":"string"}},{"name":"the_privacy_policy_link","desc":"","summary":"Displays the privacy policy link with formatting, when applicable.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":" Display before privacy policy link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after privacy policy link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}]},{"name":"get_the_privacy_policy_link","desc":"","summary":"Returns the privacy policy link with formatting, when applicable.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":" Display before privacy policy link. Default empty.","types":"string","variable":"$before","default":"''","required":"no"},{"content":" Display after privacy policy link. Default empty.","types":"string","variable":"$after","default":"''","required":"no"}],"return":{"content":"Markup for the link and surrounding elements. Empty string if it doesn't exist.","types":"string"}},{"name":"wp_get_server_protocol","desc":"","summary":"Return the HTTP protocol sent by the server.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"The HTTP protocol. Default: HTTP/1.0.","types":"string"}},{"name":"wp_unregister_GLOBALS","desc":"","summary":"Turn register globals off.","type":"function","category":"Uncategorised","since":"2.1.0","access":"private"},{"name":"wp_fix_server_vars","desc":"","summary":"Fix `$_SERVER` variables for various setups.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"wp_check_php_mysql_versions","desc":"<p>Dies if requirements are not met.</p>","summary":"Check for the required PHP version, and the MySQL extension or a database drop-in.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"wp_favicon_request","desc":"<p>Instead, send the headers for a zero-length favicon and bail.</p>","summary":"Don't load all of WordPress when handling a favicon.ico request.","type":"function","category":"Uncategorised","since":"3.0.0"},{"name":"wp_maintenance","desc":"<p>Checks for a file in the WordPress root directory named ".maintenance". This file will contain the variable $upgrading, set to the time the file was created. If the file was created less than 10 minutes ago, WordPress enters maintenance mode and displays a message.</p> <p>The default message can be replaced by using a drop-in (maintenance.php in the wp-content directory).</p>","summary":"Die with a maintenance message when conditions are met.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"timer_start","desc":"","summary":"Start the WordPress micro-timer.","type":"function","category":"Uncategorised","since":"0.71","access":"private","return":{"content":"Always returns true.","types":"bool"}},{"name":"timer_stop","desc":"","summary":"Retrieve or display the time from the page start to when function is called.","type":"function","category":"Uncategorised","since":"0.71","param":[{"content":"Whether to echo or return the results. Accepts 0|false for return, 1|true for echo. Default 0|false.","types":"int|bool","variable":"$display","default":"0","required":"yes"},{"content":"The number of digits from the right of the decimal to display. Default 3.","types":"int","variable":"$precision","default":"3","required":"no"}],"return":{"content":"The "second.microsecond" finished time calculation. The number is formatted for human consumption, both localized and rounded.","types":"string"}},{"name":"wp_debug_mode","desc":"<p>Uses three constants: <code>WP_DEBUG</code>, <code>WP_DEBUG_DISPLAY</code>, and <code>WP_DEBUG_LOG</code>. All three can be defined in wp-config.php. By default, <code>WP_DEBUG</code> and <code>WP_DEBUG_LOG</code> are set to false, and <code>WP_DEBUG_DISPLAY</code> is set to true.</p> <p>When <code>WP_DEBUG</code> is true, all PHP notices are reported. WordPress will also display internal notices: when a deprecated WordPress function, function argument, or file is used. Deprecated code may be removed from a later version.</p> <p>It is strongly recommended that plugin and theme developers use <code>WP_DEBUG</code> in their development environments.</p> <p><code>WP_DEBUG_DISPLAY</code> and <code>WP_DEBUG_LOG</code> perform no function unless <code>WP_DEBUG</code> is true.</p> <p>When <code>WP_DEBUG_DISPLAY</code> is true, WordPress will force errors to be displayed. <code>WP_DEBUG_DISPLAY</code> defaults to true. Defining it as null prevents WordPress from changing the global configuration setting. Defining <code>WP_DEBUG_DISPLAY</code> as false will force errors to be hidden.</p> <p>When <code>WP_DEBUG_LOG</code> is true, errors will be logged to <code>wp-content/debug.log</code>. When <code>WP_DEBUG_LOG</code> is a valid path, errors will be logged to the specified file.</p> <p>Errors are never displayed for XML-RPC, REST, and Ajax requests.</p>","summary":"Set PHP error reporting based on WordPress debug settings.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private"},{"name":"wp_set_lang_dir","desc":"<p>To set directory manually, define the <code>WP_LANG_DIR</code> constant in wp-config.php.</p> <p>If the language directory exists within <code>WP_CONTENT_DIR</code>, it is used. Otherwise the language directory is assumed to live in <code>WPINC</code>.</p>","summary":"Set the location of the language directory.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"require_wp_db","desc":"","summary":"Load the database class file and instantiate the `$wpdb` global.","type":"function","category":"Uncategorised","since":"2.5.0"},{"name":"wp_set_wpdb_vars","desc":"<p>Columns not listed here default to <code>%s</code>.</p>","summary":"Set the database table prefix and the format specifiers for database table columns.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"wp_using_ext_object_cache","desc":"","summary":"Toggle `$_wp_using_ext_object_cache` on and off without directly touching global.","type":"function","category":"Uncategorised","since":"3.7.0","param":[{"content":"Whether external object cache is being used.","types":"bool","variable":"$using","default":"null","required":"no"}],"return":{"content":"The current 'using' setting.","types":"bool"}},{"name":"wp_start_object_cache","desc":"<p>If an object-cache.php file exists in the wp-content directory, it uses that drop-in as an external object cache.</p>","summary":"Start the WordPress object cache.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"wp_not_installed","desc":"<p>Dies with an error message when Multisite is enabled.</p>","summary":"Redirect to the installer if WordPress is not installed.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"wp_get_mu_plugins","desc":"<p>The default directory is wp-content/mu-plugins. To change the default directory manually, define <code>WPMU_PLUGIN_DIR</code> and <code>WPMU_PLUGIN_URL</code> in wp-config.php.</p>","summary":"Retrieve an array of must-use plugin files.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private","return":{"content":"Files to include.","types":"array"}},{"name":"wp_get_active_and_valid_plugins","desc":"<p>While upgrading or installing WordPress, no plugins are returned.</p> <p>The default directory is <code>wp-content/plugins</code>. To change the default directory manually, define <code>WP_PLUGIN_DIR</code> and <code>WP_PLUGIN_URL</code> in <code>wp-config.php</code>.</p>","summary":"Retrieve an array of active and valid plugin files.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private","return":{"content":"$plugin_file Array of paths to plugin files relative to the plugins directory.","types":"string[]"}},{"name":"wp_skip_paused_plugins","desc":"","summary":"Filters a given list of plugins, removing any paused plugins from it.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"List of absolute plugin main file paths.","types":"array","variable":"$plugins","default":"null","required":"yes"}],"return":{"content":"Filtered value of $plugins, without any paused plugins.","types":"array"}},{"name":"wp_get_active_and_valid_themes","desc":"<p>While upgrading or installing WordPress, no themes are returned.</p>","summary":"Retrieves an array of active and valid themes.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","return":{"content":"Array of paths to theme directories.","types":"array"}},{"name":"wp_skip_paused_themes","desc":"","summary":"Filters a given list of themes, removing any paused themes from it.","type":"function","category":"Uncategorised","since":"5.2.0","param":[{"content":"List of absolute theme directory paths.","types":"array","variable":"$themes","default":"null","required":"yes"}],"return":{"content":"Filtered value of $themes, without any paused themes.","types":"array"}},{"name":"wp_is_recovery_mode","desc":"<p>In this mode, plugins or themes that cause WSODs will be paused.</p>","summary":"Is WordPress in Recovery Mode.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"","types":"bool"}},{"name":"is_protected_endpoint","desc":"","summary":"Determines whether we are currently on an endpoint that should be protected against WSODs.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"True if the current endpoint should be protected.","types":"bool"}},{"name":"is_protected_ajax_action","desc":"","summary":"Determines whether we are currently handling an AJAX action that should be protected against WSODs.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"True if the current AJAX action should be protected.","types":"bool"}},{"name":"wp_set_internal_encoding","desc":"<p>In most cases the default internal encoding is latin1, which is of no use, since we want to use the <code>mb_</code> functions for <code>utf-8</code> strings.</p>","summary":"Set internal encoding.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"wp_magic_quotes","desc":"<p>Also forces <code>$_REQUEST</code> to be <code>$_GET + $_POST</code>. If <code>$_SERVER</code>, <code>$_COOKIE</code>, or <code>$_ENV</code> are needed, use those superglobals directly.</p>","summary":"Add magic quotes to `$_GET`, `$_POST`, `$_COOKIE`, and `$_SERVER`.","type":"function","category":"Uncategorised","since":"3.0.0","access":"private"},{"name":"shutdown_action_hook","desc":"","summary":"Runs just before PHP shuts down execution.","type":"function","category":"Uncategorised","since":"1.2.0","access":"private"},{"name":"wp_clone","desc":"","summary":"Copy an object.","type":"function","category":"Uncategorised","since":"2.7.0","deprecated":{"content":"3.2.0","desc":"null"},"param":[{"content":"The object to clone.","types":"object","variable":"$object","default":"null","required":"yes"}],"return":{"content":"The cloned object.","types":"object"}},{"name":"is_admin","desc":"<p>Does not check if the user is an administrator; use current_user_can() for checking roles and capabilities.</p> <p>For more information on this and similar theme functions, check out the {@link <a href=\"https://developer.wordpress.org/themes/basics/conditional-tags/\">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags} article in the Theme Developer Handbook.</p>","summary":"Determines whether the current request is for an administrative interface page.","type":"function","category":"Conditional Tags Index","since":"1.5.1","return":{"content":"True if inside WordPress administration interface, false otherwise.","types":"bool"}},{"name":"is_blog_admin","desc":"<p>e.g. <code>/wp-admin/</code></p> <p>Does not check if the user is an administrator; use current_user_can() for checking roles and capabilities.</p>","summary":"Whether the current request is for a site's admininstrative interface.","type":"function","category":"Uncategorised","since":"3.1.0","return":{"content":"True if inside WordPress blog administration pages.","types":"bool"}},{"name":"is_network_admin","desc":"<p>e.g. <code>/wp-admin/network/</code></p> <p>Does not check if the user is an administrator; use current_user_can() for checking roles and capabilities.</p>","summary":"Whether the current request is for the network administrative interface.","type":"function","category":"Uncategorised","since":"3.1.0","return":{"content":"True if inside WordPress network administration pages.","types":"bool"}},{"name":"is_user_admin","desc":"<p>e.g. <code>/wp-admin/user/</code></p> <p>Does not check if the user is an administrator; use current_user_can() for checking roles and capabilities.</p>","summary":"Whether the current request is for a user admin screen.","type":"function","category":"Uncategorised","since":"3.1.0","return":{"content":"True if inside WordPress user administration pages.","types":"bool"}},{"name":"is_multisite","desc":"","summary":"If Multisite is enabled.","type":"function","category":"Miscellaneous","since":"3.0.0","return":{"content":"True if Multisite is enabled, false otherwise.","types":"bool"}},{"name":"get_current_blog_id","desc":"","summary":"Retrieve the current site ID.","type":"function","category":"Uncategorised","since":"3.1.0","return":{"content":"Site ID.","types":"int"}},{"name":"get_current_network_id","desc":"","summary":"Retrieves the current network ID.","type":"function","category":"Uncategorised","since":"4.6.0","return":{"content":"The ID of the current network.","types":"int"}},{"name":"wp_load_translations_early","desc":"<p>Used for errors encountered during the initial loading process, before the locale has been properly detected and loaded.</p> <p>Designed for unusual load sequences (like setup-config.php) or for when the script will then terminate with an error, otherwise there is a risk that a file can be double-included.</p>","summary":"Attempt an early load of translations.","type":"function","category":"Uncategorised","since":"3.4.0","access":"private"},{"name":"wp_installing","desc":"<p>If the <code>WP_INSTALLING</code> constant is defined during the bootstrap, <code>wp_installing()</code> will default to <code>true</code>.</p>","summary":"Check or set whether WordPress is in \"installation\" mode.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":" True to set WP into Installing mode, false to turn Installing mode off. Omit this parameter if you only want to fetch the current status.","types":"bool","variable":"$is_installing","default":"null","required":"no"}],"return":{"content":"True if WP is installing, otherwise false. When a <code>$is_installing</code> is passed, the function will report whether WP was in installing mode prior to the change to <code>$is_installing</code>.","types":"bool"}},{"name":"is_ssl","desc":"","summary":"Determines if SSL is used.","type":"function","category":"Miscellaneous","since":"4.6.0","return":{"content":"True if SSL, otherwise false.","types":"bool"}},{"name":"wp_convert_hr_to_bytes","desc":"","summary":"Converts a shorthand byte value to an integer byte value.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"A (PHP ini) byte value, either shorthand or ordinary.","types":"string","variable":"$value","default":"null","required":"yes"}],"return":{"content":"An integer byte value.","types":"int"}},{"name":"wp_is_ini_value_changeable","desc":"","summary":"Determines whether a PHP ini value is changeable at runtime.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"The name of the ini setting to check.","types":"string","variable":"$setting","default":"null","required":"yes"}],"return":{"content":"True if the value is changeable at runtime. False otherwise.","types":"bool"}},{"name":"wp_doing_ajax","desc":"","summary":"Determines whether the current request is a WordPress Ajax request.","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"True if it's a WordPress Ajax request, false otherwise.","types":"bool"}},{"name":"wp_using_themes","desc":"","summary":"Determines whether the current request should use themes.","type":"function","category":"Uncategorised","since":"5.1.0","return":{"content":"True if themes should be used, false otherwise.","types":"bool"}},{"name":"wp_doing_cron","desc":"","summary":"Determines whether the current request is a WordPress cron request.","type":"function","category":"Uncategorised","since":"4.8.0","return":{"content":"True if it's a WordPress cron request, false otherwise.","types":"bool"}},{"name":"is_wp_error","desc":"<p>Returns true if $thing is an object of the WP_Error class.</p>","summary":"Check whether variable is a WordPress Error.","type":"function","category":"Miscellaneous","since":"2.1.0","param":[{"content":"Check if unknown variable is a WP_Error object.","types":"mixed","variable":"$thing","default":"null","required":"yes"}],"return":{"content":"True, if WP_Error. False, if not WP_Error.","types":"bool"}},{"name":"wp_is_file_mod_allowed","desc":"","summary":"Determines whether file modifications are allowed.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"The usage context.","types":"string","variable":"$context","default":"null","required":"yes"}],"return":{"content":"True if file modification is allowed, false otherwise.","types":"bool"}},{"name":"wp_start_scraping_edited_file_errors","desc":"","summary":"Start scraping edited file errors.","type":"function","category":"Uncategorised","since":"4.9.0"},{"name":"wp_finalize_scraping_edited_file_errors","desc":"","summary":"Finalize scraping for edited file errors.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"Scrape key.","types":"string","variable":"$scrape_key","default":"null","required":"yes"}]},{"name":"wp_is_json_request","desc":"","summary":"Checks whether current request is a JSON request, or is expecting a JSON response.","type":"function","category":"Uncategorised","since":"5.0.0","return":{"content":"True if Accepts or Content-Type headers contain application/json, false otherwise.","types":"bool"}},{"name":"wp_is_jsonp_request","desc":"","summary":"Checks whether current request is a JSONP request, or is expecting a JSONP response.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"True if JSONP request, false otherwise.","types":"bool"}},{"name":"wp_is_xml_request","desc":"","summary":"Checks whether current request is an XML request, or is expecting an XML response.","type":"function","category":"Uncategorised","since":"5.2.0","return":{"content":"True if Accepts or Content-Type headers contain xml, false otherwise.","types":"bool"}},{"name":"wp_underscore_audio_template","desc":"","summary":"Output the markup for a audio tag to be used in an Underscore template when data.model is passed.","type":"function","category":"Uncategorised","since":"3.9.0"},{"name":"wp_underscore_video_template","desc":"","summary":"Output the markup for a video tag to be used in an Underscore template when data.model is passed.","type":"function","category":"Uncategorised","since":"3.9.0"},{"name":"wp_print_media_templates","desc":"","summary":"Prints the templates used in the media manager.","type":"function","category":"Uncategorised","since":"3.5.0"},{"name":"wp_get_additional_image_sizes","desc":"","summary":"Retrieve additional image sizes.","type":"function","category":"Uncategorised","since":"4.7.0","return":{"content":"Additional images size data.","types":"array"}},{"name":"image_constrain_size_for_editor","desc":"<p>This is so that the image is a better fit for the editor and theme.</p> <p>The <code>$size</code> parameter accepts either an array or a string. The supported string values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at 128 width and 96 height in pixels. Also supported for the string value is 'medium', 'medium_large' and 'full'. The 'full' isn't actually supported, but any value other than the supported will result in the content_width size or 500 if that is not set.</p> <p>Finally, there is a filter named {@see 'editor_max_image_size'}, that will be called on the calculated array for width and height, respectively. The second parameter will be the value that was in the $size parameter. The returned type for the hook is an array with the width as the first element and the height as the second element.</p>","summary":"Scale down the default size of an image.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Width of the image in pixels.","types":"int","variable":"$width","default":"null","required":"yes"},{"content":"Height of the image in pixels.","types":"int","variable":"$height","default":"null","required":"yes"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.","types":"string|array","variable":"$size","default":"'medium'","required":"no"},{"content":" Could be 'display' (like in a theme) or 'edit' (like inserting into an editor). Default null.","types":"string","variable":"$context","default":"null","required":"no"}],"return":{"content":"Width and height of what the result image should resize to.","types":"array"}},{"name":"image_hwstring","desc":"<p>Both attributes are required in the sense that both parameters must have a value, but are optional in that if you set them to false or null, then they will not be added to the returned string.</p> <p>You can set the value using a string, but it will only take numeric values. If you wish to put 'px' after the numbers, then it will be stripped out of the return.</p>","summary":"Retrieve width and height attributes using given width and height values.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Image width in pixels.","types":"int|string","variable":"$width","default":"null","required":"yes"},{"content":"Image height in pixels.","types":"int|string","variable":"$height","default":"null","required":"yes"}],"return":{"content":"HTML attributes for width and, or height.","types":"string"}},{"name":"image_downsize","desc":"<p>Array with image url, width, height, and whether is intermediate size, in that order is returned on success is returned. $is_intermediate is true if $url is a resized image, false if it is the original.</p> <p>The URL might be the original image, or it might be a resized version. This function won't create a new resized copy, it will just return an already resized one if it exists.</p> <p>A plugin may use the {@see 'image_downsize'} filter to hook into and offer image resizing services for images. The hook must return an array with the same elements that are returned in the function. The first element being the URL to the new image that was resized.</p>","summary":"Scale an image to fit a particular size (such as 'thumb' or 'medium').","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Attachment ID for image.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":" Image size to scale to. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.","types":"array|string","variable":"$size","default":"'medium'","required":"no"}],"return":{"content":"Array containing the image URL, width, height, and boolean for whether the image is an intermediate size. False on failure.","types":"false|array"}},{"name":"add_image_size","desc":"<p>Cropping behavior for the image size is dependent on the value of $crop:</p> <ol> <li>If false (default), images will be scaled, not cropped.</li> <li>If an array in the form of array( x_crop_position, y_crop_position ): <ul> <li>x_crop_position accepts 'left' 'center', or 'right'.</li> <li>y_crop_position accepts 'top', 'center', or 'bottom'. Images will be cropped to the specified dimensions within the defined crop area.</li> </ul></li> <li>If true, images will be cropped to the specified dimensions using center positions.</li> </ol>","summary":"Register a new image size.","type":"function","category":"Other functions","since":"2.9.0","param":[{"content":"Image size identifier.","types":"string","variable":"$name","default":"null","required":"yes"},{"content":" Image width in pixels. Default 0.","types":"int","variable":"$width","default":"0","required":"no"},{"content":" Image height in pixels. Default 0.","types":"int","variable":"$height","default":"0","required":"no"},{"content":" Whether to crop images to specified width and height or resize. An array can specify positioning of the crop area. Default false.","types":"bool|array","variable":"$crop","default":"false","required":"no"}]},{"name":"has_image_size","desc":"","summary":"Check if an image size exists.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"The image size to check.","types":"string","variable":"$name","default":"null","required":"yes"}],"return":{"content":"True if the image size exists, false if not.","types":"bool"}},{"name":"remove_image_size","desc":"","summary":"Remove a new image size.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"The image size to remove.","types":"string","variable":"$name","default":"null","required":"yes"}],"return":{"content":"True if the image size was successfully removed, false on failure.","types":"bool"}},{"name":"set_post_thumbnail_size","desc":"","summary":"Registers an image size for the post thumbnail.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Image width in pixels.","types":"int","variable":"$width","default":"0","required":"yes"},{"content":"Image height in pixels.","types":"int","variable":"$height","default":"0","required":"yes"},{"content":" Whether to crop images to specified width and height or resize. An array can specify positioning of the crop area. Default false.","types":"bool|array","variable":"$crop","default":"false","required":"no"}]},{"name":"get_image_tag","desc":"<p>The {@see 'get_image_tag_class'} filter allows for changing the class name for the image without having to use regular expressions on the HTML content. The parameters are: what WordPress will use for the class, the Attachment ID, image align value, and the size the image should be.</p> <p>The second filter, {@see 'get_image_tag'}, has the HTML content, which can then be further manipulated by a plugin to change all attribute values and even HTML content.</p>","summary":"Gets an img tag for an image attachment, scaling it down if requested.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Attachment ID.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"Image Description for the alt attribute.","types":"string","variable":"$alt","default":"null","required":"yes"},{"content":"Image Description for the title attribute.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":"Part of the class name for aligning the image.","types":"string","variable":"$align","default":"null","required":"yes"},{"content":" Registered image size to retrieve a tag for. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.","types":"string|array","variable":"$size","default":"'medium'","required":"no"}],"return":{"content":"HTML IMG element for given image attachment","types":"string"}},{"name":"wp_constrain_dimensions","desc":"<p>If either width or height are empty, no constraint is applied on that dimension.</p>","summary":"Calculates the new dimensions for a down-sampled image.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Current width of the image.","types":"int","variable":"$current_width","default":"null","required":"yes"},{"content":"Current height of the image.","types":"int","variable":"$current_height","default":"null","required":"yes"},{"content":" Max width in pixels to constrain to. Default 0.","types":"int","variable":"$max_width","default":"0","required":"no"},{"content":" Max height in pixels to constrain to. Default 0.","types":"int","variable":"$max_height","default":"0","required":"no"}],"return":{"content":"First item is the width, the second item is the height.","types":"array"}},{"name":"image_resize_dimensions","desc":"<p>Calculates dimensions and coordinates for a resized image that fits within a specified width and height.</p> <p>Cropping behavior is dependent on the value of $crop:</p> <ol> <li>If false (default), images will not be cropped.</li> <li>If an array in the form of array( x_crop_position, y_crop_position ): <ul> <li>x_crop_position accepts 'left' 'center', or 'right'.</li> <li>y_crop_position accepts 'top', 'center', or 'bottom'. Images will be cropped to the specified dimensions within the defined crop area.</li> </ul></li> <li>If true, images will be cropped to the specified dimensions using center positions.</li> </ol>","summary":"Retrieves calculated resize dimensions for use in WP_Image_Editor.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Original width in pixels.","types":"int","variable":"$orig_w","default":"null","required":"yes"},{"content":"Original height in pixels.","types":"int","variable":"$orig_h","default":"null","required":"yes"},{"content":"New width in pixels.","types":"int","variable":"$dest_w","default":"null","required":"yes"},{"content":"New height in pixels.","types":"int","variable":"$dest_h","default":"null","required":"yes"},{"content":" Whether to crop image to specified width and height or resize. An array can specify positioning of the crop area. Default false.","types":"bool|array","variable":"$crop","default":"false","required":"no"}],"return":{"content":"False on failure. Returned array matches parameters for <code>imagecopyresampled()</code>.","types":"false|array"}},{"name":"image_make_intermediate_size","desc":"<p>The returned array has the file size, the image width, and image height. The {@see 'image_make_intermediate_size'} filter can be used to hook in and change the values of the returned array. The only parameter is the resized file path.</p>","summary":"Resizes an image to make a thumbnail or intermediate size.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"File path.","types":"string","variable":"$file","default":"null","required":"yes"},{"content":"Image width.","types":"int","variable":"$width","default":"null","required":"yes"},{"content":"Image height.","types":"int","variable":"$height","default":"null","required":"yes"},{"content":" Whether to crop image to specified width and height or resize. Default false.","types":"bool","variable":"$crop","default":"false","required":"no"}],"return":{"content":"False, if no image was created. Metadata array on success.","types":"false|array"}},{"name":"wp_image_matches_ratio","desc":"","summary":"Helper function to test if aspect ratios for two images match.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"Width of the first image in pixels.","types":"int","variable":"$source_width","default":"null","required":"yes"},{"content":"Height of the first image in pixels.","types":"int","variable":"$source_height","default":"null","required":"yes"},{"content":"Width of the second image in pixels.","types":"int","variable":"$target_width","default":"null","required":"yes"},{"content":"Height of the second image in pixels.","types":"int","variable":"$target_height","default":"null","required":"yes"}],"return":{"content":"True if aspect ratios match within 1px. False if not.","types":"bool"}},{"name":"image_get_intermediate_size","desc":"<p>The $size parameter can be an array with the width and height respectively. If the size matches the 'sizes' metadata array for width and height, then it will be used. If there is no direct match, then the nearest image size larger than the specified size will be used. If nothing is found, then the function will break out and return false.</p> <p>The metadata 'sizes' is used for compatible sizes that can be used for the parameter $size value.</p> <p>The url path will be given, when the $size parameter is a string.</p> <p>If you are passing an array for the $size, you should consider using add_image_size() so that a cropped version is generated. It's much more efficient than having to find the closest-sized image and then having the browser scale down the image.</p>","summary":"Retrieves the image's intermediate size (resized) path, width, and height.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"Attachment ID.","types":"int","variable":"$post_id","default":"null","required":"yes"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'thumbnail'.","types":"array|string","variable":"$size","default":"'thumbnail'","required":"no"}],"return":{"content":"$data { Array of file relative path, width, and height on success. Additionally includes absolute path and URL if registered size is passed to $size parameter. False on failure. @type string $file Image's path relative to uploads directory @type int $width Width of image @type int $height Height of image @type string $path Image's absolute filesystem path. @type string $url Image's URL. }","types":"false|array"}},{"name":"get_intermediate_image_sizes","desc":"","summary":"Gets the available intermediate image sizes.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"Returns a filtered array of image size strings.","types":"array"}},{"name":"wp_get_attachment_image_src","desc":"<p>A mime icon for files, thumbnail or intermediate size for images.</p> <p>The returned array contains four values: the URL of the attachment image src, the width of the image file, the height of the image file, and a boolean representing whether the returned array describes an intermediate (generated) image size or the original, full-sized upload.</p>","summary":"Retrieve an image to represent an attachment.","type":"function","category":"Attachments","since":"2.5.0","param":[{"content":"Image attachment ID.","types":"int","variable":"$attachment_id","default":"null","required":"yes"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'thumbnail'.","types":"string|array","variable":"$size","default":"'thumbnail'","required":"no"},{"content":" Whether the image should be treated as an icon. Default false.","types":"bool","variable":"$icon","default":"false","required":"no"}],"return":{"content":"Returns an array (url, width, height, is_intermediate), or false, if no image is available.","types":"false|array"}},{"name":"wp_get_attachment_image","desc":"<p>While <code>$size</code> will accept an array, it is better to register a size with add_image_size() so that a cropped version is generated. It's much more efficient than having to find the closest-sized image and then having the browser scale down the image.</p>","summary":"Get an HTML img element representing an image attachment","type":"function","category":"Attachments","since":"2.5.0","param":[{"content":"Image attachment ID.","types":"int","variable":"$attachment_id","default":"null","required":"yes"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'thumbnail'.","types":"string|array","variable":"$size","default":"'thumbnail'","required":"no"},{"content":" Whether the image should be treated as an icon. Default false.","types":"bool","variable":"$icon","default":"false","required":"no"},{"content":" Attributes for the image markup. Default empty.","types":"string|array","variable":"$attr","default":"''","required":"no"}],"return":{"content":"HTML img element or empty string on failure.","types":"string"}},{"name":"wp_get_attachment_image_url","desc":"","summary":"Get the URL of an image attachment.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Image attachment ID.","types":"int","variable":"$attachment_id","default":"null","required":"yes"},{"content":" Image size to retrieve. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'thumbnail'.","types":"string|array","variable":"$size","default":"'thumbnail'","required":"no"},{"content":" Whether the image should be treated as an icon. Default false.","types":"bool","variable":"$icon","default":"false","required":"no"}],"return":{"content":"Attachment URL or false if no image is available.","types":"string|false"}},{"name":"_wp_get_attachment_relative_path","desc":"","summary":"Get the attachment path relative to the upload directory.","type":"function","category":"Uncategorised","since":"4.4.1","access":"private","param":[{"content":"Attachment file name.","types":"string","variable":"$file","default":"null","required":"yes"}],"return":{"content":"Attachment path relative to the upload directory.","types":"string"}},{"name":"_wp_get_image_size_from_meta","desc":"<p>Used for responsive images.</p>","summary":"Get the image size as array from its meta data.","type":"function","category":"Uncategorised","since":"4.4.0","access":"private","param":[{"content":"Image size. Accepts any valid image size name ('thumbnail', 'medium', etc.).","types":"string","variable":"$size_name","default":"null","required":"yes"},{"content":"The image meta data.","types":"array","variable":"$image_meta","default":"null","required":"yes"}],"return":{"content":"Array of width and height values in pixels (in that order) or false if the size doesn't exist.","types":"array|bool"}},{"name":"wp_get_attachment_image_srcset","desc":"","summary":"Retrieves the value for an image attachment's 'srcset' attribute.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Image attachment ID.","types":"int","variable":"$attachment_id","default":"null","required":"yes"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.","types":"array|string","variable":"$size","default":"'medium'","required":"no"},{"content":" The image meta data as returned by 'wp_get_attachment_metadata()'. Default null.","types":"array","variable":"$image_meta","default":"null","required":"no"}],"return":{"content":"A 'srcset' value string or false.","types":"string|bool"}},{"name":"wp_calculate_image_srcset","desc":"","summary":"A helper function to calculate the image sources to include in a 'srcset' attribute.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Array of width and height values in pixels (in that order).","types":"array","variable":"$size_array","default":"null","required":"yes"},{"content":"The 'src' of the image.","types":"string","variable":"$image_src","default":"null","required":"yes"},{"content":"The image meta data as returned by 'wp_get_attachment_metadata()'.","types":"array","variable":"$image_meta","default":"null","required":"yes"},{"content":" The image attachment ID to pass to the filter. Default 0.","types":"int","variable":"$attachment_id","default":"0","required":"no"}],"return":{"content":"The 'srcset' attribute value. False on error or when only one source exists.","types":"string|bool"}},{"name":"wp_get_attachment_image_sizes","desc":"","summary":"Retrieves the value for an image attachment's 'sizes' attribute.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Image attachment ID.","types":"int","variable":"$attachment_id","default":"null","required":"yes"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.","types":"array|string","variable":"$size","default":"'medium'","required":"no"},{"content":" The image meta data as returned by 'wp_get_attachment_metadata()'. Default null.","types":"array","variable":"$image_meta","default":"null","required":"no"}],"return":{"content":"A valid source size value for use in a 'sizes' attribute or false.","types":"string|bool"}},{"name":"wp_calculate_image_sizes","desc":"","summary":"Creates a 'sizes' attribute value for an image.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"Image size to retrieve. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.","types":"array|string","variable":"$size","default":"null","required":"yes"},{"content":" The URL to the image file. Default null.","types":"string","variable":"$image_src","default":"null","required":"no"},{"content":" The image meta data as returned by 'wp_get_attachment_metadata()'. Default null.","types":"array","variable":"$image_meta","default":"null","required":"no"},{"content":" Image attachment ID. Either <code>$image_meta</code> or <code>$attachment_id</code> is needed when using the image size name as argument for <code>$size</code>. Default 0.","types":"int","variable":"$attachment_id","default":"0","required":"no"}],"return":{"content":"A valid source size value for use in a 'sizes' attribute or false.","types":"string|bool"}},{"name":"wp_make_content_images_responsive","desc":"","summary":"Filters 'img' elements in post content to add 'srcset' and 'sizes' attributes.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"The raw post content to be filtered.","types":"string","variable":"$content","default":"null","required":"yes"}],"return":{"content":"Converted content with 'srcset' and 'sizes' attributes added to images.","types":"string"}},{"name":"wp_image_add_srcset_and_sizes","desc":"","summary":"Adds 'srcset' and 'sizes' attributes to an existing 'img' element.","type":"function","category":"Uncategorised","since":"4.4.0","param":[{"content":"An HTML 'img' element to be filtered.","types":"string","variable":"$image","default":"null","required":"yes"},{"content":"The image meta data as returned by 'wp_get_attachment_metadata()'.","types":"array","variable":"$image_meta","default":"null","required":"yes"},{"content":"Image attachment ID.","types":"int","variable":"$attachment_id","default":"null","required":"yes"}],"return":{"content":"Converted 'img' element with 'srcset' and 'sizes' attributes added.","types":"string"}},{"name":"_wp_post_thumbnail_class_filter","desc":"<p>Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'} action hooks to dynamically add/remove itself so as to only filter post thumbnails.</p>","summary":"Adds a 'wp-post-image' class to post thumbnails. Internal use only.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Thumbnail attributes including src, class, alt, title.","types":"array","variable":"$attr","default":"null","required":"yes"}],"return":{"content":"Modified array of attributes including the new 'wp-post-image' class.","types":"array"}},{"name":"_wp_post_thumbnail_class_filter_add","desc":"","summary":"Adds '_wp_post_thumbnail_class_filter' callback to the 'wp_get_attachment_image_attributes' filter hook. Internal use only.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Thumbnail attributes including src, class, alt, title.","types":"array","variable":"$attr","default":"null","required":"yes"}]},{"name":"_wp_post_thumbnail_class_filter_remove","desc":"","summary":"Removes the '_wp_post_thumbnail_class_filter' callback from the 'wp_get_attachment_image_attributes' filter hook. Internal use only.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Thumbnail attributes including src, class, alt, title.","types":"array","variable":"$attr","default":"null","required":"yes"}]},{"name":"img_caption_shortcode","desc":"<p>Allows a plugin to replace the content that would otherwise be returned. The filter is {@see 'img_caption_shortcode'} and passes an empty string, the attr parameter and the content parameter values.</p> <p>The supported attributes for the shortcode are 'id', 'caption_id', 'align', 'width', 'caption', and 'class'.</p>","summary":"Builds the Caption shortcode output.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"{ Attributes of the caption shortcode. @type string $id ID of the image and caption container element, i.e. <code><figure></code> or <code><div></code>. @type string $caption_id ID of the caption element, i.e. <code><figcaption></code> or <code><p></code>. @type string $align Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft', 'aligncenter', alignright', 'alignnone'. @type int $width The width of the caption, in pixels. @type string $caption The caption text. @type string $class Additional class name(s) added to the caption container. }","types":"array","variable":"$attr","default":"null","required":"yes"},{"content":"Shortcode content.","types":"string","variable":"$content","default":"null","required":"no"}],"return":{"content":"HTML content to display the caption.","types":"string"}},{"name":"gallery_shortcode","desc":"<p>This implements the functionality of the Gallery Shortcode for displaying WordPress images on a post.</p>","summary":"Builds the Gallery shortcode output.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":"{ Attributes of the gallery shortcode. @type string $order Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'. @type string $orderby The field to use when ordering the images. Default 'menu_order ID'. Accepts any valid SQL ORDERBY statement. @type int $id Post ID. @type string $itemtag HTML tag to use for each image in the gallery. Default 'dl', or 'figure' when the theme registers HTML5 gallery support. @type string $icontag HTML tag to use for each image's icon. Default 'dt', or 'div' when the theme registers HTML5 gallery support. @type string $captiontag HTML tag to use for each image's caption. Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support. @type int $columns Number of columns of images to display. Default 3. @type string|array $size Size of the images to display. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'thumbnail'. @type string $ids A comma-separated list of IDs of attachments to display. Default empty. @type string $include A comma-separated list of IDs of attachments to include. Default empty. @type string $exclude A comma-separated list of IDs of attachments to exclude. Default empty. @type string $link What to link each image to. Default empty (links to the attachment page). Accepts 'file', 'none'. }","types":"array","variable":"$attr","default":"null","required":"yes"}],"return":{"content":"HTML content to display gallery.","types":"string"}},{"name":"wp_underscore_playlist_templates","desc":"","summary":"Outputs the templates used by playlists.","type":"function","category":"Uncategorised","since":"3.9.0"},{"name":"wp_playlist_scripts","desc":"","summary":"Outputs and enqueue default scripts and styles for playlists.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"Type of playlist. Accepts 'audio' or 'video'.","types":"string","variable":"$type","default":"null","required":"yes"}]},{"name":"wp_playlist_shortcode","desc":"<p>This implements the functionality of the playlist shortcode for displaying a collection of WordPress audio or video files in a post.</p>","summary":"Builds the Playlist shortcode output.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"{ Array of default playlist attributes. @type string $type Type of playlist to display. Accepts 'audio' or 'video'. Default 'audio'. @type string $order Designates ascending or descending order of items in the playlist. Accepts 'ASC', 'DESC'. Default 'ASC'. @type string $orderby Any column, or columns, to sort the playlist. If $ids are passed, this defaults to the order of the $ids array ('post__in'). Otherwise default is 'menu_order ID'. @type int $id If an explicit $ids array is not present, this parameter will determine which attachments are used for the playlist. Default is the current post ID. @type array $ids Create a playlist out of these explicit attachment IDs. If empty, a playlist will be created from all $type attachments of $id. Default empty. @type array $exclude List of specific attachment IDs to exclude from the playlist. Default empty. @type string $style Playlist style to use. Accepts 'light' or 'dark'. Default 'light'. @type bool $tracklist Whether to show or hide the playlist. Default true. @type bool $tracknumbers Whether to show or hide the numbers next to entries in the playlist. Default true. @type bool $images Show or hide the video or audio thumbnail (Featured Image/post thumbnail). Default true. @type bool $artists Whether to show or hide artist name in the playlist. Default true. }","types":"array","variable":"$attr","default":"null","required":"yes"}],"return":{"content":"Playlist output. Empty string if the passed type is unsupported.","types":"string"}},{"name":"wp_mediaelement_fallback","desc":"","summary":"Provides a No-JS Flash fallback as a last resort for audio / video.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"The media element URL.","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"Fallback HTML.","types":"string"}},{"name":"wp_get_audio_extensions","desc":"","summary":"Returns a filtered list of WP-supported audio formats.","type":"function","category":"Uncategorised","since":"3.6.0","return":{"content":"Supported audio formats.","types":"array"}},{"name":"wp_get_attachment_id3_keys","desc":"","summary":"Returns useful keys to use to lookup data from an attachment's stored metadata.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"The current attachment, provided for context.","types":"WP_Post","variable":"$attachment","default":"null","required":"yes"},{"content":" The context. Accepts 'edit', 'display'. Default 'display'.","types":"string","variable":"$context","default":"'display'","required":"no"}],"return":{"content":"Key/value pairs of field keys to labels.","types":"array"}},{"name":"wp_audio_shortcode","desc":"<p>This implements the functionality of the Audio Shortcode for displaying WordPress mp3s in a post.</p>","summary":"Builds the Audio shortcode output.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"{ Attributes of the audio shortcode. @type string $src URL to the source of the audio file. Default empty. @type string $loop The 'loop' attribute for the <code><audio></code> element. Default empty. @type string $autoplay The 'autoplay' attribute for the <code><audio></code> element. Default empty. @type string $preload The 'preload' attribute for the <code><audio></code> element. Default 'none'. @type string $class The 'class' attribute for the <code><audio></code> element. Default 'wp-audio-shortcode'. @type string $style The 'style' attribute for the <code><audio></code> element. Default 'width: 100%;'. }","types":"array","variable":"$attr","default":"null","required":"yes"},{"content":"Shortcode content.","types":"string","variable":"$content","default":"''","required":"no"}],"return":{"content":"HTML content to display audio.","types":"string|void"}},{"name":"wp_get_video_extensions","desc":"","summary":"Returns a filtered list of WP-supported video formats.","type":"function","category":"Uncategorised","since":"3.6.0","return":{"content":"List of supported video formats.","types":"array"}},{"name":"wp_video_shortcode","desc":"<p>This implements the functionality of the Video Shortcode for displaying WordPress mp4s in a post.</p>","summary":"Builds the Video shortcode output.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"{ Attributes of the shortcode. @type string $src URL to the source of the video file. Default empty. @type int $height Height of the video embed in pixels. Default 360. @type int $width Width of the video embed in pixels. Default $content_width or 640. @type string $poster The 'poster' attribute for the <code><video></code> element. Default empty. @type string $loop The 'loop' attribute for the <code><video></code> element. Default empty. @type string $autoplay The 'autoplay' attribute for the <code><video></code> element. Default empty. @type string $preload The 'preload' attribute for the <code><video></code> element. Default 'metadata'. @type string $class The 'class' attribute for the <code><video></code> element. Default 'wp-video-shortcode'. }","types":"array","variable":"$attr","default":"null","required":"yes"},{"content":"Shortcode content.","types":"string","variable":"$content","default":"''","required":"no"}],"return":{"content":"HTML content to display video.","types":"string|void"}},{"name":"previous_image_link","desc":"","summary":"Displays previous image link that has the same post parent.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Image size. Accepts any valid image size, an array of width and height values in pixels (in that order), 0, or 'none'. 0 or 'none' will default to 'post_title' or <code>$text</code>. Default 'thumbnail'.","types":"string|array","variable":"$size","default":"'thumbnail'","required":"no"},{"content":" Link text. Default false.","types":"string","variable":"$text","default":"false","required":"no"}]},{"name":"next_image_link","desc":"","summary":"Displays next image link that has the same post parent.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Image size. Accepts any valid image size, an array of width and height values in pixels (in that order), 0, or 'none'. 0 or 'none' will default to 'post_title' or <code>$text</code>. Default 'thumbnail'.","types":"string|array","variable":"$size","default":"'thumbnail'","required":"no"},{"content":" Link text. Default false.","types":"string","variable":"$text","default":"false","required":"no"}]},{"name":"adjacent_image_link","desc":"<p>Retrieves the current attachment object from the $post global.</p>","summary":"Displays next or previous image link that has the same post parent.","type":"function","category":"Uncategorised","since":"2.5.0","param":[{"content":" Whether to display the next (false) or previous (true) link. Default true.","types":"bool","variable":"$prev","default":"true","required":"no"},{"content":" Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'thumbnail'.","types":"string|array","variable":"$size","default":"'thumbnail'","required":"no"},{"content":" Link text. Default false.","types":"bool","variable":"$text","default":"false","required":"no"}]},{"name":"get_attachment_taxonomies","desc":"","summary":"Retrieves taxonomies attached to given the attachment.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Attachment ID, data array, or data object.","types":"int|array|object","variable":"$attachment","default":"null","required":"yes"},{"content":"Output type. 'names' to return an array of taxonomy names, or 'objects' to return an array of taxonomy objects. Default is 'names'.","types":"string","variable":"$output","default":"'names'","required":"no"}],"return":{"content":"Empty array on failure. List of taxonomies on success.","types":"array"}},{"name":"get_taxonomies_for_attachments","desc":"<p>Handles mime-type-specific taxonomies such as attachment:image and attachment:video.</p>","summary":"Retrieves all of the taxonomies that are registered for attachments.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":" The type of taxonomy output to return. Accepts 'names' or 'objects'. Default 'names'.","types":"string","variable":"$output","default":"'names'","required":"no"}],"return":{"content":"Array of names or objects of registered taxonomies for attachments.","types":"string[]|WP_Taxonomy[]"}},{"name":"wp_imagecreatetruecolor","desc":"","summary":"Create new GD image resource with transparency support","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Image width in pixels.","types":"int","variable":"$width","default":"null","required":"yes"},{"content":"Image height in pixels..","types":"int","variable":"$height","default":"null","required":"yes"}],"return":{"content":"The GD image resource.","types":"resource"}},{"name":"wp_expand_dimensions","desc":"","summary":"Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"The width of an example embed.","types":"int","variable":"$example_width","default":"null","required":"yes"},{"content":"The height of an example embed.","types":"int","variable":"$example_height","default":"null","required":"yes"},{"content":"The maximum allowed width.","types":"int","variable":"$max_width","default":"null","required":"yes"},{"content":"The maximum allowed height.","types":"int","variable":"$max_height","default":"null","required":"yes"}],"return":{"content":"The maximum possible width and height based on the example ratio.","types":"array"}},{"name":"wp_max_upload_size","desc":"","summary":"Determines the maximum upload size allowed in php.ini.","type":"function","category":"Miscellaneous","since":"2.5.0","return":{"content":"Allowed upload size.","types":"int"}},{"name":"wp_get_image_editor","desc":"","summary":"Returns a WP_Image_Editor instance and loads file into it.","type":"function","category":"Miscellaneous","since":"3.5.0","param":[{"content":"Path to the file to load.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":" Additional arguments for retrieving the image editor. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"The WP_Image_Editor object if successful, an WP_Error object otherwise.","types":"WP_Image_Editor|WP_Error"}},{"name":"wp_image_editor_supports","desc":"","summary":"Tests whether there is an editor that supports a given mime type or methods.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":" Array of arguments to retrieve the image editor supports. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"True if an eligible editor is found; false otherwise.","types":"bool"}},{"name":"_wp_image_editor_choose","desc":"","summary":"Tests which editors are capable of supporting the request.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":" Array of arguments for choosing a capable editor. Default empty array.","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Class name for the first editor that claims to support the request. False if no editor claims to support the request.","types":"string|false"}},{"name":"wp_plupload_default_settings","desc":"","summary":"Prints default Plupload arguments.","type":"function","category":"Uncategorised","since":"3.4.0"},{"name":"wp_prepare_attachment_for_js","desc":"","summary":"Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.","type":"function","category":"Attachments","since":"3.5.0","param":[{"content":"Attachment ID or object.","types":"int|WP_Post","variable":"$attachment","default":"null","required":"yes"}],"return":{"content":"Array of attachment details.","types":"array|void"}},{"name":"wp_enqueue_media","desc":"","summary":"Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.","type":"function","category":"Uncategorised","since":"3.5.0","param":[{"content":"{ Arguments for enqueuing media scripts. @type int|WP_Post A post object or ID. }","types":"array","variable":"$args","default":"array()","required":"no"}]},{"name":"get_attached_media","desc":"","summary":"Retrieves media attached to the passed post.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Mime type.","types":"string","variable":"$type","default":"null","required":"yes"},{"content":" Post ID or WP_Post object. Default is global $post.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"}],"return":{"content":"Found attachments.","types":"array"}},{"name":"get_media_embedded_in_content","desc":"","summary":"Check the content blob for an audio, video, object, embed, or iframe tags.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"A string which might contain media data.","types":"string","variable":"$content","default":"null","required":"yes"},{"content":"An array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'.","types":"array","variable":"$types","default":"null","required":"no"}],"return":{"content":"A list of found HTML media embeds.","types":"array"}},{"name":"get_post_galleries","desc":"","summary":"Retrieves galleries from the passed post's content.","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":"Post ID or object.","types":"int|WP_Post","variable":"$post","default":"null","required":"yes"},{"content":" Whether to return HTML or data in the array. Default true.","types":"bool","variable":"$html","default":"true","required":"no"}],"return":{"content":"A list of arrays, each containing gallery data and srcs parsed from the expanded shortcode.","types":"array"}},{"name":"get_post_gallery","desc":"","summary":"Check a specified post's content for gallery and, if present, return the first","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":" Post ID or WP_Post object. Default is global $post.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"},{"content":" Whether to return HTML or data. Default is true.","types":"bool","variable":"$html","default":"true","required":"no"}],"return":{"content":"Gallery data and srcs parsed from the expanded shortcode.","types":"string|array"}},{"name":"get_post_galleries_images","desc":"","summary":"Retrieve the image srcs from galleries from a post's content, if present","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":" Post ID or WP_Post object. Default is global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"}],"return":{"content":"A list of lists, each containing image srcs parsed. from an expanded shortcode","types":"array"}},{"name":"get_post_gallery_images","desc":"","summary":"Checks a post's content for galleries and return the image srcs for the first found gallery","type":"function","category":"Uncategorised","since":"3.6.0","param":[{"content":" Post ID or WP_Post object. Default is global <code>$post</code>.","types":"int|WP_Post","variable":"$post","default":"0","required":"no"}],"return":{"content":"A list of a gallery's image srcs in order.","types":"array"}},{"name":"wp_maybe_generate_attachment_metadata","desc":"","summary":"Maybe attempts to generate attachment metadata, if missing.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"Attachment object.","types":"WP_Post","variable":"$attachment","default":"null","required":"yes"}]},{"name":"attachment_url_to_postid","desc":"","summary":"Tries to convert an attachment URL into a post ID.","type":"function","category":"Uncategorised","since":"4.0.0","param":[{"content":"The URL to resolve.","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"The found post ID, or 0 on failure.","types":"int"}},{"name":"wpview_media_sandbox_styles","desc":"","summary":"Returns the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.","type":"function","category":"Uncategorised","since":"4.0.0","return":{"content":"The relevant CSS file URLs.","types":"array"}},{"name":"wp_register_media_personal_data_exporter","desc":"","summary":"Registers the personal data exporter for media","type":"function","category":"Uncategorised","param":[{"content":"An array of personal data exporters.","types":"array","variable":"$exporters","default":"null","required":"yes"}],"return":{"content":"An array of personal data exporters.","types":"array"}},{"name":"wp_media_personal_data_exporter","desc":"","summary":"Finds and exports attachments associated with an email address.","type":"function","category":"Uncategorised","since":"4.9.6","param":[{"content":"The attachment owner email address.","types":"string","variable":"$email_address","default":"null","required":"yes"},{"content":"Attachment page.","types":"int","variable":"$page","default":"1","required":"no"}],"return":{"content":"$return An array of personal data.","types":"array"}},{"name":"add_metadata","desc":"","summary":"Add metadata for the specified object.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID of the object metadata is for","types":"int","variable":"$object_id","default":"null","required":"yes"},{"content":"Metadata key","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value. Must be serializable if non-scalar.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":" 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.","types":"bool","variable":"$unique","default":"false","required":"no"}],"return":{"content":"The meta ID on success, false on failure.","types":"int|false"}},{"name":"update_metadata","desc":"","summary":"Update metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID of the object metadata is for","types":"int","variable":"$object_id","default":"null","required":"yes"},{"content":"Metadata key","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value. Must be serializable if non-scalar.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":" If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.","types":"mixed","variable":"$prev_value","default":"''","required":"no"}],"return":{"content":"The new meta field ID if a field with the given key didn't exist and was therefore added, true on successful update, false on failure.","types":"int|bool"}},{"name":"delete_metadata","desc":"","summary":"Delete metadata for the specified object.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID of the object metadata is for","types":"int","variable":"$object_id","default":"null","required":"yes"},{"content":"Metadata key","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":" Metadata value. Must be serializable if non-scalar. If specified, only delete metadata entries with this value. Otherwise, delete all entries with the specified meta_key. Pass <code>null</code>, <code>false</code>, or an empty string to skip this check. (For backward compatibility, it is not possible to pass an empty string to delete those entries with an empty string for a value.)","types":"mixed","variable":"$meta_value","default":"''","required":"no"},{"content":" 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.","types":"bool","variable":"$delete_all","default":"false","required":"no"}],"return":{"content":"True on successful delete, false on failure.","types":"bool"}},{"name":"get_metadata","desc":"","summary":"Retrieve metadata for the specified object.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID of the object metadata is for","types":"int","variable":"$object_id","default":"null","required":"yes"},{"content":" Metadata key. If not specified, retrieve all metadata for the specified object.","types":"string","variable":"$meta_key","default":"''","required":"no"},{"content":" 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.","types":"bool","variable":"$single","default":"false","required":"no"}],"return":{"content":"Single metadata value, or array of values","types":"mixed"}},{"name":"metadata_exists","desc":"","summary":"Determine if a meta key is set for a given object","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID of the object metadata is for","types":"int","variable":"$object_id","default":"null","required":"yes"},{"content":"Metadata key.","types":"string","variable":"$meta_key","default":"null","required":"yes"}],"return":{"content":"True of the key is set, false if not.","types":"bool"}},{"name":"get_metadata_by_mid","desc":"","summary":"Get meta data by meta ID","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID for a specific meta row","types":"int","variable":"$meta_id","default":"null","required":"yes"}],"return":{"content":"Meta object or false.","types":"object|false"}},{"name":"update_metadata_by_mid","desc":"","summary":"Update meta data by meta ID","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID for a specific meta row","types":"int","variable":"$meta_id","default":"null","required":"yes"},{"content":"Metadata value","types":"string","variable":"$meta_value","default":"null","required":"yes"},{"content":" you can provide a meta key to update it","types":"string","variable":"$meta_key","default":"false","required":"no"}],"return":{"content":"True on successful update, false on failure.","types":"bool"}},{"name":"delete_metadata_by_mid","desc":"","summary":"Delete meta data by meta ID","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"ID for a specific meta row","types":"int","variable":"$meta_id","default":"null","required":"yes"}],"return":{"content":"True on successful delete, false on failure.","types":"bool"}},{"name":"update_meta_cache","desc":"","summary":"Update the metadata cache for the specified objects.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Type of object metadata is for (e.g., comment, post, term, or user).","types":"string","variable":"$meta_type","default":"null","required":"yes"},{"content":"Array or comma delimited list of object IDs to update cache for","types":"int|array","variable":"$object_ids","default":"null","required":"yes"}],"return":{"content":"Metadata cache for the specified objects, or false on failure.","types":"array|false"}},{"name":"wp_metadata_lazyloader","desc":"","summary":"Retrieves the queue for lazy-loading metadata.","type":"function","category":"Uncategorised","since":"4.5.0","return":{"content":"$lazyloader Metadata lazyloader queue.","types":"WP_Metadata_Lazyloader"}},{"name":"get_meta_sql","desc":"","summary":"Given a meta query, generates SQL clauses to be appended to a main query.","type":"function","category":"sql","since":"3.2.0","param":[{"content":"A meta query.","types":"array","variable":"$meta_query","default":"null","required":"yes"},{"content":"Type of meta.","types":"string","variable":"$type","default":"null","required":"yes"},{"content":"Primary database table name.","types":"string","variable":"$primary_table","default":"null","required":"yes"},{"content":"Primary ID column name.","types":"string","variable":"$primary_id_column","default":"null","required":"yes"},{"content":" The main query object","types":"object","variable":"$context","default":"null","required":"no"}],"return":{"content":"Associative array of <code>JOIN</code> and <code>WHERE</code> SQL.","types":"array"}},{"name":"_get_meta_table","desc":"","summary":"Retrieve the name of the metadata table for the specified object type.","type":"function","category":"Uncategorised","since":"2.9.0","param":[{"content":"Type of object to get metadata table for (e.g., comment, post, term, or user).","types":"string","variable":"$type","default":"null","required":"yes"}],"return":{"content":"Metadata table name, or false if no metadata table exists","types":"string|false"}},{"name":"is_protected_meta","desc":"","summary":"Determines whether a meta key is considered protected.","type":"function","category":"Uncategorised","since":"3.1.3","param":[{"content":"Meta key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":" Type of object metadata is for (e.g., comment, post, term, or user).","types":"string|null","variable":"$meta_type","default":"null","required":"no"}],"return":{"content":"Whether the meta key is considered protected.","types":"bool"}},{"name":"sanitize_meta","desc":"","summary":"Sanitize meta value.","type":"function","category":"Uncategorised","since":"4.9.8","param":[{"content":"Meta key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Meta value to sanitize.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":"Type of object the meta is registered to.","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":" The subtype of the object type.","types":"string","variable":"$object_subtype","default":"''","required":"no"}],"return":{"content":"Sanitized $meta_value.","types":"mixed"}},{"name":"register_meta","desc":"<p>It is recommended to register meta keys for a specific combination of object type and object subtype. If passing an object subtype is omitted, the meta key will be registered for the entire object type, however it can be partly overridden in case a more specific meta key of the same name exists for the same object type and a subtype.</p> <p>If an object type does not support any subtypes, such as users or comments, you should commonly call this function without passing a subtype.</p>","summary":"Registers a meta key.","type":"function","category":"Custom Fields (postmeta)","since":"4.9.8","param":[{"content":"Type of object this meta is registered to.","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":"Meta key to register.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"{ Data used to describe the meta key when registered. @type string $object_subtype A subtype; e.g. if the object type is "post", the post type. If left empty, the meta key will be registered on the entire object type. Default empty. @type string $type The type of data associated with this meta key. Valid values are 'string', 'boolean', 'integer', and 'number'. @type string $description A description of the data attached to this meta key. @type bool $single Whether the meta key has one value per object, or an array of values per object. @type string $sanitize_callback A function or method to call when sanitizing <code>$meta_key</code> data. @type string $auth_callback Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks. @type bool $show_in_rest Whether data associated with this meta key can be considered public. }","types":"array","variable":"$args","default":"null","required":"yes"},{"content":"Deprecated. Use <code>$args</code> instead.","types":"string|array","variable":"$deprecated","default":"null","required":"no"}],"return":{"content":"True if the meta key was successfully registered in the global array, false if not. Registering a meta key with distinct sanitize and auth callbacks will fire those callbacks, but will not add to the global registry.","types":"bool"}},{"name":"registered_meta_key_exists","desc":"","summary":"Checks if a meta key is registered.","type":"function","category":"Uncategorised","since":"4.9.8","param":[{"content":"The type of object.","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":"The meta key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":" The subtype of the object type.","types":"string","variable":"$object_subtype","default":"''","required":"no"}],"return":{"content":"True if the meta key is registered to the object type and, if provided, the object subtype. False if not.","types":"bool"}},{"name":"unregister_meta_key","desc":"","summary":"Unregisters a meta key from the list of registered keys.","type":"function","category":"Uncategorised","since":"4.9.8","param":[{"content":"The type of object.","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":"The meta key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":" The subtype of the object type.","types":"string","variable":"$object_subtype","default":"''","required":"no"}],"return":{"content":"True if successful. False if the meta key was not registered.","types":"bool"}},{"name":"get_registered_meta_keys","desc":"","summary":"Retrieves a list of registered meta keys for an object type.","type":"function","category":"Uncategorised","since":"4.9.8","param":[{"content":"The type of object. Post, comment, user, term.","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":" The subtype of the object type.","types":"string","variable":"$object_subtype","default":"''","required":"no"}],"return":{"content":"List of registered meta keys.","types":"array"}},{"name":"get_registered_metadata","desc":"<p>The results include both meta that is registered specifically for the object's subtype and meta that is registered for the entire object type.</p>","summary":"Retrieves registered metadata for a specified object.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"Type of object to request metadata for. (e.g. comment, post, term, user)","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":"ID of the object the metadata is for.","types":"int","variable":"$object_id","default":"null","required":"yes"},{"content":" Registered metadata key. If not specified, retrieve all registered metadata for the specified object.","types":"string","variable":"$meta_key","default":"''","required":"no"}],"return":{"content":"A single value or array of values for a key if specified. An array of all registered keys and values for an object ID if not. False if a given $meta_key is not registered.","types":"mixed"}},{"name":"_wp_register_meta_args_whitelist","desc":"<p><code>register_meta()</code> args may change over time, so requiring the whitelist to be explicitly turned off is a warranty seal of sorts.</p>","summary":"Filter out `register_meta()` args based on a whitelist.","type":"function","category":"Uncategorised","access":"private","since":"4.6.0","param":[{"content":"Arguments from <code>register_meta()</code>.","types":"array","variable":"$args","default":"null","required":"yes"},{"content":"Default arguments for <code>register_meta()</code>.","types":"array","variable":"$default_args","default":"null","required":"yes"}],"return":{"content":"Filtered arguments.","types":"array"}},{"name":"get_object_subtype","desc":"","summary":"Returns the object subtype for a given object ID of a specific type.","type":"function","category":"Uncategorised","since":"4.9.8","param":[{"content":"Type of object to request metadata for. (e.g. comment, post, term, user)","types":"string","variable":"$object_type","default":"null","required":"yes"},{"content":"ID of the object to retrieve its subtype.","types":"int","variable":"$object_id","default":"null","required":"yes"}],"return":{"content":"The object subtype or an empty string if unspecified subtype.","types":"string"}},{"name":"wpmu_update_blogs_date","desc":"","summary":"Update the last_updated field for the current site.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)"},{"name":"get_blogaddress_by_id","desc":"","summary":"Get a full blog URL, given a blog id.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"Blog ID","types":"int","variable":"$blog_id","default":"null","required":"yes"}],"return":{"content":"Full URL of the blog if found. Empty string if not.","types":"string"}},{"name":"get_blogaddress_by_name","desc":"","summary":"Get a full blog URL, given a blog name.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The (subdomain or directory) name","types":"string","variable":"$blogname","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"get_id_from_blogname","desc":"","summary":"Retrieves a sites ID given its (subdomain or directory) slug.","type":"function","category":"Multisite Functions","since":"4.7.0","param":[{"content":"A site's slug.","types":"string","variable":"$slug","default":"null","required":"yes"}],"return":{"content":"The site ID, or null if no site is found for the given slug.","types":"int|null"}},{"name":"get_blog_details","desc":"","summary":"Retrieve the details for a blog from the blogs table and blog options.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":" A blog ID, a blog slug, or an array of fields to query against. If not specified the current blog ID is used.","types":"int|string|array","variable":"$fields","default":"null","required":"no"},{"content":"Whether to retrieve all details or only the details in the blogs table. Default is true.","types":"bool","variable":"$get_all","default":"true","required":"no"}],"return":{"content":"Blog details on success. False on failure.","types":"WP_Site|false"}},{"name":"refresh_blog_details","desc":"","summary":"Clear the blog details cache.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":" Blog ID. Defaults to current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}]},{"name":"update_blog_details","desc":"","summary":"Update the details for a blog. Updates the blogs table for a given blog id.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"Blog ID","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"Array of details keyed by blogs table field names.","types":"array","variable":"$details","default":"array()","required":"no"}],"return":{"content":"True if update succeeds, false otherwise.","types":"bool"}},{"name":"clean_site_details_cache","desc":"","summary":"Cleans the site details cache for a site.","type":"function","category":"Uncategorised","since":"4.7.4","param":[{"content":" Site ID. Default is the current site ID.","types":"int","variable":"$site_id","default":"0","required":"no"}]},{"name":"get_blog_option","desc":"<p>If the option does not exist or does not have a value, then the return value will be false. This is useful to check whether you need to install an option and is commonly used during installation of plugin options and to test whether upgrading is required.</p> <p>If the option was serialized then it will be unserialized when it is returned.</p>","summary":"Retrieve option value for a given blog id based on name of option.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"A blog ID. Can be null to refer to the current blog.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"Name of option to retrieve. Expected to not be SQL-escaped.","types":"string","variable":"$option","default":"null","required":"yes"},{"content":" Default value to return if the option does not exist.","types":"mixed","variable":"$default","default":"false","required":"no"}],"return":{"content":"Value set for the option.","types":"mixed"}},{"name":"add_blog_option","desc":"<p>You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is inserted into the database. Remember, resources can not be serialized or added as an option.</p> <p>You can create options without values and then update the values later. Existing options will not be updated and checks are performed to ensure that you aren't adding a protected WordPress option. Care should be taken to not name options the same as the ones which are protected.</p>","summary":"Add a new option for a given blog id.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"A blog ID. Can be null to refer to the current blog.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"Name of option to add. Expected to not be SQL-escaped.","types":"string","variable":"$option","default":"null","required":"yes"},{"content":" Option value, can be anything. Expected to not be SQL-escaped.","types":"mixed","variable":"$value","default":"null","required":"no"}],"return":{"content":"False if option was not added and true if option was added.","types":"bool"}},{"name":"delete_blog_option","desc":"","summary":"Removes option by name for a given blog id. Prevents removal of protected WordPress options.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"A blog ID. Can be null to refer to the current blog.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"Name of option to remove. Expected to not be SQL-escaped.","types":"string","variable":"$option","default":"null","required":"yes"}],"return":{"content":"True, if option is successfully deleted. False on failure.","types":"bool"}},{"name":"update_blog_option","desc":"","summary":"Update an option for a particular blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The blog id.","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"The option key.","types":"string","variable":"$option","default":"null","required":"yes"},{"content":"The option value.","types":"mixed","variable":"$value","default":"null","required":"yes"},{"content":"Not used.","types":"mixed","variable":"$deprecated","default":"null","required":"no"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"switch_to_blog","desc":"<p>This function is useful if you need to pull posts, or other information, from other blogs. You can switch back afterwards using restore_current_blog().</p> <p>Things that aren't switched:</p> <ul> <li>plugins. See #14941</li> </ul>","summary":"Switch the current blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The id of the blog you want to switch to. Default: current blog","types":"int","variable":"$new_blog","default":"null","required":"yes"},{"content":"Deprecated argument","types":"bool","variable":"$deprecated","default":"null","required":"no"}],"return":{"content":"Always returns True.","types":"true"}},{"name":"restore_current_blog","desc":"","summary":"Restore the current blog, after calling switch_to_blog()","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","return":{"content":"True on success, false if we're already on the current blog","types":"bool"}},{"name":"wp_switch_roles_and_user","desc":"","summary":"Switches the initialized roles and current user capabilities to another site.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"New site ID.","types":"int","variable":"$new_site_id","default":"null","required":"yes"},{"content":"Old site ID.","types":"int","variable":"$old_site_id","default":"null","required":"yes"}]},{"name":"ms_is_switched","desc":"","summary":"Determines if switch_to_blog() is in effect","type":"function","category":"Uncategorised","since":"3.5.0","return":{"content":"True if switched, false otherwise.","types":"bool"}},{"name":"is_archived","desc":"","summary":"Check if a particular blog is archived.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The blog id","types":"int","variable":"$id","default":"null","required":"yes"}],"return":{"content":"Whether the blog is archived or not","types":"string"}},{"name":"update_archived","desc":"","summary":"Update the 'archived' status of a particular blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The blog id","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"The new status","types":"string","variable":"$archived","default":"null","required":"yes"}],"return":{"content":"$archived","types":"string"}},{"name":"update_blog_status","desc":"","summary":"Update a blog details field.","type":"function","category":"Multisite Functions","since":"5.1.0","param":[{"content":"BLog ID","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"A field name","types":"string","variable":"$pref","default":"null","required":"yes"},{"content":"Value for $pref","types":"string","variable":"$value","default":"null","required":"yes"},{"content":"","types":"null","variable":"$deprecated","default":"null","required":"no"}],"return":{"content":"$value","types":"string|false"}},{"name":"get_blog_status","desc":"","summary":"Get a blog details field.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The blog id","types":"int","variable":"$id","default":"null","required":"yes"},{"content":"A field name","types":"string","variable":"$pref","default":"null","required":"yes"}],"return":{"content":"$value","types":"bool|string|null"}},{"name":"get_last_updated","desc":"","summary":"Get a list of most recently updated blogs.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"Not used","types":"mixed","variable":"$deprecated","default":"''","required":"no"},{"content":"The offset","types":"int","variable":"$start","default":"0","required":"yes"},{"content":"The maximum number of blogs to retrieve. Default is 40.","types":"int","variable":"$quantity","default":"40","required":"no"}],"return":{"content":"The list of blogs","types":"array"}},{"name":"_update_blog_date_on_post_publish","desc":"","summary":"Handler for updating the site's last updated date when a post is published or an already published post is changed.","type":"function","category":"Uncategorised","since":"3.3.0","param":[{"content":"The new post status","types":"string","variable":"$new_status","default":"null","required":"yes"},{"content":"The old post status","types":"string","variable":"$old_status","default":"null","required":"yes"},{"content":"Post object","types":"object","variable":"$post","default":"null","required":"yes"}]},{"name":"_update_blog_date_on_post_delete","desc":"","summary":"Handler for updating the current site's last updated date when a published post is deleted.","type":"function","category":"Uncategorised","since":"3.4.0","param":[{"content":"Post ID","types":"int","variable":"$post_id","default":"null","required":"yes"}]},{"name":"_update_posts_count_on_delete","desc":"","summary":"Handler for updating the current site's posts count when a post is deleted.","type":"function","category":"Uncategorised","since":"4.0.0","param":[{"content":"Post ID.","types":"int","variable":"$post_id","default":"null","required":"yes"}]},{"name":"_update_posts_count_on_transition_post_status","desc":"","summary":"Handler for updating the current site's posts count when a post status changes.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"The status the post is changing to.","types":"string","variable":"$new_status","default":"null","required":"yes"},{"content":"The status the post is changing from.","types":"string","variable":"$old_status","default":"null","required":"yes"},{"content":"Post object","types":"WP_Post","variable":"$post","default":"null","required":"no"}]},{"name":"ms_upload_constants","desc":"<p>Exists for backward compatibility with legacy file-serving through wp-includes/ms-files.php (wp-content/blogs.php in MU).</p>","summary":"Defines Multisite upload constants.","type":"function","category":"Multisite Functions","since":"3.0.0"},{"name":"ms_cookie_constants","desc":"","summary":"Defines Multisite cookie constants.","type":"function","category":"Multisite Functions","since":"3.0.0"},{"name":"ms_file_constants","desc":"<p>Exists for backward compatibility with legacy file-serving through wp-includes/ms-files.php (wp-content/blogs.php in MU).</p>","summary":"Defines Multisite file constants.","type":"function","category":"Multisite Functions","since":"3.0.0"},{"name":"ms_subdomain_constants","desc":"<p>VHOST is deprecated in favor of SUBDOMAIN_INSTALL, which is a bool.</p> <p>On first call, the constants are checked and defined. On second call, we will have translations loaded and can trigger warnings easily.</p>","summary":"Defines Multisite subdomain constants and handles warnings and notices.","type":"function","category":"Multisite Functions","since":"3.0.0"},{"name":"get_dashboard_blog","desc":"<p>Dashboard blog functionality was removed in WordPress 3.1, replaced by the user admin.</p>","summary":"Get the \"dashboard blog\", the blog where users without a blog edit their profile data.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"3.1.0","desc":"Use get_site()"},"return":{"content":"Current site object.","types":"WP_Site"}},{"name":"generate_random_password","desc":"","summary":"Generates a random password.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use wp_generate_password()"},"param":[{"content":" The length of password to generate. Default 8.","types":"int","variable":"$len","default":"8","required":"no"}]},{"name":"is_site_admin","desc":"<p>Plugins should use is_multisite() instead of checking if this function exists to determine if multisite is enabled.</p> <p>This function must reside in a file included only if is_multisite() due to legacy function_exists() checks to determine if multisite is enabled.</p>","summary":"Determine if user is a site admin.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use is_super_admin()"},"param":[{"content":" Username for the user to check. Default empty.","types":"string","variable":"$user_login","default":"''","required":"no"}]},{"name":"graceful_fail","desc":"","summary":"Deprecated functionality to gracefully fail.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use wp_die()"}},{"name":"get_user_details","desc":"","summary":"Deprecated functionality to retrieve user information.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use get_user_by()"},"param":[{"content":"Username.","types":"string","variable":"$username","default":"null","required":"yes"}]},{"name":"clear_global_post_cache","desc":"","summary":"Deprecated functionality to clear the global post cache.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use clean_post_cache()"},"param":[{"content":"Post ID.","types":"int","variable":"$post_id","default":"null","required":"yes"}]},{"name":"is_main_blog","desc":"","summary":"Deprecated functionality to determin if the current site is the main site.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use is_main_site()"}},{"name":"validate_email","desc":"","summary":"Deprecated functionality to validate an email address.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use is_email()"},"param":[{"content":"Email address to verify.","types":"string","variable":"$email","default":"null","required":"yes"},{"content":"Deprecated.","types":"bool","variable":"$check_domain","default":"true","required":"no"}],"return":{"content":"Either false or the valid email address.","types":"string|bool"}},{"name":"get_blog_list","desc":"","summary":"Deprecated functionality to retrieve a list of all sites.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"Use wp_get_sites()"},"param":[{"content":" Offset for retrieving the blog list. Default 0.","types":"int","variable":"$start","default":"0","required":"no"},{"content":" Number of blogs to list. Default 10.","types":"int","variable":"$num","default":"10","required":"no"},{"content":"Unused.","types":"string","variable":"$deprecated","default":"''","required":"no"}]},{"name":"get_most_active_blogs","desc":"","summary":"Deprecated functionality to retrieve a list of the most active sites.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.0.0","desc":"null"},"param":[{"content":" Number of activate blogs to retrieve. Default 10.","types":"int","variable":"$num","default":"10","required":"no"},{"content":" Whether or not to display the most active blogs list. Default true.","types":"bool","variable":"$display","default":"true","required":"no"}],"return":{"content":"List of "most active" sites.","types":"array"}},{"name":"wpmu_admin_do_redirect","desc":"<p>The function looks for redirect arguments in the following order: 1) $_GET['ref'] 2) $_POST['ref'] 3) $_SERVER['HTTP_REFERER'] 4) $_GET['redirect'] 5) $_POST['redirect'] 6) $url</p>","summary":"Redirect a user based on $_GET or $_POST arguments.","type":"function","category":"Uncategorised","since":"MU (3.0.0)","deprecated":{"content":"3.3.0","desc":"Use wp_redirect()"},"param":[{"content":" Redirect URL. Default empty.","types":"string","variable":"$url","default":"''","required":"no"}]},{"name":"wpmu_admin_redirect_add_updated_param","desc":"","summary":"Adds an 'updated=true' argument to a URL.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"3.3.0","desc":"Use add_query_arg()"},"param":[{"content":" Redirect URL. Default empty.","types":"string","variable":"$url","default":"''","required":"no"}],"return":{"content":"","types":"string"}},{"name":"get_user_id_from_string","desc":"<p>A numeric string is considered to be an existing user ID and is simply returned as such.</p>","summary":"Get a numeric user ID from either an email address or a login.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"3.6.0","desc":"Use get_user_by()"},"param":[{"content":"Either an email address or a login.","types":"string","variable":"$string","default":"null","required":"yes"}],"return":{"content":"","types":"int"}},{"name":"get_blogaddress_by_domain","desc":"","summary":"Get a full blog URL, given a domain and a path.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"3.7.0","desc":"null"},"param":[{"content":"","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"","types":"string","variable":"$path","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"create_empty_blog","desc":"","summary":"Create an empty blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"4.4.0","desc":"null"},"param":[{"content":"The new blog's domain.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The new blog's path.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"The new blog's title.","types":"string","variable":"$weblog_title","default":"null","required":"yes"},{"content":" Defaults to 1.","types":"int","variable":"$site_id","default":"1","required":"no"}],"return":{"content":"The ID of the newly created blog","types":"string|int"}},{"name":"get_admin_users_for_domain","desc":"","summary":"Get the admin for a domain/path combination.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"4.4.0","desc":"null"},"param":[{"content":" Network domain.","types":"string","variable":"$domain","default":"''","required":"no"},{"content":" Network path.","types":"string","variable":"$path","default":"''","required":"no"}],"return":{"content":"The network admins.","types":"array|false"}},{"name":"wp_get_sites","desc":"","summary":"Return an array of sites for a network or networks.","type":"function","category":"Multisite Functions","since":"3.7.0","deprecated":{"content":"4.6.0","desc":"Use get_sites()"},"param":[{"content":"{ Array of default arguments. Optional. @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites from all networks. Defaults to current network ID. @type int $public Retrieve public or non-public sites. Default null, for any. @type int $archived Retrieve archived or non-archived sites. Default null, for any. @type int $mature Retrieve mature or non-mature sites. Default null, for any. @type int $spam Retrieve spam or non-spam sites. Default null, for any. @type int $deleted Retrieve deleted or non-deleted sites. Default null, for any. @type int $limit Number of sites to limit the query to. Default 100. @type int $offset Exclude the first x sites. Used in combination with the $limit parameter. Default 0. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"An empty array if the installation is considered "large" via wp_is_large_network(). Otherwise, an associative array of site data arrays, each containing the site (network) ID, blog ID, site domain and path, dates registered and modified, and the language ID. Also, boolean values for whether the site is public, archived, mature, spam, and/or deleted.","types":"array"}},{"name":"is_user_option_local","desc":"","summary":"Check whether a usermeta key has to do with the current blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"4.9.0","desc":"null"},"param":[{"content":"","types":"string","variable":"$key","default":"null","required":"yes"},{"content":" Defaults to current user.","types":"int","variable":"$user_id","default":"0","required":"no"},{"content":" Defaults to current blog.","types":"int","variable":"$blog_id","default":"0","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"insert_blog","desc":"<p>This function creates a row in the wp_blogs table and returns the new blog's ID. It is the first step in creating a new blog.</p>","summary":"Store basic site info in the blogs table.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"5.1.0","desc":"Use <code>wp_insert_site()</code>"},"param":[{"content":"The domain of the new site.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The path of the new site.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"Unless you're running a multi-network install, be sure to set this value to 1.","types":"int","variable":"$site_id","default":"null","required":"yes"}],"return":{"content":"The ID of the new row","types":"int|false"}},{"name":"install_blog","desc":"<p>Creates the new blog tables and options. If calling this function directly, be sure to use switch_to_blog() first, so that $wpdb points to the new blog.</p>","summary":"Install an empty blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"5.1.0","desc":"null"},"param":[{"content":"The value returned by wp_insert_site().","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"The title of the new site.","types":"string","variable":"$blog_title","default":"''","required":"no"}]},{"name":"install_blog_defaults","desc":"<p>This function creates a row in the wp_blogs table.</p>","summary":"Set blog defaults.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","deprecated":{"content":"Use wp_install_defaults()","desc":"Use wp_install_defaults()"},"param":[{"content":"Ignored in this function.","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"}]},{"name":"get_sitestats","desc":"","summary":"Gets the network's site and user counts.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","return":{"content":"Site and user count for the network.","types":"array"}},{"name":"get_active_blog_for_user","desc":"<p>Returns the user's primary blog, if they have one and it is active. If it's inactive, function returns another active blog of the user. If none are found, the user is added as a Subscriber to the Dashboard Blog and that blog is returned.</p>","summary":"Get one of a user's active blogs","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The unique ID of the user","types":"int","variable":"$user_id","default":"null","required":"yes"}],"return":{"content":"The blog object","types":"WP_Site|void"}},{"name":"get_user_count","desc":"<p>The count is cached and updated twice daily. This is not a live count.</p>","summary":"The number of active users in your installation.","type":"function","category":"Multisite Functions","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}],"return":{"content":"Number of active users on the network.","types":"int"}},{"name":"get_blog_count","desc":"<p>The count is cached and updated twice daily. This is not a live count.</p>","summary":"The number of active sites on your installation.","type":"function","category":"Multisite Functions","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}],"return":{"content":"Number of active sites on the network.","types":"int"}},{"name":"get_blog_post","desc":"","summary":"Get a blog post from any site on the network.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"ID of the blog.","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"ID of the post you're looking for.","types":"int","variable":"$post_id","default":"null","required":"yes"}],"return":{"content":"WP_Post on success or null on failure","types":"WP_Post|null"}},{"name":"add_user_to_blog","desc":"<p>Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.</p>","summary":"Adds a user to a blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"ID of the blog you're adding the user to.","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"ID of the user you're adding.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"The role you want the user to have","types":"string","variable":"$role","default":"null","required":"yes"}],"return":{"content":"","types":"true|WP_Error"}},{"name":"remove_user_from_blog","desc":"<p>Use the {@see 'remove_user_from_blog'} action to fire an event when users are removed from a blog.</p> <p>Accepts an optional <code>$reassign</code> parameter, if you want to reassign the user's blog posts to another user upon removal.</p>","summary":"Remove a user from a blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"ID of the user you're removing.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"ID of the blog you're removing the user from.","types":"int","variable":"$blog_id","default":"''","required":"no"},{"content":" A user to whom to reassign posts.","types":"string","variable":"$reassign","default":"''","required":"no"}],"return":{"content":"","types":"true|WP_Error"}},{"name":"get_blog_permalink","desc":"","summary":"Get the permalink for a post on another blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0) 1.0","param":[{"content":"ID of the source blog.","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"ID of the desired post.","types":"int","variable":"$post_id","default":"null","required":"yes"}],"return":{"content":"The post's permalink","types":"string"}},{"name":"get_blog_id_from_url","desc":"<p>On a subdirectory installation like example.com/blog1/, $domain will be the root 'example.com' and $path the subdirectory '/blog1/'. With subdomains like blog1.example.com, $domain is 'blog1.example.com' and $path is '/'.</p>","summary":"Get a blog's numeric ID from its URL.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":" Not required for subdomain installations.","types":"string","variable":"$path","default":"'/'","required":"no"}],"return":{"content":"0 if no blog found, otherwise the ID of the matching blog","types":"int"}},{"name":"is_email_address_unsafe","desc":"<p>This function checks against the Banned Email Domains list at wp-admin/network/settings.php. The check is only run on self-registrations; user creation at wp-admin/network/users.php bypasses this check.</p>","summary":"Checks an email address against a list of banned domains.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The email provided by the user at registration.","types":"string","variable":"$user_email","default":"null","required":"yes"}],"return":{"content":"Returns true when the email address is banned.","types":"bool"}},{"name":"wpmu_validate_user_signup","desc":"<p>Verifies the validity and uniqueness of user names and user email addresses, and checks email addresses against admin-provided domain whitelists and blacklists.</p> <p>The {@see 'wpmu_validate_user_signup'} hook provides an easy way to modify the sign-up process. The value $result, which is passed to the hook, contains both the user-provided info and the error messages created by the function. {@see 'wpmu_validate_user_signup'} allows you to process the data in any way you'd like, and unset the relevant errors if necessary.</p>","summary":"Sanitize and validate data required for a user sign-up.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The login name provided by the user.","types":"string","variable":"$user_name","default":"null","required":"yes"},{"content":"The email provided by the user.","types":"string","variable":"$user_email","default":"null","required":"yes"}],"return":{"content":"Contains username, email, and error messages.","types":"array"}},{"name":"wpmu_validate_blog_signup","desc":"<p>Checks the data provided by the user during blog signup. Verifies the validity and uniqueness of blog paths and domains.</p> <p>This function prevents the current user from registering a new site with a blogname equivalent to another user's login name. Passing the $user parameter to the function, where $user is the other user, is effectively an override of this limitation.</p> <p>Filter {@see 'wpmu_validate_blog_signup'} if you want to modify the way that WordPress validates new site signups.</p>","summary":"Processes new site registrations.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The blog name provided by the user. Must be unique.","types":"string","variable":"$blogname","default":"null","required":"yes"},{"content":"The blog title provided by the user.","types":"string","variable":"$blog_title","default":"null","required":"yes"},{"content":" The user object to check against the new site name.","types":"WP_User|string","variable":"$user","default":"''","required":"no"}],"return":{"content":"Contains the new site data and error messages.","types":"array"}},{"name":"wpmu_signup_blog","desc":"","summary":"Record site signup information for future activation.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The requested domain.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The requested path.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"The requested site title.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":"The user's requested login name.","types":"string","variable":"$user","default":"null","required":"yes"},{"content":"The user's email address.","types":"string","variable":"$user_email","default":"null","required":"yes"},{"content":" Signup meta data. By default, contains the requested privacy setting and lang_id.","types":"array","variable":"$meta","default":"array()","required":"no"}]},{"name":"wpmu_signup_user","desc":"<p>This function is used when user registration is open but new site registration is not.</p>","summary":"Record user signup information for future activation.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The user's requested login name.","types":"string","variable":"$user","default":"null","required":"yes"},{"content":"The user's email address.","types":"string","variable":"$user_email","default":"null","required":"yes"},{"content":" Signup meta data. Default empty array.","types":"array","variable":"$meta","default":"array()","required":"no"}]},{"name":"wpmu_signup_blog_notification","desc":"<p>This is the notification function used when site registration is enabled.</p> <p>Filter {@see 'wpmu_signup_blog_notification'} to bypass this function or replace it with your own notification behavior.</p> <p>Filter {@see 'wpmu_signup_blog_notification_email'} and {@see 'wpmu_signup_blog_notification_subject'} to change the content and subject line of the email sent to newly registered users.</p>","summary":"Send a confirmation request email to a user when they sign up for a new site. The new site will not become active until the confirmation link is clicked.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The new blog domain.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The new blog path.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"The site title.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":"The user's login name.","types":"string","variable":"$user_login","default":"null","required":"yes"},{"content":"The user's email address.","types":"string","variable":"$user_email","default":"null","required":"yes"},{"content":"The activation key created in wpmu_signup_blog()","types":"string","variable":"$key","default":"null","required":"yes"},{"content":" Signup meta data. By default, contains the requested privacy setting and lang_id.","types":"array","variable":"$meta","default":"array()","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"wpmu_signup_user_notification","desc":"<p>This is the notification function used when no new site has been requested.</p> <p>Filter {@see 'wpmu_signup_user_notification'} to bypass this function or replace it with your own notification behavior.</p> <p>Filter {@see 'wpmu_signup_user_notification_email'} and {@see 'wpmu_signup_user_notification_subject'} to change the content and subject line of the email sent to newly registered users.</p>","summary":"Send a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not become active until the confirmation link is clicked.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The user's login name.","types":"string","variable":"$user_login","default":"null","required":"yes"},{"content":"The user's email address.","types":"string","variable":"$user_email","default":"null","required":"yes"},{"content":"The activation key created in wpmu_signup_user()","types":"string","variable":"$key","default":"null","required":"yes"},{"content":" Signup meta data. Default empty array.","types":"array","variable":"$meta","default":"array()","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"wpmu_activate_signup","desc":"<p>Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events that should happen only when users or sites are self-created (since those actions are not called when users and sites are created by a Super Admin).</p>","summary":"Activate a signup.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The activation key provided to the user.","types":"string","variable":"$key","default":"null","required":"yes"}],"return":{"content":"An array containing information about the activated user and/or blog","types":"array|WP_Error"}},{"name":"wpmu_create_user","desc":"<p>This function runs when a user self-registers as well as when a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events that should affect all new users, but only on Multisite (otherwise use {@see'user_register'}).</p>","summary":"Create a user.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The new user's login name.","types":"string","variable":"$user_name","default":"null","required":"yes"},{"content":"The new user's password.","types":"string","variable":"$password","default":"null","required":"yes"},{"content":"The new user's email address.","types":"string","variable":"$email","default":"null","required":"yes"}],"return":{"content":"Returns false on failure, or int $user_id on success","types":"int|false"}},{"name":"wpmu_create_blog","desc":"<p>This function runs when a user self-registers a new site as well as when a Super Admin creates a new site. Hook to {@see 'wpmu_new_blog'} for events that should affect all new sites.</p> <p>On subdirectory installations, $domain is the same as the main site's domain, and the path is the subdirectory name (eg 'example.com' and '/blog1/'). On subdomain installations, $domain is the new subdomain + root domain (eg 'blog1.example.com'), and $path is '/'.</p>","summary":"Create a site.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The new site's domain.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The new site's path.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"The new site's title.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":"The user ID of the new site's admin.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":" Array of key=>value pairs used to set initial site options. If valid status keys are included ('public', 'archived', 'mature', 'spam', 'deleted', or 'lang_id') the given site status(es) will be updated. Otherwise, keys and values will be used to set options for the new site. Default empty array.","types":"array","variable":"$options","default":"array()","required":"no"},{"content":" Network ID. Only relevant on multi-network installations.","types":"int","variable":"$network_id","default":"1","required":"no"}],"return":{"content":"Returns WP_Error object on failure, the new site ID on success.","types":"int|WP_Error"}},{"name":"newblog_notify_siteadmin","desc":"<p>Filter {@see 'newblog_notify_siteadmin'} to change the content of the notification email.</p>","summary":"Notifies the network admin that a new site has been activated.","type":"function","category":"Multisite Functions","since":"5.1.0","param":[{"content":"The new site's object or ID.","types":"WP_Site|int","variable":"$blog_id","default":"null","required":"yes"},{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"newuser_notify_siteadmin","desc":"<p>Filter {@see 'newuser_notify_siteadmin'} to change the content of the notification email.</p>","summary":"Notifies the network admin that a new user has been activated.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The new user's ID.","types":"int","variable":"$user_id","default":"null","required":"yes"}],"return":{"content":"","types":"bool"}},{"name":"domain_exists","desc":"<p>The name is the site's subdomain or the site's subdirectory path depending on the network settings.</p> <p>Used during the new site registration process to ensure that each site name is unique.</p>","summary":"Checks whether a site name is already taken.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The domain to be checked.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The path to be checked.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":" Network ID. Relevant only on multi-network installations.","types":"int","variable":"$network_id","default":"1","required":"no"}],"return":{"content":"The site ID if the site name exists, null otherwise.","types":"int|null"}},{"name":"wpmu_welcome_notification","desc":"<p>Filter {@see 'wpmu_welcome_notification'} to disable or bypass.</p> <p>Filter {@see 'update_welcome_email'} and {@see 'update_welcome_subject'} to modify the content and subject line of the notification email.</p>","summary":"Notify a user that their blog activation has been successful.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"Blog ID.","types":"int","variable":"$blog_id","default":"null","required":"yes"},{"content":"User ID.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"User password.","types":"string","variable":"$password","default":"null","required":"yes"},{"content":"Site title.","types":"string","variable":"$title","default":"null","required":"yes"},{"content":" Signup meta data. By default, contains the requested privacy setting and lang_id.","types":"array","variable":"$meta","default":"array()","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"wpmu_welcome_user_notification","desc":"<p>Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.</p> <p>Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to modify the content and subject line of the notification email.</p>","summary":"Notify a user that their account activation has been successful.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"User ID.","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"User password.","types":"string","variable":"$password","default":"null","required":"yes"},{"content":" Signup meta data. Default empty array.","types":"array","variable":"$meta","default":"array()","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"get_current_site","desc":"<p>Returns an object containing the 'id', 'domain', 'path', and 'site_name' properties of the network being viewed.</p>","summary":"Get the current network.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","return":{"content":"","types":"WP_Network"}},{"name":"get_most_recent_post_of_user","desc":"<p>Walks through each of a user's blogs to find the post with the most recent post_date_gmt.</p>","summary":"Get a user's most recent post.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"}],"return":{"content":"Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts","types":"array"}},{"name":"check_upload_mimes","desc":"<p>WordPress ships with a set of allowed upload filetypes, which is defined in wp-includes/functions.php in get_allowed_mime_types(). This function is used to filter that list against the filetype whitelist provided by Multisite Super Admins at wp-admin/network/settings.php.</p>","summary":"Check an array of MIME types against a whitelist.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"array","variable":"$mimes","default":"null","required":"yes"}],"return":{"content":"","types":"array"}},{"name":"update_posts_count","desc":"<p>WordPress MS stores a blog's post count as an option so as to avoid extraneous COUNTs when a blog's details are fetched with get_site(). This function is called when posts are published or unpublished to make sure the count stays current.</p>","summary":"Update a blog's post count.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"}]},{"name":"wpmu_log_new_registrations","desc":"","summary":"Logs the user email, IP, and registration date of a new site.","type":"function","category":"Multisite Functions","since":"5.1.0","param":[{"content":"The new site's object or ID.","types":"WP_Site|int","variable":"$blog_id","default":"null","required":"yes"},{"content":"User ID, or array of arguments including 'user_id'.","types":"int|array","variable":"$user_id","default":"null","required":"yes"}]},{"name":"global_terms","desc":"","summary":"Maintains a canonical list of terms by syncing terms created for each blog with the global terms table.","type":"function","category":"Multisite Functions","since":"3.0.0","param":[{"content":"An ID for a term on the current blog.","types":"int","variable":"$term_id","default":"null","required":"yes"},{"content":"Not used.","types":"string","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"An ID from the global terms table mapped from $term_id.","types":"int"}},{"name":"redirect_this_site","desc":"","summary":"Ensure that the current site's domain is listed in the allowed redirect host list.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"Not used.","types":"array|string","variable":"$deprecated","default":"''","required":"no"}],"return":{"content":"The current site's domain","types":"array"}},{"name":"upload_is_file_too_big","desc":"","summary":"Check whether an upload is too big.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"array","variable":"$upload","default":"null","required":"yes"}],"return":{"content":"If the upload is under the size limit, $upload is returned. Otherwise returns an error message.","types":"string|array"}},{"name":"signup_nonce_fields","desc":"","summary":"Add a nonce field to the signup page.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)"},{"name":"signup_nonce_check","desc":"","summary":"Process the signup nonce created in signup_nonce_fields().","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"array","variable":"$result","default":"null","required":"yes"}],"return":{"content":"","types":"array"}},{"name":"maybe_redirect_404","desc":"","summary":"Correct 404 redirects when NOBLOGREDIRECT is defined.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)"},{"name":"maybe_add_existing_user_to_blog","desc":"<p>This will only work when the user's details are saved as an option keyed as 'new<em>user</em>{key}', where '{key}' is a hash generated for the user to be added, as when a user is invited through the regular WP Add User interface.</p>","summary":"Add a new user to a blog by visiting /newbloguser/{key}/.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)"},{"name":"add_existing_user_to_blog","desc":"","summary":"Add a user to a blog based on details from maybe_add_existing_user_to_blog().","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"array","variable":"$details","default":"false","required":"no"}],"return":{"content":"","types":"true|WP_Error|void"}},{"name":"add_new_user_to_blog","desc":"<p>To add a user in general, use add_user_to_blog(). This function is specifically hooked into the {@see 'wpmu_activate_user'} action.</p>","summary":"Adds a newly created user to the appropriate blog","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"int","variable":"$user_id","default":"null","required":"yes"},{"content":"Ignored.","types":"mixed","variable":"$password","default":"null","required":"yes"},{"content":"","types":"array","variable":"$meta","default":"null","required":"yes"}]},{"name":"fix_phpmailer_messageid","desc":"","summary":"Correct From host on outgoing mail to match the site domain","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"The PHPMailer instance (passed by reference).","types":"PHPMailer","variable":"$phpmailer","default":"null","required":"yes"}]},{"name":"is_user_spammy","desc":"","summary":"Check to see whether a user is marked as a spammer, based on user login.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":" Defaults to current user. WP_User object, or user login name as a string.","types":"string|WP_User","variable":"$user","default":"null","required":"no"}],"return":{"content":"","types":"bool"}},{"name":"update_blog_public","desc":"<p>Public blogs have a setting of 1, private blogs are 0.</p>","summary":"Update this blog's 'public' setting in the global blogs table.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"int","variable":"$old_value","default":"null","required":"yes"},{"content":"The new public value","types":"int","variable":"$value","default":"null","required":"yes"}]},{"name":"users_can_register_signup_filter","desc":"","summary":"Check whether users can self-register, based on Network settings.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","return":{"content":"","types":"bool"}},{"name":"welcome_user_msg_filter","desc":"","summary":"Ensure that the welcome message is not empty. Currently unused.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","param":[{"content":"","types":"string","variable":"$text","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"force_ssl_content","desc":"","summary":"Whether to force SSL on content.","type":"function","category":"Multisite Functions","since":"2.8.5","param":[{"content":"","types":"bool","variable":"$force","default":"''","required":"no"}],"return":{"content":"True if forced, false if not forced.","types":"bool"}},{"name":"filter_SSL","desc":"<p>Useful as a filter.</p>","summary":"Formats a URL to use https.","type":"function","category":"Multisite Functions","since":"2.8.5","param":[{"content":"URL","types":"string","variable":"$url","default":"null","required":"yes"}],"return":{"content":"URL with https as the scheme","types":"string"}},{"name":"wp_schedule_update_network_counts","desc":"","summary":"Schedule update of the network-wide counts for the current network.","type":"function","category":"Uncategorised","since":"3.1.0"},{"name":"wp_update_network_counts","desc":"","summary":"Update the network-wide counts for the current network.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}]},{"name":"wp_maybe_update_network_site_counts","desc":"<p>If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count on a network when a site is created or its status is updated.</p>","summary":"Update the count of sites for the current network.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}]},{"name":"wp_maybe_update_network_user_counts","desc":"<p>If enabled through the {@see 'enable_live_network_counts'} filter, update the users count on a network when a user is created or its status is updated.</p>","summary":"Update the network-wide users count.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}]},{"name":"wp_update_network_site_counts","desc":"","summary":"Update the network-wide site count.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}]},{"name":"wp_update_network_user_counts","desc":"","summary":"Update the network-wide user count.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}]},{"name":"get_space_used","desc":"","summary":"Returns the space used by the current blog.","type":"function","category":"Multisite Functions","since":"3.5.0","return":{"content":"Used space in megabytes","types":"int"}},{"name":"get_space_allowed","desc":"","summary":"Returns the upload quota for the current blog.","type":"function","category":"Multisite Functions","since":"MU (3.0.0)","return":{"content":"Quota in megabytes","types":"int"}},{"name":"get_upload_space_available","desc":"","summary":"Determines if there is any upload space left in the current blog's quota.","type":"function","category":"Multisite Functions","since":"3.0.0","return":{"content":"of upload space available in bytes","types":"int"}},{"name":"is_upload_space_available","desc":"","summary":"Determines if there is any upload space left in the current blog's quota.","type":"function","category":"Multisite Functions","since":"3.0.0","return":{"content":"True if space is available, false otherwise.","types":"bool"}},{"name":"upload_size_limit_filter","desc":"","summary":"Filters the maximum upload file size allowed, in bytes.","type":"function","category":"Multisite Functions","since":"3.0.0","param":[{"content":"Upload size limit in bytes.","types":"int","variable":"$size","default":"null","required":"yes"}],"return":{"content":"Upload size limit in bytes.","types":"int"}},{"name":"wp_is_large_network","desc":"<p>The default criteria for a large network is either more than 10,000 users or more than 10,000 sites. Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.</p>","summary":"Whether or not we have a large network.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"'sites or 'users'. Default is 'sites'.","types":"string","variable":"$using","default":"'sites'","required":"no"},{"content":"ID of the network. Default is the current network.","types":"int|null","variable":"$network_id","default":"null","required":"no"}],"return":{"content":"True if the network meets the criteria for large. False otherwise.","types":"bool"}},{"name":"get_subdirectory_reserved_names","desc":"","summary":"Retrieves a list of reserved site on a sub-directory Multisite installation.","type":"function","category":"Uncategorised","since":"4.4.0","return":{"content":"$names Array of reserved subdirectory names.","types":"array"}},{"name":"update_network_option_new_admin_email","desc":"<p>The new network admin address will not become active until confirmed.</p>","summary":"Send a confirmation request email when a change of network admin email address is attempted.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"The old network admin email address.","types":"string","variable":"$old_value","default":"null","required":"yes"},{"content":"The proposed new network admin email address.","types":"string","variable":"$value","default":"null","required":"yes"}]},{"name":"wp_network_admin_email_change_notification","desc":"","summary":"Send an email to the old network admin email address when the network admin email address changes.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"The relevant database option name.","types":"string","variable":"$option_name","default":"null","required":"yes"},{"content":"The new network admin email address.","types":"string","variable":"$new_email","default":"null","required":"yes"},{"content":"The old network admin email address.","types":"string","variable":"$old_email","default":"null","required":"yes"},{"content":"ID of the network.","types":"int","variable":"$network_id","default":"null","required":"yes"}]},{"name":"is_subdomain_install","desc":"","summary":"Whether a subdomain configuration is enabled.","type":"function","category":"Multisite Functions","since":"3.0.0","return":{"content":"True if subdomain configuration is enabled, false otherwise.","types":"bool"}},{"name":"wp_get_active_network_plugins","desc":"<p>The default directory is wp-content/plugins. To change the default directory manually, define <code>WP_PLUGIN_DIR</code> and <code>WP_PLUGIN_URL</code> in <code>wp-config.php</code>.</p>","summary":"Returns array of network plugin files to be included in global scope.","type":"function","category":"Uncategorised","access":"private","since":"3.1.0","return":{"content":"Files to include.","types":"array"}},{"name":"ms_site_check","desc":"<p>Checks if the blog is deleted, inactive, archived, or spammed.</p> <p>Dies with a default message if the blog does not pass the check.</p> <p>To change the default message when a blog does not pass the check, use the wp-content/blog-deleted.php, blog-inactive.php and blog-suspended.php drop-ins.</p>","summary":"Checks status of current blog.","type":"function","category":"Multisite Functions","since":"3.0.0","return":{"content":"Returns true on success, or drop-in file to include.","types":"true|string"}},{"name":"get_network_by_path","desc":"","summary":"Retrieve the closest matching network for a domain and path.","type":"function","category":"Uncategorised","since":"3.9.0","param":[{"content":"Domain to check.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"Path to check.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"Path segments to use. Defaults to null, or the full path.","types":"int|null","variable":"$segments","default":"null","required":"no"}],"return":{"content":"Network object if successful. False when no network is found.","types":"WP_Network|false"}},{"name":"get_site_by_path","desc":"<p>This will not necessarily return an exact match for a domain and path. Instead, it breaks the domain and path into pieces that are then used to match the closest possibility from a query.</p> <p>The intent of this method is to match a site object during bootstrap for a requested site address</p>","summary":"Retrieves the closest matching site object by its domain and path.","type":"function","category":"Uncategorised","since":"4.7.0","param":[{"content":"Domain to check.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"Path to check.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":"Path segments to use. Defaults to null, or the full path.","types":"int|null","variable":"$segments","default":"null","required":"no"}],"return":{"content":"Site object if successful. False when no site is found.","types":"WP_Site|false"}},{"name":"ms_load_current_site_and_network","desc":"<p>Prior to 4.6.0, this was a procedural block in <code>ms-settings.php</code>. It was wrapped into a function to facilitate unit tests. It should not be used outside of core.</p> <p>Usually, it's easier to query the site first, which then declares its network. In limited situations, we either can or must find the network first.</p> <p>If a network and site are found, a <code>true</code> response will be returned so that the request can continue.</p> <p>If neither a network or site is found, <code>false</code> or a URL string will be returned so that either an error can be shown or a redirect can occur.</p>","summary":"Identifies the network and site of a requested domain and path and populates the corresponding network and site global objects as part of the multisite bootstrap process.","type":"function","category":"Uncategorised","since":"4.6.0","access":"private","param":[{"content":"The requested domain.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The requested path.","types":"string","variable":"$path","default":"null","required":"yes"},{"content":" Whether a subdomain (true) or subdirectory (false) configuration. Default false.","types":"bool","variable":"$subdomain","default":"false","required":"no"}],"return":{"content":"True if bootstrap successfully populated <code>$current_blog</code> and <code>$current_site</code>. False if bootstrap could not be properly completed. Redirect URL if parts exist, but the request as a whole can not be fulfilled.","types":"bool|string"}},{"name":"ms_not_installed","desc":"<p>Used when a blog's tables do not exist. Checks for a missing $wpdb->site table as well.</p>","summary":"Displays a failure message.","type":"function","category":"Multisite Functions","access":"private","since":"4.4.0","param":[{"content":"The requested domain for the error to reference.","types":"string","variable":"$domain","default":"null","required":"yes"},{"content":"The requested path for the error to reference.","types":"string","variable":"$path","default":"null","required":"yes"}]},{"name":"get_current_site_name","desc":"<p>This function simply returns the object, as before. The bootstrap takes care of setting site_name.</p>","summary":"This deprecated function formerly set the site_name property of the $current_site object.","type":"function","category":"Multisite Functions","access":"private","since":"3.0.0","deprecated":{"content":"3.9.0","desc":"Use get_current_site() instead."},"param":[{"content":"","types":"object","variable":"$current_site","default":"null","required":"yes"}],"return":{"content":"","types":"object"}},{"name":"wpmu_current_site","desc":"<p>The current bootstrap code is now responsible for parsing the site and network load as well as setting the global $current_site object.</p>","summary":"This deprecated function managed much of the site and network loading in multisite.","type":"function","category":"Multisite Functions","access":"private","since":"3.0.0","deprecated":{"content":"3.9.0","desc":"null"},"return":{"content":"","types":"object"}},{"name":"wp_get_network","desc":"","summary":"Retrieve an object containing information about the requested network.","type":"function","category":"Uncategorised","since":"3.9.0","deprecated":{"content":"4.7.0","desc":"Use <code>get_network()</code>"},"param":[{"content":"The network's database row or ID.","types":"object|int","variable":"$network","default":"null","required":"yes"}],"return":{"content":"Object containing network information if found, false if not.","types":"WP_Network|false"}},{"name":"get_network","desc":"<p>Network data will be cached and returned after being passed through a filter. If the provided network is empty, the current network global will be used.</p>","summary":"Retrieves network data given a network ID or network object.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Network to retrieve. Default is the current network.","types":"WP_Network|int|null","variable":"$network","default":"null","required":"no"}],"return":{"content":"The network object or null if not found.","types":"WP_Network|null"}},{"name":"get_networks","desc":"","summary":"Retrieves a list of networks.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Array or string of arguments. See WP_Network_Query::parse_query() for information on accepted arguments. Default empty array.","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"List of WP_Network objects, a list of network ids when 'fields' is set to 'ids', or the number of networks when 'count' is passed as a query var.","types":"array|int"}},{"name":"clean_network_cache","desc":"","summary":"Removes a network from the object cache.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"Network ID or an array of network IDs to remove from cache.","types":"int|array","variable":"$ids","default":"null","required":"yes"}]},{"name":"update_network_cache","desc":"<p>Will add the networks in $networks to the cache. If network ID already exists in the network cache then it will not be updated. The network is added to the cache using the network group with the key using the ID of the networks.</p>","summary":"Updates the network cache of given networks.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":"Array of network row objects.","types":"array","variable":"$networks","default":"null","required":"yes"}]},{"name":"_prime_network_caches","desc":"","summary":"Adds any networks from the given IDs to the cache that do not already exist in cache.","type":"function","category":"Uncategorised","since":"4.6.0","access":"private","param":[{"content":"Array of network IDs.","types":"array","variable":"$network_ids","default":"null","required":"yes"}]},{"name":"wp_insert_site","desc":"","summary":"Inserts a new site into the database.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"{ Data for the new site that should be inserted. @type string $domain Site domain. Default empty string. @type string $path Site path. Default '/'. @type int $network_id The site's network ID. Default is the current network ID. @type string $registered When the site was registered, in SQL datetime format. Default is the current time. @type string $last_updated When the site was last updated, in SQL datetime format. Default is the value of $registered. @type int $public Whether the site is public. Default 1. @type int $archived Whether the site is archived. Default 0. @type int $mature Whether the site is mature. Default 0. @type int $spam Whether the site is spam. Default 0. @type int $deleted Whether the site is deleted. Default 0. @type int $lang_id The site's language ID. Currently unused. Default 0. @type int $user_id User ID for the site administrator. Passed to the <code>wp_initialize_site</code> hook. @type string $title Site title. Default is 'Site %d' where %d is the site ID. Passed to the <code>wp_initialize_site</code> hook. @type array $options Custom option $key => $value pairs to use. Default empty array. Passed to the <code>wp_initialize_site</code> hook. @type array $meta Custom site metadata $key => $value pairs to use. Default empty array. Passed to the <code>wp_initialize_site</code> hook. }","types":"array","variable":"$data","default":"null","required":"yes"}],"return":{"content":"The new site's ID on success, or error object on failure.","types":"int|WP_Error"}},{"name":"wp_update_site","desc":"","summary":"Updates a site in the database.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"ID of the site that should be updated.","types":"int","variable":"$site_id","default":"null","required":"yes"},{"content":"Site data to update. See {@see wp_insert_site()} for the list of supported keys.","types":"array","variable":"$data","default":"null","required":"yes"}],"return":{"content":"The updated site's ID on success, or error object on failure.","types":"int|WP_Error"}},{"name":"wp_delete_site","desc":"","summary":"Deletes a site from the database.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"ID of the site that should be deleted.","types":"int","variable":"$site_id","default":"null","required":"yes"}],"return":{"content":"The deleted site object on success, or error object on failure.","types":"WP_Site|WP_Error"}},{"name":"get_site","desc":"<p>Site data will be cached and returned after being passed through a filter. If the provided site is empty, the current site global will be used.</p>","summary":"Retrieves site data given a site ID or site object.","type":"function","category":"Uncategorised","since":"4.6.0","param":[{"content":" Site to retrieve. Default is the current site.","types":"WP_Site|int|null","variable":"$site","default":"null","required":"no"}],"return":{"content":"The site object or null if not found.","types":"WP_Site|null"}},{"name":"_prime_site_caches","desc":"","summary":"Adds any sites from the given ids to the cache that do not already exist in cache.","type":"function","category":"Uncategorised","since":"5.1.0","access":"private","param":[{"content":"ID list.","types":"array","variable":"$ids","default":"null","required":"yes"},{"content":" Whether to update the meta cache. Default true.","types":"bool","variable":"$update_meta_cache","default":"true","required":"no"}]},{"name":"update_site_cache","desc":"","summary":"Updates sites in cache.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Array of site objects.","types":"array","variable":"$sites","default":"null","required":"yes"},{"content":"Whether to update site meta cache. Default true.","types":"bool","variable":"$update_meta_cache","default":"true","required":"no"}]},{"name":"update_sitemeta_cache","desc":"<p>Performs SQL query to retrieve all metadata for the sites matching <code>$site_ids</code> and stores them in the cache. Subsequent calls to <code>get_site_meta()</code> will not need to query the database.</p>","summary":"Updates metadata cache for list of site IDs.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"List of site IDs.","types":"array","variable":"$site_ids","default":"null","required":"yes"}],"return":{"content":"Returns false if there is nothing to update. Returns an array of metadata on success.","types":"array|false"}},{"name":"get_sites","desc":"","summary":"Retrieves a list of sites matching requested arguments.","type":"function","category":"Uncategorised","since":"4.8.0","param":[{"content":"{ Optional. Array or query string of site query parameters. Default empty. @type array $site<strong>in Array of site IDs to include. Default empty. @type array $site</strong>not_in Array of site IDs to exclude. Default empty. @type bool $count Whether to return a site count (true) or array of site objects. Default false. @type array $date_query Date query clauses to limit sites by. See WP_Date_Query. Default null. @type string $fields Site fields to return. Accepts 'ids' (returns an array of site IDs) or empty (returns an array of complete site objects). Default empty. @type int $ID A site ID to only return that site. Default empty. @type int $number Maximum number of sites to retrieve. Default 100. @type int $offset Number of sites to offset the query. Used to build LIMIT clause. Default 0. @type bool $no_found_rows Whether to disable the <code>SQL_CALC_FOUND_ROWS</code> query. Default true. @type string|array $orderby Site status or array of statuses. Accepts 'id', 'domain', 'path', 'network_id', 'last_updated', 'registered', 'domain_length', 'path_length', 'site<strong>in' and 'network</strong>in'. Also accepts false, an empty array, or 'none' to disable <code>ORDER BY</code> clause. Default 'id'. @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'. @type int $network_id Limit results to those affiliated with a given network ID. If 0, include all networks. Default 0. @type array $network<strong>in Array of network IDs to include affiliated sites for. Default empty. @type array $network</strong>not_in Array of network IDs to exclude affiliated sites for. Default empty. @type string $domain Limit results to those affiliated with a given domain. Default empty. @type array $domain<strong>in Array of domains to include affiliated sites for. Default empty. @type array $domain</strong>not_in Array of domains to exclude affiliated sites for. Default empty. @type string $path Limit results to those affiliated with a given path. Default empty. @type array $path<strong>in Array of paths to include affiliated sites for. Default empty. @type array $path</strong>not_in Array of paths to exclude affiliated sites for. Default empty. @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. @type int $lang_id Limit results to a language ID. Default empty. @type array $lang<strong>in Array of language IDs to include affiliated sites for. Default empty. @type array $lang</strong>not_in Array of language IDs to exclude affiliated sites for. Default empty. @type string $search Search term(s) to retrieve matching sites for. Default empty. @type array $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. Default empty array. @type bool $update_site_cache Whether to prime the cache for found sites. Default true. }","types":"string|array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"List of WP_Site objects, a list of site ids when 'fields' is set to 'ids', or the number of sites when 'count' is passed as a query var.","types":"array|int"}},{"name":"wp_prepare_site_data","desc":"","summary":"Prepares site data for insertion or update in the database.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Associative array of site data passed to the respective function. See {@see wp_insert_site()} for the possibly included data.","types":"array","variable":"$data","default":"null","required":"yes"},{"content":"Site data defaults to parse $data against.","types":"array","variable":"$defaults","default":"null","required":"yes"},{"content":" Old site object if an update, or null if an insertion. Default null.","types":"WP_Site|null","variable":"$old_site","default":"null","required":"no"}],"return":{"content":"Site data ready for a database transaction, or WP_Error in case a validation error occurred.","types":"array|WP_Error"}},{"name":"wp_normalize_site_data","desc":"","summary":"Normalizes data for a site prior to inserting or updating in the database.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Associative array of site data passed to the respective function. See {@see wp_insert_site()} for the possibly included data.","types":"array","variable":"$data","default":"null","required":"yes"}],"return":{"content":"Normalized site data.","types":"array"}},{"name":"wp_validate_site_data","desc":"","summary":"Validates data for a site prior to inserting or updating in the database.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Error object, passed by reference. Will contain validation errors if any occurred.","types":"WP_Error","variable":"$errors","default":"null","required":"yes"},{"content":"Associative array of complete site data. See {@see wp_insert_site()} for the included data.","types":"array","variable":"$data","default":"null","required":"yes"},{"content":"The old site object if the data belongs to a site being updated, or null if it is a new site being inserted.","types":"WP_Site|null","variable":"$old_site","default":"null","required":"no"}]},{"name":"wp_initialize_site","desc":"<p>This process includes creating the site's database tables and populating them with defaults.</p>","summary":"Runs the initialization routine for a given site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID or object.","types":"int|WP_Site","variable":"$site_id","default":"null","required":"yes"},{"content":"{ Optional. Arguments to modify the initialization behavior. @type int $user_id Required. User ID for the site administrator. @type string $title Site title. Default is 'Site %d' where %d is the site ID. @type array $options Custom option $key => $value pairs to use. Default empty array. @type array $meta Custom site metadata $key => $value pairs to use. Default empty array. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"True on success, or error object on failure.","types":"bool|WP_Error"}},{"name":"wp_uninitialize_site","desc":"<p>This process includes dropping the site's database tables and deleting its uploads directory.</p>","summary":"Runs the uninitialization routine for a given site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID or object.","types":"int|WP_Site","variable":"$site_id","default":"null","required":"yes"}],"return":{"content":"True on success, or error object on failure.","types":"bool|WP_Error"}},{"name":"wp_is_site_initialized","desc":"<p>A site is considered initialized when its database tables are present.</p>","summary":"Checks whether a site is initialized.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID or object.","types":"int|WP_Site","variable":"$site_id","default":"null","required":"yes"}],"return":{"content":"True if the site is initialized, false otherwise.","types":"bool"}},{"name":"clean_blog_cache","desc":"","summary":"Clean the blog cache","type":"function","category":"Miscellaneous","since":"3.5.0","param":[{"content":"The site object or ID to be cleared from cache.","types":"WP_Site|int","variable":"$blog","default":"null","required":"yes"}]},{"name":"add_site_meta","desc":"","summary":"Adds metadata to a site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID.","types":"int","variable":"$site_id","default":"null","required":"yes"},{"content":"Metadata name.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value. Must be serializable if non-scalar.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":" Whether the same key should not be added. Default false.","types":"bool","variable":"$unique","default":"false","required":"no"}],"return":{"content":"Meta ID on success, false on failure.","types":"int|false"}},{"name":"delete_site_meta","desc":"<p>You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.</p>","summary":"Removes metadata matching criteria from a site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID.","types":"int","variable":"$site_id","default":"null","required":"yes"},{"content":"Metadata name.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":" Metadata value. Must be serializable if non-scalar. Default empty.","types":"mixed","variable":"$meta_value","default":"''","required":"no"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"get_site_meta","desc":"","summary":"Retrieves metadata for a site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID.","types":"int","variable":"$site_id","default":"null","required":"yes"},{"content":" The meta key to retrieve. By default, returns data for all keys. Default empty.","types":"string","variable":"$key","default":"''","required":"no"},{"content":" Whether to return a single value. Default false.","types":"bool","variable":"$single","default":"false","required":"no"}],"return":{"content":"Will be an array if $single is false. Will be value of meta data field if $single is true.","types":"mixed"}},{"name":"update_site_meta","desc":"<p>Use the $prev_value parameter to differentiate between meta fields with the same key and site ID.</p> <p>If the meta field for the site does not exist, it will be added.</p>","summary":"Updates metadata for a site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID.","types":"int","variable":"$site_id","default":"null","required":"yes"},{"content":"Metadata key.","types":"string","variable":"$meta_key","default":"null","required":"yes"},{"content":"Metadata value. Must be serializable if non-scalar.","types":"mixed","variable":"$meta_value","default":"null","required":"yes"},{"content":" Previous value to check before removing. Default empty.","types":"mixed","variable":"$prev_value","default":"''","required":"no"}],"return":{"content":"Meta ID if the key didn't exist, true on successful update, false on failure.","types":"int|bool"}},{"name":"delete_site_meta_by_key","desc":"","summary":"Deletes everything from site meta matching meta key.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Metadata key to search for when deleting.","types":"string","variable":"$meta_key","default":"null","required":"yes"}],"return":{"content":"Whether the site meta key was deleted from the database.","types":"bool"}},{"name":"wp_maybe_update_network_site_counts_on_update","desc":"","summary":"Updates the count of sites for a network based on a changed site.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"The site object that has been inserted, updated or deleted.","types":"WP_Site","variable":"$new_site","default":"null","required":"yes"},{"content":" If $new_site has been updated, this must be the previous state of that site. Default null.","types":"WP_Site|null","variable":"$old_site","default":"null","required":"no"}]},{"name":"wp_maybe_transition_site_statuses_on_update","desc":"","summary":"Triggers actions on site status updates.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"The site object after the update.","types":"WP_Site","variable":"$new_site","default":"null","required":"yes"},{"content":" If $new_site has been updated, this must be the previous state of that site. Default null.","types":"WP_Site|null","variable":"$old_site","default":"null","required":"no"}]},{"name":"wp_maybe_clean_new_site_cache_on_update","desc":"","summary":"Cleans the necessary caches after specific site data has been updated.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"The site object after the update.","types":"WP_Site","variable":"$new_site","default":"null","required":"yes"},{"content":"The site obejct prior to the update.","types":"WP_Site","variable":"$old_site","default":"null","required":"yes"}]},{"name":"wp_update_blog_public_option_on_site_update","desc":"","summary":"Updates the `blog_public` option for a given site ID.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Site ID.","types":"int","variable":"$site_id","default":"null","required":"yes"},{"content":"The value of the site status.","types":"string","variable":"$public","default":"null","required":"yes"}]},{"name":"wp_cache_set_sites_last_changed","desc":"","summary":"Sets the last changed time for the 'sites' cache group.","type":"function","category":"Uncategorised","since":"5.1.0"},{"name":"wp_check_site_meta_support_prefilter","desc":"","summary":"Aborts calls to site meta if it is not supported.","type":"function","category":"Uncategorised","since":"5.1.0","param":[{"content":"Skip-value for whether to proceed site meta function execution.","types":"mixed","variable":"$check","default":"null","required":"yes"}],"return":{"content":"Original value of $check, or false if site meta is not supported.","types":"mixed"}},{"name":"wp_nav_menu","desc":"","summary":"Displays a navigation menu.","type":"function","category":"Other functions","since":"4.7.0","param":[{"content":"{ Optional. Array of nav menu arguments. @type int|string|WP_Term $menu Desired menu. Accepts a menu ID, slug, name, or object. Default empty. @type string $menu_class CSS class to use for the ul element which forms the menu. Default 'menu'. @type string $menu_id The ID that is applied to the ul element which forms the menu. Default is the menu slug, incremented. @type string $container Whether to wrap the ul, and what to wrap it with. Default 'div'. @type string $container_class Class that is applied to the container. Default 'menu-{menu slug}-container'. @type string $container_id The ID that is applied to the container. Default empty. @type callable|bool $fallback_cb If the menu doesn't exists, a callback function will fire. Default is 'wp_page_menu'. Set to false for no fallback. @type string $before Text before the link markup. Default empty. @type string $after Text after the link markup. Default empty. @type string $link_before Text before the link text. Default empty. @type string $link_after Text after the link text. Default empty. @type bool $echo Whether to echo the menu or return it. Default true. @type int $depth How many levels of the hierarchy are to be included. 0 means all. Default 0. @type object $walker Instance of a custom walker class. Default empty. @type string $theme_location Theme location to be used. Must be registered with register_nav_menu() in order to be selectable by the user. @type string $items_wrap How the list items should be wrapped. Default is a ul with an id and class. Uses printf() format with numbered placeholders. @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'. }","types":"array","variable":"$args","default":"array()","required":"no"}],"return":{"content":"Menu output if $echo is false, false if there are no items or no menu was found.","types":"string|false|void"}},{"name":"_wp_menu_item_classes_by_context","desc":"","summary":"Add the class property classes for the current context, if applicable.","type":"function","category":"Uncategorised","access":"private","since":"3.0.0","param":[{"content":"The current menu item objects to which to add the class property information.","types":"array","variable":"$menu_items","default":"null","required":"yes"}]},{"name":"walk_nav_menu_tree","desc":"","summary":"Retrieve the HTML list content for nav menu items.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"The menu items, sorted by each menu item's menu order.","types":"array","variable":"$items","default":"null","required":"yes"},{"content":"Depth of the item in reference to parents.","types":"int","variable":"$depth","default":"null","required":"yes"},{"content":"An object containing wp_nav_menu() arguments.","types":"stdClass","variable":"$r","default":"null","required":"yes"}],"return":{"content":"The HTML list content for the menu items.","types":"string"}},{"name":"_nav_menu_item_id_use_once","desc":"","summary":"Prevents a menu item ID from being used more than once.","type":"function","category":"Uncategorised","since":"3.0.1","access":"private","param":[{"content":"","types":"string","variable":"$id","default":"null","required":"yes"},{"content":"","types":"object","variable":"$item","default":"null","required":"yes"}],"return":{"content":"","types":"string"}},{"name":"wp_get_nav_menu_object","desc":"","summary":"Returns a navigation menu object.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Menu ID, slug, name, or object.","types":"int|string|WP_Term","variable":"$menu","default":"null","required":"yes"}],"return":{"content":"False if $menu param isn't supplied or term does not exist, menu object if successful.","types":"WP_Term|false"}},{"name":"is_nav_menu","desc":"<p>Returns true if it is; false otherwise.</p>","summary":"Check if the given ID is a navigation menu.","type":"function","category":"Uncategorised","since":"3.0.0","param":[{"content":"Menu ID, slug, name, or object of menu to check.","types":"int|string|WP_Term","variable":"$menu","default":"null","required":"yes"}],"return":{"content":"Whether the menu exists.","types":"bool"}},{"name":"register_nav_menus","desc":"","summary":"Registers navigation menu locations for a theme.","type":"function","category":"Other functions","since":"3.0.0","param":[{"content":"Associative array of menu location identifiers (like a slug) and descriptive text.","types":"array","variable":"$locations","default":"array()","required":"no"}]},{"name":"unregister_nav_menu","desc":"","summary":"Unregisters a navigation menu location for a theme.","type":"function","category":"Other functions","since":"3.1.0","param":[{"content":"The menu location identifier.","types":"string","variable":"$location","default":"null","required":"yes"}],"return":{"content":"True on success, false on failure.","types":"bool"}},{"name":"register_nav_menu","desc":"","summary":"Registers a navigation menu location for a theme.","type":"function","category":"Other functions","since":"3.0.0","param":[{"content":"Menu location identifier, like a slug.","types":"string","variable":"$location","default":"null","required":"yes"},{"content":"Menu location descriptive text.","types":"string","variable":"$description","default":"null","required":"yes"}]},{"name":"get_registered_nav_menus","desc":"","summary":"Retrieves all registered navigation menu locations in a theme.","type":"function","category":"Other functions","since":"3.0.0","return":{"content":"Registered navigation menu locations. If none are registered, an empty array.","types":"array"}},{"name":"get_nav_menu_locations","desc":"","summary":"Retrieves all registered navigation menu locations and the menus assigned to them.","type":"function","category":"Uncategorised","since":"3.0.0","return":{"content":"Registered navigation menu locations and the menus assigned them. If none are registered, an empty array.","types":"array"}},{"name":"has_nav_menu","desc":"","summary":"Determines whether a registered nav menu location has a menu assigned to it.","type":"function","category":"Conditional Tags Index","since":"3.0.0","param":[{"content":"Menu location identifier.","types":"string","variable":"$location","default":"null","required":"yes"}],"return":{"content":"Whether location has a menu.","types":"bool"}},{"name":"wp_get_nav_menu_name","desc":"","summary":"Returns the name of a navigation menu.","type":"function","category":"Uncategorised","since":"4.9.0","param":[{"content":"Menu location identifier.","types":"string","variable":"$location","default":"null","required":"yes"}],"return":{"content":" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment