Skip to content

docs: document SCF namespace and API naming policy - #545

Open
faisalahammad wants to merge 1 commit into
WordPress:trunkfrom
faisalahammad:fix/150-scf-namespace-roadmap
Open

faisalahammad wants to merge 1 commit into
WordPress:trunkfrom
faisalahammad:fix/150-scf-namespace-roadmap

Conversation

@faisalahammad

Copy link
Copy Markdown

Adds docs/concepts/namespace-migration.md to record the naming policy for issue #150. The page keeps existing public ACF functions, hooks, classes, and constants stable, uses scf_ and scf/ 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.php and secure-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.md and docs/contributing/index.md, and is registered in the regenerated docs/bin/manifest.json.

Closes #150

Testing instructions

  • Open docs/concepts/namespace-migration.md and confirm the policy covers the public API, filename, and migration scope.
  • Confirm docs/concepts/index.md and docs/contributing/index.md link to it.
  • Confirm docs/bin/manifest.json contains concepts/namespace-migration.
  • npm run lint:md
  • composer test:php
  • npm run test:unit

Docs only. No runtime behavior changes and no release zip changes. E2E and manual UI tests were not run because no plugin code was touched.

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
@github-actions

Copy link
Copy Markdown

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props faisalahammad, priethor.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migration of old APIs and filenames to SCF namespace

1 participant