X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/48ab98cb1779cf2088c1351ac3dd3d0da6fb31d3..a7cd4c052013b423c6301153f68c7fdbaa2a447b:/wp-includes/deprecated.php diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index 0671dc12..64291cae 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -427,7 +427,7 @@ function get_linksbyname($cat_name = "noname", $before = '', $after = '
', * * @param string $category The category to use. * @param string $args - * @return bool|null + * @return string|null */ function wp_get_linksbyname($category, $args = '') { _deprecated_function(__FUNCTION__, '2.1', 'wp_list_bookmarks()'); @@ -451,12 +451,10 @@ function wp_get_linksbyname($category, $args = '') { /** * Gets an array of link objects associated with category $cat_name. * - * - * $links = get_linkobjectsbyname('fred'); - * foreach ($links as $link) { - * echo '
  • '.$link->link_name.'
    • '; - * } - *     + * $links = get_linkobjectsbyname( 'fred' ); + * foreach ( $links as $link ) { + * echo '
  • ' . $link->link_name . '
    • '; + * } * * @since 1.0.1 * @deprecated 2.1.0 @@ -468,7 +466,7 @@ function wp_get_linksbyname($category, $args = '') { * 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 + * @return array */ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) { _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' ); @@ -485,31 +483,29 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $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.'
    • '; - * } - * } - *     + * + * $links = get_linkobjects(1); + * if ($links) { + * foreach ($links as $link) { + * echo '
  • '.$link->link_name.'
    '.$link->link_description.'
    • '; + * } + * } * * Fields are: - *
      - *
    1. link_id
      2. - *
    2. link_url
      3. - *
    3. link_name
      4. - *
    4. link_image
      5. - *
    5. link_target
      6. - *
    6. link_category
      7. - *
    7. link_description
      8. - *
    8. link_visible
      9. - *
    9. link_owner
      10. - *
    10. link_rating
      11. - *
    11. link_updated
      12. - *
    12. link_rel
      13. - *
    13. link_notes
      14. - *
    + * + * - 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 * * @since 1.0.1 * @deprecated 2.1.0 @@ -522,7 +518,7 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit * 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 + * @return array */ function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) { _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' ); @@ -582,7 +578,7 @@ function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = * 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 $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, @@ -631,7 +627,7 @@ function get_autotoggle($id = 0) { * @param string $feed_image * @param string $exclude * @param bool $hierarchical - * @return unknown + * @return false|null */ 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, @@ -650,7 +646,7 @@ function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_orde * @see wp_list_categories() * * @param string|array $args - * @return unknown + * @return false|null|string */ function wp_list_cats($args = '') { _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' ); @@ -691,7 +687,7 @@ function wp_list_cats($args = '') { * @param bool $optionnone * @param int $selected * @param int $exclude - * @return unknown + * @return string */ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = 'asc', $show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = false, @@ -726,7 +722,7 @@ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = ' * @param bool $hide_empty * @param string $feed * @param string $feed_image - * @return unknown + * @return null|string */ function list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') { _deprecated_function( __FUNCTION__, '2.1', 'wp_list_authors()' ); @@ -743,7 +739,7 @@ function list_authors($optioncount = false, $exclude_admin = true, $show_fullnam * * @param int $blogid Not Used * @param int $post_ID - * @return unknown + * @return array */ function wp_get_post_cats($blogid = '1', $post_ID = 0) { _deprecated_function( __FUNCTION__, '2.1', 'wp_get_post_categories()' ); @@ -761,7 +757,7 @@ function wp_get_post_cats($blogid = '1', $post_ID = 0) { * @param int $blogid Not used * @param int $post_ID * @param array $post_categories - * @return unknown + * @return bool|mixed */ function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array()) { _deprecated_function( __FUNCTION__, '2.1', 'wp_set_post_categories()' ); @@ -780,7 +776,7 @@ function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array( * @param string $before * @param string $after * @param bool $show_post_count - * @return unknown + * @return string|null */ function get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) { _deprecated_function( __FUNCTION__, '2.1', 'wp_get_archives()' ); @@ -1098,7 +1094,7 @@ function links_popup_script($text = 'Links', $width=400, $height=400, $file='lin * @see sanitize_bookmark_field() * * @param object $link - * @return unknown + * @return mixed */ function get_linkrating($link) { _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' ); @@ -1160,7 +1156,7 @@ function comments_rss_link($link_text = 'Comments RSS') { * * @param bool $echo * @param int $cat_ID - * @return string|null + * @return string */ function get_category_rss_link($echo = false, $cat_ID = 1) { _deprecated_function( __FUNCTION__, '2.5', 'get_category_feed_link()' ); @@ -1182,7 +1178,7 @@ function get_category_rss_link($echo = false, $cat_ID = 1) { * * @param bool $echo * @param int $author_id - * @return string|null + * @return string */ function get_author_rss_link($echo = false, $author_id = 1) { _deprecated_function( __FUNCTION__, '2.5', 'get_author_feed_link()' ); @@ -1218,7 +1214,7 @@ function comments_rss() { * * @param string $username The user's username. * @param string $password The user's password. - * @param string $email The user's email (optional). + * @param string $email The user's email. * @return int The new user's ID. */ function create_user($username, $password, $email) { @@ -1661,7 +1657,7 @@ function the_author_url() { * @deprecated Use get_the_author_meta('ID') * @see get_the_author_meta() * - * @return int The author's ID. + * @return string|int The author's ID. */ function get_the_author_ID() { _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'ID\')' ); @@ -1699,14 +1695,13 @@ function the_author_ID() { * and the rest of the content will be removed. * * @since 0.71 - * @uses apply_filters() Calls 'the_content_rss' on the content before processing. * * @deprecated 2.9.0 * @deprecated Use the_content_feed() * @see the_content_feed() * * @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 int $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. @@ -1807,7 +1802,6 @@ function _c( $text, $domain = 'default' ) { * contains a context after its last vertical bar. * * @since 2.5.0 - * @uses translate() * @deprecated 3.0.0 * @deprecated Use _x() * @see _x() @@ -1966,7 +1960,7 @@ function get_attachment_icon_src( $id = 0, $fullsize = false ) { * @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. + * @return false|string HTML content. */ function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) { _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' ); @@ -2023,7 +2017,7 @@ function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) { * @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 + * @return false|string */ function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) { _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' ); @@ -2426,7 +2420,8 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) { * * @since 2.2.0 * @deprecated 3.1.0 - * @uses $wpdb WordPress database object for queries + * + * @global wpdb $wpdb WordPress database abstraction object. * @uses $blog_id The Blog id of the blog for those that use more than one blog * * @param int $id Blog ID. @@ -2506,7 +2501,7 @@ function funky_javascript_callback($matches) { } /** - * Fixes javascript bugs in browsers. + * Fixes JavaScript bugs in browsers. * * Converts unicode characters to HTML numbered entities. * @@ -2520,7 +2515,7 @@ function funky_javascript_callback($matches) { */ function funky_javascript_fix($text) { _deprecated_function( __FUNCTION__, '3.0' ); - // Fixes for browsers' javascript bugs + // Fixes for browsers' JavaScript bugs. global $is_macIE, $is_winIE; if ( $is_winIE || $is_macIE ) @@ -2990,7 +2985,7 @@ function get_current_theme() { /** * Accepts matches array from preg_replace_callback in wpautop() or a string. * - * Ensures that the contents of a <
    >...<
    > HTML block are not + * Ensures that the contents of a `
    ...
    ` HTML block are not * converted into paragraphs or line-breaks. * * @since 1.2.0 @@ -3046,7 +3041,7 @@ function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admi * @deprecated Use remove_theme_support('custom-header') * @see remove_theme_support() * - * @return bool Whether support was removed. + * @return null|bool Whether support was removed. */ function remove_custom_image_header() { _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-header\' )' ); @@ -3083,7 +3078,7 @@ function add_custom_background( $wp_head_callback = '', $admin_head_callback = ' * @since 3.1.0 * @see add_custom_background() * - * @return bool Whether support was removed. + * @return null|bool Whether support was removed. */ function remove_custom_background() { _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-background\' )' ); @@ -3152,8 +3147,6 @@ function update_page_cache( &$pages ) { * @since 2.0.0 * @deprecated 3.4.0 * - * @uses do_action() Will call the 'clean_page_cache' hook action. - * * @param int $id Page ID to clean */ function clean_page_cache( $id ) { @@ -3299,7 +3292,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de * * @param int $postid Post ID. * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A. - * @return object|array Post object or array holding post contents and information + * @return WP_Post|null Post object or array holding post contents and information */ function wp_get_single_post( $postid = 0, $mode = OBJECT ) { _deprecated_function( __FUNCTION__, '3.5', 'get_post()' );