Changeset 48185 for trunk/src/wp-includes/media.php

Timestamp:

06/26/2020 06:47:28 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Standardize on "Returning a value from the filter" vs. "Passing a value to the filter".

The filter is the callback function added with add_filter(), therefore the hook passes a value to the filter, and the filter returns a value to change its behaviour.

The documentation is referring to the latter.

Props johnbillion.
See #49572, #16557.

File:

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

trunk/src/wp-includes/media.php

@@ -542 +542 @@
      * Filters whether to preempt calculating the image resize dimensions.
      *
-     * Passing a non-null value to the filter will effectively short-circuit
+     * Returning a non-null value from the filter will effectively short-circuit
      * image_resize_dimensions(), returning that value instead.
      *
@@ -1626 +1626 @@
  *
  * @param string $content The HTML content to be filtered.
- * @param string $context Optional. Additional context to pass to the filters. Defaults to `current_filter()` when not set.
+ * @param string $context Optional. Additional context to pass to the filters.
+ *                        Defaults to `current_filter()` when not set.
  * @return string Converted content with images modified.
  */
@@ -2370 +2371 @@
      * Filters the playlist output.
      *
-     * Passing a non-empty value to the filter will short-circuit generation
+     * Returning a non-empty value from the filter will short-circuit generation
      * of the default playlist output, returning the passed value instead.
      *