WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#34360 closed enhancement (fixed)

Minor text inconsistencies in includes/plugin.php

Reported by: Mckilem Owned by: SergeyBiryukov
Milestone: 4.4 Priority: normal
Severity: normal Version: 4.3.1
Component: Administration Keywords: has-patch
Focuses: docs Cc:

Description

Inside /wp-admin/includes/plugin.php file, I believe there are some inconsistencies within inline comments. For example, for add_users_page() function, comments tell us (line 1283) the following:

"Add sub menu page to the Users/Profile main menu."

And that's OK.

But for add_theme_page(), the comment says:

"Add sub menu page to the themes main menu."

Which I find inconsistent. It should be Appearance, which is more clear on where submenu goes.

The biggest "problem" could be for Settings page (function add_options_page()) - on line 1220, it says:

"Add sub menu page to the options main menu."

In my view, it should say:

"Add sub menu page to the Settings main menu."

And this should be consistent for all administration menu functions, so these would match WordPress core admin menu titles.

Attachments (2)

34360.diff (2.8 KB) - added by atomicjack 3 years ago.
Fixed comment inconsistencies on wp-admin functions.
34360.2.diff (2.8 KB) - added by SergeyBiryukov 3 years ago.

Download all attachments as: .zip

Change History (8)

#1 @swissspidy
3 years ago

  • Component changed from Text Changes to Administration
  • Keywords needs-patch added

@atomicjack
3 years ago

Fixed comment inconsistencies on wp-admin functions.

#2 @atomicjack
3 years ago

  • Keywords has-patch added; needs-patch removed

This patch resolves multiple inconsistencies: incorrect capitalisation, and inconsistent naming of menu names.

#3 @Mckilem
3 years ago

Looks ok to me.

#4 @SergeyBiryukov
3 years ago

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

In 35373:

Docs: Use consistent naming and capitalization of menu names in add_submenu_page() wrappers.

Props atomicjack, Mckilem.
Fixes #34360.

#5 @SergeyBiryukov
3 years ago

  • Milestone changed from Awaiting Review to 4.4

#6 @SergeyBiryukov
3 years ago

In 35731:

Docs: Improve DocBlock formatting for add_menu_page() and add_submenu_page() wrappers.

See #34360.

Note: See TracTickets for help on using tickets.