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.

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

Avoid early call to wptexturize #40

Merged
merged 2 commits into from
Mar 7, 2024
Merged

Avoid early call to wptexturize #40

merged 2 commits into from
Mar 7, 2024

Conversation

Biont
Copy link
Member

@Biont Biont commented Mar 7, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Bug fix

What is the current behavior? (You can also link to an open issue here)

In PluginProperties, we call get_plugin_data().
With default parameters, this triggers a call to wptexturize() which can result in wrong quotes being used throughout the entire website if called too early. There is a TRAC ticket for this here:
https://core.trac.wordpress.org/ticket/49965

What is the new behavior (if this is a feature change)?
We pass $markup=false in order to skip HTML generation - and with it the call to wptexturize

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
If you have previously relied on $data['PluginURI'] and $data['AuthorURI'] to be wrapped in <a> tags, then this needs to be added manualls now.
On the flipside, we actually receive the raw data now which might be preferrable withing the service resolution environment int's intended for.

Other information:
I am aware that we are not solving the issue here. We're just pushing it away a bit.
At the same time, hooking modularity in plugins_loaded (or a similar, very early stage) is a very common thing to do.
This means that a huge chunk of our work based on modularity may expose this bug to client systems and this is an effort to stay on the safe side without causing too much noise.

Signed-off-by: Moritz Meißelbach <[email protected]>
@Biont Biont requested a review from gmazzap March 7, 2024 12:59
Copy link

codecov bot commented Mar 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.86%. Comparing base (a9e3803) to head (3a49976).

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #40   +/-   ##
=========================================
  Coverage     98.86%   98.86%           
  Complexity      189      189           
=========================================
  Files             9        9           
  Lines           528      528           
=========================================
  Hits            522      522           
  Misses            6        6           
Flag Coverage Δ
unittests 98.86% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Moritz Meißelbach <[email protected]>
@gmazzap gmazzap requested a review from Chrico March 7, 2024 13:42
Copy link
Member

@Chrico Chrico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 💪🏻 Good catch!

@Chrico Chrico merged commit df169cb into master Mar 7, 2024
66 checks passed
@Chrico Chrico deleted the Biont-patch-1 branch March 7, 2024 13:44
@Chrico Chrico mentioned this pull request Nov 22, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants