| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Deprecated functions from past WordPress versions. You shouldn't use these functions and look for the alternatives instead. The functions will be removed in a later version.
| File Size: | 4313 lines (128 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| get_postdata($postid) X-Ref |
| Retrieves all post data for a given post. return: array Post data. param: int $postid Post ID. since: 0.71 |
| start_wp() X-Ref |
| Sets up the WordPress Loop. Use The Loop instead. since: 1.0.1 |
| the_category_ID($display = true) X-Ref |
| Returns or prints a category ID. return: int Category ID. param: bool $display Optional. Whether to display the output. Default true. since: 0.71 |
| the_category_head( $before = '', $after = '' ) X-Ref |
| Prints a category with optional text before and after. param: string $before Optional. Text to display before the category. Default empty. param: string $after Optional. Text to display after the category. Default empty. since: 0.71 |
| previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') X-Ref |
| Prints a link to the previous post. param: string $format param: string $previous param: string $title param: string $in_same_cat param: int $limitprev param: string $excluded_categories since: 1.5.0 |
| next_post($format='%', $next='next post: ', $title='yes', $in_same_cat='no', $limitnext=1, $excluded_categories='') X-Ref |
| Prints link to the next post. param: string $format param: string $next param: string $title param: string $in_same_cat param: int $limitnext param: string $excluded_categories since: 0.71 |
| user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') X-Ref |
| Whether user can create a post. return: bool param: int $user_id param: int $blog_id Not Used param: int $category_id Not Used since: 1.5.0 |
| user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') X-Ref |
| Whether user can create a post. return: bool param: int $user_id param: int $blog_id Not Used param: int $category_id Not Used since: 1.5.0 |
| user_can_edit_post($user_id, $post_id, $blog_id = 1) X-Ref |
| Whether user can edit a post. return: bool param: int $user_id param: int $post_id param: int $blog_id Not Used since: 1.5.0 |
| user_can_delete_post($user_id, $post_id, $blog_id = 1) X-Ref |
| Whether user can delete a post. return: bool param: int $user_id param: int $post_id param: int $blog_id Not Used since: 1.5.0 |
| user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') X-Ref |
| Whether user can set new posts' dates. return: bool param: int $user_id param: int $blog_id Not Used param: int $category_id Not Used since: 1.5.0 |
| user_can_edit_post_date($user_id, $post_id, $blog_id = 1) X-Ref |
| Whether user can delete a post. return: bool returns true if $user_id can edit $post_id's date param: int $user_id param: int $post_id param: int $blog_id Not Used since: 1.5.0 |
| user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) X-Ref |
| Whether user can delete a post. return: bool returns true if $user_id can edit $post_id's comments param: int $user_id param: int $post_id param: int $blog_id Not Used since: 1.5.0 |
| user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) X-Ref |
| Whether user can delete a post. return: bool returns true if $user_id can delete $post_id's comments param: int $user_id param: int $post_id param: int $blog_id Not Used since: 1.5.0 |
| user_can_edit_user($user_id, $other_user) X-Ref |
| Can user can edit other user. return: bool param: int $user_id param: int $other_user since: 1.5.0 |
| get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',$show_description = true, $show_rating = false,$limit = -1, $show_updated = 0) X-Ref |
| Gets the links associated with category $cat_name. param: string $cat_name Optional. The category name to use. If no match is found, uses all. param: string $before Optional. The HTML to output before the link. Default empty. param: string $after Optional. The HTML to output after the link. Default '<br />'. param: string $between Optional. The HTML to output between the link/image and its description. param: bool $show_images Optional. Whether to show images (if defined). Default true. param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', param: bool $show_description Optional. Whether to show the description if show_images=false/not defined. param: bool $show_rating Optional. Show rating stars/chars. Default false. param: int $limit Optional. Limit to X entries. If not specified, all entries are shown. param: int $show_updated Optional. Whether to show last updated timestamp. Default 0. since: 0.71 |
| wp_get_linksbyname($category, $args = '') X-Ref |
| Gets the links associated with the named category. return: string|null param: string $category The category to use. param: string $args since: 1.0.1 |
| get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) X-Ref |
| Gets an array of link objects associated with category $cat_name. $links = get_linkobjectsbyname( 'fred' ); foreach ( $links as $link ) { echo '<li>' . $link->link_name . '</li>'; } return: array param: string $cat_name Optional. The category name to use. If no match is found, uses all. param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', param: int $limit Optional. Limit to X entries. If not specified, all entries are shown. since: 1.0.1 |
| get_linkobjects($category = 0, $orderby = 'name', $limit = 0) X-Ref |
| Gets an array of link objects associated with category n. Usage: $links = get_linkobjects(1); if ($links) { foreach ($links as $link) { echo '<li>'.$link->link_name.'<br />'.$link->link_description.'</li>'; } } Fields are: - link_id - link_url - link_name - link_image - link_target - link_category - link_description - link_visible - link_owner - link_rating - link_updated - link_rel - link_notes return: array param: int $category Optional. The category to use. If no category supplied, uses all. param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', param: int $limit Optional. Limit to X entries. If not specified, all entries are shown. since: 1.0.1 |
| get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '<br />', $between = " ",$show_images = true, $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) X-Ref |
| Gets the links associated with category 'cat_name' and display rating stars/chars. param: string $cat_name Optional. The category name to use. If no match is found, uses all. param: string $before Optional. The HTML to output before the link. Default empty. param: string $after Optional. The HTML to output after the link. Default '<br />'. param: string $between Optional. The HTML to output between the link/image and its description. param: bool $show_images Optional. Whether to show images (if defined). Default true. param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', param: bool $show_description Optional. Whether to show the description if show_images=false/not defined. param: int $limit Optional. Limit to X entries. If not specified, all entries are shown. param: int $show_updated Optional. Whether to show last updated timestamp. Default 0. since: 0.71 |
| get_links_withrating($category = -1, $before = '', $after = '<br />', $between = " ", $show_images = true,$orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) X-Ref |
| Gets the links associated with category n and display rating stars/chars. param: int $category Optional. The category to use. If no category supplied, uses all. param: string $before Optional. The HTML to output before the link. Default empty. param: string $after Optional. The HTML to output after the link. Default '<br />'. param: string $between Optional. The HTML to output between the link/image and its description. param: bool $show_images Optional. Whether to show images (if defined). Default true. param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', param: bool $show_description Optional. Whether to show the description if show_images=false/not defined. param: int $limit Optional. Limit to X entries. If not specified, all entries are shown. param: int $show_updated Optional. Whether to show last updated timestamp. Default 0. since: 0.71 |
| get_autotoggle($id = 0) X-Ref |
| Gets the auto_toggle setting. return: int Only returns 0. param: int $id The category to get. If no category supplied uses 0 since: 0.71 |
| list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,$optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,$recurse=0, $feed = '', $feed_image = '', $exclude = '', $hierarchical=false) X-Ref |
| Lists categories. return: null|false param: int $optionall param: string $all param: string $sort_column param: string $sort_order param: string $file param: bool $list param: int $optiondates param: int $optioncount param: int $hide_empty param: int $use_desc_for_title param: bool $children param: int $child_of param: int $categories param: int $recurse param: string $feed param: string $feed_image param: string $exclude param: bool $hierarchical since: 0.71 |
| wp_list_cats($args = '') X-Ref |
| Lists categories. return: null|string|false param: string|array $args since: 1.2.0 |
| dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = 'asc',$show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = false,$selected = 0, $exclude = 0) X-Ref |
| Deprecated method for generating a drop-down of categories. return: string param: int $optionall param: string $all param: string $orderby param: string $order param: int $show_last_update param: int $show_count param: int $hide_empty param: bool $optionnone param: int $selected param: int $exclude since: 0.71 |
| list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') X-Ref |
| Lists authors. return: null|string param: bool $optioncount param: bool $exclude_admin param: bool $show_fullname param: bool $hide_empty param: string $feed param: string $feed_image since: 1.2.0 |
| wp_get_post_cats($blogid = '1', $post_ID = 0) X-Ref |
| Retrieves a list of post categories. return: array param: int $blogid Not Used param: int $post_ID since: 1.0.1 |
| wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array() X-Ref |
| Sets the categories that the post ID belongs to. return: bool|mixed param: int $blogid Not used param: int $post_ID param: array $post_categories since: 1.0.1 |
| get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) X-Ref |
| Retrieves a list of archives. return: string|null param: string $type param: string $limit param: string $format param: string $before param: string $after param: bool $show_post_count since: 0.71 |
| get_author_link($display, $author_id, $author_nicename = '') X-Ref |
| Returns or Prints link to the author's posts. return: string|null param: bool $display param: int $author_id param: string $author_nicename Optional. since: 1.2.0 |
| link_pages($before='<br />', $after='<br />', $next_or_number='number', $nextpagelink='next page', $previouspagelink='previous page',$pagelink='%', $more_file='') X-Ref |
| Print list of pages based on arguments. return: string param: string $before param: string $after param: string $next_or_number param: string $nextpagelink param: string $previouspagelink param: string $pagelink param: string $more_file since: 0.71 |
| get_settings($option) X-Ref |
| Get value based on option. return: string param: string $option since: 0.71 |
| permalink_link() X-Ref |
| Print the permalink of the current post in the loop. since: 0.71 |
| permalink_single_rss($deprecated = '') X-Ref |
| Print the permalink to the RSS feed. param: string $deprecated since: 0.71 |
| wp_get_links($args = '') X-Ref |
| Gets the links associated with category. return: null|string param: string $args a query string since: 1.0.1 |
| get_links($category = -1, $before = '', $after = '<br />', $between = ' ', $show_images = true, $orderby = 'name',$show_description = true, $show_rating = false, $limit = -1, $show_updated = 1, $display = true) X-Ref |
| Gets the links associated with category by ID. return: null|string param: int $category Optional. The category to use. If no category supplied uses all. param: string $before Optional. The HTML to output before the link. Default empty. param: string $after Optional. The HTML to output after the link. Default '<br />'. param: string $between Optional. The HTML to output between the link/image and its description. param: bool $show_images Optional. Whether to show images (if defined). Default true. param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', param: bool $show_description Optional. Whether to show the description if show_images=false/not defined. param: bool $show_rating Optional. Show rating stars/chars. Default false. param: int $limit Optional. Limit to X entries. If not specified, all entries are shown. param: int $show_updated Optional. Whether to show last updated timestamp. Default 1. param: bool $display Whether to display the results, or return them instead. since: 0.71 |
| get_links_list($order = 'name') X-Ref |
| Output entire list of links by category. Output a list of all links, listed by category, using the settings in $wpdb->linkcategories and output it as a nested HTML unordered list. param: string $order Sort link categories by 'name' or 'id' since: 1.0.1 |
| links_popup_script($text = 'Links', $width=400, $height=400, $file='links.all.php', $count = true) X-Ref |
| Show the link to the links popup and the number of links. param: string $text the text of the link param: int $width the width of the popup window param: int $height the height of the popup window param: string $file the page to open in the popup window param: bool $count the number of links in the db since: 0.71 |
| get_linkrating( $link ) X-Ref |
| Legacy function that retrieved the value of a link's link_rating field. return: mixed Value of the 'link_rating' field, false otherwise. param: object $link Link object. since: 1.0.1 |
| get_linkcatname($id = 0) X-Ref |
| Gets the name of category by ID. return: string param: int $id The category to get. If no category supplied uses 0 since: 0.71 |
| comments_rss_link($link_text = 'Comments RSS') X-Ref |
| Print RSS comment feed link. param: string $link_text since: 1.0.1 |
| get_category_rss_link($display = false, $cat_ID = 1) X-Ref |
| Print/Return link to category RSS2 feed. return: string param: bool $display param: int $cat_ID since: 1.2.0 |
| get_author_rss_link($display = false, $author_id = 1) X-Ref |
| Print/Return link to author RSS feed. return: string param: bool $display param: int $author_id since: 1.2.0 |
| comments_rss() X-Ref |
| Return link to the post RSS feed. return: string since: 1.5.0 |
| create_user($username, $password, $email) X-Ref |
| An alias of wp_create_user(). return: int The new user's ID. param: string $username The user's username. param: string $password The user's password. param: string $email The user's email. since: 2.0.0 |
| gzip_compression() X-Ref |
| Unused function. |
| get_commentdata( $comment_ID, $no_cache = 0, $include_unapproved = false ) X-Ref |
| Retrieve an array of comment data about comment $comment_ID. return: array The comment data param: int $comment_ID The ID of the comment param: int $no_cache Whether to use the cache (cast to bool) param: bool $include_unapproved Whether to include unapproved comments since: 0.71 |
| get_catname( $cat_ID ) X-Ref |
| Retrieve the category name by the category ID. return: string category name param: int $cat_ID Category ID since: 0.71 |
| get_category_children( $id, $before = '/', $after = '', $visited = array() X-Ref |
| Retrieve category children list separated before and after the term IDs. return: string param: int $id Category ID to retrieve children. param: string $before Optional. Prepend before category term ID. Default '/'. param: string $after Optional. Append after category term ID. Default empty string. param: array $visited Optional. Category Term IDs that have already been added. since: 1.2.0 |
| get_all_category_ids() X-Ref |
| Retrieves all category IDs. return: int[] List of all of the category IDs. since: 2.0.0 |
| get_the_author_description() X-Ref |
| Retrieve the description of the author of the current post. return: string The author's description. since: 1.5.0 |
| the_author_description() X-Ref |
| Display the description of the author of the current post. since: 1.0.0 |
| get_the_author_login() X-Ref |
| Retrieve the login name of the author of the current post. return: string The author's login name (username). since: 1.5.0 |
| the_author_login() X-Ref |
| Display the login name of the author of the current post. since: 0.71 |
| get_the_author_firstname() X-Ref |
| Retrieve the first name of the author of the current post. return: string The author's first name. since: 1.5.0 |
| the_author_firstname() X-Ref |
| Display the first name of the author of the current post. since: 0.71 |
| get_the_author_lastname() X-Ref |
| Retrieve the last name of the author of the current post. return: string The author's last name. since: 1.5.0 |
| the_author_lastname() X-Ref |
| Display the last name of the author of the current post. since: 0.71 |
| get_the_author_nickname() X-Ref |
| Retrieve the nickname of the author of the current post. return: string The author's nickname. since: 1.5.0 |
| the_author_nickname() X-Ref |
| Display the nickname of the author of the current post. since: 0.71 |
| get_the_author_email() X-Ref |
| Retrieve the email of the author of the current post. return: string The author's username. since: 1.5.0 |
| the_author_email() X-Ref |
| Display the email of the author of the current post. since: 0.71 |
| get_the_author_icq() X-Ref |
| Retrieve the ICQ number of the author of the current post. return: string The author's ICQ number. since: 1.5.0 |
| the_author_icq() X-Ref |
| Display the ICQ number of the author of the current post. since: 0.71 |
| get_the_author_yim() X-Ref |
| Retrieve the Yahoo! IM name of the author of the current post. return: string The author's Yahoo! IM name. since: 1.5.0 |
| the_author_yim() X-Ref |
| Display the Yahoo! IM name of the author of the current post. since: 0.71 |
| get_the_author_msn() X-Ref |
| Retrieve the MSN address of the author of the current post. return: string The author's MSN address. since: 1.5.0 |
| the_author_msn() X-Ref |
| Display the MSN address of the author of the current post. since: 0.71 |
| get_the_author_aim() X-Ref |
| Retrieve the AIM address of the author of the current post. return: string The author's AIM address. since: 1.5.0 |
| the_author_aim() X-Ref |
| Display the AIM address of the author of the current post. since: 0.71 |
| get_author_name( $auth_id = false ) X-Ref |
| Retrieve the specified author's preferred display name. return: string The author's display name. param: int $auth_id The ID of the author. since: 1.0.0 |
| get_the_author_url() X-Ref |
| Retrieve the URL to the home page of the author of the current post. return: string The URL to the author's page. since: 1.5.0 |
| the_author_url() X-Ref |
| Display the URL to the home page of the author of the current post. since: 0.71 |
| get_the_author_ID() X-Ref |
| Retrieve the ID of the author of the current post. return: string|int The author's ID. since: 1.5.0 |
| the_author_ID() X-Ref |
| Display the ID of the author of the current post. since: 0.71 |
| the_content_rss($more_link_text='(more...) X-Ref |
| Display the post content for the feed. 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. - '2' will strip all HTML tags from the content. 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. 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. param: string $more_link_text Optional. Text to display when more content is available param: int $stripteaser Optional. Default 0. param: string $more_file Optional. param: int $cut Optional. Amount of words to keep for the content. param: int $encode_html Optional. How to encode the content. since: 0.71 |
| make_url_footnote( $content ) X-Ref |
| Strip HTML and put links at the bottom of stripped content. Searches for all of the links, strips them out of the content, and places them at the bottom of the content with numbers. return: string HTML stripped out of content with links at the bottom. param: string $content Content to get links. since: 0.71 |
| _c( $text, $domain = 'default' ) X-Ref |
| Retrieve translated string with vertical bar context Quite a few times, there will be collisions with similar translatable text found in more than two places but with different translated context. 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. 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. return: string Translated context string without pipe. param: string $text Text to translate. param: string $domain Optional. Domain to retrieve the translated text. since: 2.2.0 |
| translate_with_context( $text, $domain = 'default' ) X-Ref |
| Translates $text like translate(), but assumes that the text contains a context after its last vertical bar. return: string Translated text. param: string $text Text to translate. param: string $domain Domain to retrieve the translated text. since: 2.5.0 |
| _nc( $single, $plural, $number, $domain = 'default' ) X-Ref |
| Legacy version of _n(), which supports contexts. Strips everything from the translation after the last bar. return: string The translated singular or plural form. param: string $single The text to be used if the number is singular. param: string $plural The text to be used if the number is plural. param: int $number The number to compare against to use either the singular or plural form. param: string $domain Optional. Text domain. Unique identifier for retrieving translated strings. since: 2.7.0 |
| __ngettext( ...$args ) X-Ref |
| Retrieve the plural or single form based on the amount. since: 1.2.0 |
| __ngettext_noop( ...$args ) X-Ref |
| Register plural strings in POT file, but don't translate them. since: 2.5.0 |
| get_alloptions() X-Ref |
| Retrieve all autoload options, or all options if no autoloaded ones exist. return: array List of all options. since: 1.0.0 |
| get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false, $permalink = false) X-Ref |
| Retrieve HTML content of attachment image with link. return: string param: int $id Optional. Post ID. param: bool $fullsize Optional. Whether to use full size image. Default false. param: array $max_dims Optional. Max image dimensions. param: bool $permalink Optional. Whether to include permalink to image. Default false. since: 2.0.0 |
| get_attachment_icon_src( $id = 0, $fullsize = false ) X-Ref |
| Retrieve icon URL and Path. return: array Icon URL and full path to file, respectively. param: int $id Optional. Post ID. param: bool $fullsize Optional. Whether to have full image. Default false. since: 2.1.0 |
| get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) X-Ref |
| Retrieve HTML content of icon attachment image element. return: string|false HTML content. param: int $id Optional. Post ID. param: bool $fullsize Optional. Whether to have full size image. Default false. param: array $max_dims Optional. Dimensions of image. since: 2.0.0 |
| get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) X-Ref |
| Retrieve HTML content of image element. return: string|false param: int $id Optional. Post ID. param: bool $fullsize Optional. Whether to have full size image. Default false. param: array $max_dims Optional. Dimensions of image. since: 2.0.0 |
| get_link( $bookmark_id, $output = OBJECT, $filter = 'raw' ) X-Ref |
| Retrieves bookmark data based on ID. return: object|array Bookmark object or array, depending on the type specified by `$output`. param: int $bookmark_id ID of link param: string $output Optional. Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A. param: string $filter Optional. How to filter the link for output. Accepts 'raw', 'edit', since: 2.0.0 |
| clean_url( $url, $protocols = null, $context = 'display' ) X-Ref |
| Checks and cleans a URL. A number of characters are removed from the URL. If the URL is for displaying (the default behaviour) ampersands are also replaced. The 'clean_url' filter is applied to the returned cleaned URL. return: string The cleaned $url after the {@see 'clean_url'} filter is applied. param: string $url The URL to be cleaned. param: array $protocols Optional. An array of acceptable protocols. param: string $context Optional. How the URL will be used. Default is 'display'. since: 1.2.0 |
| js_escape( $text ) X-Ref |
| Escape single quotes, specialchar double quotes, and fix line endings. The filter {@see 'js_escape'} is also applied by esc_js(). return: string Escaped text. param: string $text The text to be escaped. since: 2.0.4 |
| wp_specialchars( $text, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) X-Ref |
| Legacy escaping for HTML blocks. return: string Escaped `$text`. param: string $text Text to escape. param: string $quote_style Unused. param: false|string $charset Unused. param: false $double_encode Whether to double encode. Unused. |
| attribute_escape( $text ) X-Ref |
| Escaping for HTML attributes. return: string param: string $text since: 2.0.6 |
| register_sidebar_widget($name, $output_callback, $classname = '', ...$params) X-Ref |
| Register widget for sidebar with backward compatibility. 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. Passes to wp_register_sidebar_widget() after argument list and backward compatibility is complete. param: string|int $name Widget ID. param: callable $output_callback Run when widget is called. param: string $classname Optional. Classname widget option. Default empty. param: mixed ...$params Widget parameters. since: 2.2.0 |
| unregister_sidebar_widget($id) X-Ref |
| Serves as an alias of wp_unregister_sidebar_widget(). param: int|string $id Widget ID. since: 2.2.0 |
| register_widget_control($name, $control_callback, $width = '', $height = '', ...$params) X-Ref |
| Registers widget control callback for customizing options. 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. Passes to wp_register_widget_control() after the argument list has been compiled. param: int|string $name Sidebar ID. param: callable $control_callback Widget control callback to display and process form. param: int $width Widget width. param: int $height Widget height. param: mixed ...$params Widget parameters. since: 2.2.0 |
| unregister_widget_control($id) X-Ref |
| Alias of wp_unregister_widget_control(). param: int|string $id Widget ID. since: 2.2.0 |
| delete_usermeta( $user_id, $meta_key, $meta_value = '' ) X-Ref |
| Remove user meta data. return: bool True deletion completed and false if user_id is not a number. param: int $user_id User ID. param: string $meta_key Metadata key. param: mixed $meta_value Optional. Metadata value. Default empty. since: 2.0.0 |
| get_usermeta( $user_id, $meta_key = '' ) X-Ref |
| Retrieve user metadata. 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. return: mixed param: int $user_id User ID param: string $meta_key Optional. Metadata key. Default empty. since: 2.0.0 |
| update_usermeta( $user_id, $meta_key, $meta_value ) X-Ref |
| Update metadata of user. 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. Will remove the metadata, if the meta value is empty. return: bool True on successful update, false on failure. param: int $user_id User ID param: string $meta_key Metadata key. param: mixed $meta_value Metadata value. since: 2.0.0 |
| get_users_of_blog( $id = '' ) X-Ref |
| Get users for the site. For setups that use the multisite feature. Can be used outside of the multisite feature. return: array List of users that are part of that site ID param: int $id Site ID. since: 2.2.0 |
| automatic_feed_links( $add = true ) X-Ref |
| Enable/disable automatic general feed link outputting. param: bool $add Optional. Add or remove links. Default true. since: 2.8.0 |
| get_profile( $field, $user = false ) X-Ref |
| Retrieve user data based on field. return: string The author's field from the current author's DB object. param: string $field User meta field. param: false|int $user Optional. User ID to retrieve the field for. Default false (current user). since: 1.5.0 |
| get_usernumposts( $userid ) X-Ref |
| Retrieves the number of posts a user has written. return: int Number of posts the given user has written. param: int $userid User to count posts for. since: 0.71 |
| funky_javascript_callback($matches) X-Ref |
| Callback used to change %uXXXX to &#YYY; syntax return: string An HTML entity param: array $matches Single Match since: 2.8.0 |
| funky_javascript_fix($text) X-Ref |
| Fixes JavaScript bugs in browsers. Converts unicode characters to HTML numbered entities. return: string Fixed text. param: string $text Text to be made safe. since: 1.5.0 |
| is_taxonomy( $taxonomy ) X-Ref |
| Checks that the taxonomy name exists. return: bool Whether the taxonomy exists. param: string $taxonomy Name of taxonomy object since: 2.3.0 |
| is_term( $term, $taxonomy = '', $parent = 0 ) X-Ref |
| Check if Term exists. return: mixed Get the term ID or term object, if exists. param: int|string $term The term to check param: string $taxonomy The taxonomy name to use param: int $parent ID of parent term under which to confine the exists search. since: 2.3.0 |
| is_plugin_page() X-Ref |
| Determines whether the current admin page is generated by a plugin. Use global $plugin_page and/or get_plugin_page_hookname() hooks. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. return: bool since: 1.5.0 |
| update_category_cache() X-Ref |
| Update the categories cache. 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. return: bool Always return True since: 1.5.0 |
| wp_timezone_supported() X-Ref |
| Check for PHP timezone support return: bool since: 2.9.0 |
| the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2, $extended = true) X-Ref |
| Displays an editor: TinyMCE, HTML, or both. param: string $content Textarea content. param: string $id Optional. HTML ID attribute value. Default 'content'. param: string $prev_id Optional. Unused. param: bool $media_buttons Optional. Whether to display media buttons. Default true. param: int $tab_index Optional. Unused. param: bool $extended Optional. Unused. since: 2.1.0 |
| get_user_metavalues($ids) X-Ref |
| Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users return: array of arrays. The array is indexed by user_id, containing $metavalues object arrays. param: array $ids User ID numbers list. since: 3.0.0 |
| sanitize_user_object($user, $context = 'display') X-Ref |
| Sanitize every user field. If the context is 'raw', then the user object or array will get minimal santization of the int fields. return: object|array The now sanitized user object or array (will be the same type as $user). param: object|array $user The user object or array. param: string $context Optional. How to sanitize user fields. Default 'display'. since: 2.3.0 |
| get_boundary_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $start = true) X-Ref |
| Get boundary post relational link. Can either be start or end post relational link. return: string param: string $title Optional. Link title format. Default '%title'. param: bool $in_same_cat Optional. Whether link should be in a same category. param: string $excluded_categories Optional. Excluded categories IDs. Default empty. param: bool $start Optional. Whether to display link to first or last post. since: 2.8.0 |
| start_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') X-Ref |
| Display relational link for the first post. param: string $title Optional. Link title format. param: bool $in_same_cat Optional. Whether link should be in a same category. param: string $excluded_categories Optional. Excluded categories IDs. since: 2.8.0 |
| get_index_rel_link() X-Ref |
| Get site index relational link. return: string since: 2.8.0 |
| index_rel_link() X-Ref |
| Display relational link for the site index. since: 2.8.0 |
| get_parent_post_rel_link( $title = '%title' ) X-Ref |
| Get parent post relational link. return: string param: string $title Optional. Link title format. Default '%title'. since: 2.8.0 |
| parent_post_rel_link( $title = '%title' ) X-Ref |
| Display relational link for parent item param: string $title Optional. Link title format. Default '%title'. since: 2.8.0 |
| wp_admin_bar_dashboard_view_site_menu( $wp_admin_bar ) X-Ref |
| Add the "Dashboard"/"Visit Site" menu. param: WP_Admin_Bar $wp_admin_bar WP_Admin_Bar instance. since: 3.2.0 |
| is_blog_user( $blog_id = 0 ) X-Ref |
| Checks if the current user belong to a given site. return: bool True if the current users belong to $blog_id, false if not. param: int $blog_id Site ID since: MU (3.0.0) |
| debug_fopen( $filename, $mode ) X-Ref |
| Open the file handle for debugging. return: false Always false. param: string $filename File name. param: string $mode Type of access you required to the stream. since: 0.71 |
| debug_fwrite( $fp, $message ) X-Ref |
| Write contents to the file used for debugging. param: mixed $fp Unused. param: string $message Message to log. since: 0.71 |
| debug_fclose( $fp ) X-Ref |
| Close the debugging file handle. param: mixed $fp Unused. since: 0.71 |
| get_themes() X-Ref |
| Retrieve list of themes with theme data in theme directory. 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. return: array Theme list with theme data. since: 1.5.0 |
| get_theme( $theme ) X-Ref |
| Retrieve theme data. return: array|null Null, if theme name does not exist. Theme data, if exists. param: string $theme Theme name. since: 1.5.0 |
| get_current_theme() X-Ref |
| Retrieve current theme name. return: string since: 1.5.0 |
| clean_pre($matches) X-Ref |
| Accepts matches array from preg_replace_callback in wpautop() or a string. Ensures that the contents of a `<pre>...</pre>` HTML block are not converted into paragraphs or line breaks. return: string The pre block without paragraph/line break conversion. param: array|string $matches The array or string since: 1.2.0 |
| add_custom_image_header( $wp_head_callback, $admin_head_callback, $admin_preview_callback = '' ) X-Ref |
| Add callbacks for image header display. param: callable $wp_head_callback Call on the {@see 'wp_head'} action. param: callable $admin_head_callback Call on custom header administration screen. param: callable $admin_preview_callback Output a custom header image div on the custom header administration screen. Optional. since: 2.1.0 |
| remove_custom_image_header() X-Ref |
| Remove image header support. return: null|bool Whether support was removed. since: 3.1.0 |
| add_custom_background( $wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '' ) X-Ref |
| Add callbacks for background image display. param: callable $wp_head_callback Call on the {@see 'wp_head'} action. param: callable $admin_head_callback Call on custom background administration screen. param: callable $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional. since: 3.0.0 |
| remove_custom_background() X-Ref |
| Remove custom background support. return: null|bool Whether support was removed. since: 3.1.0 |
| get_theme_data( $theme_file ) X-Ref |
| Retrieve theme data from parsed theme file. return: array Theme data. param: string $theme_file Theme file path. since: 1.5.0 |
| update_page_cache( &$pages ) X-Ref |
| Alias of update_post_cache(). param: array $pages list of page objects since: 1.5.1 |
| clean_page_cache( $id ) X-Ref |
| Will clean the page in the cache. Clean (read: delete) page from cache that matches $id. Will also clean cache associated with 'all_page_ids' and 'get_pages'. param: int $id Page ID to clean since: 2.0.0 |
| wp_explain_nonce( $action ) X-Ref |
| Retrieve nonce action "Are you sure" message. Deprecated in 3.4.1 and 3.5.0. Backported to 3.3.3. return: string Are you sure message. param: string $action Nonce action. since: 2.0.4 |
| sticky_class( $post_id = null ) X-Ref |
| Display "sticky" CSS class, if a post is sticky. param: int $post_id An optional post ID. since: 2.7.0 |
| _get_post_ancestors( &$post ) X-Ref |
| Retrieve post ancestors. This is no longer needed as WP_Post lazy-loads the ancestors property with get_post_ancestors(). param: WP_Post $post Post object, passed by reference (unused). since: 2.3.4 |
| wp_load_image( $file ) X-Ref |
| Load an image from a string, if PHP supports it. return: resource|GdImage|string The resulting image resource or GdImage instance on success, param: string $file Filename of the image to load. since: 2.1.0 |
| image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $dest_path = null, $jpeg_quality = 90 ) X-Ref |
| Scale down an image to fit a particular size and save a new copy of the image. 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. 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. return: mixed WP_Error on failure. String with new destination path. param: string $file Image file path. param: int $max_w Maximum width to resize to. param: int $max_h Maximum height to resize to. param: bool $crop Optional. Whether to crop image or resize. Default false. param: string $suffix Optional. File suffix. Default null. param: string $dest_path Optional. New image file path. Default null. param: int $jpeg_quality Optional. Image quality percentage. Default 90. since: 2.5.0 |
| wp_get_single_post( $postid = 0, $mode = OBJECT ) X-Ref |
| Retrieve a single post, based on post ID. Has categories in 'post_category' property or key. Has tags in 'tags_input' property or key. return: WP_Post|null Post object or array holding post contents and information param: int $postid Post ID. param: string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A. since: 1.0.0 |
| user_pass_ok($user_login, $user_pass) X-Ref |
| Check that the user login name and password is correct. return: bool False if does not authenticate, true if username and password authenticates. param: string $user_login User name. param: string $user_pass User password. since: 0.71 |
| _save_post_hook() X-Ref |
| Callback formerly fired on the save_post hook. No longer needed. since: 2.3.0 |
| gd_edit_image_support($mime_type) X-Ref |
| Check if the installed version of GD supports particular image type return: bool param: string $mime_type since: 2.9.0 |
| wp_convert_bytes_to_hr( $bytes ) X-Ref |
| Converts an integer byte value to a shorthand byte value. return: string A shorthand byte value. param: int $bytes An integer byte value. since: 2.3.0 |
| _search_terms_tidy( $t ) X-Ref |
| Formerly used internally to tidy up the search terms. return: string Trimmed search terms. param: string $t Search terms to "tidy", e.g. trim. since: 2.9.0 |
| rich_edit_exists() X-Ref |
| Determine if TinyMCE is available. Checks to see if the user has deleted the tinymce files to slim down their WordPress installation. return: bool Whether TinyMCE exists. since: 2.1.0 |
| default_topic_count_text( $count ) X-Ref |
| Old callback for tag link tooltips. return: int Number of topics. param: int $count Number of topics. since: 2.7.0 |
| format_to_post( $content ) X-Ref |
| Formerly used to escape strings before inserting into the DB. Has not performed this function for many, many years. Use wpdb::prepare() instead. return: string The very same text. param: string $content The text to format. since: 0.71 |
| like_escape($text) X-Ref |
| Formerly used to escape strings before searching the DB. It was poorly documented and never worked as described. return: string text, safe for inclusion in LIKE query. param: string $text The text to be escaped. since: 2.5.0 |
| url_is_accessable_via_ssl( $url ) X-Ref |
| Determines if the URL can be accessed over SSL. Determines if the URL can be accessed over SSL by using the WordPress HTTP API to access the URL using https as the scheme. return: bool Whether SSL access is available. param: string $url The URL to test. since: 2.5.0 |
| preview_theme() X-Ref |
| Start preview theme output buffer. Will only perform task if the user has permissions and template and preview query variables exist. since: 2.6.0 |
| _preview_theme_template_filter() X-Ref |
| Private function to modify the current template when previewing a theme return: string since: 2.9.0 |
| _preview_theme_stylesheet_filter() X-Ref |
| Private function to modify the current stylesheet when previewing a theme return: string since: 2.9.0 |
| preview_theme_ob_filter( $content ) X-Ref |
| Callback function for ob_start() to capture all links in the theme. return: string param: string $content since: 2.6.0 |
| preview_theme_ob_filter_callback( $matches ) X-Ref |
| Manipulates preview theme links in order to control and maintain location. Callback function for preg_replace_callback() to accept and filter matches. return: string param: array $matches since: 2.6.0 |
| wp_richedit_pre($text) X-Ref |
| Formats text for the rich text editor. The {@see 'richedit_pre'} filter is applied here. If `$text` is empty the filter will be applied to an empty string. return: string The formatted text after filter is applied. param: string $text The text to be formatted. since: 2.0.0 |
| wp_htmledit_pre($output) X-Ref |
| Formats text for the HTML editor. Unless $output is empty it will pass through htmlspecialchars before the {@see 'htmledit_pre'} filter is applied. return: string Formatted text after filter applied. param: string $output The text to be formatted. since: 2.5.0 |
| post_permalink( $post_id = 0 ) X-Ref |
| Retrieve permalink from post ID. return: string|false param: int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. since: 1.0.0 |
| wp_get_http( $url, $file_path = false, $red = 1 ) X-Ref |
| Perform a HTTP HEAD or GET request. If $file_path is a writable filename, this will do a GET request and write the file to that path. return: bool|string False on failure and string of headers if HEAD request. param: string $url URL to fetch. param: string|bool $file_path Optional. File path to write request to. Default false. param: int $red Optional. The number of Redirects followed, Upon 5 being hit, since: 2.5.0 |
| force_ssl_login( $force = null ) X-Ref |
| Whether SSL login should be forced. return: bool True if forced, false if not forced. param: string|bool $force Optional Whether to force SSL login. Default null. since: 2.6.0 |
| get_comments_popup_template() X-Ref |
| Retrieve path of comment popup template in current or parent template. return: string Full path to comments popup template file. since: 1.5.0 |
| is_comments_popup() X-Ref |
| Determines whether the current URL is within the comments popup window. For more information on this and similar theme functions, check out the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags} article in the Theme Developer Handbook. return: false Always returns false. since: 1.5.0 |
| comments_popup_script() X-Ref |
| Display the JS popup script to show a comment. since: 0.71 |
| popuplinks( $text ) X-Ref |
| Adds element attributes to open links in new tabs. return: string Content that has filtered links. param: string $text Content to replace links to open in a new tab. since: 0.71 |
| wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) X-Ref |
| The Google Video embed handler callback. Deprecated function that previously assisted in turning Google Video URLs into embeds but that service has since been shut down. return: string An empty string. since: 2.9.0 |
| get_paged_template() X-Ref |
| Retrieve path of paged template in current or parent template. return: string Full path to paged template file. since: 1.5.0 |
| wp_kses_js_entities( $content ) X-Ref |
| Removes the HTML JavaScript entities found in early versions of Netscape 4. 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. 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. return: string param: string $content since: 1.0.0 |
| _usort_terms_by_ID( $a, $b ) X-Ref |
| Sort categories by ID. Used by usort() as a callback, should not be used directly. Can actually be used to sort any term object. return: int param: object $a param: object $b since: 2.3.0 |
| _usort_terms_by_name( $a, $b ) X-Ref |
| Sort categories by name. Used by usort() as a callback, should not be used directly. Can actually be used to sort any term object. return: int param: object $a param: object $b since: 2.3.0 |
| _sort_nav_menu_items( $a, $b ) X-Ref |
| Sort menu items by the desired key. return: int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b. param: object $a The first object to compare param: object $b The second object to compare since: 3.0.0 |
| get_shortcut_link() X-Ref |
| Retrieves the Press This bookmarklet link. since: 2.6.0 |
| wp_ajax_press_this_save_post() X-Ref |
| Ajax handler for saving a post from Press This. since: 4.2.0 |
| wp_ajax_press_this_add_category() X-Ref |
| Ajax handler for creating new category from Press This. since: 4.2.0 |
| wp_get_user_request_data( $request_id ) X-Ref |
| Return the user request object for the specified request ID. return: WP_User_Request|false param: int $request_id The ID of the user request. since: 4.9.6 |
| wp_make_content_images_responsive( $content ) X-Ref |
| Filters 'img' elements in post content to add 'srcset' and 'sizes' attributes. return: string Converted content with 'srcset' and 'sizes' attributes added to images. param: string $content The raw post content to be filtered. since: 4.4.0 |
| wp_unregister_GLOBALS() X-Ref |
| Turn register globals off. since: 2.1.0 |
| wp_blacklist_check( $author, $email, $url, $comment, $user_ip, $user_agent ) X-Ref |
| Does comment contain disallowed characters or words. return: bool True if comment contains disallowed content, false if comment does not param: string $author The author of the comment param: string $email The email of the comment param: string $url The url used in the comment param: string $comment The comment content param: string $user_ip The comment author's IP address param: string $user_agent The author's browser user agent since: 1.5.0 |
| _wp_register_meta_args_whitelist( $args, $default_args ) X-Ref |
| Filters out `register_meta()` args based on an allowed list. `register_meta()` args may change over time, so requiring the allowed list to be explicitly turned off is a warranty seal of sorts. return: array Filtered arguments. param: array $args Arguments from `register_meta()`. param: array $default_args Default arguments for `register_meta()`. since: 4.6.0 |
| add_option_whitelist( $new_options, $options = '' ) X-Ref |
| Adds an array of options to the list of allowed options. return: array param: array $new_options param: string|array $options since: 2.7.0 |
| remove_option_whitelist( $del_options, $options = '' ) X-Ref |
| Removes a list of options from the allowed options list. return: array param: array $del_options param: string|array $options since: 2.7.0 |
| wp_slash_strings_only( $value ) X-Ref |
| Adds slashes to only string values in an array of values. This should be used when preparing data for core APIs that expect slashed data. This should not be used to escape data going directly into an SQL query. return: mixed Slashes $value param: mixed $value Scalar or array of scalars. since: 5.3.0 |
| addslashes_strings_only( $value ) X-Ref |
| Adds slashes only if the provided value is a string. return: mixed param: mixed $value since: 5.3.0 |
| noindex() X-Ref |
| Displays a `noindex` meta tag if required by the blog configuration. 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. Typical usage is as a {@see 'wp_head'} callback: add_action( 'wp_head', 'noindex' ); since: 2.1.0 |
| wp_no_robots() X-Ref |
| Display a `noindex` meta tag. Outputs a `noindex` meta tag that tells web robots not to index the page content. Typical usage is as a {@see 'wp_head'} callback: add_action( 'wp_head', 'wp_no_robots' ); since: 3.3.0 since: 5.3.0 Echo `noindex,nofollow` if search engine visibility is discouraged. |
| wp_sensitive_page_meta() X-Ref |
| Display a `noindex,noarchive` meta tag and referrer `strict-origin-when-cross-origin` meta tag. Outputs a `noindex,noarchive` meta tag that tells web robots not to index or cache the page content. Outputs a referrer `strict-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. Typical usage is as a {@see 'wp_head'} callback: add_action( 'wp_head', 'wp_sensitive_page_meta' ); since: 5.0.1 |
| _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) X-Ref |
| Render inner blocks from the `core/columns` block for generating an excerpt. return: string The rendered inner blocks. param: array $columns The parsed columns block. param: array $allowed_blocks The list of allowed inner blocks. since: 5.2.0 |
| wp_render_duotone_filter_preset( $preset ) X-Ref |
| Renders the duotone filter SVG and returns the CSS filter property to reference the rendered SVG. return: string Duotone CSS filter property. param: array $preset Duotone preset value as seen in theme.json. since: 5.9.0 |
| wp_skip_border_serialization( $block_type ) X-Ref |
| Checks whether serialization of the current block's border properties should occur. return: bool Whether serialization of the current block's border properties param: WP_Block_Type $block_type Block type. since: 5.8.0 |
| wp_skip_dimensions_serialization( $block_type ) X-Ref |
| Checks whether serialization of the current block's dimensions properties should occur. return: bool Whether to serialize spacing support styles & classes. param: WP_Block_type $block_type Block type. since: 5.9.0 |
| wp_skip_spacing_serialization( $block_type ) X-Ref |
| Checks whether serialization of the current block's spacing properties should occur. return: bool Whether to serialize spacing support styles & classes. param: WP_Block_Type $block_type Block type. since: 5.9.0 |
| wp_add_iframed_editor_assets_html() X-Ref |
| Inject the block editor assets that need to be loaded into the editor's iframe as an inline script. since: 5.8.0 |
| Generated: Sat Nov 23 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |