Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark traverse_and_serialize_block(s) as @access private #5607

Conversation

ockham
Copy link
Contributor

@ockham ockham commented Nov 1, 2023

Change the PHPDoc for traverse_and_serialize_block and traverse_and_serialize_blocks to:

  • Mark them as with @access private.
  • Add an explanation to the DocBlock to better document they are intended for Core only usage.
  • Consider renaming with the private _ prefix to further denote these are for Core only.

Trac ticket: https://core.trac.wordpress.org/ticket/59783


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@ockham ockham self-assigned this Nov 1, 2023
@hellofromtonya hellofromtonya marked this pull request as ready for review November 6, 2023 12:29
Copy link
Contributor

@hellofromtonya hellofromtonya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking these functions as private with the added note meets the scope and intent of the Trac ticket. This is ready for commit.

@hellofromtonya
Copy link
Contributor

Commit 2db9f42 adds the docblock explanation to make_before_block_visitor() and make_after_block_visitor(), so that all 4 of these new functions have the same documentation.

@hellofromtonya
Copy link
Contributor

Committed to trunk via https://core.trac.wordpress.org/changeset/57066.

@ockham ockham deleted the update/traverse-and-serialize-blocks-mark-as-private branch November 7, 2023 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants