Fix conflict by disabling Yoast initialization on Divi preview

[renatho]

Fixes temporarily #6112

Changes proposed in this Pull Request

• In order to fix the conflict between Learning Mode + Divi + Yoast, this PR disables the Yoast initialization when it's running the Divi preview in the editor.
• It's important to mention that I didn't find the root cause of the issue yet, but since this solution is probably safe I decided to stop investing much more time in that. I don't think a user would want to optimize the SEO in the Divi preview in the editor - unless there's any other implication that I didn't realize.

My findings from the investigation

• \add_action( 'wpseo_head', [ $this, 'present_head' ], -9999 ); in Yoast will make it call the get_the_excerpt (Post_Helper::get_the_excerpt). If we don't call the get_the_excerpt there, the problem doesn't happen.
• There's also a method in Divi that I suspect a little, but I couldn't figure out too much from that. The method is ET_Builder_Element::reset_element_indexes. It seems it tries to fix something related to the_content recursions. And my suspicious is that it has something related to the problem because with the Learning Mode we make some nested the_content calls in Sensei\Blocks\Course_Theme\Course_Content::render_content.

Testing instructions

• See the issue details, and make sure you can reproduce it using the trunk.
• Check that running the code from this branch the problem doesn't happen anymore.

[renatho]

The ideal would be to also have a check to run it only in lessons with Learning Mode, but it's too early to check this.

[codecov]

Codecov Report

Merging #6342 (86d4422) into trunk (f55d8f2) will increase coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              trunk    #6342   +/-   ##
=========================================
  Coverage     45.97%   45.97%           
  Complexity     9546     9546           
=========================================
  Files           459      459           
  Lines         33831    33829    -2     
  Branches        275      275           
=========================================
  Hits          15553    15553           
+ Misses        18073    18071    -2     
  Partials        205      205           

Impacted Files	Coverage Δ
includes/class-sensei-posttypes.php	11.18% <0.00%> (+0.04%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 52e6a6d...86d4422. Read the comment docs.

[jom]

This fixes the described issue. I wonder if after this is merged we should transfer your notes to a new issue. It makes sense to me to merge this now, but we should probably prioritize finding a less blunt solution.

[jom]

Actually, I just had a thought. This allows non-authenticated users to prevent loading Yoast from any request. It seems a bit too powerful. Is there a way we can restrict it just to the required request?

[renatho]

Actually, I just had a thought. This allows non-authenticated users to prevent loading Yoast from any request. It seems a bit too powerful. Is there a way we can restrict it just to the required request?

Hi Jake! Thank you for your review! That's a great point! Since it's in the plugins_loaded hook, we don't have too much information to check, but I think the extra check I added is enough: eea3a40. It will check if the request is coming from the admin. WDYT?

we should probably prioritize finding a less blunt solution.

Totally agree! For now, I just added this comment to the original issue, changing it to low priority. So we can keep all the history of this issue in the same issue. Does it make sense?

[renatho]

@jom, I checked that we could check the user roles (edit_lessons, for example) in the plugins_loaded, but based on your idea, I sent another commit here changing the hook and removing all actions from wpseo_head: 932fc83. So we check if they can edit specifically that post.

Update: I also added another check to remove the action only when it's a lesson with learning mode enabled. 86d4422

[jom]

Looks great! Thanks for picking this one up. 🪂