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

Description

Cette fonction est utilisée quand un argument déprécié d'une fonction est utilisé. Avant que _deprecated_argument() ne soit appelée l'argument doit être vérifié en le comparant à son ancienne valeur par défaut ou en évaluant s'il est vide.

Le hook 'deprecated_argument_run' sera appelé. Il peut garder une trace de quelle fonction (et dans quel fichier) a utilisé un argument déprécié.

Le comportement par défaut est de cibler une erreur utilisateur si la constante 'WP_DEBUG' est définie à true.

Paramètres

$function

(string) (Requis) La fonction qui a été appelé

$version

(string) (Requis) La version de WordPress qui a déprécié l'argument utilisé.

$message

(string) (Optionnel) Message concernant le changement d'argument.

Valeur par défaut : ''

Structure de la fonction _deprecated_argument()

Définie dans le fichier wp-includes/functions.php à la ligne 5032 :

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

    /**
     * Fires when a deprecated argument is called.
     *
     * @since 3.0.0
     *
     * @param string $function 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, $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 ) {
                trigger_error(
                    sprintf(
                        /* translators: 1: PHP function name, 2: Version number, 3: Optional message regarding the change. */
                        __( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s' ),
                        $function,
                        $version,
                        $message
                    ),
                    E_USER_DEPRECATED
                );
            } else {
                trigger_error(
                    sprintf(
                        /* translators: 1: PHP function name, 2: Version number. */
                        __( '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.' ),
                        $function,
                        $version
                    ),
                    E_USER_DEPRECATED
                );
            }
        } else {
            if ( $message ) {
                trigger_error(
                    sprintf(
                        '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s',
                        $function,
                        $version,
                        $message
                    ),
                    E_USER_DEPRECATED
                );
            } else {
                trigger_error(
                    sprintf(
                        '%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.',
                        $function,
                        $version
                    ),
                    E_USER_DEPRECATED
                );
            }
        }
    }
}

Fonctions et Hooks utilisés par _deprecated_argument()

__()

Retourne la traduction d'un texte.

deprecated_argument_run

Se lance quand un argument déprécié est appelé.

deprecated_argument_trigger_error

Se lance pour cibler une erreur pour les arguments dépréciés.

do_action()

Exécute des fonctions attachées à un hook spécifique.

apply_filters()

Appel les fonctions qui ont été attaché à un filtre (hook).

Où trouver la fonction _deprecated_argument() dans le CMS Wordpress

Rechercher

Sources

Codex Wordpress : _deprecated_argument()

Autres fonctions dans le même fichier : wp-includes/functions.php