Changeset 45917

Timestamp:

08/30/2019 04:56:39 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Simplify get_plugin_data() and get_file_data() description.

See #47110.

Location:

trunk/src

Files:

• wp-admin/includes/plugin.php (modified) (3 diffs)
• wp-includes/functions.php (modified) (3 diffs)

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

@@ -10 +10 @@
  * Parses the plugin contents to retrieve plugin's metadata.
  *
- * The metadata of the plugin's data searches for the following in the plugin's
- * header. All plugin data must be on its own line. For plugin description, it
- * must not have any newlines or only parts of the description will be displayed
- * and the same goes for the plugin data. The below is formatted for printing.
+ * All plugin headers must be on their own line. Plugin description must not have
+ * any newlines, otherwise only parts of the description will be displayed.
+ * The below is formatted for printing.
  *
  *     /*
@@ -34 +33 @@
  *     Requires at least: Optional. Specify the minimum required WordPress version.
  *     Requires PHP: Optional. Specify the minimum required PHP version.
- *      * / # Remove the space to close comment
- *
- * Some users have issues with opening large files and manipulating the contents
- * for want is usually the first 1kiB or 2kiB. This function stops pulling in
- * the plugin contents when it has all of the required plugin data.
- *
- * The first 8kiB of the file will be pulled in and if the plugin data is not
- * within that first 8kiB, then the plugin author should correct their plugin
+ *     * / # Remove the space to close comment.
+ *
+ * The first 8 KB of the file will be pulled in and if the plugin data is not
+ * within that first 8 KB, then the plugin author should correct their plugin
  * and move the plugin data headers to the top.
  *
@@ -49 +44 @@
  *
  * @since 1.5.0
- * @since 5.3.0 Added support for `Requires at least` and `Requires PHP`.
+ * @since 5.3.0 Added support for `Requires at least` and `Requires PHP` headers.
  *
  * @param string $plugin_file Absolute path to the main plugin file.

trunk/src/wp-includes/functions.php

@@ -5685 +5685 @@
  * Retrieve metadata from a file.
  *
- * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
+ * Searches for metadata in the first 8 KB of a file, such as a plugin or theme.
  * Each piece of metadata must be on its own line. Fields can not span multiple
  * lines, the value will get cut at the end of the first line.
  *
- * If the file data is not within that first 8kiB, then the author should correct
+ * If the file data is not within that first 8 KB, then the author should correct
  * their plugin file and move the data headers to the top.
  *
@@ -5697 +5697 @@
  *
  * @param string $file            Absolute path to the file.
- * @param array  $default_headers List of headers, in the format `array('HeaderKey' => 'Header Name')`.
+ * @param array  $default_headers List of headers, in the format `array( 'HeaderKey' => 'Header Name' )`.
  * @param string $context         Optional. If specified adds filter hook {@see 'extra_$context_headers'}.
  *                                Default empty.
@@ -5706 +5706 @@
     $fp = fopen( $file, 'r' );
 
-    // Pull only the first 8kiB of the file in.
+    // Pull only the first 8 KB of the file in.
     $file_data = fread( $fp, 8 * KB_IN_BYTES );