Changeset 42787 for trunk/src/wp-admin/includes/file.php

Timestamp:

03/05/2018 09:49:53 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Standardise and correct documentation relating to parameters which accept plugin names.

See #42505

File:

• trunk/src/wp-admin/includes/file.php (modified) (3 diffs)

trunk/src/wp-admin/includes/file.php

@@ -176 +176 @@
  * @since 4.9.0
  *
- * @param string $plugin Path to the main plugin file from plugins directory.
+ * @param string $plugin Path to the plugin file relative to the plugins directory.
  * @return string[] Array of editable file extensions.
  */
@@ -223 +223 @@
      *
      * @param string[] $editable_extensions An array of editable plugin file extensions.
-     * @param string   $plugin              Path to the main plugin file from plugins directory.
+     * @param string   $plugin              Path to the plugin file relative to the plugins directory.
      */
     $editable_extensions = (array) apply_filters( 'editable_extensions', $editable_extensions, $plugin );
@@ -343 +343 @@
  *
  *     @type string $file       Relative path to file.
- *     @type string $plugin     Plugin being edited.
+ *     @type string $plugin     Path to the plugin file relative to the plugins directory.
  *     @type string $theme      Theme being edited.
  *     @type string $newcontent New content for the file.