X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..1c09677af04c9e37714e09b73eb9dbc5b2e3eb13:/wp-includes/deprecated.php diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index 3bc3c0ca..0b546ebf 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -1,25 +1,96 @@ 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; /* * Deprecated functions come here to die. */ -// Use get_post(). +/** + * Entire Post data. + * + * @since 0.71 + * @deprecated Use get_post() + * @see get_post() + * + * @param int $postid + * @return array + */ function get_postdata($postid) { + _deprecated_function(__FUNCTION__, '0.0', 'get_post()'); + $post = &get_post($postid); $postdata = array ( @@ -43,17 +114,36 @@ function get_postdata($postid) { return $postdata; } -// Use the new post loop. +/** + * Sets up the WordPress Loop. + * + * @since 1.0.1 + * @deprecated Since 1.5 - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop} + */ function start_wp() { global $wp_query, $post; + _deprecated_function(__FUNCTION__, '1.5', __('new WordPress Loop') ); + // Since the old style loop is being used, advance the query iterator here. $wp_query->next_post(); setup_postdata($post); } +/** + * 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) { + _deprecated_function(__FUNCTION__, '0.0', 'get_the_category()'); + // Grab the first cat in the list. $categories = get_the_category(); $cat = $categories[0]->term_id; @@ -64,8 +154,21 @@ function the_category_ID($echo = true) { return $cat; } +/** + * 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; + + _deprecated_function(__FUNCTION__, '0.0', 'get_the_category_by_ID()'); + // Grab the first cat in the list. $categories = get_the_category(); $currentcat = $categories[0]->category_id; @@ -77,9 +180,24 @@ function the_category_head($before='', $after='') { } } -// Use previous_post_link(). +/** + * Prints link to the previous post. + * + * @since 1.5 + * @deprecated Use previous_post_link() + * @see previous_post_link() + * + * @param string $format + * @param string $previous + * @param string $title + * @param string $in_same_cat + * @param int $limitprev + * @param string $excluded_categories + */ function previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') { + _deprecated_function(__FUNCTION__, '0.0', 'previous_post_link()'); + if ( empty($in_same_cat) || 'no' == $in_same_cat ) $in_same_cat = false; else @@ -98,8 +216,22 @@ function previous_post($format='%', $previous='previous post: ', $title='yes', $ echo $format; } -// Use next_post_link(). +/** + * Prints link to the next post. + * + * @since 0.71 + * @deprecated Use next_post_link() + * @see next_post_link() + * + * @param string $format + * @param string $previous + * @param string $title + * @param string $in_same_cat + * @param int $limitprev + * @param string $excluded_categories + */ function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat='no', $limitnext=1, $excluded_categories='') { + _deprecated_function(__FUNCTION__, '0.0', 'next_post_link()'); if ( empty($in_same_cat) || 'no' == $in_same_cat ) $in_same_cat = false; @@ -119,24 +251,59 @@ function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat= echo $format; } -// -// Use current_user_can() for these. -// - -/* returns true if $user_id can create a new post */ +/** + * Whether user can create a post. + * + * @since 1.5 + * @deprecated Use current_user_can() + * @see current_user_can() + * + * @param int $user_id + * @param int $blog_id Not Used + * @param int $category_id Not Used + * @return bool + */ function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + $author_data = get_userdata($user_id); return ($author_data->user_level > 1); } -/* returns true if $user_id can create a new post */ +/** + * Whether user can create a post. + * + * @since 1.5 + * @deprecated Use current_user_can() + * @see current_user_can() + * + * @param int $user_id + * @param int $blog_id Not Used + * @param int $category_id Not Used + * @return bool + */ function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + $author_data = get_userdata($user_id); return ($author_data->user_level >= 1); } -/* returns true if $user_id can edit $post_id */ +/** + * Whether user can edit 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($user_id, $post_id, $blog_id = 1) { + _deprecated_function(__FUNCTION__, '0', 'current_user_can()'); + $author_data = get_userdata($user_id); $post = get_post($post_id); $post_author_data = get_userdata($post->post_author); @@ -150,37 +317,115 @@ function user_can_edit_post($user_id, $post_id, $blog_id = 1) { } } -/* returns true if $user_id can delete $post_id */ +/** + * 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($user_id, $post_id, $blog_id = 1) { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + // right now if one can edit, one can delete return user_can_edit_post($user_id, $post_id, $blog_id); } -/* returns true if $user_id can set new posts' dates on $blog_id */ +/** + * Whether user can set new posts' dates. + * + * @since 1.5 + * @deprecated Use current_user_can() + * @see current_user_can() + * + * @param int $user_id + * @param int $blog_id Not Used + * @param int $category_id Not Used + * @return bool + */ function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + $author_data = get_userdata($user_id); return (($author_data->user_level > 4) && user_can_create_post($user_id, $blog_id, $category_id)); } -/* returns true if $user_id can edit $post_id's 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 returns true if $user_id can edit $post_id's date + */ function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + $author_data = get_userdata($user_id); return (($author_data->user_level > 4) && user_can_edit_post($user_id, $post_id, $blog_id)); } -/* returns true if $user_id can edit $post_id's 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 returns true if $user_id can edit $post_id's comments + */ function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + // right now if one can edit a post, one can edit comments made on it return user_can_edit_post($user_id, $post_id, $blog_id); } -/* returns true if $user_id can delete $post_id's 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 returns true if $user_id can delete $post_id's comments + */ function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + // right now if one can edit comments, one can delete comments return user_can_edit_post_comments($user_id, $post_id, $blog_id); } +/** + * 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) { + _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); + $user = get_userdata($user_id); $other = get_userdata($other_user); if ( $user->user_level > $other->user_level || $user->user_level > 8 || $user->ID == $other->ID ) @@ -189,51 +434,54 @@ function user_can_edit_user($user_id, $other_user) { return false; } -/** function get_linksbyname() - ** Gets the links associated with category 'cat_name'. - ** Parameters: - ** cat_name (default 'noname') - The category name to use. If no - ** match is found uses all - ** before (default '') - the html to output before the link - ** after (default '
') - the html to output after the link - ** between (default ' ') - the html to output between the link/image - ** and it's description. Not used if no image or show_images == true - ** show_images (default true) - whether to show images (if defined). - ** orderby (default 'id') - the order to output the links. E.g. 'id', 'name', - ** 'url', 'description' or 'rating'. Or maybe owner. If you start the - ** name with an underscore the order will be reversed. - ** You can also specify 'rand' as the order which will return links in a - ** random order. - ** show_description (default true) - whether to show the description if - ** show_images=false/not defined - ** show_rating (default false) - show rating stars/chars - ** limit (default -1) - Limit to X entries. If not specified, all entries - ** are shown. - ** show_updated (default 0) - whether to show last updated timestamp - */ -function get_linksbyname($cat_name = "noname", $before = '', $after = '
', - $between = " ", $show_images = true, $orderby = 'id', - $show_description = true, $show_rating = false, - $limit = -1, $show_updated = 0) { - global $wpdb; - $cat_id = -1; - $cat = get_term_by('name', $cat_name, 'link_category'); - if ( $cat ) - $cat_id = $cat->term_id; - - get_links($cat_id, $before, $after, $between, $show_images, $orderby, - $show_description, $show_rating, $limit, $show_updated); -} - -/** function wp_get_linksbyname() - ** Gets the links associated with the named category. - ** Parameters: - ** category (no default) - The category to use. - **/ -function wp_get_linksbyname($category, $args = '') { - global $wpdb; +/** + * Gets the links associated with category $cat_name. + * + * @since 0.71 + * @deprecated Use get_links() + * @see get_links() + * + * @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. + * If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a + * random order. + * @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 + */ +function get_linksbyname($cat_name = "noname", $before = '', $after = '
', $between = " ", $show_images = true, $orderby = 'id', + $show_description = true, $show_rating = false, + $limit = -1, $show_updated = 0) { + _deprecated_function(__FUNCTION__, '0.0', 'get_links()'); + $cat_id = -1; $cat = get_term_by('name', $cat_name, 'link_category'); + if ( $cat ) + $cat_id = $cat->term_id; + + get_links($cat_id, $before, $after, $between, $show_images, $orderby, $show_description, $show_rating, $limit, $show_updated); +} + +/** + * Gets the links associated with the named category. + * + * @since 1.0.1 + * @deprecated Use wp_get_links() + * @see wp_get_links() + * + * @param string $category The category to use. + * @param string $args + * @return bool|null + */ +function wp_get_linksbyname($category, $args = '') { + _deprecated_function(__FUNCTION__, '0.0', 'wp_get_links()'); + + $cat = get_term_by('name', $category, 'link_category'); if ( !$cat ) return false; $cat_id = $cat->term_id; @@ -242,161 +490,206 @@ function wp_get_linksbyname($category, $args = '') { wp_get_links($args); } -/** function get_linkobjectsbyname() - ** Gets an array of link objects associated with category 'cat_name'. - ** Parameters: - ** cat_name (default 'noname') - The category name to use. If no - ** match is found uses all - ** orderby (default 'id') - the order to output the links. E.g. 'id', 'name', - ** 'url', 'description', or 'rating'. Or maybe owner. If you start the - ** name with an underscore the order will be reversed. - ** You can also specify 'rand' as the order which will return links in a - ** random order. - ** limit (default -1) - Limit to X entries. If not specified, all entries - ** are shown. - ** - ** Use this like: - ** $links = get_linkobjectsbyname('fred'); - ** foreach ($links as $link) { - ** echo '
  • '.$link->link_name.'
  • '; - ** } - **/ +/** + * Gets an array of link objects associated with category $cat_name. + * + * + * $links = get_linkobjectsbyname('fred'); + * foreach ($links as $link) { + * echo '
  • '.$link->link_name.'
  • '; + * } + *
    + * + * @since 1.0.1 + * @deprecated Use get_linkobjects() + * @see get_linkobjects() + * + * @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'. + * Or maybe owner. If you start the name with an underscore the order will be reversed. You can also + * specify 'rand' as the order which will return links in a random order. + * @param int $limit Limit to X entries. If not specified, all entries are shown. + * @return unknown + */ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) { - global $wpdb; - $cat_id = -1; - $cat = get_term_by('name', $cat_name, 'link_category'); - if ( $cat ) - $cat_id = $cat->term_id; - - return get_linkobjects($cat_id, $orderby, $limit); -} - -/** function get_linkobjects() - ** Gets an array of link objects associated with category n. - ** Parameters: - ** category (default -1) - The category to use. If no category supplied - ** uses all - ** orderby (default 'id') - the order to output the links. E.g. 'id', 'name', - ** 'url', 'description', or 'rating'. Or maybe owner. If you start the - ** name with an underscore the order will be reversed. - ** You can also specify 'rand' as the order which will return links in a - ** random order. - ** limit (default -1) - Limit to X entries. If not specified, all entries - ** are shown. - ** - ** Use this like: - ** $links = get_linkobjects(1); - ** if ($links) { - ** foreach ($links as $link) { - ** echo '
  • '.$link->link_name.'
    '.$link->link_description.'
  • '; - ** } - ** } - ** 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 - **/ -// Deprecate in favor of get_linkz(). + _deprecated_function(__FUNCTION__, '0.0', 'get_linkobjects()'); + + $cat_id = -1; + $cat = get_term_by('name', $cat_name, 'link_category'); + if ( $cat ) + $cat_id = $cat->term_id; + + return get_linkobjects($cat_id, $orderby, $limit); +} + +/** + * Gets an array of link objects associated with category n. + * + * Usage: + * + * $links = get_linkobjects(1); + * if ($links) { + * foreach ($links as $link) { + * echo '
  • '.$link->link_name.'
    '.$link->link_description.'
  • '; + * } + * } + *
    + * + * Fields are: + *
      + *
    1. link_id
    2. + *
    3. link_url
    4. + *
    5. link_name
    6. + *
    7. link_image
    8. + *
    9. link_target
    10. + *
    11. link_category
    12. + *
    13. link_description
    14. + *
    15. link_visible
    16. + *
    17. link_owner
    18. + *
    19. link_rating
    20. + *
    21. link_updated
    22. + *
    23. link_rel
    24. + *
    25. link_notes
    26. + *
    + * + * @since 1.0.1 + * @deprecated Use get_bookmarks() + * @see get_bookmarks() + * + * @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', + * 'description', or 'rating'. Or maybe owner. If you start the name with an + * underscore the order will be reversed. You can also specify 'rand' as the + * order which will return links in a random order. + * @param int $limit Limit to X entries. If not specified, all entries are shown. + * @return unknown + */ function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) { - global $wpdb; + _deprecated_function(__FUNCTION__, '0.0', 'get_bookmarks()'); - $links = get_bookmarks("category=$category&orderby=$orderby&limit=$limit"); + $links = get_bookmarks("category=$category&orderby=$orderby&limit=$limit"); - $links_array = array(); - foreach ($links as $link) { - $links_array[] = $link; - } + $links_array = array(); + foreach ($links as $link) + $links_array[] = $link; + + return $links_array; +} + +/** + * Gets the links associated with category 'cat_name' and display rating stars/chars. + * + * @since 0.71 + * @deprecated Use get_bookmarks() + * @see get_bookmarks() + * + * @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', + * 'description', or 'rating'. Or maybe owner. If you start the name with an + * underscore the order will be reversed. You can also specify 'rand' as the + * order which will return links in a random order. + * @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 + */ +function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '
    ', $between = " ", + $show_images = true, $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) { + _deprecated_function(__FUNCTION__, '0.0', 'get_bookmarks()'); + + get_linksbyname($cat_name, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated); +} + +/** + * Gets the links associated with category n and display rating stars/chars. + * + * @since 0.71 + * @deprecated Use get_bookmarks() + * @see get_bookmarks() + * + * @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', + * 'description', or 'rating'. Or maybe owner. If you start the name with an + * underscore the order will be reversed. You can also specify 'rand' as the + * order which will return links in a random order. + * @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 + */ +function get_links_withrating($category = -1, $before = '', $after = '
    ', $between = " ", $show_images = true, + $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) { + _deprecated_function(__FUNCTION__, '0.0', 'get_bookmarks()'); - return $links_array; -} - -/** function get_linksbyname_withrating() - ** Gets the links associated with category 'cat_name' and display rating stars/chars. - ** Parameters: - ** cat_name (default 'noname') - The category name to use. If no - ** match is found uses all - ** before (default '') - the html to output before the link - ** after (default '
    ') - the html to output after the link - ** between (default ' ') - the html to output between the link/image - ** and it's description. Not used if no image or show_images == true - ** show_images (default true) - whether to show images (if defined). - ** orderby (default 'id') - the order to output the links. E.g. 'id', 'name', - ** 'url' or 'description'. Or maybe owner. If you start the - ** name with an underscore the order will be reversed. - ** You can also specify 'rand' as the order which will return links in a - ** random order. - ** show_description (default true) - whether to show the description if - ** show_images=false/not defined - ** limit (default -1) - Limit to X entries. If not specified, all entries - ** are shown. - ** show_updated (default 0) - whether to show last updated timestamp - */ -function get_linksbyname_withrating($cat_name = "noname", $before = '', - $after = '
    ', $between = " ", - $show_images = true, $orderby = 'id', - $show_description = true, $limit = -1, $show_updated = 0) { - - get_linksbyname($cat_name, $before, $after, $between, $show_images, - $orderby, $show_description, true, $limit, $show_updated); -} - -/** function get_links_withrating() - ** Gets the links associated with category n and display rating stars/chars. - ** Parameters: - ** category (default -1) - The category to use. If no category supplied - ** uses all - ** before (default '') - the html to output before the link - ** after (default '
    ') - the html to output after the link - ** between (default ' ') - the html to output between the link/image - ** and it's description. Not used if no image or show_images == true - ** show_images (default true) - whether to show images (if defined). - ** orderby (default 'id') - the order to output the links. E.g. 'id', 'name', - ** 'url' or 'description'. Or maybe owner. If you start the - ** name with an underscore the order will be reversed. - ** You can also specify 'rand' as the order which will return links in a - ** random order. - ** show_description (default true) - whether to show the description if - ** show_images=false/not defined . - ** limit (default -1) - Limit to X entries. If not specified, all entries - ** are shown. - ** show_updated (default 0) - whether to show last updated timestamp - */ -function get_links_withrating($category = -1, $before = '', $after = '
    ', - $between = " ", $show_images = true, - $orderby = 'id', $show_description = true, - $limit = -1, $show_updated = 0) { - - get_links($category, $before, $after, $between, $show_images, $orderby, - $show_description, true, $limit, $show_updated); -} - -/** function get_get_autotoggle() - ** Gets the auto_toggle setting of category n. - ** Parameters: id (default 0) - The category to get. If no category supplied - ** uses 0 + get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated); +} + +/** + * Gets the auto_toggle setting. + * + * @since 0.71 + * @deprecated No alternative function available + * + * @param int $id The category to get. If no category supplied uses 0 + * @return int Only returns 0. */ function get_autotoggle($id = 0) { + _deprecated_function(__FUNCTION__, '0.0' ); return 0; } -// Use wp_list_cats(). -function 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) { +/** + * @since 0.71 + * @deprecated Use wp_list_categories() + * @see wp_list_categories() + * + * @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 + */ +function 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) { + _deprecated_function(__FUNCTION__, '0.0', 'wp_list_categories()'); + $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'); return wp_list_cats($query); } +/** + * @since 1.2 + * @deprecated Use wp_list_categories() + * @see wp_list_categories() + * + * @param string|array $args + * @return unknown + */ function wp_list_cats($args = '') { + _deprecated_function(__FUNCTION__, '0.0', 'wp_list_categories()'); + $r = wp_parse_args( $args ); // Map to new names. @@ -417,9 +710,27 @@ function wp_list_cats($args = '') { return wp_list_categories($r); } +/** + * @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', - $show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = FALSE, + $show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = false, $selected = 0, $exclude = 0) { + _deprecated_function(__FUNCTION__, '0.0', 'wp_dropdown_categories()'); $show_option_all = ''; if ( $optionall ) @@ -435,32 +746,102 @@ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = ' return wp_dropdown_categories($query); } -// Use wp_print_scripts() or WP_Scripts. +/** + * @since 2.1 + * @deprecated Use wp_tiny_mce(). + * @see wp_tiny_mce() + */ function tinymce_include() { - wp_print_script('wp_tiny_mce'); + _deprecated_function(__FUNCTION__, '0.0', 'wp_tiny_mce()'); + + 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 = '') { + _deprecated_function(__FUNCTION__, '0.0', 'wp_list_authors()'); + $args = compact('optioncount', 'exclude_admin', 'show_fullname', 'hide_empty', 'feed', 'feed_image'); return wp_list_authors($args); } +/** + * @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) { + _deprecated_function(__FUNCTION__, '0.0', 'wp_get_post_categories()'); return wp_get_post_categories($post_ID); } +/** + * 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()) { + _deprecated_function(__FUNCTION__, '0.0', 'wp_set_post_categories()'); return wp_set_post_categories($post_ID, $post_categories); } -// Use wp_get_archives(). +/** + * @since 0.71 + * @deprecated Use wp_get_archives() + * @see wp_get_archives() + * + * @param string $type + * @param string $limit + * @param string $format + * @param string $before + * @param string $after + * @param bool $show_post_count + * @return unknown + */ function get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) { + _deprecated_function(__FUNCTION__, '0.0', 'wp_get_archives()'); $args = compact('type', 'limit', 'format', 'before', 'after', 'show_post_count'); return wp_get_archives($args); } -// Use get_author_posts_url(). +/** + * Returns or Prints link to the author's posts. + * + * @since 1.2 + * @deprecated Use get_author_posts_url() + * @see get_author_posts_url() + * + * @param bool $echo Optional. + * @param int $author_id Required. + * @param string $author_nicename Optional. + * @return string|null + */ function get_author_link($echo = false, $author_id, $author_nicename = '') { + _deprecated_function(__FUNCTION__, '0.0', 'get_author_posts_url()'); + $link = get_author_posts_url($author_id, $author_nicename); if ( $echo ) @@ -468,36 +849,85 @@ function get_author_link($echo = false, $author_id, $author_nicename = '') { return $link; } -// Use wp_link_pages(). -function link_pages($before='
    ', $after='
    ', $next_or_number='number', $nextpagelink='next page', $previouspagelink='previous page', $pagelink='%', $more_file='') { +/** + * Print list of pages based on arguments. + * + * @since 0.71 + * @deprecated Use wp_link_pages() + * @see wp_link_pages() + * + * @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 + */ +function link_pages($before='
    ', $after='
    ', $next_or_number='number', $nextpagelink='next page', $previouspagelink='previous page', + $pagelink='%', $more_file='') { + _deprecated_function(__FUNCTION__, '0.0', 'wp_link_pages()'); + $args = compact('before', 'after', 'next_or_number', 'nextpagelink', 'previouspagelink', 'pagelink', 'more_file'); return wp_link_pages($args); } -// Use get_option(). +/** + * Get value based on option. + * + * @since 0.71 + * @deprecated Use get_option() + * @see get_option() + * + * @param string $option + * @return string + */ function get_settings($option) { + _deprecated_function(__FUNCTION__, '0.0', 'get_option()'); + return get_option($option); } -// Use the_permalink(). +/** + * Print the permalink of the current post in the loop. + * + * @since 0.71 + * @deprecated Use the_permalink() + * @see the_permalink() + */ function permalink_link() { + _deprecated_function(__FUNCTION__, '0.0', 'the_permalink()'); the_permalink(); } -// Use the_permalink_rss() -function permalink_single_rss($file = '') { +/** + * Print the permalink to the RSS feed. + * + * @since 0.71 + * @deprecated Use the_permalink_rss() + * @see the_permalink_rss() + * + * @param string $file + */ +function permalink_single_rss($deprecated = '') { + _deprecated_function(__FUNCTION__, '0.0', 'the_permalink_rss()'); the_permalink_rss(); } -/** function wp_get_links() - ** Gets the links associated with category n. - ** Parameters: - ** category (no default) - The category to use. - ** or: - ** a query string - **/ +/** + * Gets the links associated with category. + * + * @see get_links() for argument information that can be used in $args + * @since 1.0.1 + * @deprecated Use get_bookmarks() + * @see get_bookmarks() + * + * @param string $args a query string + * @return null|string + */ function wp_get_links($args = '') { - global $wpdb; + _deprecated_function(__FUNCTION__, '0.0', 'get_bookmarks()'); if ( strpos( $args, '=' ) === false ) { $cat_id = $args; @@ -517,44 +947,35 @@ function wp_get_links($args = '') { extract( $r, EXTR_SKIP ); return get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, $show_rating, $limit, $show_updated, $echo); -} // end wp_get_links - -/** function get_links() - ** Gets the links associated with category n. - ** Parameters: - ** category (default -1) - The category to use. If no category supplied - ** uses all - ** before (default '') - the html to output before the link - ** after (default '
    ') - the html to output after the link - ** between (default ' ') - the html to output between the link/image - ** and its description. Not used if no image or show_images == true - ** show_images (default true) - whether to show images (if defined). - ** orderby (default 'id') - the order to output the links. E.g. 'id', 'name', - ** 'url', 'description', or 'rating'. Or maybe owner. If you start the - ** name with an underscore the order will be reversed. - ** You can also specify 'rand' as the order which will return links in a - ** random order. - ** show_description (default true) - whether to show the description if - ** show_images=false/not defined . - ** show_rating (default false) - show rating stars/chars - ** limit (default -1) - Limit to X entries. If not specified, all entries - ** are shown. - ** show_updated (default 0) - whether to show last updated timestamp - ** echo (default true) - whether to echo the results, or return them instead - */ -function 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) { - - global $wpdb; +} + +/** + * Gets the links associated with category by id. + * + * @since 0.71 + * @deprecated Use get_bookmarks() + * @see get_bookmarks() + * + * @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. + * 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', + * 'description', or 'rating'. Or maybe owner. If you start the name with an + * underscore the order will be reversed. You can also specify 'rand' as the order + * which will return links in a random order. + * @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 + */ +function 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) { + _deprecated_function(__FUNCTION__, '0.0', 'get_bookmarks()'); $order = 'ASC'; if ( substr($orderby, 0, 1) == '_' ) { @@ -580,13 +1001,13 @@ function get_links($category = -1, $output .= get_option('links_recently_updated_prepend'); $the_link = '#'; if ( !empty($row->link_url) ) - $the_link = clean_url($row->link_url); + $the_link = esc_url($row->link_url); $rel = $row->link_rel; if ( '' != $rel ) $rel = ' rel="' . $rel . '"'; - $desc = attribute_escape(sanitize_bookmark_field('link_description', $row->link_description, $row->link_id, 'display')); - $name = attribute_escape(sanitize_bookmark_field('link_name', $row->link_name, $row->link_id, 'display')); + $desc = esc_attr(sanitize_bookmark_field('link_description', $row->link_description, $row->link_id, 'display')); + $name = esc_attr(sanitize_bookmark_field('link_name', $row->link_name, $row->link_id, 'display')); $title = $desc; if ( $show_updated ) @@ -633,20 +1054,23 @@ function get_links($category = -1, echo $output; } -/* - * function get_links_list() +/** + * Output entire list of links by category. * - * added by Dougal + * Output a list of all links, listed by category, using the settings in + * $wpdb->linkcategories and output it as a nested HTML unordered list. * - * 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 + * @since 1.0.1 + * @deprecated Use wp_list_bookmarks() + * @see wp_list_bookmarks() * - * Parameters: - * order (default 'name') - Sort link categories by 'name' or 'id' - * hide_if_empty (default true) - Supress listing empty link categories + * @param string $order Sort link categories by 'name' or 'id' + * @param string $$deprecated Not Used */ -function get_links_list($order = 'name', $hide_if_empty = 'obsolete') { +function get_links_list($order = 'name', $deprecated = '') { + _deprecated_function(__FUNCTION__, '0.0', 'wp_list_bookmarks()'); + $order = strtolower($order); // Handle link category sorting @@ -677,18 +1101,24 @@ function get_links_list($order = 'name', $hide_if_empty = 'obsolete') { } } - -/** function links_popup_script() - ** This function contributed by Fullo -- http://sprite.csr.unibo.it/fullo/ - ** Show the link to the links popup and the number of links - ** Parameters: - ** text (default Links) - the text of the link - ** width (default 400) - the width of the popup window - ** height (default 400) - the height of the popup window - ** file (default linkspopup.php) - the page to open in the popup window - ** count (default true) - the number of links in the db +/** + * Show the link to the links popup and the number of links. + * + * @author Fullo + * @link http://sprite.csr.unibo.it/fullo/ + * + * @since 0.71 + * @deprecated {@internal Use function instead is unknown}} + * + * @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 */ function links_popup_script($text = 'Links', $width=400, $height=400, $file='links.all.php', $count = true) { + _deprecated_function(__FUNCTION__, '0.0' ); + if ( $count ) $counts = $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->links"); @@ -702,17 +1132,32 @@ function links_popup_script($text = 'Links', $width=400, $height=400, $file='lin echo $javascript; } - +/** + * @since 1.0.1 + * @deprecated Use sanitize_bookmark_field() + * @see sanitize_bookmark_field() + * + * @param object $link + * @return unknown + */ function get_linkrating($link) { + _deprecated_function(__FUNCTION__, '0.0', 'sanitize_bookmark_field()'); return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display'); } -/** function get_linkcatname() - ** Gets the name of category n. - ** Parameters: id (default 0) - The category to get. If no category supplied - ** uses 0 +/** + * Gets the name of category by id. + * + * @since 0.71 + * @deprecated Use get_category() + * @see get_category() + * + * @param int $id The category to get. If no category supplied uses 0 + * @return string */ function get_linkcatname($id = 0) { + _deprecated_function(__FUNCTION__, '0.0', 'get_category()'); + $id = (int) $id; if ( empty($id) ) @@ -729,4 +1174,640 @@ function get_linkcatname($id = 0) { return $cat->name; } +/** + * Print RSS comment feed link. + * + * @since 1.0.1 + * @deprecated Use post_comments_feed_link() + * @see post_comments_feed_link() + * + * @param string $link_text + * @param string $deprecated Not used + */ +function comments_rss_link($link_text = 'Comments RSS', $deprecated = '') { + _deprecated_function(__FUNCTION__, '0.0', 'post_comments_feed_link()'); + post_comments_feed_link($link_text); +} + +/** + * Print/Return link to category RSS2 feed. + * + * @since 1.2 + * @deprecated Use get_category_feed_link() + * @see get_category_feed_link() + * + * @param bool $echo + * @param int $cat_ID + * @param string $deprecated Not used + * @return string|null + */ +function get_category_rss_link($echo = false, $cat_ID = 1, $deprecated = '') { + _deprecated_function(__FUNCTION__, '0.0', 'get_category_feed_link()'); + + $link = get_category_feed_link($cat_ID, 'rss2'); + + if ( $echo ) + echo $link; + return $link; +} + +/** + * Print/Return link to author RSS feed. + * + * @since 1.2 + * @deprecated Use get_author_feed_link() + * @see get_author_feed_link() + * + * @param bool $echo + * @param int $author_id + * @param string $deprecated Not used + * @return string|null + */ +function get_author_rss_link($echo = false, $author_id = 1, $deprecated = '') { + _deprecated_function(__FUNCTION__, '0.0', 'get_author_feed_link()'); + + $link = get_author_feed_link($author_id); + if ( $echo ) + echo $link; + return $link; +} + +/** + * Return link to the post RSS feed. + * + * @since 1.5 + * @deprecated Use get_post_comments_feed_link() + * @see get_post_comments_feed_link() + * + * @param string $deprecated Not used + * @return string + */ +function comments_rss($deprecated = '') { + _deprecated_function(__FUNCTION__, '2.2', 'get_post_comments_feed_link()'); + return get_post_comments_feed_link(); +} + +/** + * 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. + * @deprecated Use wp_create_user() + * @see wp_create_user() + */ +function create_user($username, $password, $email) { + _deprecated_function( __FUNCTION__, '2.0', 'wp_create_user()' ); + return wp_create_user($username, $password, $email); +} + +/** + * Unused Admin function. + * + * @since 2.0 + * @param string $deprecated Unknown + * @deprecated 2.5 + */ +function documentation_link( $deprecated = '' ) { + _deprecated_function( __FUNCTION__, '2.5', '' ); + return; +} + +/** + * Unused function. + * + * @deprecated 2.5 +*/ +function gzip_compression() { + return false; +} + +/** + * Retrieve an array of comment data about comment $comment_ID. + * + * @deprecated Use get_comment() + * @see get_comment() + * @since 0.71 + * + * @uses $id + * @uses $wpdb Database Object + * + * @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 + */ +function get_commentdata( $comment_ID, $no_cache = 0, $include_unapproved = false ) { + _deprecated_function( __FUNCTION__, '2.7', 'get_comment()' ); + return get_comment($comment_ID, ARRAY_A); +} + +/** + * Retrieve the category name by the category ID. + * + * @since 0.71 + * @deprecated Use get_cat_name() + * @see get_cat_name() get_catname() is deprecated in favor of get_cat_name(). + * + * @param int $cat_ID Category ID + * @return string category name + */ +function get_catname( $cat_ID ) { + _deprecated_function(__FUNCTION__, '2.8', 'get_cat_name()'); + return get_cat_name( $cat_ID ); +} + +/** + * Retrieve category children list separated before and after the term IDs. + * + * @since 1.2.0 + * + * @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 + */ +function get_category_children( $id, $before = '/', $after = '', $visited = array() ) { + _deprecated_function(__FUNCTION__, '2.8', 'get_term_children()'); + if ( 0 == $id ) + return ''; + + $chain = ''; + /** TODO: consult hierarchy */ + $cat_ids = get_all_category_ids(); + foreach ( (array) $cat_ids as $cat_id ) { + if ( $cat_id == $id ) + continue; + + $category = get_category( $cat_id ); + if ( is_wp_error( $category ) ) + return $category; + if ( $category->parent == $id && !in_array( $category->term_id, $visited ) ) { + $visited[] = $category->term_id; + $chain .= $before.$category->term_id.$after; + $chain .= get_category_children( $category->term_id, $before, $after ); + } + } + return $chain; +} + +/** + * Retrieve the description of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's description. + * @deprecated Use the_author_meta('description') + */ +function get_the_author_description() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'description\')' ); + return get_the_author_meta('description'); +} + +/** + * Display the description of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_description + * @since 1.0.0 + * @deprecated 2.8 + * @deprecated Use the_author_meta('description') + */ +function the_author_description() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'description\')' ); + the_author_meta('description'); +} + +/** + * Retrieve the login name of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's login name (username). + * @deprecated Use the_author_meta('login') + */ +function get_the_author_login() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'login\')' ); + return get_the_author_meta('login'); +} + +/** + * Display the login name of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_login + * @since 0.71 + * @deprecated 2.8 + * @deprecated Use the_author_meta('login') + */ +function the_author_login() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'login\')' ); + the_author_meta('login'); +} + +/** + * Retrieve the first name of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's first name. + * @deprecated Use the_author_meta('first_name') + */ +function get_the_author_firstname() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'first_name\')' ); + return get_the_author_meta('first_name'); +} + +/** + * Display the first name of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_firstname + * @since 0.71 + * @deprecated 2.8 + * @deprecated Use the_author_meta('first_name') + */ +function the_author_firstname() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'first_name\')' ); + the_author_meta('first_name'); +} + +/** + * Retrieve the last name of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's last name. + * @deprecated Use the_author_meta('last_name') + */ +function get_the_author_lastname() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'last_name\')' ); + return get_the_author_meta('last_name'); +} + +/** + * Display the last name of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_lastname + * @since 0.71 + * @deprecated 2.8 + * @deprecated Use the_author_meta('last_name') + */ +function the_author_lastname() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'last_name\')' ); + the_author_meta('last_name'); +} + +/** + * Retrieve the nickname of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's nickname. + * @deprecated Use the_author_meta('nickname') + */ +function get_the_author_nickname() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'nickname\')' ); + return get_the_author_meta('nickname'); +} + +/** + * Display the nickname of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_nickname + * @since 0.71 + * @deprecated 2.8 + * @deprecated Use the_author_meta('nickname') + */ +function the_author_nickname() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'nickname\')' ); + the_author_meta('nickname'); +} + +/** + * Retrieve the email of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's username. + * @deprecated Use the_author_meta('email') + */ +function get_the_author_email() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'email\')' ); + return get_the_author_meta('email'); +} + +/** + * Display the email of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_email + * @since 0.71 + * @deprecated 2.8 + * @deprecated Use the_author_meta('email') + */ +function the_author_email() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'email\')' ); + the_author_meta('email'); +} + +/** + * Retrieve the ICQ number of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's ICQ number. + * @deprecated Use the_author_meta('icq') + */ +function get_the_author_icq() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'icq\')' ); + return get_the_author_meta('icq'); +} + +/** + * Display the ICQ number of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_icq + * @since 0.71 + * @deprecated 2.8 + * @see get_the_author_icq() + * @deprecated Use the_author_meta('icq') + */ +function the_author_icq() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'icq\')' ); + the_author_meta('icq'); +} + +/** + * Retrieve the Yahoo! IM name of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's Yahoo! IM name. + * @deprecated Use the_author_meta('yim') + */ +function get_the_author_yim() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'yim\')' ); + return get_the_author_meta('yim'); +} + +/** + * Display the Yahoo! IM name of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_yim + * @since 0.71 + * @deprecated 2.8 + * @deprecated Use the_author_meta('yim') + */ +function the_author_yim() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'yim\')' ); + the_author_meta('yim'); +} + +/** + * Retrieve the MSN address of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's MSN address. + * @deprecated Use the_author_meta('msn') + */ +function get_the_author_msn() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'msn\')' ); + return get_the_author_meta('msn'); +} + +/** + * Display the MSN address of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_msn + * @since 0.71 + * @deprecated 2.8 + * @see get_the_author_msn() + * @deprecated Use the_author_meta('msn') + */ +function the_author_msn() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'msn\')' ); + the_author_meta('msn'); +} + +/** + * Retrieve the AIM address of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The author's AIM address. + * @deprecated Use the_author_meta('aim') + */ +function get_the_author_aim() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'aim\')' ); + return get_the_author_meta('aim'); +} + +/** + * Display the AIM address of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_aim + * @since 0.71 + * @deprecated 2.8 + * @see get_the_author_aim() + * @deprecated Use the_author_meta('aim') + */ +function the_author_aim() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'aim\')' ); + the_author_meta('aim'); +} + +/** + * Retrieve the specified author's preferred display name. + * + * @since 1.0.0 + * @deprecated 2.8 + * @param int $auth_id The ID of the author. + * @return string The author's display name. + * @deprecated Use the_author_meta('display_name') + */ +function get_author_name( $auth_id = false ) { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'display_name\')' ); + return get_the_author_meta('display_name', $auth_id); +} + +/** + * Retrieve the URL to the home page of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @uses $authordata The current author's DB object. + * @return string The URL to the author's page. + */ +function get_the_author_url() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'url\')' ); + return get_the_author_meta('url'); +} + +/** + * Display the URL to the home page of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_url + * @since 0.71 + * @deprecated 2.8 + */ +function the_author_url() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'url\')' ); + the_author_meta('url'); +} + +/** + * Retrieve the ID of the author of the current post. + * + * @since 1.5 + * @deprecated 2.8 + * @return int The author's ID. + */ +function get_the_author_ID() { + _deprecated_function(__FUNCTION__, '2.8', 'get_the_author_meta(\'ID\')' ); + return get_the_author_meta('ID'); +} + +/** + * Display the ID of the author of the current post. + * + * @link http://codex.wordpress.org/Template_Tags/the_author_ID + * @since 0.71 + * @deprecated 2.8 + * @uses get_the_author_ID() +*/ +function the_author_ID() { + _deprecated_function(__FUNCTION__, '2.8', 'the_author_meta(\'ID\')' ); + the_author_meta('ID'); +} + +/** + * 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. + * + * @package WordPress + * @subpackage Feed + * @since 0.71 + * @uses apply_filters() Calls 'the_content_rss' on the content before processing. + * @see get_the_content() For the $more_link_text, $stripteaser, and $more_file + * parameters. + * + * @deprecated 2.9.0 + * + * @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. + */ +function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) { + _deprecated_function(__FUNCTION__, '2.9', 'the_content_feed' ); + $content = get_the_content($more_link_text, $stripteaser, $more_file); + $content = apply_filters('the_content_rss', $content); + if ( $cut && !$encode_html ) + $encode_html = 2; + if ( 1== $encode_html ) { + $content = esc_html($content); + $cut = 0; + } elseif ( 0 == $encode_html ) { + $content = make_url_footnote($content); + } elseif ( 2 == $encode_html ) { + $content = strip_tags($content); + } + if ( $cut ) { + $blah = explode(' ', $content); + if ( count($blah) > $cut ) { + $k = $cut; + $use_dotdotdot = 1; + } else { + $k = count($blah); + $use_dotdotdot = 0; + } + + /** @todo Check performance, might be faster to use array slice instead. */ + for ( $i=0; $i<$k; $i++ ) + $excerpt .= $blah[$i].' '; + $excerpt .= ($use_dotdotdot) ? '...' : ''; + $content = $excerpt; + } + $content = str_replace(']]>', ']]>', $content); + echo $content; +} + +/** + * 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. + * + * @since 0.71 + * @deprecated 2.9.0 + * + * @param string $content Content to get links + * @return string HTML stripped out of content with links at the bottom. + */ +function make_url_footnote( $content ) { + _deprecated_function(__FUNCTION__, '2.9', '' ); + preg_match_all( '/(.+?)<\/a>/', $content, $matches ); + $links_summary = "\n"; + for ( $i=0; $i \ No newline at end of file