Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 3 years ago

#42777 closed defect (bug) (fixed)

'wp_refresh_nonces' filter missing docs

Reported by: dlh Owned by: obenland
Milestone: 5.1 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch commit
Focuses: docs Cc:


As far as I can see, at least. The filter appears in wp_ajax_heartbeat().

Attachments (2)

#42777-wp_refresh_nonces-docs.patch (1.0 KB) - added by slushman 4 years ago.
Adds PHPDocs to the wp_refresh_nonces filter.
42777-updated.diff (710 bytes) - added by chetan200891 4 years ago.
Updated patch based on PHPDocs coding standards alignment.

Download all attachments as: .zip

Change History (10)

4 years ago

Adds PHPDocs to the wp_refresh_nonces filter.

#1 @slushman
4 years ago

  • Keywords has-patch needs-testing added; needs-patch removed

Uploaded patch that adds PHPDocs documentation to the wp_refresh_nonces filter.

This ticket was mentioned in Slack in #docs by ramiy. View the logs.

4 years ago

#3 @netweb
4 years ago

  • Keywords needs-refresh added; good-first-bug needs-testing removed
  • Milestone changed from Awaiting Review to 5.0

Thanks for the patch @slushman, it needs a couple of tweaks per our PHPDocs coding standards alignment, in particular the spacing of the @param lines:

You can read about those here: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#docblock-formatting

4 years ago

Updated patch based on PHPDocs coding standards alignment.

#4 @chetan200891
4 years ago

@netweb Updated patch 42777-updated.diff added as per your suggestion to tweak PHPDocs coding standards alignment.

#5 @netweb
4 years ago

  • Keywords commit added; needs-refresh removed

#6 @obenland
4 years ago

  • Owner set to obenland
  • Resolution set to fixed
  • Status changed from new to closed

In 42717:

Docs: Add filter docs for wp_refresh_nonces

Props chetan200891, slushman, dlh, netweb.
Fixes #42777.

#7 @SergeyBiryukov
4 years ago

In 42720:

Docs: Correct documentation for Heartbeat filters.

$response parameter is documented as an array or object, but only array is actually supported.

See #42777, #42505.

#8 @pento
3 years ago

  • Milestone changed from 5.0 to 5.1
Note: See TracTickets for help on using tickets.