WordPress.org

Make WordPress Core


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/functions.php

    r45914 r45917  
    56855685 * Retrieve metadata from a file.
    56865686 *
    5687  * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
     5687 * Searches for metadata in the first 8 KB of a file, such as a plugin or theme.
    56885688 * Each piece of metadata must be on its own line. Fields can not span multiple
    56895689 * lines, the value will get cut at the end of the first line.
    56905690 *
    5691  * If the file data is not within that first 8kiB, then the author should correct
     5691 * If the file data is not within that first 8 KB, then the author should correct
    56925692 * their plugin file and move the data headers to the top.
    56935693 *
     
    56975697 *
    56985698 * @param string $file            Absolute path to the file.
    5699  * @param array  $default_headers List of headers, in the format `array('HeaderKey' => 'Header Name')`.
     5699 * @param array  $default_headers List of headers, in the format `array( 'HeaderKey' => 'Header Name' )`.
    57005700 * @param string $context         Optional. If specified adds filter hook {@see 'extra_$context_headers'}.
    57015701 *                                Default empty.
     
    57065706    $fp = fopen( $file, 'r' );
    57075707
    5708     // Pull only the first 8kiB of the file in.
     5708    // Pull only the first 8 KB of the file in.
    57095709    $file_data = fread( $fp, 8 * KB_IN_BYTES );
    57105710
Note: See TracChangeset for help on using the changeset viewer.