Changeset 30532

Timestamp:

11/23/2014 05:56:14 PM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -4164 +4164 @@
  * 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
+ *
  * @param string $file            Path to the file.
  * @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".
  *                                Default empty.
+ * @return array Array of file headers in `HeaderKey => Header Value` format.
  */
 function get_file_data( $file, $default_headers, $context = '' ) {