WordPress.org

Make WordPress Core

Opened 19 months ago

Closed 9 months ago

#43643 closed enhancement (fixed)

Properly document the `$page_hook` action

Reported by: johnbillion Owned by: pento
Milestone: 5.1 Priority: normal
Severity: normal Version:
Component: Plugins Keywords: has-patch 2nd-opinion
Focuses: docs Cc:
PR Number:

Description

The $page_hook action lacks meaningful documentation. This is the only action in core that uses a completely dynamic hook name, which means it needs to be well documented to help developers who may wish to use it.

Most of the documentation from the load-{$page_hook} action immediately above it can be reused, and then the @ignore tag can be removed so the unnecessary private flag gets removed from the developer reference.

Refs:

Attachments (1)

43643.diff (939 bytes) - added by johnbillion 19 months ago.

Download all attachments as: .zip

Change History (4)

@johnbillion
19 months ago

#1 @johnbillion
19 months ago

  • Keywords has-patch 2nd-opinion added; needs-patch removed

So, this hook is used by core itself to load the plugin page, but there's technically no reason for it to be ignored / marked as private. Thoughts?

#2 @SergeyBiryukov
12 months ago

  • Milestone changed from 5.0 to 5.1

Switching milestone due to the focus on the new editor (Gutenberg) for WordPress 5.0.

#3 @pento
9 months ago

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

In 44501:

Docs: Document the $page_hook action.

Props johnbillion.
Fixes #43643.

Note: See TracTickets for help on using tickets.