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. Built from https://develop.svn.wordpress.org/trunk@30532 git-svn-id: http://core.svn.wordpress.org/trunk@30521 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
e8a4452f05
commit
0fb8811fb6
|
@ -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.
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '4.1-beta2-30531';
|
$wp_version = '4.1-beta2-30532';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|
Loading…
Reference in New Issue