Make WordPress Core

Opened 11 years ago

Closed 11 years ago

#28499 closed defect (bug) (fixed)

plugins_url() documentation doesn't mention it works for mu-plugins

Reported by: ericlewis's profile ericlewis Owned by:
Milestone: 4.0 Priority: normal
Severity: normal Version: 2.8
Component: Plugins Keywords: has-patch
Focuses: docs Cc:

Description

plugins_url() works for plugins in the mu-plugin directory (see #9561). However, inline and codex documentation don't mention that at all. Both should be updated.

Attachments (4)

28499.diff (1.3 KB) - added by ericlewis 11 years ago.
28499.1.diff (1.4 KB) - added by ericlewis 11 years ago.
28499.1.2.diff (1.4 KB) - added by ericlewis 11 years ago.
28499.2.diff (1.4 KB) - added by DrewAPicture 11 years ago.

Download all attachments as: .zip

Change History (11)

#1 @ericlewis
11 years ago

  • Keywords needs-codex added

#2 @ericlewis
11 years ago

  • Summary changed from Update documentation for plugins_url() to plugins_url() documentation doesn't mention it works for mu-plugins

@ericlewis
11 years ago

#3 @ericlewis
11 years ago

  • Keywords has-patch added

In attachment:28499.diff, first pass at cleaning up the documentation for plugins_url().

#4 @DrewAPicture
11 years ago

  • Keywords needs-patch added; has-patch removed
  • Milestone changed from Awaiting Review to 4.0

Hi, thanks for the patch. I've been playing around a little with the language and can't quite decide how to approach it.

I think the short description is fine as-is (well, besides capitalizing 'URL'). The mu-plugins directory only comes into play when $plugin is supplied, so that information is best reflected in the long description.

I'd like to see the additional information about $plugin and $path (excluding the mu-plugins info above) live within the parameter descriptions instead of in the long description. Also, it's unclear whether $path is appended to the end of the combined base + plugin URL, or after the base but before the plugin.

@ericlewis
11 years ago

@ericlewis
11 years ago

#5 @ericlewis
11 years ago

  • Keywords has-patch added; needs-patch removed

In attachment:28499.1.diff, I've moved the descriptions into the parameter descriptions, and give a clear short and long description.

#6 @DrewAPicture
11 years ago

In 28977:

Clarify the inline documentation for plugins_url() to reflect that it also works with mu-plugins.

Props ericlewis.
See #28499.

#7 @DrewAPicture
11 years ago

  • Keywords needs-codex removed
  • Resolution set to fixed
  • Status changed from new to closed

Updated the Codex.

Note: See TracTickets for help on using tickets.