Changeset 37861 for trunk/tests/phpunit/tests/actions.php

Timestamp:

06/25/2016 07:56:19 PM (10 years ago)

Author:

boonebgorges

Message:

Allow action and filter hooks to be deprecated.

When a filter or action hook is deprecated, the corresponding apply_filters()
or do_action() calls should be switched out with apply_filters_deprecated()
or do_action_deprecated(). The latter functions will throw a deprecation
before invoking the original hook.

Props solarissmoke, SergeyBiryukov, DrewAPicture.
Fixes #10441.

File:

• trunk/tests/phpunit/tests/actions.php (modified) (1 diff)

trunk/tests/phpunit/tests/actions.php

@@ -420 +420 @@
         $this->assertFalse( doing_filter( 'something_else' ) );
     }
+
+    /**
+     * @ticket 10441
+     * @expectedDeprecated tests_do_action_deprecated
+     */
+    public function test_do_action_deprecated() {
+        $p = new WP_Post( (object) array( 'post_title' => 'Foo' ) );
+
+        add_action( 'tests_do_action_deprecated', array( __CLASS__, 'deprecated_action_callback' ) );
+        do_action_deprecated( 'tests_do_action_deprecated', array( $p ), '4.6' );
+        remove_action( 'tests_do_action_deprecated', array( __CLASS__, 'deprecated_action_callback' ) );
+
+        $this->assertSame( 'Bar', $p->post_title );
+    }
+
+    public static function deprecated_action_callback( $p ) {
+        $p->post_title = 'Bar';
+    }
+
+    /**
+     * @ticket 10441
+     * @expectedDeprecated tests_do_action_deprecated
+     */
+    public function test_do_action_deprecated_with_multiple_params() {
+        $p1 = new WP_Post( (object) array( 'post_title' => 'Foo1' ) );
+        $p2 = new WP_Post( (object) array( 'post_title' => 'Foo2' ) );
+
+        add_action( 'tests_do_action_deprecated', array( __CLASS__, 'deprecated_action_callback_multiple_params' ), 10, 2 );
+        do_action_deprecated( 'tests_do_action_deprecated', array( $p1, $p2 ), '4.6' );
+        remove_action( 'tests_do_action_deprecated', array( __CLASS__, 'deprecated_action_callback_multiple_params' ), 10, 2 );
+
+        $this->assertSame( 'Bar1', $p1->post_title );
+        $this->assertSame( 'Bar2', $p2->post_title );
+    }
+
+    public static function deprecated_action_callback_multiple_params( $p1, $p2 ) {
+        $p1->post_title = 'Bar1';
+        $p2->post_title = 'Bar2';
+    }
+
+    /**
+     * @ticket 10441
+     * @expectedDeprecated tests_apply_filters_deprecated
+     */
+    public function test_apply_filters_deprecated() {
+        $p = 'Foo';
+
+        add_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback' ) );
+        $p = apply_filters_deprecated( 'tests_apply_filters_deprecated', array( $p ), '4.6' );
+        remove_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback' ) );
+
+        $this->assertSame( 'Bar', $p );
+    }
+
+    public static function deprecated_filter_callback( $p ) {
+        $p = 'Bar';
+        return $p;
+    }
+
+    /**
+     * @ticket 10441
+     * @expectedDeprecated tests_apply_filters_deprecated
+     */
+    public function test_apply_filters_deprecated_with_multiple_params() {
+        $p1 = 'Foo1';
+        $p2 = 'Foo2';
+
+        add_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback_multiple_params' ), 10, 2 );
+        $p1 = apply_filters_deprecated( 'tests_apply_filters_deprecated', array( $p1, $p2 ), '4.6' );
+        remove_filter( 'tests_apply_filters_deprecated', array( __CLASS__, 'deprecated_filter_callback_multiple_params' ), 10, 2 );
+
+        $this->assertSame( 'Bar1', $p1 );
+
+        // Not passed by reference, so not modified.
+        $this->assertSame( 'Foo2', $p2 );
+    }
+
+    public static function deprecated_filter_callback_multiple_params( $p1, $p2 ) {
+        $p1 = 'Bar1';
+        $p2 = 'Bar2';
+
+        return $p1;
+    }
 }