Changeset 51182

Timestamp:

06/18/2021 02:02:44 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Themes: Make sure get_file_data() recognizes headers prefixed by <?php tag.

This allows for using headers in the format of <?php // Template Name: Something ?>, which previously could not be recognized correctly.

Props dd32, m_uysl, thomas-vitale, boblinthorst.
Fixes #33387.

Location:

trunk

Files:

• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/data/formatting/file-header-cr-line-endings.php (moved) (moved from trunk/tests/phpunit/data/formatting/cr-line-endings-file-header.php )
• tests/phpunit/data/formatting/file-header-php-open-tag-prefix.php (added)
• tests/phpunit/tests/file.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -6288 +6288 @@
 
         foreach ( $all_headers as $field => $regex ) {
-                if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] ) {
+                if ( preg_match( '/^(?:[ \t]*<\?php)?[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] ) {
                         $all_headers[ $field ] = _cleanup_header_comment( $match[1] );
                 } else {

trunk/tests/phpunit/tests/file.php

@@ -45 +45 @@
 
         /**
+         * @ticket 19854
          * @group plugins
          * @group themes
          */
-        function test_get_file_data_cr_line_endings() {
-                $headers  = array(
+        function test_get_file_data_with_cr_line_endings() {
+                $headers = array(
                         'SomeHeader'  => 'Some Header',
                         'Description' => 'Description',
                         'Author'      => 'Author',
                 );
-                $actual   = get_file_data( DIR_TESTDATA . '/formatting/cr-line-endings-file-header.php', $headers );
+
+                $actual   = get_file_data( DIR_TESTDATA . '/formatting/file-header-cr-line-endings.php', $headers );
                 $expected = array(
                         'SomeHeader'  => 'Some header value!',
                         'Description' => 'This file is using CR line endings for a testcase.',
                         'Author'      => 'A Very Old Mac',
+                );
+
+                foreach ( $actual as $header => $value ) {
+                        $this->assertSame( $expected[ $header ], $value, $header );
+                }
+        }
+
+        /**
+         * @ticket 47186
+         * @group plugins
+         * @group themes
+         */
+        function test_get_file_data_with_php_open_tag_prefix() {
+                $headers = array(
+                        'TemplateName' => 'Template Name',
+                );
+
+                $actual   = get_file_data( DIR_TESTDATA . '/formatting/file-header-php-open-tag-prefix.php', $headers );
+                $expected = array(
+                        'TemplateName' => 'Something',
                 );