Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ras-acc): update newsletters palette on theme primary color updates #3083

Merged
merged 8 commits into from
May 20, 2024
Merged

feat(ras-acc): update newsletters palette on theme primary color updates #3083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c2a4362
fix: update newsletter palette before creating/updating templates
chickenn00dle Apr 23, 2024
43ec4f8
fix: update markup for social icons
chickenn00dle Apr 23, 2024
70e3b3b
fix: apply social icon editor styles
chickenn00dle Apr 23, 2024
aa0b99a
fix: apply social icon color to all email templates
chickenn00dle Apr 25, 2024
d66a7da
fix: trigger color palette update in rendered email html too
dkoo May 15, 2024
5b99e69
fix: phpunit tests
chickenn00dle May 15, 2024
75bb2ad
fix: account for child themes
chickenn00dle May 16, 2024
e898500
fix: remove references to secondary text color
chickenn00dle May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 54 additions & 21 deletions includes/emails/class-emails.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static function init() {
add_action( 'enqueue_block_editor_assets', [ __CLASS__, 'enqueue_block_editor_assets' ] );
add_filter( 'newspack_newsletters_email_editor_cpts', [ __CLASS__, 'register_email_cpt_with_email_editor' ] );
add_filter( 'newspack_newsletters_allowed_editor_actions', [ __CLASS__, 'register_scripts_enqueue_with_email_editor' ] );
add_action( 'update_option_theme_mods_' . get_template(), [ __CLASS__, 'maybe_update_email_templates' ], 10, 2 );
add_action( 'update_option_theme_mods_' . ( wp_get_theme()->parent() ? get_stylesheet() : get_template() ), [ __CLASS__, 'maybe_update_email_templates' ], 10, 2 );
add_action( 'admin_head', [ __CLASS__, 'inject_dynamic_email_template_styles' ] );
}

Expand Down Expand Up @@ -488,6 +488,17 @@ public static function get_email_config_by_type( $type ) {
/** Only attempt to create the email post if wp-includes/pluggable.php is loaded. */
return false;
} else {
// Make sure newsletters color palette is updated with latest theme colors.
if ( self::supports_emails() && method_exists( '\Newspack_Newsletters', 'update_color_palette' ) ) {
$theme_colors = newspack_get_theme_colors();
\Newspack_Newsletters::update_color_palette(
[
'primary' => $theme_colors['primary_color'],
'primary-text' => $theme_colors['primary_text_color'],
]
);
}

$email_post_data = self::load_email_template( $type );
if ( ! $email_post_data ) {
Logger::error( 'Error: could not retrieve template for type: ' . $type );
Expand Down Expand Up @@ -630,12 +641,30 @@ public static function get_password_reset_url( $user, $key ) {
* @return void
*/
public static function maybe_update_email_templates( $previous_value, $updated_value ) {
// Do nothing if newsletters is not active.
if ( ! self::supports_emails() ) {
return;
}

// Check for theme mod color settings in case a non-newspack theme is installed.
if ( ! isset( $previous_value['primary_color_hex'], $previous_value['secondary_color_hex'], $updated_value['primary_color_hex'], $updated_value['secondary_color_hex'] ) ) {
if ( ! isset( $previous_value['primary_color_hex'], $updated_value['primary_color_hex'] ) ) {
return;
}

if ( $previous_value['primary_color_hex'] !== $updated_value['primary_color_hex'] || $previous_value['secondary_color_hex'] !== $updated_value['secondary_color_hex'] ) {
if ( $previous_value['primary_color_hex'] !== $updated_value['primary_color_hex'] ) {
// Update the newsletters color palette.
$updated = \Newspack_Newsletters::update_color_palette(
[
'primary' => $updated_value['primary_color_hex'],
'primary-text' => newspack_get_color_contrast( $updated_value['primary_color_hex'] ),
]
);

if ( ! $updated ) {
Logger::error( 'There was an error updating the newsletters color palette.' );
}

// Trigger an update of all email templates to regenerate HTML.
$templates = get_posts(
[
'post_type' => self::POST_TYPE,
Expand All @@ -645,26 +674,22 @@ public static function maybe_update_email_templates( $previous_value, $updated_v
);

foreach ( $templates as $template ) {
wp_update_post( [ 'ID' => $template->ID ] );
}

if ( class_exists( 'Newspack_Newsletters' ) ) {
// Update newsletters color palette option so emails reflect the new colors.
$request = new \WP_REST_Request( 'POST', '/newspack-newsletters/v1/color-palette' );
$request->set_body(
wp_json_encode(
[
'primary' => $updated_value['primary_color_hex'],
'primary-text' => newspack_get_color_contrast( $updated_value['primary_color_hex'] ),
]
)
// Find/replace the old hex values with the new ones in the rendered email HTML.
$email_html = get_post_meta( $template->ID, \Newspack_Newsletters::EMAIL_HTML_META, true );
$email_html = str_replace(
[
$previous_value['primary_color_hex'],
newspack_get_color_contrast( $previous_value['primary_color_hex'] ),
],
[
$updated_value['primary_color_hex'],
newspack_get_color_contrast( $updated_value['primary_color_hex'] ),
],
$email_html
);
update_post_meta( $template->ID, \Newspack_Newsletters::EMAIL_HTML_META, $email_html );

$response = rest_do_request( $request );

if ( $response->is_error() ) {
Logger::error( 'Error updating newsletters color palette: ' . $response->as_error()->get_error_message() );
}
wp_update_post( [ 'ID' => $template->ID ] );
}
}
}
Expand All @@ -687,6 +712,14 @@ public static function inject_dynamic_email_template_styles() {
.<?php echo esc_html( self::POST_TYPE ); ?>-has-primary-text-color a {
color: <?php echo esc_attr( $primary_text_color ); ?> !important;
}

.is-style-filled-primary-text li {
background: transparent !important;
}

.is-style-filled-primary-text li svg {
color: <?php echo esc_attr( $primary_text_color ); ?> !important;
}
</style>
<?php
}
Expand Down
2 changes: 1 addition & 1 deletion includes/util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ function newspack_get_social_markup( $color = 'white' ) {
$cm = Configuration_Managers::configuration_manager_class_for_plugin_slug( 'wordpress_seo' );
$social_urls = [];
$markup = [
'block_markup' => '<!-- wp:social-links {"iconColor":"primary-text","iconColorValue":"primary-text","layout":{"type":"flex","flexWrap":"nowrap"}} --><ul class="wp-block-social-links has-icon-color">',
'block_markup' => '<!-- wp:social-links {"iconColor":"primary-text","iconColorValue":"primary-text","className":"is-style-filled-primary-text","layout":{"type":"flex","flexWrap":"nowrap"}} --><ul class="wp-block-social-links has-icon-color is-style-filled-primary-text">',
'html_markup' => '',
];

Expand Down