Social Menu: Replacing SVG file inclusion method

[coder-karen]

Proposed changes:

• This PR removes usage of require_once in order to display SVG files, replacing it with file_get_contents which reads the SVG file as plain text and returns the value as a string.
• This affects three files: projects/plugins/jetpack/modules/theme-tools/social-icons.php, projects/plugins/jetpack/modules/theme-tools/social-menu/icon-functions.php and a newer file projects/packages/classic-theme-helper/src/social-menu/icon-functions.php which was a copy of the soon-to-be-removed Jetpack module file.

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

p9dueE-8ng-p2
See also PR no. 9 in the related internal repository.

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

• This PR has been reviewed code-wise internally, but still worth testing functionality:

Social Menus:

• Switch to a theme that already has support for jetpack-social-menu, Dara is a good example.
• Go to Appearance > Customize > Menus
• Create a new menu with some links, e.g. https://www.facebook.com/jetpackme/, https://x.com/jetpack and sms:0102030405
• Assign that menu to the Social Menu location
• Ensure the menu and menu icons display correctly

Social Icons Widget:

• Switch to a classic theme like the Twenty Ten.
• Install and activate the Classic Widgets plugin.
• Ensure 'extra widgets' are enabled from Jetpack > Settings > Writing
• Go to Appearance > Widgets, and then drag the Jetpack Social Icons widget to your sidebar.
• Add a few social networks to the widget's settings, such as those mentioned above.
• Save the changes and view the front-end of the site - the icons should display correctly.

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/svg-icon-inclusion-method branch.

  • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack update/svg-icon-inclusion-method
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/svg-icon-inclusion-method
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Choose a review path based on your changes:
   • A. Team Review: add the "[Status] Needs Team Review" label
     • For most changes, including minor cross-team impacts.
     • Example: Updating a team-specific component or a small change to a shared library.
   • B. Crew Review: add the "[Status] Needs Review" label
     • For significant changes to core functionality.
     • Example: Major updates to a shared library or complex features.
   • C. Both: Start with Team, then request Crew
     • For complex changes or when you need extra confidence.
     • Example: Refactor affecting multiple systems.
3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

---

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

• WordPress.com Simple releases happen daily.
• WoA releases happen weekly.
• Releases to self-hosted sites happen monthly. The next release is scheduled for September 3, 2024 (scheduled code freeze on September 2, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

[chrisbliss18]

Good work on these changes. The new approach is much better than the use of require_once. I appreciate the use of wp_kses as a precaution.

Thanks for the good work. Approved! :)