Allow numeric theme name

[alvastar]

What steps should be taken to consistently reproduce the problem?

• Create a theme with a numeric name or rename an existing one.
• Activate the theme for your site.

The theme will not be displayed as active.

Also, when using the Gutenberg editor, calls to the add_theme_support function will not work.

Possibly the problem is how PHP is converting the keys of the array:

Strings containing valid decimal ints, unless the number is preceded by a + sign, will be cast to the int type. E.g. the key "8" will actually be stored under 8. On the other hand "08" will not be cast, as it isn't a valid decimal integer.

Suggested solution to the problem:

File in wp-icnludes/rest-api/endpoints/class-wp-rest-themes-controller.php replace this

/**
 * Helper function to compare two themes.
 *
 * @since 5.7.0
 *
 * @param WP_Theme $theme_a First theme to compare.
 * @param WP_Theme $theme_b Second theme to compare.
 * @return bool
 */
protected function is_same_theme( $theme_a, $theme_b ) {
        return $theme_a->get_stylesheet() === $theme_b->get_stylesheet();
}

with this

/**
 * Helper function to compare two themes.
 *
 * @since 5.7.0
 *
 * @param WP_Theme $theme_a First theme to compare.
 * @param WP_Theme $theme_b Second theme to compare.
 * @return bool
 */
protected function is_same_theme( $theme_a, $theme_b ) {
        return (string)$theme_a->get_stylesheet() === (string)$theme_b->get_stylesheet();
}

[SergeyBiryukov]

#54666 was marked as a duplicate.

Casts theme dir name to string when creating a WP_Theme object, allowing to have numerical dirnames for themes.

Trac ticket: https://core.trac.wordpress.org/ticket/54645

[lopo]

To clarify: having a numerical name (in style.css) doesn't seem to create problems, while having a numerical folder name does.

The patch fixes this by making sure that we cast the theme dirname to a string when creating the WP_Theme object when assigning to the stylesheet property in the WP_Theme contructor.

To test, rename e.g. wp-content/themes/twentytwentyone to wp-content/themes/2021.

Without the patch:

• setting the theme as "Active" doesn't result in being displayed as such in Appearance > Themes
• editing a post in the block editor shows e.g. no section to set featured image in the sidebar

With this patch:

• setting the theme as "Active" results in being displayed as such in Appearance > Themes
• editing a post in the block editor shows the supported features e.g. the featured image

I'm removing the needs-unit-tests keyword since there's currently no default theme with a numerical dirname to be retrieved by a call to wp_get_themes() Unit test added after change of approach.

[SergeyBiryukov]

Replying to lopo:

I'm removing the needs-unit-tests keyword since there's currently no default theme with a numerical dirname to be retrieved by a call to wp_get_themes().

Thanks for the patch! I think this change would still benefit from unit tests to make sure the fix works as expected and there are no regressions at a later point.

[lopo]

Replying to SergeyBiryukov:

Replying to lopo:

I'm removing the needs-unit-tests keyword since there's currently no default theme with a numerical dirname to be retrieved by a call to wp_get_themes().

Thanks for the patch! I think this change would still benefit from unit tests to make sure the fix works as expected and there are no regressions at a later point.

Would love to, @SergeyBiryukov, but I'm not sure how it can be done without adding a theme to the default ones?
I changed the approach by moving the cast inside the WP_Theme constructor so I could add a unit test for that.

[hugodevos]

Test Report

This report validates that the indicated patch addresses the issue.

Patch tested: REPLACE_WITH_PATCH_URL

Environment

• OS: macOS 12.3.1
• Web Server: Nginx
• PHP: 7.4.29
• WordPress: 6.1-alpha-53344-src
• Browser: Chrome 105.0.5195.102 (Official Build) (x86_64)
• Theme: Twenty Twenty-Two (and Twenty Twenty-One)
• Active Plugins:

Actual Results

• ✅ Issue resolved with patch.
• All worked as expected

Additional Notes

• Any additional details worth mention.
• Also tested with other interesting characters such as $$$ for the filename or 2021.2021 and worked as expected.

[Ankit K Gupta]

Hello All, I also got a chance to test this issue with some other theme like, Numeric, Alphanumeric, etc and PR ​https://github.com/WordPress/wordpress-develop/pull/2758 fixed the issue.

Test Report

Env

• WordPress - 6.1-beta1-54282-src
• Chrome Version - 105.0.5195.125 (Official Build) (x86_64)
• OS - macOS Monterey V12.3.1
• Theme: Twenty Twenty Two
• PHP - 8.0.0
• Web Server - Apache
• Database - MySQL 5.7.28
• Used PR - ​https://github.com/WordPress/wordpress-develop/pull/2758

Steps to test

1. Rename the theme name from style.css and folder name like 'wp-content/themes/2022' or 'wp-content/themes/AB123'
2. Go to Appearance > Themes
3. Activate your theme which has a name set in step-1

Test result

A theme that has names like 'ABC2022' / '2022' / 'Twenty Twenty Two', etc is appearing as active (if activated) with available option 'Customize'.

Screencast example:

Before Fix -

After Fix by PR2758 -

[spacedmonkey]

Sadly didn't get to this ticket in 6.1 release. Punting to 6.2

[jakariaistauk]

Test Report

This report validates that the indicated patch addresses the issue.

Patch tested: ​https://github.com/WordPress/wordpress-develop/pull/2758

Environment

• OS: macOS 13.0
• Web Server: Nginx
• PHP: 7.4.30
• WordPress: 6.2-alpha-54642-src
• Browser: Google Chrome 108.0.5359.124, Mozilla Firefox 108.0.1(64bit)
• Theme: Twenty Ten, Twenty Twenty-Three

Actual Results

• ✅Issue resolved with patch.

[jakariaistauk]

Screenshot before fix the issue

[jakariaistauk]

Screenshot after fix the issue

[mukesh27]

@alvastar thanks for the ticket!

This ticket was discussed during the recent bug scrub. It looks like it's unlikely that work will be done on this during the 6.2 cycle.

According to the manual test report, the ticket is operational. 

@spacedmonkey Is this still possible to land in 6.2, or should it be moved to Future Release for now?

[spacedmonkey]

Bumping to future release.

[SergeyBiryukov]

In 55426:

Themes: Account for a numeric theme directory in WP_Theme::__construct().

This ensures that if a theme with a numeric directory name is active, it is correctly identified as such, and that theme support features work as expected.

Follow-up to [20029], [49925].

Props lopo, alvastar, winterpsv, hugodevos, ankit-k-gupta, jakariaistauk, mukesh27, spacedmonkey, SergeyBiryukov.
Fixes #54645.

Thanks for the PR! Merged in r55426.