`@param` cleanup:

* `get_metadata()` will return literally anything, needs to be `mixed`
* `wp()` and `WP_Query::__construct()` no longer just take a query string
* Clarify a few others

See #30799.

Built from https://develop.svn.wordpress.org/trunk@31212


git-svn-id: http://core.svn.wordpress.org/trunk@31193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-01-16 19:03:23 +00:00
parent cde4c83091
commit bc55996a0b
7 changed files with 11 additions and 12 deletions

View File

@ -168,7 +168,7 @@ class WP_Filesystem_Base {
* @since 2.7.0 * @since 2.7.0
* *
* @param string $folder the folder to locate. * @param string $folder the folder to locate.
* @return string The location of the remote path. * @return string|false The location of the remote path, false on failure.
*/ */
public function find_folder( $folder ) { public function find_folder( $folder ) {
@ -236,7 +236,7 @@ class WP_Filesystem_Base {
* @param string $folder The folder to locate. * @param string $folder The folder to locate.
* @param string $base The folder to start searching from. * @param string $base The folder to start searching from.
* @param bool $loop If the function has recursed, Internal use only. * @param bool $loop If the function has recursed, Internal use only.
* @return string The location of the remote path. * @return string|false The location of the remote path, false to cease looping.
*/ */
public function search_for_folder( $folder, $base = '.', $loop = false ) { public function search_for_folder( $folder, $base = '.', $loop = false ) {
if ( empty( $base ) || '.' == $base ) if ( empty( $base ) || '.' == $base )

View File

@ -191,9 +191,8 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
* *
* @see wp_handle_upload_error * @see wp_handle_upload_error
* *
* @param array $file Reference to a single element of $_FILES. Call the function once for * @param array $file Reference to a single element of $_FILES. Call the function once for each uploaded file.
* each uploaded file. * @param array|false $overrides An associative array of names => values to override default variables. Default false.
* @param array $overrides An associative array of names => values to override default variables.
* @param string $time Time formatted in 'yyyy/mm'. * @param string $time Time formatted in 'yyyy/mm'.
* @param string $action Expected value for $_POST['action']. * @param string $action Expected value for $_POST['action'].
* @return array On success, returns an associative array of file attributes. On failure, returns * @return array On success, returns an associative array of file attributes. On failure, returns

View File

@ -2161,7 +2161,7 @@ function attribute_escape( $text ) {
* @param string|int $name Widget ID. * @param string|int $name Widget ID.
* @param callback $output_callback Run when widget is called. * @param callback $output_callback Run when widget is called.
* @param string $classname Classname widget option. * @param string $classname Classname widget option.
* @param mixed $params,... Widget parameters. * @param mixed $params ,... Widget parameters.
*/ */
function register_sidebar_widget($name, $output_callback, $classname = '') { function register_sidebar_widget($name, $output_callback, $classname = '') {
_deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' ); _deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' );

View File

@ -869,7 +869,7 @@ function wp_remote_fopen( $uri ) {
* *
* @since 2.0.0 * @since 2.0.0
* *
* @param string $query_vars Default WP_Query arguments. * @param string|array $query_vars Default WP_Query arguments.
*/ */
function wp( $query_vars = '' ) { function wp( $query_vars = '' ) {
global $wp, $wp_query, $wp_the_query; global $wp, $wp_query, $wp_the_query;

View File

@ -449,7 +449,7 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
* the specified object. * the specified object.
* @param bool $single Optional, default is false. If true, return only the first value of the * @param bool $single Optional, default is false. If true, return only the first value of the
* specified meta_key. This parameter has no effect if meta_key is not specified. * specified meta_key. This parameter has no effect if meta_key is not specified.
* @return string|array Single metadata value, or array of values * @return mixed Single metadata value, or array of values
*/ */
function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) { function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
if ( ! $meta_type || ! is_numeric( $object_id ) ) { if ( ! $meta_type || ! is_numeric( $object_id ) ) {

View File

@ -3942,7 +3942,7 @@ class WP_Query {
* @since 1.5.0 * @since 1.5.0
* @access public * @access public
* *
* @param string $query URL query string. * @param string|array $query URL query string or array of vars.
*/ */
public function __construct($query = '') { public function __construct($query = '') {
if ( ! empty($query) ) { if ( ! empty($query) ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.2-alpha-31211'; $wp_version = '4.2-alpha-31212';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.