PHP lib docs: update to include information about prefixes in block PHP code

[ramonjd]

What?

Updates lib/README.md to include information about Gutenberg prefixes in block (hint: don't do it)
Motivation: https://github.com/WordPress/gutenberg/pull/54801/files#r1361396788

Why?

To make it clear that recommendations around plugin-specific prefixes/suffixes apply to PHP files in the /lib directory and not block PHP code.

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/README.md

[andrewserong]

Looking good, thanks for expanding on the docs here!

Just left a couple of minor comments, but nothing major 🙂

[andrewserong]

Is it worth mentioning that if blocks code needs to call gutenberg versions of core functions, there's a transformation that can be used in our webpack config, to ensure that in Gutenberg the GB version is called, where in core, the core version is called?

gutenberg/tools/webpack/blocks.js

Lines 25 to 36 in 00753a7

	/**
	* We need to automatically rename some functions when they are called inside block files,
	* but have been declared elsewhere. This way we can call Gutenberg override functions, but
	* the block will still call the core function when updates are back ported.
	*/
	const prefixFunctions = [
	'wp_apply_colors_support',
	'wp_enqueue_block_support_styles',
	'wp_get_typography_font_size_value',
	'wp_style_engine_get_styles',
	'wp_get_global_settings',
	];

It's also mentioned in this code comment:

gutenberg/tools/webpack/blocks.js

Lines 144 to 148 in 00753a7

	// Within content, search and prefix any function calls from
	// `prefixFunctions` list. This is needed because some functions
	// are called inside block files, but have been declared elsewhere.
	// So with the rename we can call Gutenberg override functions, but the
	// block will still call the core function when updates are back ported.

[ramonjd]

Good point. It would be good to surface that somewhere.

I also wanted to update block-library/README.md to stress the points raised in this PR.

I thought block-library/README.md might be more appropriate since it'd live and travel with that package (?)

[andrewserong]

I thought block-library/README.md might be more appropriate since it'd live and travel with that package (?)

Yep, that'd be a better place for it!

[ramonjd]

I should actually just bundle that with this PR

[andrewserong]

Either way — we can always include it in both places 🙂

[andrewserong]

LGTM as-is! ✨ Happy to proofread again if you wind up wanting to add the blocks changes to this PR 🙂

[ramonjd]

Happy to proofread again if you wind up wanting to add the blocks changes to this PR

Thanks for the help! I've quickly added a section about the webpack replace process in the block library README

[andrewserong]

Thanks for the help! I've quickly added a section about the webpack replace process in the block library README

Perfect, looks great to me! 🙇

[github-actions]

Flaky tests detected in 07b4aac.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6542161824
📝 Reported issues:

• [Flaky Test] should insert elements from multiple completers in a single block #47916 in /test/e2e/specs/editor/various/autocomplete-and-mentions.spec.js

[getdave]

Thank you for this 👏