Changeset 45917 for trunk/src/wp-includes/functions.php

Timestamp:

08/30/2019 04:56:39 PM (3 months ago)

Author:

SergeyBiryukov

Message:

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

See #47110.

File:

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

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 );