apply_filters_deprecated

函式
apply_filters_deprecated ( $hook_name, $args, $version, $replacement = '', $message = '' )
引數
  • (string) $hook_name The name of the filter hook.
    Required:
  • (array) $args Array of additional function arguments to be passed to apply_filters().
    Required:
  • (string) $version The version of WordPress that deprecated the hook.
    Required:
  • (string) $replacement Optional. The hook that should have been used. Default empty.
    Required:
    Default: (empty)
  • (string) $message Optional. A message regarding the change. Default empty.
    Required:
    Default: (empty)
相關
  • _deprecated_hook()
定義位置
相關方法
apply_filters_ref_arrayapply_filtersdo_action_deprecatedwp_filter_post_kseswp_apply_colors_support
引入
4.6.0
棄用
-

apply_filters_deprecated: 這個函式與apply_filters相似,但它是用來應用已棄用的過濾器。它需要三個引數:第一個是要應用的過濾器的名稱,第二個是要過濾的值,第三個是當使用過時的過濾器時顯示給開發者的資訊。

執行附屬於已棄用的過濾器鉤子的函式。

當一個過濾器鉤子被棄用時,apply_filters()呼叫被替換為apply_filters_deprecated(),這將觸發一個棄用通知,然後觸發原始過濾器鉤子。

注意:傳遞給原始apply_filters()呼叫的值和額外的引數必須作為一個陣列在這裡傳遞給`$args`。比如說:

// 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’ );

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
if ( ! has_filter( $hook_name ) ) {
return $args[0];
}
_deprecated_hook( $hook_name, $version, $replacement, $message );
return apply_filters_ref_array( $hook_name, $args );
}
function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) { if ( ! has_filter( $hook_name ) ) { return $args[0]; } _deprecated_hook( $hook_name, $version, $replacement, $message ); return apply_filters_ref_array( $hook_name, $args ); }
function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
	if ( ! has_filter( $hook_name ) ) {
		return $args[0];
	}

	_deprecated_hook( $hook_name, $version, $replacement, $message );

	return apply_filters_ref_array( $hook_name, $args );
}

常見問題

FAQs
檢視更多 >