Repository navigation
docs: document SCF namespace and API naming policy - #545
Open
faisalahammad wants to merge 1 commit into
Open
faisalahammad wants to merge 1 commit into
faisalahammad wants to merge 1 commit into
Conversation
Keep existing public ACF names stable and use SCF names for new code. This records the staged migration criteria from issue 150 without renaming the public API. Closes WordPress#150
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/concepts/namespace-migration.mdto record the naming policy for issue #150. The page keeps existing public ACF functions, hooks, classes, and constants stable, usesscf_andscf/for new code, and describes the staged migration criteria.It also documents the compatibility boundaries that have to be checked before any rename: plugin slug,
acf.phpandsecure-custom-fields.php, documented public APIs, internal implementation, and compatibility code. It covers the legacy mode tradeoffs from #92 and the requirement that security fixes stay in one common code path where possible.The page is linked from
docs/concepts/index.mdanddocs/contributing/index.md, and is registered in the regenerateddocs/bin/manifest.json.Closes #150
Testing instructions
docs/concepts/namespace-migration.mdand confirm the policy covers the public API, filename, and migration scope.docs/concepts/index.mdanddocs/contributing/index.mdlink to it.docs/bin/manifest.jsoncontainsconcepts/namespace-migration.npm run lint:mdcomposer test:phpnpm run test:unitDocs only. No runtime behavior changes and no release zip changes. E2E and manual UI tests were not run because no plugin code was touched.