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

See #41017.


git-svn-id: https://develop.svn.wordpress.org/trunk@41308 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2017-08-23 15:51:21 +00:00
parent a6f8f9668b
commit 0549e9198a

View File

@ -575,6 +575,15 @@ function remove_all_actions($tag, $priority = false) {
* 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
*
* @see _deprecated_hook()