Make WordPress Core

#63879 closed defect (bug) (fixed)

Correct DocBlock tag order for @since and @global in WordPress core

Reported by: viralsampat Owned by: SergeyBiryukov
Priority: normal Milestone: 6.9
Component: General Version:
Severity: normal Keywords: has-patch
Cc: Focuses: coding-standards

Description

Hello,

While reviewing WordPress core files, I noticed that in some DocBlocks the @since and @global tags are not in the correct order according to the documentation standards.

To maintain consistency with the WordPress documentation guidelines, the order of these tags should be corrected.

Here, I mentioned list of those files:

/wp-includes/option.php
/wp-includes/ms-settings.php
/wp-admin/includes/template.php

I have checked core tickets and found the one ticket where all the docblock changes are define.

Thanks,

Attachments (3)

63879.patch (3.3 KB ) - added by viralsampat 12 months ago.
I have checked above mentioned issue and resolved it. Here, I have added my patch.
63879.2.patch (3.4 KB ) - added by sandipsinh007 12 months ago.
Patch Updated
63879.3.patch (825 bytes ) - added by viralsampat 12 months ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.

Download all attachments as: .zip

Change History (7)

@viralsampat
12 months ago

I have checked above mentioned issue and resolved it. Here, I have added my patch.

#1 @shailu25
12 months ago

There is one more instance in src/wp-admin/nav-menus.php wp_nav_menu_max_depth function since should add before global

@sandipsinh007
12 months ago

Patch Updated

#2 @sandipsinh007
12 months ago

  • Keywords has-patch added; dev-feedback 2nd-opinion removed

@shailu25 I have updated patch as per you suggestion.

#3 @SergeyBiryukov
12 months ago

  • Milestone Awaiting Review6.9
  • Owner set to SergeyBiryukov
  • Status newaccepted

#4 @SergeyBiryukov
12 months ago

  • Resolutionfixed
  • Status acceptedclosed

In 60682:

Docs: Correct the order of @since and @global tags in some files.

Follow-up to [9053], [13177], [16660], [32642], [37226], [54953], [59865], [60658].

Props viralsampat, shailu25, sandipsinh007.
Fixes #63879. See #63166.

@viralsampat
12 months ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

Note: See TracTickets for help on using tickets.