Changeset 6370

Timestamp:

12/10/07 18:52:24 (1 year ago)

Author:

ryan

Message:

phpdoc for deprecated funcs. Props darkdragon. fixes #5444

Files:

• trunk/wp-includes/deprecated.php (modified) (33 diffs)

trunk/wp-includes/deprecated.php

@@ -1 +1 @@
-<?php
+/**
+ * Deprecated functions from past WordPress versions
+ * @package WordPress
+ * @subpackage Deprecated
+ */
-
-/*
@@ -5 +10 @@
- */
-
+/**
+ * The name of the Posts table
+ * @global string $tableposts
+ * @deprecated Use $wpdb->posts
+ */
-$tableposts = $wpdb->posts;
+
+/**
+ * The name of the Users table
+ * @global string $tableusers
+ * @deprecated Use $wpdb->users
+ */
-$tableusers = $wpdb->users;
+
+/**
+ * The name of the Categories table
+ * @global string $tablecategories
+ * @deprecated Use $wpdb->categories
+ */
-$tablecategories = $wpdb->categories;
+
+/**
+ * The name of the post to category table
+ * @global string $tablepost2cat
+ * @deprecated Use $wpdb->post2cat;
+ */
-$tablepost2cat = $wpdb->post2cat;
+
+/**
+ * The name of the comments table
+ * @global string $tablecomments
+ * @deprecated Use $wpdb->comments;
+ */
-$tablecomments = $wpdb->comments;
+
+/**
+ * The name of the links table
+ * @global string $tablelinks
+ * @deprecated Use $wpdb->links;
+ */
-$tablelinks = $wpdb->links;
+
+/**
+ * @global string $tablelinkcategories
+ * @deprecated Not used anymore;
+ */
-$tablelinkcategories = 'linkcategories_is_gone';
+
+/**
+ * The name of the options table
+ * @global string $tableoptions
+ * @deprecated Use $wpdb->options;
+ */
-$tableoptions = $wpdb->options;
+
+/**
+ * The name of the postmeta table
+ * @global string $tablepostmeta
+ * @deprecated Use $wpdb->postmeta;
+ */
-$tablepostmeta = $wpdb->postmeta;
-
@@ -19 +76 @@
- */
-
-
+
+
+
+
+
+
+
+
+
+
-function get_postdata($postid) {
-    $post = &get_post($postid);
@@ -44 +110 @@
-}
-
-
+
+
+
+
+
+
-function start_wp() {
-    global $wp_query, $post;
@@ -54 +125 @@
-}
-
+/**
+ * the_category_ID() - Return or Print Category ID
+ *
+ * @since 0.71
+ * @deprecated use get_the_category()
+ * @see get_the_category()
+ *
+ * @param bool $echo
+ * @return null|int
+ */
-function the_category_ID($echo = true) {
-    // Grab the first cat in the list.
@@ -65 +146 @@
-}
-
+/**
+ * the_category_head() - Print category with optional text before and after
+ *
+ * @since 0.71
+ * @deprecated use get_the_category_by_ID()
+ * @see get_the_category_by_ID()
+ *
+ * @param string $before
+ * @param string $after
+ */
-function the_category_head($before='', $after='') {
-    global $currentcat, $previouscat;
@@ -78 +169 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') {
-
@@ -99 +203 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat='no', $limitnext=1, $excluded_categories='') {
-
@@ -120 +237 @@
-}
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') {
-    $author_data = get_userdata($user_id);
@@ -130 +254 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') {
-    $author_data = get_userdata($user_id);
@@ -136 +271 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function user_can_edit_post($user_id, $post_id, $blog_id = 1) {
-    $author_data = get_userdata($user_id);
@@ -151 +297 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function user_can_delete_post($user_id, $post_id, $blog_id = 1) {
-    // right now if one can edit, one can delete
@@ -157 +314 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') {
-    $author_data = get_userdata($user_id);
@@ -164 +332 @@
-
-/* returns true if $user_id can edit $post_id's date */
+/**
+ * user_can_edit_post_date() - Whether user can delete a post
+ *
+ * @since 1.5
+ * @deprecated Use current_user_can()
+ * @see current_user_can()
+ *
+ * @param int $user_id
+ * @param int $post_id
+ * @param int $blog_id Not Used
+ * @return bool
+ */
-function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
-    $author_data = get_userdata($user_id);
@@ -170 +350 @@
-
-/* returns true if $user_id can edit $post_id's comments */
+/**
+ * user_can_edit_post_comments() - Whether user can delete a post
+ *
+ * @since 1.5
+ * @deprecated Use current_user_can()
+ * @see current_user_can()
+ *
+ * @param int $user_id
+ * @param int $post_id
+ * @param int $blog_id Not Used
+ * @return bool
+ */
-function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
-    // right now if one can edit a post, one can edit comments made on it
@@ -176 +368 @@
-
-/* returns true if $user_id can delete $post_id's comments */
+/**
+ * user_can_delete_post_comments() - Whether user can delete a post
+ *
+ * @since 1.5
+ * @deprecated Use current_user_can()
+ * @see current_user_can()
+ *
+ * @param int $user_id
+ * @param int $post_id
+ * @param int $blog_id Not Used
+ * @return bool
+ */
-function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) {
-    // right now if one can edit comments, one can delete comments
@@ -181 +385 @@
-}
-
+/**
+ * user_can_edit_user() - Can user can edit other user
+ *
+ * @since 1.5
+ * @deprecated Use current_user_can()
+ * @see current_user_can()
+ *
+ * @param int $user_id
+ * @param int $other_user
+ * @return bool
+ */
-function user_can_edit_user($user_id, $other_user) {
-    $user  = get_userdata($user_id);
@@ -190 +405 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_get_linksbyname($category, $args = '') {
-
-
-
+
-    if ( !$cat )
-        return false;
@@ -243 +457 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- */
-function get_autotoggle($id = 0) {
@@ -390 +604 @@
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    $query = compact('optionall', 'all', 'sort_column', 'sort_order', 'file', 'list', 'optiondates', 'optioncount', 'hide_empty', 'use_desc_for_title', 'children',
-        'child_of', 'categories', 'recurse', 'feed', 'feed_image', 'exclude', 'hierarchical');
@@ -397 +637 @@
-}
-
+/**
+ * @since 1.2
+ * @deprecated Use wp_list_categories()
+ * @see wp_list_categories()
+ *
+ * @param string|array $args
+ * @return unknown
+ */
-function wp_list_cats($args = '') {
-    $r = wp_parse_args( $args );
@@ -418 +666 @@
-}
-
+/**
+ * @since 0.71
+ * @deprecated Use wp_dropdown_categories()
+ * @see wp_dropdown_categories()
+ *
+ * @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
+ */
-function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = 'asc',
-FALSE
+false
-        $selected = 0, $exclude = 0) {
-
@@ -436 +701 @@
-}
-
-
+
+
+
+
+
+
-function tinymce_include() {
-    wp_print_script('wp_tiny_mce');
-}
-
+/**
+ * @since 1.2
+ * @deprecated Use wp_list_authors()
+ * @see wp_list_authors()
+ *
+ * @param bool $optioncount
+ * @param bool $exclude_admin
+ * @param bool $show_fullname
+ * @param bool $hide_empty
+ * @param string $feed
+ * @param string $feed_image
+ * @return unknown
+ */
-function list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') {
-    $args = compact('optioncount', 'exclude_admin', 'show_fullname', 'hide_empty', 'feed', 'feed_image');
@@ -446 +729 @@
-}
-
+/**
+ * @since 1.0.1
+ * @deprecated Use wp_get_post_categories()
+ * @see wp_get_post_categories()
+ *
+ * @param int $blogid Not Used
+ * @param int $post_ID
+ * @return unknown
+ */
-function wp_get_post_cats($blogid = '1', $post_ID = 0) {
-    return wp_get_post_categories($post_ID);
-}
-
+/**
+ * wp_set_post_cats() - Sets the categories that the post id belongs to.
+ *
+ * @since 1.0.1
+ * @deprecated Use wp_set_post_categories()
+ * @see wp_set_post_categories()
+ *
+ * @param int $blogid Not used
+ * @param int $post_ID
+ * @param array $post_categories
+ * @return unknown
+ */
-function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array()) {
-    return wp_set_post_categories($post_ID, $post_categories);
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) {
-    $args = compact('type', 'limit', 'format', 'before', 'after', 'show_post_count');
@@ -460 +776 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function get_author_link($echo = false, $author_id, $author_nicename = '') {
-    $link = get_author_posts_url($author_id, $author_nicename);
@@ -469 +796 @@
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    $args = compact('before', 'after', 'next_or_number', 'nextpagelink', 'previouspagelink', 'pagelink', 'more_file');
-    return wp_link_pages($args);
-}
-
-
+
+
+
+
+
+
+
+
+
+
-function get_settings($option) {
-    return get_option($option);
-}
-
-
+
+
+
+
+
+
+
-function permalink_link() {
-    the_permalink();
-}
-
-
+
+
+
+
+
+
+
+
+
-function permalink_single_rss($file = '') {
-    the_permalink_rss();
-}
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-function wp_get_links($args = '') {
-    global $wpdb;
-
-    if ( strpos( $args, '=' ) === false ) {
-        $cat_id = $args;
@@ -518 +886 @@
-
-    return get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, $show_rating, $limit, $show_updated, $echo);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    $order = 'ASC';
@@ -634 +992 @@
-}
-
-
-
-
-
+
+
- *
- * Output a list of all links, listed by category, using the
@@ -643 +999 @@
- * HTML unordered list.
- *
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-    $order = strtolower($order);
-
@@ -678 +1038 @@
-}
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- */
-function links_popup_script($text = 'Links', $width=400, $height=400, $file='links.all.php', $count = true) {
@@ -703 +1067 @@
-}
-
-
+
+
+
+
+
+
+
+
-function get_linkrating($link) {
-    return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display');
-}
-
-
-
-
-
+
+
+
+
+
+
+
+
+
- */
-function get_linkcatname($id = 0) {
@@ -730 +1106 @@
-}
-
-
+
+
+
+
+
+
+
+