[Theme compatibility] WP/PHP compatibility tests for single site theme updates/activation

[afragen]

As part of the WP/PHP version compatibility testing for themes, this ticket is directed towards theme updating and activation on a single site installation.

If the theme is not compatible with the currently running WP or PHP version, updating will be blocked. This also includes blocking theme activation for incompatible themes.

This addresses the themes.php and upgrade-core.php pages.

[afragen]

Still to do are tickets/patches for installing themes and multisite.

[afragen]

Related: #44592

[afragen]

The screenshots screenshot_02.png​, screenshot_04.png​, and screenshot_01.png​ show an incompatible update.

I manually set the PHP requirement so it would fail.

[afragen]

Precedence: API > readme.txt > style.css

[afragen]

Hmm, I think I need to deactivate the Live Preview button as it can be used to activate.

[afragen]

It is still possible, using the Customizer, to see updates and activate a non-compliant theme. I will need help with fixing this component.

[afragen]

Disable 'Live Preview' button

[afragen]

It is my plan to clean up this a bit. My intent is to remove the changes to WP_Theme and put them in their own ticket/patch. This patch would be the first patch needed to be reviewed/committed as it will be required by all these subsequent tickets/patches.

That way this ticket doesn't need to be committed before any of the others. Hopefully this simplifies the testing.

[afragen]

removed changes to class-wp-theme.php, now in #48515

[sathyapulse]

@afragen I am not able to apply the patch in my local environment. Could you please regenerate the patch?

[afragen]

@sathyapulse it's likely because the patch was created against core.git.wordpress.org, not develop.git.wordpress.org.

[afragen]

@sathyapulse I've tested the patch again and it is applies cleanly on trunk using npm run grunt patch:48491

It might depend upon how your local environment is set up.

[afragen]

Pinging @jorbin per our discussion at WCPHX.

[SergeyBiryukov]

Just noting this is on my list to commit today (along with #48507), more eyes definitely welcome though :)

[jorbin]

I'm taking a look now, but that doesn't need to block merging by any means

[jorbin]

Uploaded update that applies cleanly, still testing

[jorbin]

I think this is going to need the customizer piece in order to be complete and land in trunk.

Based on timing, I would suggest punting and work continuing so it can be ready for 5.5

[TimothyBlynJacobs]

For the customizer stuff, it looks like this data can be added in the wp_ajax_query_themes() PHP function. And adding a modification like this in the tmpl-theme-preview template in wp-admin/theme-install.php.

<# if ( data.installed ) { #>
    <a class="button button-primary activate" href="{{ data.activate_url }}"><?php _e( 'Activate' ); ?></a>
<# } else if ( data.compatible_php ) { #>
    <a href="{{ data.install_url }}" class="button button-primary theme-install" data-name="{{ data.name }}" data-slug="{{ data.id }}"><?php _e( 'Install' ); ?></a>
<# } else { #>
    <a href="{{ data.install_url }}" class="button button-primary theme-install disabled" data-name="{{ data.name }}" data-slug="{{ data.id }}"><?php _e( 'Install' ); ?></a>
<# } #>

[Clorith]

Moving this to the 5.5 milestone, as it's marked early, and we are one day away from beta for 5.4

[afragen]

Latest patch 48491.5.diff​ adds compatibility testing when in the Customizer.

To test simply change the Requires PHP header of the style.css of an installed theme. You can test the update part by also decrementing the version number too.

[afragen]

add Customizer part

[afragen]

minor updates to patch

[afragen]

update 'Activate & Publish' back to button type

[SergeyBiryukov]

This is great work, I'm sorry the review took so long. There really are a lot of different layers and parts of the themes UI, so testing that everything works as expected is non-trivial.

Some notes on the patch:

• No need to use ReflectionObject in wp-admin/customize.php, the WP_Customize_Manager::theme() method can be used to retrieve the theme object instead.
• It seems like the update parts need some more work. Unless I've missed something in my testing, at least in a few places the messages state that the theme update is incompatible, but the compatibility checks are actually performed for the currently installed version, not for the update.
• The activation parts look good, commit incoming.

[SergeyBiryukov]

In 47816:

Themes: Prevent activation and live preview of themes that require a higher version of PHP or WordPress.

Props afragen, jorbin, TimothyBlynJacobs, SergeyBiryukov.
See #48491.

[SergeyBiryukov]

In 47817:

Themes: Remove debug call from wp-admin/theme-install.php.

Follow-up to [47816].

See #48491.

[SergeyBiryukov]

In 47818:

Themes: Remove extra whitespace from wp-admin/includes/ajax-actions.php and wp-admin/includes/theme.php.

Follow-up to [47816].

See #48491.

[SergeyBiryukov]

Replying to SergeyBiryukov:

There really are a lot of different layers and parts of the themes UI, so testing that everything works as expected is non-trivial.

For future reference:

• wp-admin/customize.php
  • Includes displaying the "Activate & Publish" button in Customizer side panel.
• wp-admin/includes/ajax-actions.php
  • wp_ajax_query_themes() provides data for the Add Themes screen.
• wp-admin/includes/theme.php
  • customize_themes_print_templates() is used for displaying the Theme Details modal in the Customizer theme browser.
• wp-admin/theme-install.php
  • #tmpl-theme is used for displaying the grid on the Add Themes screen.
  • #tmpl-theme-preview is used for displaying the Details & Preview modal on the Add Themes screen.
• wp-admin/themes.php has three different templates:
  • The first one (in PHP) is used for displaying the grid on the Themes screen when JS is turned off.
  • #tmpl-theme is used for displaying the grid on the Themes screen.
  • #tmpl-theme-single is used for displaying the Theme Details modal on the Themes screen.
• wp-includes/customize/class-wp-customize-theme-control.php
  • WP_Customize_Theme_Control::content_template() is used for displaying the grid in the Customizer theme browser.

[SergeyBiryukov]

To summarize: with the activation and live preview parts out of the way in [47816], it should hopefully be easier to focus on the update parts now.

[afragen]

Thanks @SergeyBiryukov 🤩

Thanks for documenting all the above. 😊

[SergeyBiryukov]

In 47819:

Themes: Prevent installation of themes that require a higher version of PHP or WordPress.

Props afragen.
Fixes #49653. See #48491.

[davidbaumwald]

Removing early tag per discussion with @SergeyBiryukov

[desrosj]

Just wanted to circle back on this and make sure that the error messages were not omitted on accident. @SergeyBiryukov I believe that is what you mean in 48491#comment:36, but wanted to make sure.

Attached screenshots to document the current experience. The missing error messages are very apparent.

Also, #48245 was created to add some extra details to the error message displayed when a user attempts to activate a plugin without proper support. I think some of these points could be used to improve the messaging that will be added here. From @johnbillion in #48245:

Some helpful information should be added to this screen:

• The plugins' minimum required PHP version
• The current PHP version
• A link to the support documentation on how to update PHP

[afragen]

I believe the error messages on these particular screens are omitted on purpose as there’s no obvious location and error messages do exist in other locations. I haven’t looked at this recently however.

[SergeyBiryukov]

In 48636:

Themes: Display a message in Theme Details modal if a theme requires a higher version of PHP or WordPress.

Props afragen, desrosj, SergeyBiryukov.
See #48491.

[SergeyBiryukov]

In 48637:

Themes: Display a message in Details & Preview modal on Add Themes screen if a theme requires a higher version of PHP or WordPress.

Props afragen, desrosj, SergeyBiryukov.
See #48491.

[SergeyBiryukov]

In 48638:

Themes: Display a message in theme grid if a theme requires a higher version of PHP or WordPress.

This applies to the Themes screen, Add Themes screen, and the Customizer theme browser.

Props afragen, desrosj, SergeyBiryukov.
See #48491.

[SergeyBiryukov]

In 48640:

Themes: Display a message in theme grid if a theme requires a higher version of PHP or WordPress.

This applies to the Themes screen fallback used when JS is turned off.

Props afragen, desrosj, SergeyBiryukov.
See #48491.

[SergeyBiryukov]

In 48652:

Themes: Display a message in theme grid and Theme Details modal if a theme update requires a higher version of PHP or WordPress.

This applies to the Themes screen and the Customizer theme browser.

Props afragen, SergeyBiryukov.
See #48491.

[SergeyBiryukov]

In 48653:

Themes: Correct the logic for displaying a message in theme grid if a theme update requires a higher version of PHP or WordPress.

This applies to the Themes screen fallback used when JS is turned off.

Follow-up to [48652].

See #48491.

[SergeyBiryukov]

In 48654:

Themes: Display a message in theme updates list if an update requires a higher version of PHP or WordPress.

This applies to the WordPress Updates screen.

Props afragen, SergeyBiryukov.
Fixes #48491.

[SergeyBiryukov]

In 48659:

Themes: Include theme name in available update messages, for better accessibility and consistency with other similar messages.

Follow-up to [48652-48654].

See #48491.

[SergeyBiryukov]

In 48660:

Themes: Display a message on Themes list table if a theme update requires a higher version of PHP or WordPress.

This applies to the Themes screen in Multisite network admin.

Props afragen, SergeyBiryukov.
Fixes #48507. See #48491.

[SergeyBiryukov]

In 48689:

Themes: Pass correct variable to is_php_version_compatible() in wp_theme_update_row().

This applies to the Themes screen in Multisite network admin.

Follow-up to [48660].

Props pbiron, afragen.
Fixes #48507. See #48491.

[SergeyBiryukov]

In 48690:

Themes: Pass correct variable to is_php_version_compatible() in wp_theme_update_row().

This applies to the Themes screen in Multisite network admin.

Follow-up to [48660].

Props pbiron, afragen.
Reviewed by peterwilsoncc, SergeyBiryukov.
Merges [48689] to the 5.5 branch.
Fixes #48507. See #48491.

[justinahinon]

Dev note link: ​https://make.wordpress.org/core/2020/07/30/themes-field-guide-wordpress-5-5/