wpseek.com
A WordPress-centric search engine for devs and theme authors



_deprecated_function › WordPress Function

Since2.5.0
Deprecatedn/a
› _deprecated_function ( $function_name, $version, $replacement = '' )
Parameters: (3)
  • (string) $function_name The function that was called.
    Required: Yes
  • (string) $version The version of WordPress that deprecated the function.
    Required: Yes
  • (string) $replacement Optional. The function that should have been called. Default empty string.
    Required: No
    Default: (empty)
Defined at:
Codex:
Change Log:
  • 5.4.0
  • 5.4.0

Marks a function as deprecated and inform when it has been used.

There is a hook {@see 'deprecated_function_run'} that will be called that can be used to get the backtrace up to what file and function called the deprecated function. The current behavior is to trigger a user error if WP_DEBUG is true. This function is to be used in every function that is deprecated.


Related Functions: _deprecated_file, rest_handle_deprecated_function, _deprecated_argument, _deprecated_hook, _deprecated_constructor

Source 

function _deprecated_function( $function_name, $version, $replacement = '' ) {

	/**
	 * Fires when a deprecated function is called.
	 *
	 * @since 2.5.0
	 *
	 * @param string $function_name The function that was called.
	 * @param string $replacement   The function that should have been called.
	 * @param string $version       The version of WordPress that deprecated the function.
	 */
	do_action( 'deprecated_function_run', $function_name, $replacement, $version );

	/**
	 * Filters whether to trigger an error for deprecated functions.
	 *
	 * @since 2.5.0
	 *
	 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
	 */
	if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
		if ( function_exists( '__' ) ) {
			if ( $replacement ) {
				trigger_error(
					sprintf(
						/* translators: 1: PHP function name, 2: Version number, 3: Alternative function name. */
						__( 'Function %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
						$function_name,
						$version,
						$replacement
					),
					E_USER_DEPRECATED
				);
			} else {
				trigger_error(
					sprintf(
						/* translators: 1: PHP function name, 2: Version number. */
						__( 'Function %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
						$function_name,
						$version
					),
					E_USER_DEPRECATED
				);
			}
		} else {
			if ( $replacement ) {
				trigger_error(
					sprintf(
						'Function %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
						$function_name,
						$version,
						$replacement
					),
					E_USER_DEPRECATED
				);
			} else {
				trigger_error(
					sprintf(
						'Function %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',
						$function_name,
						$version
					),
					E_USER_DEPRECATED
				);
			}
		}
	}
}