Inconsistent use of blogname and sitename in Privacy emails

[desrosj]

In the core privacy email notifications, there is inconsistent use of get_option( 'blogname' ) and get_option( 'sitename' ).

In _wp_privacy_send_erasure_fulfillment_notification() and _wp_privacy_send_request_confirmation_notification(), the $email_data array has an index for sitename that is set to blog name. The subject is also set to blog name.

In wp_send_user_request(), the $email_data array has an index for site_name that is set to the site name if on multisite, and blog name for single sites. Further down in the function, the blog name is always used for the email subject.

The value used for these should be consistent across all privacy emails.

[subrataemfluence]

Proposed patch

[subrataemfluence]

Missed ENT_QUOTES. Fixed.

[flixos90]

I agree we should be consistent, my suggestion would be to use single-site terminology throughout. Even before the privacy-related changes in 4.9.6, there were inconsistencies, for example in send_confirmation_on_profile_email() which used the network name in one place, but the site name for another place, both affecting the same email.

Since all of this so far does not really support a multisite-context yet, I think it makes sense to only use site scope at this point. Once we move forward with network-wide privacy control, we can enhance it as needed (for example there could be a parameter $network_wide for those emails, or similar).

Last but not least, this context issue does not only affect the site name, but also the URL.

In 44396.2.diff​ I use get_option( 'blogname' ) and home_url() throughout (instead of get_site_option( 'site_name' ) and network_home_url() for the network). I also changed a variable name from $blogname to $sitename since we shouldn't be using the "blog" terminology any more, and that variable is being publicly exposed via a filter and its docs.

[desrosj]

Related: #43822, #43738.

[desrosj]

44396.3.diff​ has some minor updates to ensure get_option( 'blogname' ) is only called once per function, and that it is always passed through wp_specialchars_decode().

[flixos90]

In 43388:

Privacy: Use consistent values for the site name and URL used in notification emails.

The functions send_confirmation_on_profile_email(), _wp_privacy_send_request_confirmation_notification(), _wp_privacy_send_erasure_fulfillment_notification(), and wp_send_user_request() all include a title and URL indicating the current site. However, so far they have dealt with those values inconsistently, sometimes using the site values, other times using the network values if in a multisite. This changeset ensures that only the current site is taken into account in all cases and that special characters in the site name are consistently decoded.

Props subrataemfluence, desrosj.
Fixes #44396.

[flixos90]

This needs to be backported to 4.9.7.

[pento]

This is causing ​Travis failures.

[flixos90]

In 43390:

Tests: Fix failing test after [43388].

Fixes #44396.

[flixos90]

Both [43388] and [43390] need to be backported to 4.9.7.

[ocean90]

4.9.7 has been released, moving to next milestone.

[desrosj]

Noticed one more inconsistency in wp-admin/includes/file.php. The email linking to the user's personal data export file is sent in wp_privacy_send_personal_data_export_email(). 44396.4.diff​ has a fix for that.

[flixos90]

In 43435:

Privacy: Fix a further inconsistency of site name and URL usage in notification emails.

This is a follow-up to [43388].

Props desrosj.
Fixes #44396.

[flixos90]

[43388], [43390], and [43435] all need to be backported to 4.9.8.

[SergeyBiryukov]

In 43459:

Privacy: Use consistent values for the site name and URL used in notification emails.

The functions send_confirmation_on_profile_email(), _wp_privacy_send_request_confirmation_notification(), _wp_privacy_send_erasure_fulfillment_notification(), and wp_send_user_request() all include a title and URL indicating the current site. However, so far they have dealt with those values inconsistently, sometimes using the site values, other times using the network values if in a multisite. This changeset ensures that only the current site is taken into account in all cases and that special characters in the site name are consistently decoded.

Props subrataemfluence, desrosj.
Merges [43388], [43390], and [43435] to the 4.9 branch.
Fixes #44396.