Changeset 48855

Timestamp:

08/24/2020 10:14:17 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for wp_lazy_loading_enabled() per the documentation standards.

See #50768.

File:

• trunk/src/wp-includes/media.php (modified) (3 diffs)

trunk/src/wp-includes/media.php

@@ -1685 +1685 @@
 
 /**
- * Determine whether to add the `loading` attribute to the specified tag in the specified context.
+ * Determines whether to add the `loading` attribute to the specified tag in the specified context.
  *
  * @since 5.5.0
  *
  * @param string $tag_name The tag name.
- * @param string $context  Additional context, like the current filter name or the function name from where this was called.
+ * @param string $context  Additional context, like the current filter name
+ *                         or the function name from where this was called.
  * @return bool Whether to add the attribute.
  */
@@ -1705 +1706 @@
      * @param bool   $default  Default value.
      * @param string $tag_name The tag name.
-     * @param string $context  Additional context, like the current filter name or the function name from where this was called.
+     * @param string $context  Additional context, like the current filter name
+     *                         or the function name from where this was called.
      */
     return (bool) apply_filters( 'wp_lazy_loading_enabled', $default, $tag_name, $context );
@@ -1818 +1820 @@
      *
      * @param string|bool $value   The `loading` attribute value. Returning a falsey value will result in
-     *                             the attribute being omitted for the image. Default is `lazy`.
+     *                             the attribute being omitted for the image. Default 'lazy'.
      * @param string      $image   The HTML `img` tag to be filtered.
      * @param string      $context Additional context about how the function was called or where the img tag is.