WordPress.org

Making WordPress.org

Opened 5 weeks ago

Closed 4 weeks ago

#5443 closed defect (reported-upstream)

PHP Coding standards documentation does not show PHP code

Reported by: stuardostr Owned by:
Milestone: Priority: high
Component: Developer Hub Keywords:
Cc:

Description

The coding standards documentation at https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/ has a message saying that the content in that page is deprecated.

The message points to

https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/

In that page, the examples with opening <?php tags break and do not show the PHP code, which I think is the most important block of the documentation. That's why I flagged priority as high.

Attachments (1)

2020-09-18_12-04.png (83.9 KB) - added by stuardostr 5 weeks ago.
compariso

Download all attachments as: .zip

Change History (3)

@stuardostr
5 weeks ago

compariso

This ticket was mentioned in Slack in #meta by tellyworth. View the logs.


4 weeks ago

#2 @coffee2code
4 weeks ago

  • Resolution set to reported-upstream
  • Status changed from new to closed

Thanks for the report!

All content for the Coding Standards Handbook is imported from an associated GitHub repository.

I've reported the issue there and have included a pull request for their consideration to address this.

This is related to #5346, where I recommended (and also previously recommended upsteam in the handbook's GitHub repo (#GH38) that the handbook maintainers should use Markdown code fence notation to denote code blocks instead of shortcodes. The Block Editor does this and is able to show <?php (see example).

Note: See TracTickets for help on using tickets.