_deprecated_file( string $file, string $version, string $replacement = '', string $message = '' )

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$filestring

The file that was included.

$versionstring

The version of WordPress that deprecated the file.

$replacementstringoptional

The file that should have been included based on ABSPATH.
Default empty string.Default: ''

$messagestringoptional

A message regarding the change. Default empty string.Default: ''

Performance profile

How much work a call to _deprecated_file() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–46

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 74.

Plugin surface

2 hooks

Third-party callbacks on 'deprecated_file_included', 'deprecated_file_trigger_error' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _deprecated_file() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while _deprecated_file() runs, in this order:

1. 1
   do_action( deprecated_file_included )actionline 5897 (+12 into the body)

   Fires when a deprecated file is called.

2. 2
   apply_filters( deprecated_file_trigger_error )filterline 5906 (+21 into the body)

   Filters whether to trigger an error for deprecated files.

Uses · 4

• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.

Used by · 1

• wp_get_active_and_valid_plugins()Retrieves an array of active and valid plugin files.

Source code

View on Trac ↗View on GitHub ↗

5885function _deprecated_file( $file, $version, $replacement = '', $message = '' ) {5886 5887	/**5888	 * Fires when a deprecated file is called.5889	 *5890	 * @since 2.5.05891	 *5892	 * @param string $file        The file that was called.5893	 * @param string $replacement The file that should have been included based on ABSPATH.5894	 * @param string $version     The version of WordPress that deprecated the file.5895	 * @param string $message     A message regarding the change.5896	 */5897	do_action( 'deprecated_file_included', $file, $replacement, $version, $message );5898 5899	/**5900	 * Filters whether to trigger an error for deprecated files.5901	 *5902	 * @since 2.5.05903	 *5904	 * @param bool $trigger Whether to trigger the error for deprecated files. Default true.5905	 */5906	if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {5907		$message = empty( $message ) ? '' : ' ' . $message;5908 5909		if ( function_exists( '__' ) ) {5910			if ( $replacement ) {5911				$message = sprintf(5912					/* translators: 1: PHP file name, 2: Version number, 3: Alternative file name. */5913					__( 'File %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),5914					$file,5915					$version,5916					$replacement5917				) . $message;5918			} else {5919				$message = sprintf(5920					/* translators: 1: PHP file name, 2: Version number. */5921					__( 'File %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),5922					$file,5923					$version5924				) . $message;5925			}5926		} else {5927			if ( $replacement ) {5928				$message = sprintf(5929					'File %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',5930					$file,5931					$version,5932					$replacement5933				);5934			} else {5935				$message = sprintf(5936					'File %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',5937					$file,5938					$version5939				) . $message;5940			}5941		}5942 5943		wp_trigger_error( '', $message, E_USER_DEPRECATED );5944	}5945}

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.