Try applying notice classes with JS templates #5225

joedolson · 2023-09-15T22:33:13Z

Uses echo wp_get_admin_notice() because wp_kses_post removes template conditionals
Adds function to output data because there are two usages in theme-install.php and the only difference is the notice class.
Function will be easier to clone for use in other similar contexts.

Tested and works. Currently loses the padding in the error messages due to missing p wrapper; todo.

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

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

- Uses echo wp_get_admin_notice() because wp_kses_post removes template conditionals - Adds function to output data because there are two usages in theme-install.php and the only difference is the notice class. - Function will be easier to clone for use in other similar contexts.

src/wp-admin/includes/theme-install.php

src/wp-admin/theme-install.php

Co-authored-by: Colin Stewart <79332690+costdev@users.noreply.github.com>

…press-develop into 57791-jstemplates

costdev

Mostly looks good @joedolson! I hadn't gotten a chance to follow up on this so thanks for continuing work here!

Just left a few queries, and some alignment corrections.

costdev · 2023-10-09T03:17:32Z

src/wp-admin/includes/update.php

+			 *     @type string   $requires_php The version of PHP which the plugin requires.
+			 * }
+			 */
+			$compatibility_notice . do_action( "in_plugin_update_message-{$file}", $plugin_data, $response ), // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores,


Since do_action() returns void, this appends null (or '') to the notice. While this doesn't present an issue for the message, I wonder if we should just call do_action() above the wp_admin_notice() call?

costdev · 2023-10-09T03:18:42Z

src/wp-admin/includes/update.php

+		 *     @type string $package     Theme update package URL.
+		 * }
+		 */
+		$compatibility_notice . do_action( "in_theme_update_message-{$theme_key}", $theme, $response ), // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores


Same query as above

costdev · 2023-10-09T03:20:17Z

src/wp-admin/theme-install.php

-							</p></div>
+							<?php
+							$compatibility_template = theme_compatibility_template();
+							echo wp_get_admin_notice(


Is this used instead of wp_admin_notice() because of escaping issues? If so, we might consider adding an inline comment to ensure this doesn't get changed in future without awareness of possible escaping issues.

costdev · 2023-10-09T03:25:20Z

src/wp-admin/themes.php

+					'type' => 'warning',
+					'additional_classes' => array( 'update-message', 'inline', 'notice-alt' ),


Suggested change

'type' => 'warning',

'additional_classes' => array( 'update-message', 'inline', 'notice-alt' ),

'type' => 'warning',

'additional_classes' => array( 'update-message', 'inline', 'notice-alt' ),

costdev · 2023-10-09T03:26:20Z

src/wp-admin/includes/theme.php

+						$no_customizer_support = __( 'This theme doesn\'t support Customizer.' );
+						$no_customizer_support .= '<# if ( data.actions.activate ) { #>';
+						$no_customizer_support .= sprintf(


Suggested change

$no_customizer_support = __( 'This theme doesn\'t support Customizer.' );

$no_customizer_support .= '<# if ( data.actions.activate ) { #>';

$no_customizer_support .= sprintf(

$no_customizer_support = __( 'This theme doesn\'t support Customizer.' );

$no_customizer_support .= '<# if ( data.actions.activate ) { #>';

$no_customizer_support .= sprintf(

costdev · 2023-10-09T03:26:50Z

src/wp-admin/includes/theme.php

+									'type' => 'error',
+									'additional_classes' => array( 'notice-alt', 'notice-large' ),
+									'attributes'         => array(


Suggested change

'type' => 'error',

'additional_classes' => array( 'notice-alt', 'notice-large' ),

'attributes' => array(

'type' => 'error',

'additional_classes' => array( 'notice-alt', 'notice-large' ),

'attributes' => array(

costdev · 2023-10-09T03:27:15Z

src/wp-admin/includes/theme.php

+							$update_incompatible = '<h3 class="notice-title">' . __( 'Update Incompatible' ) . '</h3><p><# if ( ! data.updateResponse.compatibleWP && ! data.updateResponse.compatiblePHP ) { #>';
+							$update_incompatible .= sprintf(


Suggested change

$update_incompatible = '<h3 class="notice-title">' . __( 'Update Incompatible' ) . '</h3><p><# if ( ! data.updateResponse.compatibleWP && ! data.updateResponse.compatiblePHP ) { #>';

$update_incompatible .= sprintf(

$update_incompatible = '<h3 class="notice-title">' . __( 'Update Incompatible' ) . '</h3><p><# if ( ! data.updateResponse.compatibleWP && ! data.updateResponse.compatiblePHP ) { #>';

$update_incompatible .= sprintf(

costdev · 2023-10-09T03:31:31Z

src/wp-admin/includes/theme.php

+								);
+								$update_incompatible .= wp_update_php_annotation( '</p><p><em>', '</em>', false );
+							}
+							$update_incompatible .= '<# } else if ( ! data.updateResponse.compatibleWP ) { #>'


Suggested change

$update_incompatible .= '<# } else if ( ! data.updateResponse.compatibleWP ) { #>'

$update_incompatible .= '<# } else if ( ! data.updateResponse.compatibleWP ) { #>';

And you would've gotten away with it too, if it hadn't been for that pesky semi-colon!

github-actions · 2024-03-04T22:42:38Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props joedolson, costdev.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2024-03-04T22:57:11Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

costdev reviewed Sep 16, 2023

View reviewed changes

src/wp-admin/includes/theme-install.php Outdated Show resolved Hide resolved

costdev reviewed Sep 16, 2023

View reviewed changes

src/wp-admin/theme-install.php Outdated Show resolved Hide resolved

costdev reviewed Sep 16, 2023

View reviewed changes

src/wp-admin/theme-install.php Outdated Show resolved Hide resolved

joedolson and others added 9 commits September 17, 2023 12:04

Merge branch 'WordPress:trunk' into 57791-jstemplates

356daff

Compat template needs a p wrap; add blank line

71435d7

Update src/wp-admin/includes/theme-install.php

81afa26

Co-authored-by: Colin Stewart <79332690+costdev@users.noreply.github.com>

Merge branch 'WordPress:trunk' into 57791-jstemplates

13df9fe

Merge branch 'WordPress:trunk' into 57791-jstemplates

a46e147

Include more JS templates into wp_admin_notice

b2f22bd

Merge branch '57791-jstemplates' of https://github.com/joedolson/word…

3e8cb54

…press-develop into 57791-jstemplates

CS

191191d

More complex notices

f2524a8

costdev reviewed Oct 9, 2023

View reviewed changes

Merge branch 'WordPress:trunk' into 57791-jstemplates

aac980b

joedolson closed this by deleting the head repository Mar 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Try applying notice classes with JS templates #5225

Try applying notice classes with JS templates #5225

joedolson commented Sep 15, 2023

costdev left a comment

costdev Oct 9, 2023

costdev Oct 9, 2023

costdev Oct 9, 2023

costdev Oct 9, 2023

costdev Oct 9, 2023

costdev Oct 9, 2023

costdev Oct 9, 2023

costdev Oct 9, 2023

github-actions bot commented Mar 4, 2024

github-actions bot commented Mar 4, 2024

		'type' => 'warning',
		'additional_classes' => array( 'update-message', 'inline', 'notice-alt' ),

		$update_incompatible = '<h3 class="notice-title">' . __( 'Update Incompatible' ) . '</h3><p><# if ( ! data.updateResponse.compatibleWP && ! data.updateResponse.compatiblePHP ) { #>';
		$update_incompatible .= sprintf(

	$update_incompatible .= '<# } else if ( ! data.updateResponse.compatibleWP ) { #>'
	$update_incompatible .= '<# } else if ( ! data.updateResponse.compatibleWP ) { #>';

Try applying notice classes with JS templates #5225

Try applying notice classes with JS templates #5225

Conversation

joedolson commented Sep 15, 2023

costdev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 4, 2024

github-actions bot commented Mar 4, 2024

Test using WordPress Playground

Some things to be aware of