apply_filters_deprecated()

apply_filters_deprecated() — Fires functions attached to a deprecated filter hook. When a filter hook is deprecated, the apply_filters() call is replaced with 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.0’, ‘wpdocs_new_filter’ );

Inputs: $hook_name (string): The name of the filter hook. $args (non-empty-list<mixed>): Array of additional function arguments to be passed to apply_filters(). $version (string): The version of WordPress that deprecated the hook. $replacement (string): Optional. The hook that should have been used. Default empty. $message (string): Optional. A message regarding the change. Default empty.

Returns mixed: The filtered value after all hooked functions are applied to it.