Skip to content

Clarify server requirements for .htaccess file editing #22249

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

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

JSCHLTE
Copy link

@JSCHLTE JSCHLTE commented May 8, 2025

Context

This PR updates the description for the SEO tools editor to better clarify when the .htaccess file can be edited. The original wording implied that just having the file is enough, but the editor is actually only available on certain server types (like Apache).


Summary

Changelog label: changelog: other

This PR can be summarized in the following changelog entry:

  • Clarifies that the .htaccess file can only be edited if the server supports it, such as Apache, not just based on the file's presence.

Relevant technical choices:

  • Updated the desc string in admin/pages/tools.php to clarify that server compatibility (not just file existence) determines access to the editor.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  1. Go to the SEO > Tools screen in the admin dashboard.
  2. Look for the SEO File Editor tool.
  3. Confirm the new description reads:

    This tool lets you edit important SEO-related files like robots.txt. Editing .htaccess is only available on servers that support it (e.g., Apache).

  4. Confirm the .htaccess editor still only appears when using Apache.
  5. Confirm there are no PHP or UI errors.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Not dependent on post types or custom editors
  • Does not vary by browser
  • Not applicable to multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

Impact check

This PR affects the Tools screen in the WordPress admin area. It does not change logic, only visible text, so regression risk is low.


UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR does not affect Shopify

Documentation

  • No new documentation needed — this is a UI clarification only

Quality assurance

  • I have tested this code to the best of my abilities.
  • I have verified the text renders correctly.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.

Fixes #12065

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[visuals] File editor wrongly states ability to edit .htaccess file
2 participants