Extract pattern metadata (title & description)

[oandregal]

In WordPress/gutenberg#36751 Gutenberg added the ability to automatically register patterns that live in the /patterns directory. These patterns provide metadata via headers in the PHP file as in:

<?php
/**
 * Title: My heading
 * Description: My pattern description.
 * Slug: my-theme/my-heading
 * Categories: text
 */

From the existing metadata, we need the Title to be translatable. This PR adds support for looking up those patterns and extracting the Title string into the pot file.

How to test

• Pull this PR and create a foo-theme directory at the top-level, which contains the following files:

style.css with at least these contents:

/*
Theme Name: foo theme
*/

patterns/my-pattern.php with at least these contents:

<?php

/**
 * Title: My pattern title.
 * Description: My pattern description.
 */

• Execute

composer install
vendor/bin/wp i18n make-pot foo-theme

• Verify that a new foo-theme/foo-theme.pot file has been generated and that contains the pattern title and the theme name. You should get something along these lines:

# some other file header metadata

#. Theme Name of the theme
msgid "foo theme"
msgstr ""

#: patterns/my-pattern.php
msgctxt "Pattern title"
msgid "My pattern title."
msgstr ""

#: patterns/my-pattern.php
msgctxt "Pattern description"
msgid "My pattern description."
msgstr ""

[swissspidy]

From the existing metadata, we need the Title to be translatable

For this to be actually useful, Gutenberg should also actually translate the title. I don't see any $pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Title of the pattern' ); call in WordPress/gutenberg#36751

[oandregal]

For this to be actually useful, Gutenberg should also actually translate the title. I don't see any $pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Title of the pattern' );

Yeah, I need to follow-up with that as well :)

[oandregal]

I've prepared the Gutenberg PR that uses this data at WordPress/gutenberg#40047 but I'm having some trouble to get the translated strings.

[swissspidy]

Pending some tests this looks good to go! 👍

[oandregal]

Pending some tests this looks good to go! +1

Tests would need to wait until tomorrow morning :)

[oandregal]

@swissspidy pushed the test.

[swissspidy]

LGTM

Just one nit

[ocean90]

@swissspidy Do you know why this hardcodes patterns here? Since these are PHP files they should be included by default. Now you explicitly have to exclude the patterns when you for example are using --include=wp-admin/*. to only include wp-admin strings.

Related: https://meta.trac.wordpress.org/changeset/11809

[swissspidy]

I suppose the idea was to make this more efficient and only scan these files when needed.

But you're right that this is already covered by the call above. I'll create a PHP to combine these.

[swissspidy]

#320