WordPress.org
Get WordPress

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#56596 closed defect (bug) (fixed)

Docs: Default parameter not mentioned on strip_core_block_namespace

Reported by: rakibwordpress Owned by: SergeyBiryukov
Priority: normal Milestone: 6.1
Component: Editor Version: 6.0.1
Severity: normal Keywords: has-patch changes-requested
Cc: Focuses: docs

Description (last modified by sabernhardt)

In blocks.php function inline document $block_name by default is null and this is not mentioned on this function strip_core_block_namespace

Change History (6)

This ticket was mentioned in ​PR #3272 on ​WordPress/wordpress-develop by ​rakibwebdev.
4 years ago #1

  • Keywords has-patch added; needs-patch removed

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Trac ticket:

#2 @ironprogrammer
4 years ago

  • Component Security → Text Changes
  • Keywords changes-requested added

Welcome to Trac @rakibwordpress, and thank you for your ticket submission, and follow up PR! 🙌🏻🙌🏻

For the PR, I would recommend checking out the WordPress ​PHP Documentation Standards for details on how the @param tag should be formatted. For example, I think you should be able to simplify this to Default null. (Please note punctuation, too -- these tags ​convert to official documentation, so the rules are very strict.)

Version 0, edited 4 years ago by ironprogrammer (next)

#3 @sabernhardt
4 years ago

  • Component Text Changes → Editor
  • Description modified (diff)
  • Focuses docs added

#4 @SergeyBiryukov
4 years ago

  • Milestone Awaiting Review → 6.1

#5 @SergeyBiryukov
4 years ago

  • Owner set to SergeyBiryukov
  • Resolution → fixed
  • Status new → closed

In 54520:

Docs: Clarify default values for a few block function parameters.

This applies to:

  • $block_name in strip_core_block_namespace()
  • $allowed_html in filter_block_content()
  • $pagination_type in get_comments_pagination_arrow()

Follow-up to [46896], [48794], [53138], [54181].

Props rakibwordpress, ironprogrammer, sabernhardt, SergeyBiryukov.
Fixes #56596.

​@SergeyBiryukov commented on ​PR #3272:
4 years ago #6

Thanks for the PR! Merged in r54520.

Note: See TracTickets for help on using tickets.