WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 2 years ago

#25826 closed defect (bug) (fixed)

Hook Docs (26): wp-includes/meta.php

Reported by: raamdev Owned by: DrewAPicture
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Options, Meta APIs Keywords: has-patch commit
Focuses: docs Cc:

Description

Adding inline docs to hooks in wp-includes/meta.php.

Attachments (5)

25826.diff (15.8 KB) - added by raamdev 3 years ago.
25826.2.diff (16.6 KB) - added by raamdev 3 years ago.
Uses git diff --no-prefix
25826.3.diff (13.4 KB) - added by kpdesign 2 years ago.
Third pass
25826.4.diff (15.8 KB) - added by DrewAPicture 2 years ago.
Final pass.
25826.5.diff (473 bytes) - added by aliso 2 years ago.
Fix a typo in one of the PHPDoc comments

Download all attachments as: .zip

Change History (19)

@raamdev
3 years ago

#1 @raamdev
3 years ago

Added patch for do_action() and apply_filters() hooks.

There were a few things I wasn't sure about regarding the the bool|null @params. For example, on line 164, did I document the filter correctly?

Finally, the apply_filters_ref_array() filter on line 1104 still needs to be documented. I need help with that one.

#2 @raamdev
3 years ago

  • Keywords has-patch added

#3 @raamdev
3 years ago

  • Cc raam@… added

@raamdev
3 years ago

Uses git diff --no-prefix

#4 @raamdev
3 years ago

I read somewhere that I should be using the --no-prefix option when creating diffs with git, so I've updated the patch. Let me know if anything else needs changing.

#5 @kpdesign
3 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

#6 @DrewAPicture
3 years ago

  • Summary changed from Hook Docs: wp-includes/meta.php to Hook Docs (26): wp-includes/meta.php

I'll get a review done on 25826.2.diff during our sprint tomorrow.

#7 @jeremyfelt
3 years ago

  • Component changed from Inline Docs to Options and Meta
  • Focuses docs added

#8 @kpdesign
2 years ago

  • Owner changed from DrewAPicture to kpdesign

@kpdesign
2 years ago

Third pass

#9 @kpdesign
2 years ago

  • Owner changed from kpdesign to DrewAPicture

25826.3.diff cleans up descriptions, fixes some @since values, and other changes.

@todo: Hash notation for get_meta_sql needs to be completed.

@DrewAPicture
2 years ago

Final pass.

#10 @DrewAPicture
2 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 3.9

25826.4.diff should do it.

#11 @DrewAPicture
2 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 27698:

Inline documentation for hooks in wp-includes/meta.php.

Props raamdev and kpdesign.
Fixes #25826.

#12 @aliso
2 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Typo in one of the PHPDoc comments. Patch incoming.

@aliso
2 years ago

Fix a typo in one of the PHPDoc comments

#13 @DrewAPicture
2 years ago

Good call. Thanks for the patch.

#14 @DrewAPicture
2 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 27723:

Fix a typo in the deleted_{$meta_type}_meta hook description.

Props aliso.
Fixes #25826.

Note: See TracTickets for help on using tickets.