PHPXRef 0.7 : WordPress 3.0 beta 1 : Detail view of deprecated.php

Functions

Functions that are not part of a class:

get_postdata($postid) X-Ref

Entire Post data.

param: int $postid
return: array

start_wp() X-Ref

Sets up the WordPress Loop.

the_category_ID($echo = true) X-Ref

Return or Print Category ID.

param: bool $echo
return: null|int

the_category_head($before='', $after='') X-Ref

Print category with optional text before and after.

param: string $before
param: string $after

previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') X-Ref

Prints 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

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 $previous
param: string $title
param: string $in_same_cat
param: int $limitprev
param: string $excluded_categories

user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') X-Ref

Whether user can create a post.

param: int $user_id
param: int $blog_id Not Used
param: int $category_id Not Used
return: bool

user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') X-Ref

Whether user can create a post.

param: int $user_id
param: int $blog_id Not Used
param: int $category_id Not Used
return: bool

user_can_edit_post($user_id, $post_id, $blog_id = 1) X-Ref

Whether user can edit a post.

param: int $user_id
param: int $post_id
param: int $blog_id Not Used
return: bool

user_can_delete_post($user_id, $post_id, $blog_id = 1) X-Ref

Whether user can delete a post.

param: int $user_id
param: int $post_id
param: int $blog_id Not Used
return: bool

user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') X-Ref

Whether user can set new posts' dates.

param: int $user_id
param: int $blog_id Not Used
param: int $category_id Not Used
return: bool

user_can_edit_post_date($user_id, $post_id, $blog_id = 1) X-Ref

Whether user can delete a post.

param: int $user_id
param: int $post_id
param: int $blog_id Not Used
return: bool returns true if $user_id can edit $post_id's date

user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) X-Ref

Whether user can delete a post.

param: int $user_id
param: int $post_id
param: int $blog_id Not Used
return: bool returns true if $user_id can edit $post_id's comments

user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) X-Ref

Whether user can delete a post.

param: int $user_id
param: int $post_id
param: int $blog_id Not Used
return: bool returns true if $user_id can delete $post_id's comments

user_can_edit_user($user_id, $other_user) X-Ref

Can user can edit other user.

param: int $user_id
param: int $other_user
return: bool

get_linksbyname($cat_name = "noname", $before = '', $after = ' ', $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.
param: string $after Optional. The html to output after the link.
param: string $between Optional. The html to output between the link/image and it's description. Not used if no image or $show_images is true.
param: bool $show_images Optional. Whether to show images (if defined).
param: string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner.
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.
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

wp_get_linksbyname($category, $args = '') X-Ref

Gets the links associated with the named category.

param: string $category The category to use.
param: string $args
return: bool|null

get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) X-Ref

Gets an array of link objects associated with category $cat_name.

<code>
$links = get_linkobjectsbyname('fred');
foreach ($links as $link) {
echo '<li>'.$link->link_name.'</li>';
}
</code>

param: string $cat_name The category name to use. If no match is found uses all.
param: string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'.
param: int $limit Limit to X entries. If not specified, all entries are shown.
return: unknown

get_linkobjects($category = 0, $orderby = 'name', $limit = 0) X-Ref

Gets an array of link objects associated with category n.

Usage:
<code>
$links = get_linkobjects(1);
if ($links) {
foreach ($links as $link) {
echo '<li>'.$link->link_name.' '.$link->link_description.'</li>';
}
}
</code>

Fields are:
<ol>
<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>
</ol>

param: int $category The category to use. If no category supplied uses all
param: string $orderby the order to output the links. E.g. 'id', 'name', 'url',
param: int $limit Limit to X entries. If not specified, all entries are shown.
return: unknown

get_linksbyname_withrating($cat_name = "noname", $before = '', $after = ' ', $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 The category name to use. If no match is found uses all
param: string $before The html to output before the link
param: string $after The html to output after the link
param: string $between The html to output between the link/image and it's description. Not used if no image or show_images is true
param: bool $show_images Whether to show images (if defined).
param: string $orderby the order to output the links. E.g. 'id', 'name', 'url',
param: bool $show_description Whether to show the description if show_images=false/not defined
param: int $limit Limit to X entries. If not specified, all entries are shown.
param: int $show_updated Whether to show last updated timestamp

get_links_withrating($category = -1, $before = '', $after = ' ', $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 The category to use. If no category supplied uses all
param: string $before The html to output before the link
param: string $after The html to output after the link
param: string $between The html to output between the link/image and it's description. Not used if no image or show_images == true
param: bool $show_images Whether to show images (if defined).
param: string $orderby The order to output the links. E.g. 'id', 'name', 'url',
param: bool $show_description Whether to show the description if show_images=false/not defined.
param: string $limit Limit to X entries. If not specified, all entries are shown.
param: int $show_updated Whether to show last updated timestamp

get_autotoggle($id = 0) X-Ref

Gets the auto_toggle setting.

param: int $id The category to get. If no category supplied uses 0
return: int Only returns 0.

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

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
return: unknown

wp_list_cats($args = '') X-Ref

param: string|array $args
return: unknown

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

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
return: unknown

list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') X-Ref

param: bool $optioncount
param: bool $exclude_admin
param: bool $show_fullname
param: bool $hide_empty
param: string $feed
param: string $feed_image
return: unknown

wp_get_post_cats($blogid = '1', $post_ID = 0) X-Ref

param: int $blogid Not Used
param: int $post_ID
return: unknown

wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array() X-Ref

Sets the categories that the post id belongs to.

param: int $blogid Not used
param: int $post_ID
param: array $post_categories
return: unknown

get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) X-Ref

param: string $type
param: string $limit
param: string $format
param: string $before
param: string $after
param: bool $show_post_count
return: unknown

get_author_link($echo = false, $author_id, $author_nicename = '') X-Ref

Returns or Prints link to the author's posts.

param: bool $echo Optional.
param: int $author_id Required.
param: string $author_nicename Optional.
return: string|null

link_pages($before=' ', $after=' ', $next_or_number='number', $nextpagelink='next page', $previouspagelink='previous page',$pagelink='%', $more_file='') X-Ref

Print list of pages based on arguments.

param: string $before
param: string $after
param: string $next_or_number
param: string $nextpagelink
param: string $previouspagelink
param: string $pagelink
param: string $more_file
return: string

get_settings($option) X-Ref

Get value based on option.

param: string $option
return: string

permalink_link() X-Ref

Print the permalink of the current post in the loop.

permalink_single_rss($deprecated = '') X-Ref

Print the permalink to the RSS feed.

param: string $file

wp_get_links($args = '') X-Ref

Gets the links associated with category.

param: string $args a query string
return: null|string

get_links($category = -1, $before = '', $after = ' ', $between = ' ', $show_images = true, $orderby = 'name',$show_description = true, $show_rating = false, $limit = -1, $show_updated = 1, $echo = true) X-Ref

Gets the links associated with category by id.

param: int $category The category to use. If no category supplied uses all
param: string $before the html to output before the link
param: string $after the html to output after the link
param: string $between the html to output between the link/image and its description.
param: bool $show_images whether to show images (if defined).
param: string $orderby the order to output the links. E.g. 'id', 'name', 'url',
param: bool $show_description whether to show the description if show_images=false/not defined.
param: bool $show_rating show rating stars/chars
param: int $limit Limit to X entries. If not specified, all entries are shown.
param: int $show_updated whether to show last updated timestamp
param: bool $echo whether to echo the results, or return them instead
return: null|string

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'

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

get_linkrating($link) X-Ref

param: object $link
return: unknown

get_linkcatname($id = 0) X-Ref

Gets the name of category by id.

param: int $id The category to get. If no category supplied uses 0
return: string

comments_rss_link($link_text = 'Comments RSS') X-Ref

Print RSS comment feed link.

param: string $link_text

get_category_rss_link($echo = false, $cat_ID = 1) X-Ref

Print/Return link to category RSS2 feed.

param: bool $echo
param: int $cat_ID
return: string|null

get_author_rss_link($echo = false, $author_id = 1) X-Ref

Print/Return link to author RSS feed.

param: bool $echo
param: int $author_id
return: string|null

comments_rss() X-Ref

Return link to the post RSS feed.

return: string

create_user($username, $password, $email) X-Ref

An alias of wp_create_user().

param: string $username The user's username.
param: string $password The user's password.
param: string $email The user's email (optional).
return: int The new user's ID.

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.

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
return: array The comment data

get_catname( $cat_ID ) X-Ref

Retrieve the category name by the category ID.

param: int $cat_ID Category ID
return: string category name

get_category_children( $id, $before = '/', $after = '', $visited = array() X-Ref

Retrieve category children list separated before and after the term IDs.

param: int $id Category ID to retrieve children.
param: string $before Optional. Prepend before category term ID.
param: string $after Optional, default is empty string. Append after category term ID.
param: array $visited Optional. Category Term IDs that have already been added.
return: string

get_the_author_description() X-Ref

Retrieve the description of the author of the current post.

return: string The author's description.

the_author_description() X-Ref

Display the description of the author of the current post.

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).

the_author_login() X-Ref

Display the login name of the author of the current post.

get_the_author_firstname() X-Ref

Retrieve the first name of the author of the current post.

return: string The author's first name.

the_author_firstname() X-Ref

Display the first name of the author of the current post.

get_the_author_lastname() X-Ref

Retrieve the last name of the author of the current post.

return: string The author's last name.

the_author_lastname() X-Ref

Display the last name of the author of the current post.

get_the_author_nickname() X-Ref

Retrieve the nickname of the author of the current post.

return: string The author's nickname.

the_author_nickname() X-Ref

Display the nickname of the author of the current post.

get_the_author_email() X-Ref

Retrieve the email of the author of the current post.

return: string The author's username.

the_author_email() X-Ref

Display the email of the author of the current post.

get_the_author_icq() X-Ref

Retrieve the ICQ number of the author of the current post.

return: string The author's ICQ number.

the_author_icq() X-Ref

Display the ICQ number of the author of the current post.

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.

the_author_yim() X-Ref

Display the Yahoo! IM name of the author of the current post.

get_the_author_msn() X-Ref

Retrieve the MSN address of the author of the current post.

return: string The author's MSN address.

the_author_msn() X-Ref

Display the MSN address of the author of the current post.

get_the_author_aim() X-Ref

Retrieve the AIM address of the author of the current post.

return: string The author's AIM address.

the_author_aim() X-Ref

Display the AIM address of the author of the current post.

get_author_name( $auth_id = false ) X-Ref

Retrieve the specified author's preferred display name.

param: int $auth_id The ID of the author.
return: string The author's display name.

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.

the_author_url() X-Ref

Display the URL to the home page of the author of the current post.

get_the_author_ID() X-Ref

Retrieve the ID of the author of the current post.

return: int The author's ID.

the_author_ID() X-Ref

Display the ID of the author of the current post.

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. The
value of '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 but not displayed.
param: int|bool $stripteaser Optional. Default is 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.

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.

param: string $content Content to get links
return: string HTML stripped out of content with links at the bottom.

_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.

param: string $text Text to translate
param: string $domain Optional. Domain to retrieve the translated text
return: string Translated context string without pipe

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.

param: string $text Text to translate
param: string $domain Domain to retrieve the translated text
return: string Translated text

_nc( $single, $plural, $number, $domain = 'default' ) X-Ref

A version of _n(), which supports contexts.
Strips everything from the translation after the last bar.

__ngettext() X-Ref

Retrieve the plural or single form based on the amount.

__ngettext_noop() X-Ref

Register plural strings in POT file, but don't translate them.

get_alloptions() X-Ref

Retrieve all autoload options, or all options if no autoloaded ones exist.

return: array List of all options.

get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false, $permalink = false) X-Ref

Retrieve HTML content of attachment image with link.

param: int $id Optional. Post ID.
param: bool $fullsize Optional, default is false. Whether to use full size image.
param: array $max_dims Optional. Max image dimensions.
param: bool $permalink Optional, default is false. Whether to include permalink to image.
return: string

get_attachment_icon_src( $id = 0, $fullsize = false ) X-Ref

Retrieve icon URL and Path.

param: int $id Optional. Post ID.
param: bool $fullsize Optional, default to false. Whether to have full image.
return: array Icon URL and full path to file, respectively.

get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) X-Ref

Retrieve HTML content of icon attachment image element.

param: int $id Optional. Post ID.
param: bool $fullsize Optional, default to false. Whether to have full size image.
param: array $max_dims Optional. Dimensions of image.
return: string HTML content.

get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) X-Ref

Retrieve HTML content of image element.

param: int $id Optional. Post ID.
param: bool $fullsize Optional, default to false. Whether to have full size image.
param: array $max_dims Optional. Dimensions of image.
return: string

get_link($bookmark_id, $output = OBJECT, $filter = 'raw') X-Ref

No description

sanitize_url( $url, $protocols = null ) X-Ref

Performs esc_url() for database or redirect usage.

param: string $url The URL to be cleaned.
param: array $protocols An array of acceptable protocols.
return: string The cleaned URL.

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) amperstands are also replaced. The 'clean_url' filter
is applied to the returned cleaned URL.

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'.
return: string The cleaned $url after the 'clean_url' filter is applied.

js_escape( $text ) X-Ref

Escape single quotes, specialchar double quotes, and fix line endings.

The filter 'js_escape' is also applied by esc_js()

param: string $text The text to be escaped.
return: string Escaped text.

wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) X-Ref

Escaping for HTML blocks.

attribute_escape( $text ) X-Ref

Escaping for HTML attributes.

param: string $text
return: string

register_sidebar_widget($name, $output_callback, $classname = '') X-Ref

Register widget for sidebar with backwards 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 {@link wp_register_sidebar_widget()} after argument list and
backwards compatibility is complete.

param: string|int $name Widget ID.
param: callback $output_callback Run when widget is called.
param: string $classname Classname widget option.
param: mixed $params,... Widget parameters.

unregister_sidebar_widget($id) X-Ref

Alias of {@link wp_unregister_sidebar_widget()}.

param: int|string $id Widget ID.

register_widget_control($name, $control_callback, $width = '', $height = '') 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 {@link wp_register_widget_control()} after the argument list has
been compiled.

param: int|string $name Sidebar ID.
param: callback $control_callback Widget control callback to display and process form.
param: int $width Widget width.
param: int $height Widget height.

unregister_widget_control($id) X-Ref

Alias of {@link wp_unregister_widget_control()}.

param: int|string $id Widget ID.

delete_usermeta( $user_id, $meta_key, $meta_value = '' ) X-Ref

Remove user meta data.

param: int $user_id User ID.
param: string $meta_key Metadata key.
param: mixed $meta_value Metadata value.
return: bool True deletion completed and false if user_id is not a number.

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.

param: int $user_id User ID
param: string $meta_key Optional. Metadata key.
return: mixed

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.

param: int $user_id User ID
param: string $meta_key Metadata key.
param: mixed $meta_value Metadata value.
return: bool True on successful update, false on failure.

automatic_feed_links( $add = true ) X-Ref

Enable/disable automatic general feed link outputting.

param: boolean $add Optional, default is true. Add or remove links. Defaults to true.

get_profile( $field, $user = false ) X-Ref

Retrieve user data based on field.

get_usernumposts( $userid ) X-Ref

Number of posts user has written.

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

PHP Cross Reference of WordPress 3.0 beta 1

/wp-includes/ -> deprecated.php (summary)

Defines 102 functions

[ Index ]	PHP Cross Reference of WordPress 3.0 beta 1
[ Index ] [ Variables ] [ Functions ] [ Classes ] [ Constants ] [ Statistics ]