Skip to content

Fix inline documentation for hooks to follow WordPress Coding Standards#817

Merged
masteradhoc merged 3 commits intoWordPress:masterfrom
aslamdoctor:815-inline-docs-hooks
Mar 1, 2026
Merged

Fix inline documentation for hooks to follow WordPress Coding Standards#817
masteradhoc merged 3 commits intoWordPress:masterfrom
aslamdoctor:815-inline-docs-hooks

Conversation

@aslamdoctor
Copy link
Contributor

Summary

  • Fixes Inline documentation for hooks (filters & actions) does not follow WordPress Coding Standards #815
  • Adds missing DocBlocks for undocumented hooks (two_factor_rest_api_can_edit_user, two_factor_user_authenticated, two_factor_user_revalidated, two_factor_rememberme, two_factor_before_authentication_prompt, two_factor_after_authentication_prompt, two_factor_after_authentication_input, two_factor_totp_time_step_allowance)
  • Adds missing @since tags to all hook DocBlocks across the codebase
  • Replaces non-standard @var with proper @param in two_factor_backup_code_length
  • Adds cross-reference comments (/** This action is documented in ... */) for repeated hooks across providers

Details

This PR brings all hook (filter & action) inline documentation in line with the WordPress Inline Documentation Standards for PHP. Changes are documentation-only — no functional code was modified.

Test plan

  • Verify no functional changes — all edits are inside /** ... */ comment blocks
  • Confirm DocBlocks follow WordPress Coding Standards (summary, @since, @param tags)
  • Run existing test suite to confirm nothing is broken

…ds (WordPress#815)

- Add missing DocBlocks for undocumented hooks: two_factor_rest_api_can_edit_user,
  two_factor_user_authenticated, two_factor_user_revalidated, two_factor_rememberme,
  two_factor_before_authentication_prompt, two_factor_after_authentication_prompt,
  two_factor_after_authentication_input, two_factor_totp_time_step_allowance
- Add missing @SInCE tags to all hook DocBlocks
- Replace non-standard @var with proper @param in two_factor_backup_code_length
- Add cross-reference comments for repeated hooks across providers
@github-actions
Copy link

github-actions bot commented Feb 26, 2026

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: aslamdoctor <aslamdoctor@git.wordpress.org>
Co-authored-by: masteradhoc <masteradhoc@git.wordpress.org>
Co-authored-by: georgestephanis <georgestephanis@git.wordpress.org>

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

Copy link
Collaborator

@masteradhoc masteradhoc left a comment

Choose a reason for hiding this comment

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

Hey @aslamdoctor
Went through the PR and gave you several commitable feedbacks to check. Please see and let me know.

@masteradhoc masteradhoc added this to the 0.16.0 milestone Mar 1, 2026
@masteradhoc masteradhoc dismissed their stale review March 1, 2026 07:00

Feedback is adressed

@masteradhoc masteradhoc merged commit 933fd5a into WordPress:master Mar 1, 2026
28 checks passed
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.

Inline documentation for hooks (filters & actions) does not follow WordPress Coding Standards

3 participants