Skip to content

[HelpHub] Clarify theme ZIP file structure for updates #2514

Open

Description

@mrleemon

The current documentation (https://wordpress.org/documentation/article/work-with-themes/#adding-new-themes-using-the-administration-screens and https://learn.wordpress.org/lesson/updating-your-theme/) implicitly assumes that a theme's ZIP file will contain a single root folder and that all theme files will reside within that folder. This is a common and well-known best practice among experienced developers. However, it is not explicitly stated as a hard requirement (or I'm unable to find this requirement in the docs).

This lack of explicit documentation can lead to a specific bug, as demonstrated in the Trac ticket https://core.trac.wordpress.org/ticket/63737. When a user attempts to update a theme via ZIP upload, if the theme's files are at the root of the ZIP archive (instead of being inside a containing folder), a previous failed update attempt (e.g., trying to upload the theme ZIP through the plugin installer) can cause subsequent, correct update attempts to fail. WordPress, in this scenario, creates a new directory (e.g., my-theme-1) instead of overwriting the existing theme folder, breaking the update process.

Proposed Change:
Add a new, clear, and prominent section to the relevant documentation that explicitly states the correct ZIP file structure for themes. This should be added to both developer-facing and user-facing documentation.

Activity

  1. github-actions commented on Sep 29, 2026

    @github-actions

    Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

  2. mdtareqmiah commented on Oct 5, 2026

    @mdtareqmiah

    Hi! I'd like to work on this issue as my first contribution to the WordPress Documentation Team. I'm looking forward to learning and contributing!

  3. andreawetzel commented on Oct 8, 2026

    @andreawetzel
    Collaborator

    Hi! I'd like to work on this issue as my first contribution to the WordPress Documentation Team. I'm looking forward to learning and contributing!

    @mdtareqmiah Thank you for contributing. Please visit the Docs team page for onboarding information.

    To help with this ticket specifically, you could propose changes directly in this Github issue or by linking to a Google Doc, then a member of the Docs team who has edit access can review and make changes to the article.

  4. changed the title [-]Clarify theme ZIP file structure for updates[/-] [+][HelpHub] Clarify theme ZIP file structure for updates[/+] on Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions