_deprecated_argument() — описание функции WordPress на русском

Сигнатура

_deprecated_argument( string $function_name, string $version, string $message = '' )

Описание

Эту функцию следует использовать всякий раз, когда используется устаревший аргумент функции.
Перед вызовом этой функции нужно проверить, был ли аргумент использован, сравнив его со значением по умолчанию или оценив, пуст ли он.
Например:
if ( ! empty( $deprecated ) ) {
_deprecated_argument( __FUNCTION__, '3.0.0' );
}Существует хук 'deprecated_argument_run', который будет вызван и с помощью которого можно получить трассировку вплоть до того, какой файл и функция использовали устаревший аргумент.
Текущее поведение — сгенерировать пользовательскую ошибку, если WP_DEBUG равно true.

Оригинал (английский)

This function is to be used whenever a deprecated function argument is used.
Before this function is called, the argument must be checked for whether it was used by comparing it to its default value or evaluating whether it is empty.

For example:

if ( ! empty( $deprecated ) ) {
    _deprecated_argument( __FUNCTION__, '3.0.0' );
}

There is a ‘deprecated_argument_run’ hook that will be called that can be used to get the backtrace up to what file and function used the deprecated argument.

The current behavior is to trigger a user error if WP_DEBUG is true.

Параметры

$function_name string обязательный

Функция, которая была вызвана.

$version string обязательный

Версия WordPress, в которой использованный аргумент стал устаревшим.

$message string необязательный = ''

Сообщение об изменении.

Исходный код

wp-includes/functions.php:5883

function _deprecated_argument( $function_name, $version, $message = '' ) {

	/**
	 * Fires when a deprecated argument is called.
	 *
	 * @since 3.0.0
	 *
	 * @param string $function_name The function that was called.
	 * @param string $message       A message regarding the change.
	 * @param string $version       The version of WordPress that deprecated the argument used.
	 */
	do_action( 'deprecated_argument_run', $function_name, $message, $version );

	/**
	 * Filters whether to trigger an error for deprecated arguments.
	 *
	 * @since 3.0.0
	 *
	 * @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
	 */
	if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
		if ( function_exists( '__' ) ) {
			if ( $message ) {
				$message = sprintf(
					/* translators: 1: PHP function name, 2: Version number, 3: Optional message regarding the change. */
					__( 'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s' ),
					$function_name,
					$version,
					$message
				);
			} else {
				$message = sprintf(
					/* translators: 1: PHP function name, 2: Version number. */
					__( 'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
					$function_name,
					$version
				);
			}
		} else {
			if ( $message ) {
				$message = sprintf(
					'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s',
					$function_name,
					$version,
					$message
				);
			} else {
				$message = sprintf(
					'Function %1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.',
					$function_name,
					$version
				);
			}
		}

		wp_trigger_error( '', $message, E_USER_DEPRECATED );
	}
}

История изменений

Версия	Описание
5.4.0	The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE).
3.0.0	Introduced.