<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56467] trunk: Introduce a `_deprecated_class()` function.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56467">56467</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56467","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-08-25 03:24:00 +0000 (Fri, 25 Aug 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Introduce a `_deprecated_class()` function.
Similar to other function in the `_deprecated_*` series, `_deprecated_class()` comes with two new hooks: `deprecated_class_run` and `deprecated_class_trigger_error`.
Support has also been added for setting class deprecation expectations in tests.
Props jrf, wvega, ohryan.
See <a href="https://core.trac.wordpress.org/ticket/41125">#41125</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunitincludesabstracttestcasephp">trunk/tests/phpunit/includes/abstract-testcase.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2023-08-25 01:26:01 UTC (rev 56466)
+++ trunk/src/wp-includes/functions.php 2023-08-25 03:24:00 UTC (rev 56467)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5596,6 +5596,64 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Marks a class as deprecated and informs when it has been used.
+ *
+ * There is a {@see 'deprecated_class_run'} hook that will be called that can be used
+ * to get the backtrace up to what file and function called the
+ * deprecated class.
+ *
+ * The current behavior is to trigger a user error if `WP_DEBUG` is true.
+ *
+ * This function is to be used in the class constructor for every deprecated class.
+ * See {@see _deprecated_constructor()} for deprecating PHP4 style constructors.
+ *
+ * @since 6.4.0
+ *
+ * @param string $class The class being instantiated
+ * @param string $version The version of WordPress that deprecated the class.
+ * @param string $replacement Optional. The class or function that should have been called.
+ * Default empty string.
+ */
+function _deprecated_class( $class, $version, $replacement = '' ) {
+
+ /**
+ * Fires when a deprecated class is called.
+ *
+ * @since 6.4.0
+ *
+ * @param string $class The class being instantiated
+ * @param string $replacement The class or function that should have been called.
+ * @param string $version The version of WordPress that deprecated the class.
+ */
+ do_action( 'deprecated_class_run', $class, $replacement, $version );
+
+ /**
+ * Filters whether to trigger an error for a deprecated class.
+ *
+ * @since 6.4.0
+ *
+ * @param bool $trigger Whether to trigger an error for a deprecated class. Default true.
+ */
+ if ( WP_DEBUG && apply_filters( 'deprecated_class_trigger_error', true ) ) {
+ if ( function_exists( '__' ) ) {
+ if ( ! is_null( $replacement ) ) {
+ /* translators: 1: PHP class name, 2: version number, 3: alternative clas or function name */
+ trigger_error( sprintf( __('Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $class, $version, $replacement ), E_USER_DEPRECATED );
+ } else {
+ /* translators: 1: PHP class name, 2: version number */
+ trigger_error( sprintf( __('Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $class, $version ), E_USER_DEPRECATED );
+ }
+ } else {
+ if ( ! is_null( $replacement ) ) {
+ trigger_error( sprintf( 'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $class, $version, $replacement ), E_USER_DEPRECATED );
+ } else {
+ trigger_error( sprintf( 'Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $class, $version ), E_USER_DEPRECATED );
+ }
+ }
+ }
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Marks a file as deprecated and inform when it has been used.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * There is a hook {@see 'deprecated_file_included'} that will be called that can be used
</span></span></pre></div>
<a id="trunktestsphpunitincludesabstracttestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/abstract-testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/abstract-testcase.php 2023-08-25 01:26:01 UTC (rev 56466)
+++ trunk/tests/phpunit/includes/abstract-testcase.php 2023-08-25 03:24:00 UTC (rev 56467)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -568,6 +568,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ), 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ), 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'deprecated_class_run', array( $this, 'deprecated_function_run' ), 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_file_included', array( $this, 'deprecated_function_run' ), 10, 4 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_hook_run', array( $this, 'deprecated_function_run' ), 10, 4 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ), 10, 3 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -574,6 +575,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_function_trigger_error', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_argument_trigger_error', '__return_false' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'deprecated_class_trigger_error', '__return_false' );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_file_trigger_error', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_hook_trigger_error', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'doing_it_wrong_trigger_error', '__return_false' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -746,6 +748,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'deprecated_class_run':
+ if ( $replacement ) {
+ $message = sprintf(
+ 'Class %1$s is deprecated since version %2$s! Use %3$s instead.',
+ $function_name,
+ $version,
+ $replacement
+ );
+ } else {
+ $message = sprintf(
+ 'Class %1$s is deprecated since version %2$s with no alternative available.',
+ $function_name,
+ $version
+ );
+ }
+ break;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'deprecated_file_included':
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $replacement ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $message = sprintf(
</span></span></pre>
</div>
</div>
</body>
</html>