sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve return description for `get_file_data()` documentation. 

Also convert an incorrect use of `@see` to `@link`.

Props 5um17 for the initial patch.
Fixes #30466.


git-svn-id: https://develop.svn.wordpress.org/trunk@30532 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-23 17:56:14 +00:00
parent 4140cf6a46
commit 4f331ec1df
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/wp-includes/functions.php
View File

@ -4163,13 +4163,15 @@ function wp_scheduled_delete() {
* If the file data is not within that first 8kiB, then the author should correct * If the file data is not within that first 8kiB, then the author should correct
* their plugin file and move the data headers to the top. * their plugin file and move the data headers to the top.
* *
* @see http://codex.wordpress.org/File_Header * @link http://codex.wordpress.org/File_Header
* *
* @since 2.9.0 * @since 2.9.0
*
* @param string $file Path to the file. * @param string $file 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 "extra_{$context}_headers". * @param string $context Optional. If specified adds filter hook "extra_{$context}_headers".
* Default empty. * Default empty.
* @return array Array of file headers in `HeaderKey => Header Value` format.
*/ */
function get_file_data( $file, $default_headers, $context = '' ) { function get_file_data( $file, $default_headers, $context = '' ) {
// We don't need to write to the file, so just open for reading. // We don't need to write to the file, so just open for reading.