_deprecated_constructor( string $class_name, string $version, string $parent_class = '' )

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

$class_namestring

The class containing the deprecated constructor.

$versionstring

The version of WordPress that deprecated the function.

$parent_classstringoptional

The parent class calling the deprecated constructor.
Default empty string.Default: ''

Performance profile

How much work a call to _deprecated_constructor() 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

12–39

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

Plugin surface

2 hooks

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

Called by

11

11 places 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_constructor() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

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

1. 1
   do_action( deprecated_constructor_run )actionline 5615 (+12 into the body)

   Fires when a deprecated constructor is called.

2. 2
   apply_filters( deprecated_constructor_trigger_error )filterline 5626 (+23 into the body)

   Filters whether to trigger an error for deprecated functions.

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 · 11

• POMO_CachedFileReader::POMO_CachedFileReader()PHP4 constructor.
• POMO_CachedIntFileReader::POMO_CachedIntFileReader()PHP4 constructor.
• POMO_FileReader::POMO_FileReader()PHP4 constructor.
• POMO_Reader::POMO_Reader()PHP4 constructor.
• POMO_StringReader::POMO_StringReader()PHP4 constructor.
• Services_JSON::Services_JSON()PHP4 constructor.
• Services_JSON_Error::Services_JSON_Error()PHP4 constructor.
• Translation_Entry::Translation_Entry()PHP4 constructor.
• WP_User_Search::WP_User_Search()PHP4 Constructor - Sets up the object properties.
• WP_Widget::WP_Widget()PHP4 constructor.
• WP_Widget_Factory::WP_Widget_Factory()PHP4 constructor.

Source code

View on Trac ↗View on GitHub ↗

5603function _deprecated_constructor( $class_name, $version, $parent_class = '' ) {5604 5605	/**5606	 * Fires when a deprecated constructor is called.5607	 *5608	 * @since 4.3.05609	 * @since 4.5.0 Added the `$parent_class` parameter.5610	 *5611	 * @param string $class_name   The class containing the deprecated constructor.5612	 * @param string $version      The version of WordPress that deprecated the function.5613	 * @param string $parent_class The parent class calling the deprecated constructor.5614	 */5615	do_action( 'deprecated_constructor_run', $class_name, $version, $parent_class );5616 5617	/**5618	 * Filters whether to trigger an error for deprecated functions.5619	 *5620	 * `WP_DEBUG` must be true in addition to the filter evaluating to true.5621	 *5622	 * @since 4.3.05623	 *5624	 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.5625	 */5626	if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) {5627		if ( function_exists( '__' ) ) {5628			if ( $parent_class ) {5629				$message = sprintf(5630					/* translators: 1: PHP class name, 2: PHP parent class name, 3: Version number, 4: __construct() method. */5631					__( 'The called constructor method for %1$s class in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.' ),5632					$class_name,5633					$parent_class,5634					$version,5635					'<code>__construct()</code>'5636				);5637			} else {5638				$message = sprintf(5639					/* translators: 1: PHP class name, 2: Version number, 3: __construct() method. */5640					__( 'The called constructor method for %1$s class is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),5641					$class_name,5642					$version,5643					'<code>__construct()</code>'5644				);5645			}5646		} else {5647			if ( $parent_class ) {5648				$message = sprintf(5649					'The called constructor method for %1$s class in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.',5650					$class_name,5651					$parent_class,5652					$version,5653					'<code>__construct()</code>'5654				);5655			} else {5656				$message = sprintf(5657					'The called constructor method for %1$s class is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',5658					$class_name,5659					$version,5660					'<code>__construct()</code>'5661				);5662			}5663		}5664 5665		wp_trigger_error( '', $message, E_USER_DEPRECATED );5666	}5667}

Changelog

Introduced in 4.3.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 6.7.7 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.