Changeset 31212

Timestamp:

01/16/2015 07:02:26 PM (10 years ago)

Author:

wonderboymusic

Message:

@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.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-filesystem-base.php (modified) (2 diffs)
• wp-admin/includes/file.php (modified) (1 diff)
• wp-includes/deprecated.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)
• wp-includes/meta.php (modified) (1 diff)
• wp-includes/query.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-filesystem-base.php

@@ -169 +169 @@
      *
      * @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 ) {
@@ -237 +237 @@
      * @param string $base   The folder to start searching from.
      * @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 ) {

trunk/src/wp-admin/includes/file.php

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

trunk/src/wp-includes/deprecated.php

@@ -2162 +2162 @@
  * @param callback $output_callback Run when widget is called.
  * @param string $classname Classname widget option.
- * @param mixed $params,... Widget parameters.
+ * @param mixed $params ,... Widget parameters.
  */
 function register_sidebar_widget($name, $output_callback, $classname = '') {

trunk/src/wp-includes/functions.php

@@ -870 +870 @@
  * @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 = '' ) {

trunk/src/wp-includes/meta.php

@@ -450 +450 @@
  * @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.
- * @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) {

trunk/src/wp-includes/query.php

@@ -3943 +3943 @@
      * @access public
      *
-     * @param string $query URL query string.
+     * @param string|array $query URL query string or array of vars.
      */
     public function __construct($query = '') {