Changeset 30979

Timestamp:

12/20/2014 08:55:21 PM (12 years ago)

Author:

wonderboymusic

Message:

Improve some docs for @param. Remove an unneeded $wpdb global import.

See #30799.

Location:

trunk/src

Files:

• wp-admin/includes/screen.php (modified) (1 diff)
• wp-includes/capabilities.php (modified) (1 diff)
• wp-includes/class-wp-embed.php (modified) (1 diff)
• wp-includes/class-wp-image-editor-imagick.php (modified) (1 diff)
• wp-includes/class-wp-image-editor.php (modified) (2 diffs)
• wp-includes/meta.php (modified) (1 diff)

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

@@ -369 +369 @@
          * @access public
          *
-         * @param string $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen.
+         * @param string|WP_Screen $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen.
          *      Defaults to the current $hook_suffix global.
          * @return WP_Screen Screen object.

trunk/src/wp-includes/capabilities.php

@@ -551 +551 @@
          * @param string $field The field to query against: 'id', 'slug', 'email' or 'login'
          * @param string|int $value The field value
-         * @return object Raw user object
+         * @return object|false Raw user object
          */
         public static function get_data_by( $field, $value ) {

trunk/src/wp-includes/class-wp-embed.php

@@ -127 +127 @@
          * }
          * @param string $url The URL attempting to be embedded.
-         * @return string The embed HTML on success, otherwise the original URL.
+         * @return string|false The embed HTML on success, otherwise the original URL.
+         *                      `->maybe_make_link()` can return false on failure.
          */
         public function shortcode( $attr, $url = '' ) {

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -191 +191 @@
          * @param int $width
          * @param int $height
+         *
+         * @return true|WP_Error
          */
         protected function update_size( $width = null, $height = null ) {

trunk/src/wp-includes/class-wp-image-editor.php

@@ -195 +195 @@
          * @param int $width
          * @param int $height
+         * @return true
          */
         protected function update_size( $width = null, $height = null ) {
@@ -389 +390 @@
          * @access public
          *
-         * @return string suffix
+         * @return false|string suffix
          */
         public function get_suffix() {

trunk/src/wp-includes/meta.php

@@ -1147 +1147 @@
          */
         public function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
-                global $wpdb;
-
                 if ( ! $meta_table = _get_meta_table( $type ) ) {
                         return false;