⚠️ Load later for i18n (Enhance i18n of attendees-email...) #752

carstingaxion · 2024-08-01T12:06:29Z

Description of the Change

Originally planned to only close #651, some additional findings are solved with this PR, too:

Load users locale before sending emails (the first task or better rabbit hole)
Make sure translation files are loaded properly.
This is important for users who selected a different from the sites default language.
Set html language attributes correctly for the email
Conditionally render the featured image in the email, only if it is set.
Set the current user to the actual member to mail to, to make sure the GatherPress filters for date- and time- format, as well as the users timezone, are recognized by the functions inside render_template().
Bug fix: Keep slashes in user-defined date- and time-formats

How to test the Change

Testing this PR might be a little tricky and is not possible with WordPress Playground because of the necessary sending & receiving of emails.

Preparation to test:

Setup at least two different users
One of the users creates an event, the other users attends. (This will make sure, 2 emails are sent for the test)
Assign a non-site-default language to one of the users in their profile.php
Go to Updates, get to the bottom of the page and hit the "Update translations" button.
Make sure that in the following screen, the translation files for the selected non-site-default language gets downloaded!

Testing this PR:

Edit the newly created event
Compose a message via Email
Send email
Check the results, one email should follow the user-defined language, while the other is sent in the default locale

Changelog Entry

Fix sending localised emails

Credits

Props @carstingaxion

Checklist:

I agree to follow this project's Code of Conduct.
I have updated the documentation accordingly.
I have added tests to cover my change.
All new and existing tests pass.

This is important for users how selected a different from the sites default language.

what-the-diff · 2024-08-01T12:06:53Z

PR Summary

Adjusted gatherpress.php File
The unnecessary Domain Path comment has been eliminated for cleaner code.
Enhanced class-rest-api.php File
Eliminated some previously commented code used for generating email subject and body. Introduced new logic to switch languages or 'locales' more efficiently during email dissemination. The system will now restore the original language setting after mailing.
Refined class-setup.php File
Integrated a new hook that will help load the plugin's language package or 'textdomain', increasing flexibility in managing plugin translations.
Amended event-email.php File
We've taken out the HTML 'lang' attribute for greater code conciseness. We also introduced a new variable, $gatherpress_event_image, to store the event image URL for better manageability. Moreover, the event image display in the email template has been improved upon with this update. The language_attributes() function has been added to the HTML tag to incorporate language information, enhancing web accessibility. Finally, we've modernized the way the event title presents itself in the email template for better aesthetics.

…e GatherPress filters for date- and time- format, as well as the users timezone, are recognized by the functions inside render_template().

includes/core/classes/class-setup.php

carstingaxion · 2024-08-25T20:39:11Z

Ok, found the problem:

In the gatherpress timeformat settings, \ are ok and allowed.

While within the profile.php, they are not and get stripped off on save.

includes/core/classes/class-setup.php

includes/templates/admin/emails/event-email.php

includes/core/classes/class-setup.php

swissspidy · 2024-08-26T09:25:29Z

includes/core/classes/class-setup.php

+	 * A call to load_plugin_textdomain() is ABSOLUTELY NEEDED to properly load all translation files
+	 * for users who chosed another than the sites default language in their /profile.php.
+	 */
+	public function load_gatherpress_textdomain() {


You really don't need this. It's pointless and only has downsides. And saying "A call to load_plugin_textdomain() is ABSOLUTELY NEEDED" is purely WRONG.

The just-in-time translation loading in WordPress handles everything for you and only loads the translations when needed.

Hmm... a little bit strange.

I absolutely trust you in translation stuff, because I know you have been advocating and coding a lot for that topic.

From my long doc-comment you can imagine that I read & tried a lot to come up with my solution and the UPPERCASE comment. But unfortunately I can not make this work, without that line of code. Or maybe I have the wrong expectations.

How to test

Set site language to English in wp-admin/options-general.php

Set user prefered language to German in wp-admin/profile.php

Comment out load_plugin_textdomain( 'gatherpress', false, false )

Check that the Admin-UI is German now, except everything GatherPress

Re-Enable load_plugin_textdomain( 'gatherpress', false, false )

Check that the Admin-UI is German now, including everything GatherPress

The issue is that you are triggering just-in-time translation loading too early.

WordPress tries to load the translations automatically as soon as you call __(). In your case, this happens somewhere before the current user is loaded, thus the admin won't be in German.

With this manual load_plugin_textdomain() call you're just papering over this issue, causing WP to try to load the translations twice.

The proper fix is to initialize your plugin later. This in the main plugin file works:

add_action( 'plugins_loaded', static function () { // Initialize setups. GatherPress\Core\Setup::get_instance(); } ); // Or simply: add_action( 'plugins_loaded', array( '\GatherPress\Core\Setup', 'get_instance' ) );

Ok, thank you very much Pascal, once again your explanation is better than any docs (I know) about that.

I followed your advise:

Set add_action( 'plugins_loaded', array( '\GatherPress\Core\Setup', 'get_instance' ));

Disabled my attempt // add_action( 'init', array( $this, 'load_gatherpress_textdomain' ), 0 );

And started looking for the anoying bug again

and was able to track it down until Assets->localize(), which calls
'timezoneChoices' => Utility::timezone_choices(), and seems to be the culprit. Disabling this line brings all translations back into shape; having this enabled messes things up.

Going on ...

Hello @mauteri ,

do we really need all possible timezones

in the frontend markup?

in the backend markup?

on every page load?

https://github.com/carstingaxion/gatherpress/blob/02358ab60318a7464e31865ffea0f3bb8c961809/includes/core/classes/class-assets.php#L306

Isn't Assets::localize() only called in Assets::add_global_object() which is hooked to wp_head? So that should be late enough.

Aside: just adding a script tag like this is usually not a good idea. You should at least use wp_print_inline_script_tag. Even better, attach it to a specific script with wp_add_inline_script.

Bildschirmaufzeichnung.vom.05.09.2024.16.08.52.mp4

Found it: 🎉

$timezones_raw = explode( PHP_EOL, wp_timezone_choice( 'UTC', get_user_locale() ) ); // i18n FIX!

As expected, a change like to the load order will break things. At least the unit tests.

Thanks for taking the time again @swissspidy !

Isn't Assets::localize() only called in Assets::add_global_object() which is hooked to wp_head? So that should be late enough.

And on admin_print_scripts, which is the problematic trace.

Aside: just adding a script tag like this is usually not a good idea. You should at least use wp_print_inline_script_tag. Even better, attach it to a specific script with wp_add_inline_script.

👍 I wanted to suggest the same, even that the relevant data - the timezones, in this case - are only used for the Event Date Block (#684)

swissspidy · 2024-08-26T09:28:28Z

includes/core/classes/class-rest-api.php

+				/* translators: %s: event title. */
+				$subject = sprintf( __( '📅 %s', 'gatherpress' ), get_the_title( $post_id ) );


This would benefit from additional context for translators (e.g. _x( '📅 %s', 'email subject', 'gatherpress' )).

Also worth noting that this is not really useful for translators. What would you even translate here? It's just a placeholder and an emoji.

I made an issue out of your idea: #827

and will add the context.

…self is loaded on 10.

github-actions · 2024-09-05T20:26:02Z

Preview changes with Playground

You can preview the least recent changes for PR#752 by following one of the links below:

⚠️ Note: The preview sites are created using WordPress Playground. You can add content, edit settings, and test the themes as you would on a real site, but please note that changes are not saved between sessions.

carstingaxion added 4 commits August 1, 2024 13:48

Make sure translation files are loaded properly.

67c5ff7

This is important for users how selected a different from the sites default language.

Load users locale before sending emails & reset afterwards

ba03e38

Set html language attributes correctly for the email

4fec728

Conditionally render the featured image in the email, only if it is set.

da57071

Set the current user to the actual member to mail to, to make sure th…

eb20906

…e GatherPress filters for date- and time- format, as well as the users timezone, are recognized by the functions inside render_template().

carstingaxion commented Aug 1, 2024

View reviewed changes

includes/core/classes/class-setup.php Outdated Show resolved Hide resolved

carstingaxion added 5 commits August 1, 2024 17:50

Fix CS

6ffc797

Do not rely on /languages folder in favor of translate.wordpress.org

4d012cf

Fix whitespaces for CS

65905e8

Add doc-comment desc

8867db1

fulfilling 1001 wishes for the CS check action

bd0fdb7

carstingaxion changed the title ~~Fix/651~~ Enhance i18n of attendees-email & minor fixes Aug 1, 2024

carstingaxion closed this Aug 13, 2024

carstingaxion deleted the fix/651 branch August 13, 2024 20:11

carstingaxion restored the fix/651 branch August 14, 2024 14:34

carstingaxion reopened this Aug 14, 2024

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

Keep slashes in user-defined date- and time-format strings

02358ab

carstingaxion marked this pull request as ready for review August 25, 2024 21:18

mauteri requested changes Aug 25, 2024

View reviewed changes

includes/core/classes/class-setup.php Outdated Show resolved Hide resolved

includes/templates/admin/emails/event-email.php Show resolved Hide resolved

carstingaxion commented Aug 26, 2024

View reviewed changes

includes/core/classes/class-setup.php Outdated Show resolved Hide resolved

swissspidy reviewed Aug 26, 2024

View reviewed changes

This was referenced Aug 27, 2024

NEW workflow to Check if there are typos in the source code #824

Merged

Make email subject editable for each email #827

Open

carstingaxion added 2 commits September 5, 2024 16:26

Initialize all setups later, hook on 'plugins_loaded'

7e5aae7

Remove superflous load_plugin_textdomain() call

38c9f07

Fix i18n-loading problem, by providing a locale to wp_timezone_choice()

3b9a063

carstingaxion changed the title ~~Enhance i18n of attendees-email & minor fixes~~ ⚠️ Load later for i18n (Enhance i18n of attendees-email...) Sep 5, 2024

carstingaxion added 2 commits September 5, 2024 17:17

Require main-plugin-file to test on priority 9, because the plugin it…

3c2230a

…self is loaded on 10.

Move de-activation-hooks out of 'plugins_loaded'

41681fe

carstingaxion added a commit that referenced this pull request Sep 18, 2024

Run on plugins_loaded to help fix PR #752

c3d3384

carstingaxion mentioned this pull request Sep 18, 2024

Run on plugins_loaded to help fix PR #752 #884

Draft

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ Load later for i18n (Enhance i18n of attendees-email...) #752

⚠️ Load later for i18n (Enhance i18n of attendees-email...) #752

carstingaxion commented Aug 1, 2024 •

edited

Loading

what-the-diff bot commented Aug 1, 2024

This comment was marked as outdated.

This comment was marked as resolved.

carstingaxion commented Aug 25, 2024

swissspidy Aug 26, 2024

carstingaxion Aug 28, 2024 •

edited

Loading

swissspidy Aug 29, 2024

carstingaxion Sep 5, 2024

carstingaxion Sep 5, 2024

swissspidy Sep 5, 2024

carstingaxion Sep 5, 2024

carstingaxion Sep 5, 2024

carstingaxion Sep 5, 2024

carstingaxion Sep 5, 2024 •

edited

Loading

swissspidy Aug 26, 2024

carstingaxion Sep 5, 2024

github-actions bot commented Sep 5, 2024

		/* translators: %s: event title. */
		$subject = sprintf( __( '📅 %s', 'gatherpress' ), get_the_title( $post_id ) );

⚠️ Load later for i18n (Enhance i18n of attendees-email...) #752

Are you sure you want to change the base?

⚠️ Load later for i18n (Enhance i18n of attendees-email...) #752

Conversation

carstingaxion commented Aug 1, 2024 • edited Loading

Description of the Change

How to test the Change

Preparation to test:

Testing this PR:

Changelog Entry

Credits

Checklist:

what-the-diff bot commented Aug 1, 2024

PR Summary

This comment was marked as outdated.

This comment was marked as resolved.

carstingaxion commented Aug 25, 2024

Choose a reason for hiding this comment

carstingaxion Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

How to test

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

carstingaxion Sep 5, 2024 • edited Loading

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 Sep 5, 2024

Preview changes with Playground

carstingaxion commented Aug 1, 2024 •

edited

Loading

carstingaxion Aug 28, 2024 •

edited

Loading

carstingaxion Sep 5, 2024 •

edited

Loading