WordPress.org

Make WordPress Core

Changeset 16741


Ignore:
Timestamp:
12/06/2010 03:44:36 AM (10 years ago)
Author:
markjaquith
Message:

Fix up the PHPdoc for get_file_data(). props hakre. fixes #14071

File:
1 edited

Legend:

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

    r16696 r16741  
    41924192
    41934193/**
    4194  * Parse the file contents to retrieve its metadata.
    4195  *
    4196  * Searches for metadata for a file, such as a plugin or theme.  Each piece of
    4197  * metadata must be on its own line. For a field spanning multple lines, it
    4198  * must not have any newlines or only parts of it will be displayed.
    4199  *
    4200  * Some users have issues with opening large files and manipulating the contents
    4201  * for want is usually the first 1kiB or 2kiB. This function stops pulling in
    4202  * the file contents when it has all of the required data.
    4203  *
    4204  * The first 8kiB of the file will be pulled in and if the file data is not
    4205  * within that first 8kiB, then the author should correct their plugin file
    4206  * and move the data headers to the top.
    4207  *
    4208  * The file is assumed to have permissions to allow for scripts to read
    4209  * the file. This is not checked however and the file is only opened for
    4210  * reading.
     4194 * Retrieve metadata from a file.
     4195 *
     4196 * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
     4197 * Each piece of metadata must be on its own line. Fields can not span multple
     4198 * lines, the value will get cut at the end of the first line.
     4199 *
     4200 * If the file data is not within that first 8kiB, then the author should correct
     4201 * their plugin file and move the data headers to the top.
     4202 *
     4203 * @see http://codex.wordpress.org/File_Header
    42114204 *
    42124205 * @since 2.9.0
    4213  *
    42144206 * @param string $file Path to the file
    4215  * @param array $default_headers Default metadata headers
     4207 * @param array $default_headers array of regular expressions keyed with a fieldname, e.g. <code>array('Name' => 'Plugin Name')</code>
    42164208 * @param string $context If specified adds filter hook "extra_<$context>_headers"
    42174209 */
Note: See TracChangeset for help on using the changeset viewer.