WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#30699 closed defect (bug) (fixed)

Incorrect inline docs in plugin.php: referenced function "plugin_text_domain()" does not exist.

Reported by: eliorivero Owned by: nacin
Milestone: 4.2 Priority: normal
Severity: normal Version: 2.7
Component: Plugins Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

In the inline docs for the get_plugin_data() function that explains the plugin headers, there's this line:

Text Domain: Optional. Unique identifier, should be same as the one used in plugin_textdomain()

but that function doesn't exist so it should be

Text Domain: Optional. Unique identifier, should be same as the one used in load_plugin_textdomain()

This error is also in the online reference
https://developer.wordpress.org/reference/functions/get_plugin_data/

The attached patch fixes this.

Attachments (1)

plugin.patch (722 bytes) - added by eliorivero 5 years ago.
Fixes function reference in inline docs for get_plugin_data() in plugins.php

Download all attachments as: .zip

Change History (6)

@eliorivero
5 years ago

Fixes function reference in inline docs for get_plugin_data() in plugins.php

#1 in reply to: ↑ description @DrewAPicture
5 years ago

  • Keywords has-patch added
  • Milestone changed from Awaiting Review to Future Release

Hi eliorivero,

Thanks for the patch. It's a bit late for this in the release cycle, but we should be able to get it rolled in next week.

Replying to eliorivero:

This error is also in the online reference
https://developer.wordpress.org/reference/functions/get_plugin_data/

The docs on that page are generated from the docs in the source code :-)

Last edited 5 years ago by DrewAPicture (previous) (diff)

#2 @johnbillion
5 years ago

  • Version changed from trunk to 2.7

#3 @DrewAPicture
5 years ago

  • Milestone changed from Future Release to 4.2

#4 @nacin
5 years ago

  • Owner set to nacin
  • Status changed from new to accepted

Looks good.

#5 @nacin
5 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 31008:

Use correct function name in docs for get_plugin_data().

props eliorivero.
fixes #30699.

Note: See TracTickets for help on using tickets.