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

Inject "Add New Theme" button on Theme screen for simple sites #40941

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

ryelle
Copy link
Member

@ryelle ryelle commented Jan 9, 2025

This PR adds the same "Add New Theme" button that appears on core WordPress sites to simple wpcom sites. Currently, I have it directing to the Calypso Theme Showcase, as https://yoursite.wordpress.com/wp-admin/theme-install.php does not work for simple sites. If/when the theme showcase is moved to a wp-admin page, this can be replaced with the core URL.

Fixes Automattic/wp-calypso#96393

Screenshots

Note that when a site has the "classic" dashboard mode selected, this banner appears on the theme screen with the "Explore" button, which also leads to the Theme Showcase.

Before After

On simple sites the calypso dashboard mode, if you go directly to the wp-admin/themes.php page, you don't get the banner. But this still adds the button.

Before After

Atomic sites already have the button, no change needed here.

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)?

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

I don't think this applies, but I did tweak the URL target for the button, to https://wordpress.com/themes/$site_slug?ref=wpcom-themes-add — same format as the banner, but a new ref. I'm not familiar with whatever we use to track now to know if that needs to be set up somewhere else.

Testing instructions:

  1. Use a simple site with the "Classic" dashboard mode; or go directly to site.wordpress.com/wp-admin/themes.php
  2. Go to Appearance > Themes
  3. You should see the page title Themes, and next to that is the "Add New Theme" button
  4. Clicking that will take you to the theme showcase, allowing you to select a new theme

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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 add/themes-add-new-button 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-mu-wpcom-plugin add/themes-add-new-button
    

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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!


Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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


Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 9, 2025
@ryelle ryelle self-assigned this Jan 9, 2025
'addNewLabel' => esc_html__( 'Add New Theme', 'jetpack-mu-wpcom' ),
'addNewUrl' => esc_url( "https://wordpress.com/themes/$site_slug?ref=wpcom-themes-add" ),
)
);
Copy link
Member Author

@ryelle ryelle Jan 9, 2025

Choose a reason for hiding this comment

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

This seemed like the easiest place to add this, but perhaps the containing function name should be changed? (from wpcom_themes_remove_wpcom_actions)

@ryelle ryelle added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Jan 9, 2025
@ryelle ryelle marked this pull request as ready for review January 9, 2025 21:34
@ryelle ryelle removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] In Progress labels Jan 9, 2025
@scruffian
Copy link
Member

Thanks for this. I have two questions:

  1. Why you do this in Jetpack rather than on wpcom?
  2. Why use a JS solution rather than modifying themes.php directly?

@ryelle
Copy link
Member Author

ryelle commented Jan 10, 2025

Why you do this in Jetpack rather than on wpcom?

This is in the mu-plugin that jetpack builds into wpcom. There was already other theme-related code here. If there's a better place for it I'm happy to move it.

Why use a JS solution

I didn't use a PHP solution because there are no hooks into the page title area. The JS solution gets the button right where it needs to go.

rather than modifying themes.php directly?

Is there a process for modifying core files on wpcom?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[mu wpcom Feature] Wpcom Themes [Package] Jetpack mu wpcom WordPress.com Features [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Wpcomsh [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing "Install New Theme" Button on Simple Classic Sites
2 participants