[ Index ]

PHP Cross Reference of Wordpress MU 2.7

title

Body

[close]

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

Deprecated functions from past WordPress versions. You shouldn't use these globals and functions and look for the alternatives instead. The functions and globals will be removed in a later version.

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

Defines 49 functions

  get_postdata()
  start_wp()
  the_category_ID()
  the_category_head()
  previous_post()
  next_post()
  user_can_create_post()
  user_can_create_draft()
  user_can_edit_post()
  user_can_delete_post()
  user_can_set_post_date()
  user_can_edit_post_date()
  user_can_edit_post_comments()
  user_can_delete_post_comments()
  user_can_edit_user()
  get_linksbyname()
  wp_get_linksbyname()
  get_linkobjectsbyname()
  get_linkobjects()
  get_linksbyname_withrating()
  get_links_withrating()
  get_autotoggle()
  list_cats()
  wp_list_cats()
  dropdown_cats()
  tinymce_include()
  list_authors()
  wp_get_post_cats()
  wp_set_post_cats()
  get_archives()
  get_author_link()
  link_pages()
  get_settings()
  permalink_link()
  permalink_single_rss()
  wp_get_links()
  get_links()
  get_links_list()
  links_popup_script()
  get_linkrating()
  get_linkcatname()
  comments_rss_link()
  get_category_rss_link()
  get_author_rss_link()
  comments_rss()
  create_user()
  documentation_link()
  gzip_compression()
  get_commentdata()

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 = '<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.
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.'<br />'.$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 = '<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 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 = '<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 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

tinymce_include()   X-Ref


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='<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.

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 = '<br />', $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', $deprecated = '')   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.

author: Dougal
param: string $order Sort link categories by 'name' or 'id'
param: string $$deprecated Not Used

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.

author: Fullo
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', $deprecated = '')   X-Ref
Print RSS comment feed link.

param: string $link_text
param: string $deprecated Not used

get_category_rss_link($echo = false, $cat_ID = 1, $deprecated = '')   X-Ref
Print/Return link to category RSS2 feed.

param: bool $echo
param: int $cat_ID
param: string $deprecated Not used
return: string|null

get_author_rss_link($echo = false, $author_id = 1, $deprecated = '')   X-Ref
Print/Return link to author RSS feed.

param: bool $echo
param: int $author_id
param: string $deprecated Not used
return: string|null

comments_rss($deprecated = '')   X-Ref
Return link to the post RSS feed.

param: string $deprecated Not used
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.

documentation_link( $deprecated = '' )   X-Ref
Unused Admin function.

param: string $deprecated Unknown

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 or not (casted to bool)
param: bool $include_unapproved Whether to include unapproved comments or not
return: array The comment data



Generated: Thu Mar 5 12:05:07 2009 Cross-referenced by PHPXref 0.7