get_file_data() WP 2.9.0
Retrieve metadata from a file (it's specified in the header comment of the file).
Searches for metadata in the first 8kiB of a file, such as a plugin or theme. Each piece of metadata must be on its own line. Fields can not span multiple lines, the value will get cut at the end of the first line.
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.
Hooks from the function
Return
String[]. Array of file header values keyed by header name.
{{{я второй аргумент не не стал менять описание ибо тут даже понятнее описание. но русский тоже не стал трогать}}}
Usage
get_file_data( $file, $default_headers, $context );
- $file(string) (required)
- Absolute path to the file.
- $default_headers(array) (required)
- List of headers, in the format array('HeaderKey'=>'Header Name').
- $context(string)
- If specified adds filter hook {@see 'extra_$context_headers'}.
Default: ''
Examples
#1 Get plugin's data
Suppose we have created a plugin and its main file has such header:
/* Plugin Name: Name Description: Description Author: Kama Version: 1.0 */
// Path to the file of the plugin. In the file of the plugin it can be retrived using magic constant __FILE__ $file = '/home/site.ru/wp-content/plugins/myplugin/index.php'; $data = get_file_data( $file, array('ver'=>'Version', 'author'=>'Author', 'name'=>'Plugin Name' ) ); /* $data will contain: Array ( [ver] => 1.0 [author] => Kama [name] => Name ) */
#2 Dynamic version of the plugin
Suppose we're writing a plugin and it has PLUGIN_VERSION constant which represents the version of the plugin. To not change it every time we update the plugin, we can parse the plugin's metadata for the version using this function:
/* Plugin Name: Plugin Name Plugin URI: http://wp-kama.com Description: Plugin Description Author: Kama Version: 1.0 */ $data = get_file_data( __FILE__, array('ver'=>'Version') ); define('PLUGIN_VERSION', $data['ver'] );
Changelog
Since 2.9.0 | Introduced. |