Changeset 32989

Timestamp:

06/28/2015 02:55:33 PM (8 years ago)

Author:

jorbin

Message:

Add Deprecated Constructor Function

This function is one that can be called in core to indicate that a PHP4 style constructor is used. PHP4 style constructors are deprecated in PHP7.

Props jorbin, DrewAPicture for docs
See #31982

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -3417 +3417 @@
 
 /**
+ * Marks a constructor as deprecated and informs when it has been used.
+ *
+ * Similar to _deprecated_function(), but with different strings. Used to
+ * remove PHP4 style constructors.
+ *
+ * The current behavior is to trigger a user error if WP_DEBUG is true.
+ *
+ * This function is to be used in every PHP4 style constructor method that is deprecated.
+ *
+ * @since 4.3.0
+ *
+ * @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 ) {
+
+    /**
+     * Fires when a deprecated constructor is called.
+     *
+     * @since 4.3.0
+     *
+     * @param string $class   The class containing the deprecated constructor.
+     * @param string $version The version of WordPress that deprecated the function.
+     */
+    do_action( 'deprecated_constructor_run', $class, $version );
+
+    /**
+     * Filter whether to trigger an error for deprecated functions.
+     *
+     * @since 4.3.0
+     *
+     * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
+     */
+    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>' ) );
+        } 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>' ) );
+        }
+    }
+
+}
+
+/**
  * Mark a file as deprecated and inform when it has been used.
  *