From 7d7a8aa0ebda5f0f2b447826316c76995c2a67ad Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Mon, 3 Nov 2014 06:17:22 +0000 Subject: [PATCH] Correct all `@return unknown` instances. See #30224. Built from https://develop.svn.wordpress.org/trunk@30202 git-svn-id: http://core.svn.wordpress.org/trunk@30202 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/deprecated.php | 8 ++++---- wp-admin/includes/media.php | 4 ++-- wp-admin/includes/post.php | 8 ++++---- wp-admin/includes/upgrade.php | 2 +- wp-admin/includes/user.php | 2 +- wp-includes/comment.php | 2 +- wp-includes/deprecated.php | 20 ++++++++++---------- wp-includes/version.php | 2 +- 8 files changed, 24 insertions(+), 24 deletions(-) diff --git a/wp-admin/includes/deprecated.php b/wp-admin/includes/deprecated.php index fde377b6b0..21e5203352 100644 --- a/wp-admin/includes/deprecated.php +++ b/wp-admin/includes/deprecated.php @@ -274,7 +274,7 @@ function get_editable_authors( $user_id ) { * * @param int $user_id User ID. * @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros. - * @return unknown + * @return mixed */ function get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' ) { _deprecated_function( __FUNCTION__, '3.1', 'get_users()' ); @@ -607,7 +607,7 @@ class WP_User_Search { * @since 2.1.0 * @access public * - * @return unknown + * @return array */ function get_results() { return (array) $this->results; @@ -940,7 +940,7 @@ function get_allowed_themes() { * @since 1.5.0 * @deprecated 3.4.0 * - * @return unknown + * @return array */ function get_broken_themes() { _deprecated_function( __FUNCTION__, '3.4', "wp_get_themes( array( 'errors' => true )" ); @@ -964,7 +964,7 @@ function get_broken_themes() { * @since 2.0.0 * @deprecated 3.4.0 * - * @return unknown + * @return WP_Theme */ function current_theme_info() { _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' ); diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index 143a928621..14dd237e92 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -864,7 +864,7 @@ function media_sideload_image( $file, $post_id, $desc = null ) { * * @since 2.5.0 * - * @return unknown + * @return string|null */ function media_upload_gallery() { $errors = array(); @@ -887,7 +887,7 @@ function media_upload_gallery() { * * @since 2.5.0 * - * @return unknown + * @return string|null */ function media_upload_library() { $errors = array(); diff --git a/wp-admin/includes/post.php b/wp-admin/includes/post.php index 5d85a25139..142752dbc8 100644 --- a/wp-admin/includes/post.php +++ b/wp-admin/includes/post.php @@ -636,7 +636,7 @@ function post_exists($title, $content = '', $date = '') { * * @since 2.1.0 * - * @return unknown + * @return int|WP_Error */ function wp_write_post() { if ( isset($_POST['post_type']) ) @@ -705,7 +705,7 @@ function wp_write_post() { * * @since 2.0.0 * - * @return unknown + * @return int|null */ function write_post() { $result = wp_write_post(); @@ -775,7 +775,7 @@ function delete_meta( $mid ) { * * @since 1.2.0 * - * @return unknown + * @return mixed */ function get_meta_keys() { global $wpdb; @@ -1073,7 +1073,7 @@ function wp_edit_attachments_query( $q = false ) { * * @param string $id * @param string $page - * @return unknown + * @return string */ function postbox_classes( $id, $page ) { if ( isset( $_GET['edit'] ) && $_GET['edit'] == $id ) { diff --git a/wp-admin/includes/upgrade.php b/wp-admin/includes/upgrade.php index c298c8c9e0..195eeae1fd 100644 --- a/wp-admin/includes/upgrade.php +++ b/wp-admin/includes/upgrade.php @@ -2039,7 +2039,7 @@ function make_site_theme_from_default($theme_name, $template) { * * @since 1.5.0 * - * @return unknown + * @return string|bool */ function make_site_theme() { // Name the theme after the blog. diff --git a/wp-admin/includes/user.php b/wp-admin/includes/user.php index a17887512d..bcf13623a9 100644 --- a/wp-admin/includes/user.php +++ b/wp-admin/includes/user.php @@ -195,7 +195,7 @@ function edit_user( $user_id = 0 ) { * * @since 2.8.0 * - * @return unknown + * @return array */ function get_editable_roles() { global $wp_roles; diff --git a/wp-includes/comment.php b/wp-includes/comment.php index 321529af40..65651f7a9e 100644 --- a/wp-includes/comment.php +++ b/wp-includes/comment.php @@ -2204,7 +2204,7 @@ function wp_update_comment($commentarr) { * @staticvar bool $_defer * * @param bool $defer - * @return unknown + * @return bool */ function wp_defer_comment_counting($defer=null) { static $_defer = false; diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index 9a54e643b7..da73b40845 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -468,7 +468,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()' ); @@ -522,7 +522,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()' ); @@ -631,7 +631,7 @@ function get_autotoggle($id = 0) { * @param string $feed_image * @param string $exclude * @param bool $hierarchical - * @return unknown + * @return string */ 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 +650,7 @@ function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_orde * @see wp_list_categories() * * @param string|array $args - * @return unknown + * @return string */ function wp_list_cats($args = '') { _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' ); @@ -691,7 +691,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 +726,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 +743,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 +761,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 +780,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 +1098,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()' ); diff --git a/wp-includes/version.php b/wp-includes/version.php index a590606958..b5c691dcca 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.1-alpha-30201'; +$wp_version = '4.1-alpha-30202'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.