Ticket #10441: 10441.diff

src/wp-includes/functions.php

@@ -3575 +3575 @@
 }
 
 /**
+ * Marks a hook as deprecated and informs when it has been used.
+ *
+ * There is a hook deprecated_hook_used that will be called that can be used
+ * to get the backtrace up to what file and function was used for the callback.
+ *
+ * The current behavior is to trigger a user error if WP_DEBUG is true.
+ *
+ * This function is to be used for every hook that is deprecated, when any callback is
+ * attacked to the hook, as determined by has_action() or has_filter(), and shall be
+ * called before the hook is fired.
+ *
+ * @since 4.4.0
+ *
+ * @param string $hook        The hook that was used.
+ * @param string $version     The version of WordPress that deprecated the hook.
+ * @param string $replacement Optional. The hook that should have been used.
+ * @param string $message     Optional. A message regarding the change.
+ */
+function _deprecated_hook( $hook, $version, $replacement = null, $message = null ) {
+        /**
+         * Filter whether to trigger deprecated hook errors.
+         *
+         * @since 4.4.0
+         *
+         * @param bool $trigger Whether to trigger deprecated hook errors. Requires
+         *                      `WP_DEBUG` to be defined true.
+         */
+        if ( WP_DEBUG && apply_filters( 'deprecated_hook_trigger_error', true ) ) {
+                $message = empty( $message ) ? '' : ' ' . $message;
+                if ( ! is_null( $replacement ) ) {
+                        trigger_error( sprintf( __( '%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), $hook, $version, $replacement ) . $message );
+                } else {
+                        trigger_error( sprintf( __( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ), $hook, $version ) . $message );
+                }
+        }
+}
+
+/**
  * Mark something as being incorrectly called.
  *
  * There is a hook doing_it_wrong_run that will be called that can be used

src/wp-includes/plugin.php

@@ -656 +656 @@
         return remove_all_filters($tag, $priority);
 }
 
+/**
+ * Fires a deprecated filter.
+ *
+ * Wraps apply_filters().
+ *
+ * @since 4.4.0
+ *
+ * @see _deprecated_hook()
+ *
+ * @param string $tag         The name of the filter hook.
+ * @param array  $args        Array of additional function arguments to be passed to apply_filters().
+ * @param string $version     The version of WordPress that deprecated the hook.
+ * @param string $replacement Optional. The hook that should have been used.
+ * @param string $message     Optional. A message regarding the change.
+ */
+function apply_deprecated_filters( $tag, $args, $version, $replacement = false, $message = null ) {
+        if ( ! has_filter( $tag ) ) {
+                return;
+        }
+        _deprecated_hook( $tag, $version, $replacement, $message );
+
+        array_unshift( $args, $tag );
+        return call_user_func_array( 'apply_filters', $args );
+}
+
+/**
+ * Fires a deprecated action.
+ *
+ * Wraps do_action().
+ *
+ * @since 4.4.0
+ *
+ * @see _deprecated_hook()
+ *
+ * @param string $tag         The name of the filter hook.
+ * @param array  $args        Array of additional function arguments to be passed to do_action().
+ * @param string $version     The version of WordPress that deprecated the hook.
+ * @param string $replacement Optional. The hook that should have been used.
+ * @param string $message     Optional. A message regarding the change.
+ */
+function do_deprecated_action( $tag, $args, $version, $replacement = false, $message = null ) {
+        if ( ! has_action( $tag ) ) {
+                return;
+        }
+
+        _deprecated_hook( $tag, $version, $replacement, $message );
+
+        array_unshift( $args, $tag );
+        call_user_func_array( 'do_action', $args );
+}
+
 //
 // Functions for handling plugins.
 //