Changeset 36541

Timestamp:

02/16/2016 11:19:38 PM (9 years ago)

Author:

ocean90

Message:

Introduce a $parent_class parameter for _deprecated_constructor().

Use the parameter for the deprecated constructor warning in WP_Widget to provide an indication to which widget is using the PHP4 style constructor.

Props sebastian.pisula.
Fixes #33440.

Location:

trunk/src/wp-includes

Files:

• class-wp-widget.php (modified) (1 diff)
• functions.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-widget.php

@@ -169 +169 @@
      */
     public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
-        _deprecated_constructor( 'WP_Widget', '4.3.0' );
+        _deprecated_constructor( 'WP_Widget', '4.3.0', get_class( $this ) );
         WP_Widget::__construct( $id_base, $name, $widget_options, $control_options );
     }

trunk/src/wp-includes/functions.php

@@ -3629 +3629 @@
  *
  * @since 4.3.0
+ * @since 4.5.0 Added the `$parent_class` parameter.
+ *
  * @access private
  *
- * @param string $class   The class containing the deprecated constructor.
- * @param string $version The version of WordPress that deprecated the function.
- */
-function _deprecated_constructor( $class, $version ) {
+ * @param string $class        The class containing the deprecated constructor.
+ * @param string $version      The version of WordPress that deprecated the function.
+ * @param string $parent_class Optional. The parent class calling the deprecated constructor.
+ *                             Default empty string.
+ */
+function _deprecated_constructor( $class, $version, $parent_class = '' ) {
 
     /**
@@ -3640 +3644 @@
      *
      * @since 4.3.0
-     *
-     * @param string $class   The class containing the deprecated constructor.
-     * @param string $version The version of WordPress that deprecated the function.
+     * @since 4.5.0 Added the `$parent_class` parameter.
+     *
+     * @param string $class        The class containing the deprecated constructor.
+     * @param string $version      The version of WordPress that deprecated the function.
+     * @param string $parent_class The parent class calling the deprecated constructor.
      */
-    do_action( 'deprecated_constructor_run', $class, $version );
+    do_action( 'deprecated_constructor_run', $class, $version, $parent_class );
 
     /**
@@ -3657 +3663 @@
     if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) {
         if ( function_exists( '__' ) ) {
-            trigger_error( sprintf( __( 'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), $class, $version, '<pre>__construct()</pre>' ) );
+            if ( ! empty( $parent_class ) ) {
+                /* translators: 1: PHP class name, 2: PHP parent class name, 3: version number, 4: __construct() method */
+                trigger_error( sprintf( __( 'The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.' ),
+                    $class, $parent_class, $version, '<pre>__construct()</pre>' ) );
+            } else {
+                /* translators: 1: PHP class name, 2: version number, 3: __construct() method */
+                trigger_error( sprintf( __( 'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
+                    $class, $version, '<pre>__construct()</pre>' ) );
+            }
         } else {
-            trigger_error( sprintf( 'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $class, $version, '<pre>__construct()</pre>' ) );
+            if ( ! empty( $parent_class ) ) {
+                trigger_error( sprintf( 'The called constructor method for %1$s in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.',
+                    $class, $parent_class, $version, '<pre>__construct()</pre>' ) );
+            } else {
+                trigger_error( sprintf( 'The called constructor method for %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
+                    $class, $version, '<pre>__construct()</pre>' ) );
+            }
         }
     }