Changeset 53429 for trunk/tests/phpunit/tests/query/conditionals.php

Timestamp:

05/22/2022 03:15:47 PM (17 months ago)

Author:

SergeyBiryukov

Message:

Query: Check if $wp_query is set in query loop functions.

This avoids a PHP fatal error if any of these functions are called too early:

• have_posts()
• in_the_loop()
• rewind_posts()
• the_post()
• have_comments()
• the_comment()

bringing some consistency with conditional tags: is_single(), is_home(), etc.

This commit also removes unnecessary return from the_comment(), for consistency with the_post(). As WP_Query::the_comment() does not have a return value, this statement did not have any effect in practice.

Follow-up to [4934], [8807], [16947], [17068], [17083], [49147], [53395], [53396], [53400].

Props vdankbaar, thijso, teunvgisteren, timkersten655, SergeyBiryukov.
Fixes #55722.

File:

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

trunk/tests/phpunit/tests/query/conditionals.php

@@ -1661 +1661 @@
     }
 
+    /**
+     * @ticket 55722
+     *
+     * @dataProvider data_loop_functions_do_not_trigger_a_fatal_error_if_wp_query_is_not_set
+     *
+     * @param string     $function_name The name of the function to test.
+     * @param false|null $expected      Expected return value.
+     */
+    public function test_loop_functions_do_not_trigger_a_fatal_error_if_wp_query_is_not_set( $function_name, $expected ) {
+        unset( $GLOBALS['wp_query'] );
+
+        $this->assertSame( $expected, call_user_func( $function_name ) );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[] Test parameters {
+     *     @type string     $function_name The name of the function to test.
+     *     @type false|null $expected      Expected return value.
+     * }
+     */
+    public function data_loop_functions_do_not_trigger_a_fatal_error_if_wp_query_is_not_set() {
+        return array(
+            array( 'have_posts', false ),
+            array( 'in_the_loop', false ),
+            array( 'rewind_posts', null ),
+            array( 'the_post', null ),
+            array( 'have_comments', false ),
+            array( 'the_comment', null ),
+        );
+    }
+
 }