Changeset 39560 for trunk

Timestamp:

12/10/2016 06:59:24 AM (10 years ago)

Author:

westonruter

Message:

Customize: Trim whitespace for URLs supplied for external_header_video to prevent esc_url_raw() from making them invalid.

Props tyxla.
See #38172.
Fixes #39125.

Location:

trunk

Files:

• src/wp-includes/class-wp-customize-manager.php (modified) (2 diffs)
• tests/phpunit/tests/customize/manager.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -3897 +3897 @@
                         'theme_supports'    => array( 'custom-header', 'video' ),
                         'transport'         => 'postMessage',
-                        'sanitize_callback' => 'esc_url_raw',
+                        'sanitize_callback' => array( $this, '_sanitize_external_header_video' ),
                         'validate_callback' => array( $this, '_validate_external_header_video' ),
                 ) );
@@ -4320 +4320 @@
 
         /**
+         * Callback for sanitizing the external_header_video value.
+         *
+         * @since 4.7.1
+         *
+         * @param string $value URL.
+         * @return string Sanitized URL.
+         */
+        public function _sanitize_external_header_video( $value ) {
+                return esc_url_raw( trim( $value ) );
+        }
+
+        /**
          * Callback for rendering the custom logo, used in the custom_logo partial.
          *

trunk/tests/phpunit/tests/customize/manager.php

@@ -2581 +2581 @@
                 $this->assertEquals( $panels_sorted, array_keys( $result ) );
         }
+
+        /**
+         * Verify sanitization of external header video URL will trim the whitespaces in the beginning and end of the URL.
+         *
+         * @ticket 39125
+         */
+        function test_sanitize_external_header_video_trim() {
+                $this->manager->register_controls();
+                $setting = $this->manager->get_setting( 'external_header_video' );
+                $video_url = 'https://www.youtube.com/watch?v=KiS8rZBeIO0';
+
+                $whitespaces = array(
+                        ' ',  // space
+                        "\t", // horizontal tab
+                        "\n", // line feed
+                        "\r", // carriage return,
+                        "\f", // form feed,
+                        "\v", // vertical tab
+                );
+
+                foreach ( $whitespaces as $whitespace  ) {
+                        $sanitized = $setting->sanitize( $whitespace . $video_url . $whitespace );
+                        $this->assertEquals( $video_url, $sanitized );
+                }
+        }
 }