Changeset 47060 for trunk/src/wp-includes/class-wp-oembed.php

Timestamp:

01/11/2020 06:30:58 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

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

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

@@ -249 +249 @@
          * @param string        $url  The URL to the content.
          * @param string|array  $args Optional provider arguments.
-         * @return false|string False on failure, otherwise the oEmbed provider URL.
+         * @return string|false The oEmbed provider URL on success, false on failure.
          */
         public function get_provider( $url, $args = '' ) {
@@ -340 +340 @@
          * @param string       $url  The URL to the content that should be attempted to be embedded.
          * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
-         * @return false|object False on failure, otherwise the result in the form of an object.
+         * @return object|false The result in the form of an object on success, false on failure.
          */
         public function get_data( $url, $args = '' ) {
@@ -370 +370 @@
          * @param string       $url  The URL to the content that should be attempted to be embedded.
          * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
-         * @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
+         * @return string|false The UNSANITIZED (and potentially unsafe) HTML that should be used to embed on success,
+         *                      false on failure.
          */
         public function get_html( $url, $args = '' ) {
@@ -418 +419 @@
          *
          * @param string $url The URL that should be inspected for discovery `<link>` tags.
-         * @return false|string False on failure, otherwise the oEmbed provider URL.
+         * @return string|false The oEmbed provider URL on success, false on failure.
          */
         public function discover( $url ) {
@@ -510 +511 @@
          * @param string       $url      The URL to the content that is desired to be embedded.
          * @param array|string $args     Optional. Arguments, usually passed from a shortcode. Default empty.
-         * @return false|object False on failure, otherwise the result in the form of an object.
+         * @return object|false The result in the form of an object on success, false on failure.
          */
         public function fetch( $provider, $url, $args = '' ) {
@@ -548 +549 @@
          *
          * @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.)
-         * @param string $format Format to use
-         * @return false|object|WP_Error False on failure, otherwise the result in the form of an object.
+         * @param string $format                 Format to use.
+         * @return object|false|WP_Error The result in the form of an object on success, false on failure.
          */
         private function _fetch_with_format( $provider_url_with_args, $format ) {
@@ -654 +655 @@
          *
          * @param object $data A data object result from an oEmbed provider.
-         * @param string $url The URL to the content that is desired to be embedded.
-         * @return false|string False on error, otherwise the HTML needed to embed.
+         * @param string $url  The URL to the content that is desired to be embedded.
+         * @return string|false The HTML needed to embed on success, false on failure.
          */
         public function data2html( $data, $url ) {