Changeset 41308

Timestamp:

08/23/2017 03:51:21 PM (6 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify the expected usage of the $args parameter as an array in the DocBlock for apply_filters_deprecated(), including an example.

See #41017.

File:

• trunk/src/wp-includes/plugin.php (modified) (1 diff)

trunk/src/wp-includes/plugin.php

@@ -575 +575 @@
  * apply_filters_deprecated(), which triggers a deprecation notice and then fires
  * the original filter hook.
+ *
+ * Note: the value and extra arguments passed to the original apply_filters() call
+ * must be passed here to `$args` as an array. For example:
+ *
+ *     // Old filter.
+ *     return apply_filters( 'wpdocs_filter', $value, $extra_arg );
+ *
+ *     // Deprecated.
+ *     return apply_filters_deprecated( 'wpdocs_filter', array( $value, $extra_arg ), '4.9', 'wpdocs_new_filter' );
  *
  * @since 4.6.0