Skip to content

Conversation

@huzaifaalmesbah
Copy link

Updates PHP DocBlocks in Twenty Eleven theme to better align with WordPress PHP Documentation Standards.

Changes include:

  • Use third-person singular verbs in function summaries
  • Add missing @return tags for better type documentation
  • Complete @param documentation for widget methods
  • Ensure proper sentence structure with punctuation
  • Add missing DocBlock for twentyeleven_theme_options_help()

Files modified:

  • inc/theme-options.php: Updated 9 function DocBlocks
  • inc/widgets.php: Enhanced widget update() method documentation

Fixes https://core.trac.wordpress.org/ticket/64211

…ndards

Updates PHP DocBlocks in Twenty Eleven theme to better align with WordPress PHP Documentation Standards.

Changes include:
- Use third-person singular verbs in function summaries
- Add missing @return tags for better type documentation
- Complete @param documentation for widget methods
- Ensure proper sentence structure with punctuation
- Add missing DocBlock for twentyeleven_theme_options_help()
@github-actions
Copy link

github-actions bot commented Nov 7, 2025

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 huzaifaalmesbah.

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

@github-actions
Copy link

github-actions bot commented Nov 7, 2025

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link

@dhruvang21 dhruvang21 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@juanfra juanfra left a comment

Choose a reason for hiding this comment

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

LGTM

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.

3 participants