WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#31055 closed defect (bug) (fixed)

Improve the @return and hook docs for nonce functions

Reported by: johnbillion Owned by: DrewAPicture
Milestone: 4.2 Priority: normal
Severity: normal Version: 2.5
Component: Security Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

check_admin_referer() and check_ajax_referer() are missing @return docs, and their hook docs need improving.

Same goes for the @return doc for wp_verify_nonce().

Attachments (2)

31055.diff (2.6 KB) - added by johnbillion 5 years ago.
31055.2.diff (3.5 KB) - added by DrewAPicture 5 years ago.

Download all attachments as: .zip

Change History (6)

@johnbillion
5 years ago

#1 @johnbillion
5 years ago

  • Keywords has-patch added

#2 @DrewAPicture
5 years ago

  • Milestone changed from Awaiting Review to 4.2
  • Type changed from enhancement to defect (bug)

#3 @DrewAPicture
5 years ago

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

@DrewAPicture
5 years ago

#4 @DrewAPicture
5 years ago

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

In 31381:

Improve return and parameter documentation for check_admin_referer(), check_ajax_referer(), and wp_verify_nonce().

Also update and clarify docsfor the check_admin_referer and check_ajax_referer hooks.

Props johnbillion, DrewAPicture.
Fixes #31055.

Note: See TracTickets for help on using tickets.