Changeset 32533

Timestamp:

05/21/2015 09:30:31 PM (11 years ago)

Author:

wonderboymusic

Message:

In class-oembed.php, clarify/add some return docs.

See #32444.

File:

• trunk/src/wp-includes/class-oembed.php (modified) (7 diffs)

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

@@ -196 +196 @@
          * @param string        $url  The URL to the content.
          * @param string|array  $args Optional provider arguments.
-         * @return bool|string False on failure, otherwise the oEmbed provider URL.
+         * @return false|string False on failure, otherwise the oEmbed provider URL.
          */
         public function get_provider( $url, $args = '' ) {
@@ -307 +307 @@
          *
          * @param string $url The URL that should be inspected for discovery `<link>` tags.
-         * @return bool|string False on failure, otherwise the oEmbed provider URL.
+         * @return false|string False on failure, otherwise the oEmbed provider URL.
          */
         public function discover( $url ) {
@@ -385 +385 @@
          * @param string $url The URL to the content that is desired to be embedded.
          * @param array $args Optional arguments. Usually passed from a shortcode.
-         * @return bool|object False on failure, otherwise the result in the form of an object.
+         * @return false|object False on failure, otherwise the result in the form of an object.
          */
         public function fetch( $provider, $url, $args = '' ) {
@@ -421 +421 @@
          * @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.)
          * @param string $format Format to use
-         * @return bool|object False on failure, otherwise the result in the form of an object.
+         * @return false|object|WP_Error False on failure, otherwise the result in the form of an object.
          */
         private function _fetch_with_format( $provider_url_with_args, $format ) {
@@ -443 +443 @@
          * @since 3.0.0
          * @access private
+         *
+         * @param string $response_body
+         * @return object|false
          */
         private function _parse_json( $response_body ) {
-                return ( ( $data = json_decode( trim( $response_body ) ) ) && is_object( $data ) ) ? $data : false;
+                $data = json_decode( trim( $response_body ) );
+                return ( $data && is_object( $data ) ) ? $data : false;
         }
 
@@ -453 +457 @@
          * @since 3.0.0
          * @access private
+         *
+         * @param string $response_body
+         * @return object|false
          */
         private function _parse_xml( $response_body ) {
@@ -474 +481 @@
          * @since 3.6.0
          * @access private
+         *
+         * @param string $response_body
+         * @return object|false
          */
         private function _parse_xml_body( $response_body ) {