WordPress.org

Make WordPress Core

Opened 12 months ago

Last modified 3 months ago

#48640 reviewing task (blessed)

Update docblocks of register block type related function and classes

Reported by: ediamin Owned by: SergeyBiryukov
Milestone: 5.6 Priority: normal
Severity: normal Version: 5.0
Component: Editor Keywords: has-patch needs-refresh
Focuses: docs Cc:

Description

This patch updates docblocks of register_block_type, WP_Block_Type_Registry::register and WP_Block_Type::__construct methods concerning the optional arg parameter.

Attachments (2)

48640.diff (3.0 KB) - added by ediamin 12 months ago.
48640-2.diff (9.4 KB) - added by ediamin 3 months ago.
Update param doc block for WP v5.5.0

Download all attachments as: .zip

Change History (12)

@ediamin
12 months ago

#1 @SergeyBiryukov
12 months ago

  • Milestone changed from Awaiting Review to 5.4

This ticket was mentioned in Slack in #core by david.baumwald. View the logs.


9 months ago

This ticket was mentioned in Slack in #core by david.baumwald. View the logs.


9 months ago

#4 @davidbaumwald
9 months ago

  • Milestone changed from 5.4 to Future Release

This ticket still needs a review, and with 5.4 Beta 1 landing today, this is being moved to Future Release. If any maintainer or committer feels this can be included in 5.4 or wishes to assume ownership during a specific cycle, feel free to update the milestone accordingly.

#5 @SergeyBiryukov
9 months ago

  • Milestone changed from Future Release to 5.5
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

This ticket was mentioned in Slack in #core by david.baumwald. View the logs.


4 months ago

#7 @SergeyBiryukov
4 months ago

  • Type changed from enhancement to task (blessed)

#8 @SergeyBiryukov
3 months ago

In 48629:

Docs: Add a note that the $args parameter of register_block_type() accepts any public property of WP_Block_Type.

Follow-up to [47754].

Props ediamin.
See #48640.

#9 @SergeyBiryukov
3 months ago

  • Keywords needs-refresh added
  • Milestone changed from 5.5 to 5.6

Thanks for the patch! A few more properties were added in [47875] / #48529, so it needs a refresh.

Moving to 5.6 for now.

@ediamin
3 months ago

Update param doc block for WP v5.5.0

#10 @ediamin
3 months ago

@SergeyBiryukov Since the newly added param doesn't have any description of their own in class WP_Block_Type, I added them using the description I've found in https://github.com/WordPress/gutenberg/blob/master/packages/blocks/src/api/registration.js and https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/block-api/block-registration.md

If you think they are not appropriate, please suggest how I can improve.

Note: See TracTickets for help on using tickets.