Try: Add synced patterns to theme on save

[mikachan]

This PR explores the most minimal way we can introduce some pattern management into the plugin by allowing custom patterns to be saved to the theme filesystem on save, allowing them to be exported with the theme.

Part of #287.

Testing Instructions

1. Create a new synced pattern in the Editor (also try adding categories)
2. Go to the Editor, and in the Create Block Theme menu, save the theme changes with the "Save My Patterns" option checked

[eirichmond]

@mikachan Great job on this! Initial testing works well. I know it's a work in progress, but I wondered why the Inserter was set to 'no' in the pattern header. Once saved and exported, the pattern still doesn't come from the theme/patterns folder; it remains in the database. I guess there is logic behind that. For me, if I'm developing a theme, I wouldn't want anything left in the database after saving and exporting the patterns. I think there might be some thinking behind synced patterns, but as a developer creating patterns as part of the theme, I'd want them not to be restricted and synced. I'd prefer the theme to be distributed to users who could then decide to generate their own synced patterns from the ones provided by the theme, if that makes sense.

Also, I think the heredoc approach might be more readable for generating the header. This allows you to include the variables directly within the string without needing to concatenate multiple parts.

Again, I know this is a work in progress, so I guess any image-related details (e.g., downloaded to the theme assets/images and changing the reference to get_theme_file_uri('xxxx'), etc.) haven't been addressed yet. I'd love to contribute to this with my own pull request if it helps. Great job 🥳

[eirichmond]

In hindsight, I guess the reasoning for not removing them from the database is to preserve synced patterns that have already been placed throughout the site. It would be really useful if there was a flag saved within postmeta indicating whether a pattern was already synced. This could then be used to avoid removing the pattern when the theme is saved and the patterns are exported.

[mikachan]

It would be really useful if there was a flag saved within postmeta indicating whether a pattern was already synced.

It looks like the sync status is saved in postmeta under wp_pattern_sync_status, and you're able to access it using:

get_post_meta( $pattern->id, 'wp_pattern_sync_status', true );

[mikachan]

I've updated this PR with the changes from @eirichmond's PR (#693), refactored a couple of things and added some error handling. I think this is ready for review 🤞

[jffng]

This is testing pretty well for me, nice work! I was able to save custom patterns and it exported with the theme.

[mikachan]

Thanks for the feedback @jffng and @colorful-tones! This should be ready for another review.

[colorful-tones]

I'm confused about something in my testing. I created a synced pattern, then assigned it to a template, and then went into CBT and checked only the 'Save Synced Patterns' thinking that the template would also be saved, because of this overall statement: "Any synced patterns created in the Editor will be moved to the theme. Note that this will delete all synced patterns from the Editor and any references in templates will be made relative to the theme."

However, after hitting the 'Save Changes' from CBT I only see my new pattern in the patterns directory and the template has no changes at all, which makes me think the statement is a bit misleading. I imagine I would want to check the "Save Template Changes" box too, but the "any references in templates will be made relative to the theme." next to the "Save Synced Patterns" implied to me that my template changes would be saved too. 🤔

Also, after saving patterns to the theme when I go back to the template it states: "Block has been deleted or is unavailable."

[mikachan]

Thanks @colorful-tones! I've pushed an update that will update any templates that reference the pattern and save those changes to the theme, regardless of whether the "Save Template Changes" option is checked. I think that matches up with the expectations in the "Save Sycned Patterns" description. This should also fix the "Block has been deleted or is unavailable." issue.

[colorful-tones]

@mikachan I did a bunch of testing and everything is working. Nice work!

I think this functionality will help folks with creating and saving their patterns.

[colorful-tones]

LGTM! I think this functionality will be super helpful.

[mikachan]

Thanks so much for reviewing, @colorful-tones!