Changeset 52187

Timestamp:

11/16/2021 06:48:47 PM (5 years ago)

Author:

hellofromTonya

Message:

HTTP API: Remove empty ? when only anchor remains in add_query_arg().

If after processing through add_query_arg() a ?# remains, this commit removes the unnecessary and unused ? character as there are no query args in the URL.

Includes tests.

Follow-up to [1823], [5193], [5999], [6005].

Props benjaminanakenam, sabernhardt, costdev, hellofromTonya.
Fixes #44499.

Location:

trunk

Files:

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

trunk/src/wp-includes/functions.php

@@ -1170 +1170 @@
         $ret = $protocol . $base . $ret . $frag;
         $ret = rtrim( $ret, '?' );
+        $ret = str_replace( '?#', '#', $ret );
         return $ret;
 }

trunk/tests/phpunit/tests/functions.php

@@ -664 +664 @@
                 $url = add_query_arg( array( '1' => '2' ), 'foo=bar' );
                 $this->assertSame( 'foo=bar&1=2', $url );
+        }
+
+        /**
+         * Tests that add_query_arg removes the question mark when
+         * a parameter is set to false.
+         *
+         * @dataProvider data_add_query_arg_removes_question_mark
+         *
+         * @ticket 44499
+         * @group  add_query_arg
+         *
+         * @covers ::add_query_arg
+         *
+         * @param string $url      Url to test.
+         * @param string $expected Expected URL.
+         */
+        public function test_add_query_arg_removes_question_mark( $url, $expected, $key = 'param', $value = false ) {
+                $this->assertSame( $expected, add_query_arg( $key, $value, $url ) );
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array
+         */
+        public function data_add_query_arg_removes_question_mark() {
+                return array(
+                        'anchor'                                     => array(
+                                'url'      => 'http://example.org?#anchor',
+                                'expected' => 'http://example.org#anchor',
+                        ),
+                        '/ then anchor'                              => array(
+                                'url'      => 'http://example.org/?#anchor',
+                                'expected' => 'http://example.org/#anchor',
+                        ),
+                        'invalid query param and anchor'             => array(
+                                'url'      => 'http://example.org?param=value#anchor',
+                                'expected' => 'http://example.org#anchor',
+                        ),
+                        '/ then invalid query param and anchor'      => array(
+                                'url'      => 'http://example.org/?param=value#anchor',
+                                'expected' => 'http://example.org/#anchor',
+                        ),
+                        '?#anchor when adding valid key/value args'  => array(
+                                'url'      => 'http://example.org?#anchor',
+                                'expected' => 'http://example.org?foo=bar#anchor',
+                                'key'      => 'foo',
+                                'value'    => 'bar',
+                        ),
+                        '/?#anchor when adding valid key/value args' => array(
+                                'url'      => 'http://example.org/?#anchor',
+                                'expected' => 'http://example.org/?foo=bar#anchor',
+                                'key'      => 'foo',
+                                'value'    => 'bar',
+                        ),
+                );
         }