get_plugin_data

函数


      get_plugin_data ( $plugin_file, $markup = true, $translate = true )

参数

(string) $plugin_file Absolute path to the main plugin file.

Required: 是
(bool) $markup Optional. If the returned data should have HTML markup applied. Default true.

Required: 否

Default: true
(bool) $translate Optional. If the returned data should be translated. Default true.

Required: 否

Default: true

返回值

(array) { Plugin data. Values will be empty if not supplied by the plugin. @type string $Name Name of the plugin. Should be unique. @type string $PluginURI Plugin URI. @type string $Version Plugin version. @type string $Description Plugin description. @type string $Author Plugin author's name. @type string $AuthorURI Plugin author's website address (if set). @type string $TextDomain Plugin textdomain. @type string $DomainPath Plugin's relative directory path to .mo files. @type bool $Network Whether the plugin can only be activated network-wide. @type string $RequiresWP Minimum required version of WordPress. @type string $RequiresPHP Minimum required version of PHP. @type string $UpdateURI ID of the plugin for update purposes, should be a URI. @type string $Title Title of the plugin and link to the plugin's site (if set). @type string $AuthorName Plugin author's name. }

定义位置

wp-admin/includes/plugin.php , line 72

相关方法: get_plugin_updates get_plugins get_inline_data get_file_data get_plugin_files

引入: 1.5.0

弃用: -

get_plugin_data函数是一个WordPress函数，用于检索一个插件的元数据: 这个函数接受一个参数，即你想检索元数据的插件文件的路径: 该函数返回一个指定插件的元数据数组，包括名称、版本、作者和其他信息。

对插件的内容进行解析，以检索插件的元数据。

所有插件的标题必须在自己的行上。插件描述不能有任何新行，否则将只显示部分描述。下面的内容是打印用的格式。
/*
Plugin Name: Name of the plugin.
Plugin URI: The home page of the plugin.
Description: Plugin description.
Author: Plugin author’s name.
Author URI: Link to the author’s website.
Version: Plugin version.
Text Domain: Optional. Unique identifier, should be same as the one used in load_plugin_textdomain().
Domain Path: Optional. Only useful if the translations are located in a folder above the plugin’s base path. For example, if .mo files are located in the locale folder then Domain Path will be”/locale/” and must have the first slash. Defaults to the base folder the plugin is located in.
Network: Optional. Specify”Network: true” to require that a plugin is activated across all sites in an installation. This will prevent a plugin from being activated on a single site when Multisite is enabled.
Requires at least: Optional. Specify the minimum required WordPress version.
Requires PHP: Optional. Specify the minimum required PHP version.
* / # Remove the space to close comment.

文件的前8KB将被拉入，如果插件数据不在这前8KB内，那么插件作者应该修正他们的插件，并将插件数据头移到顶部。

插件文件被认为具有允许脚本读取该文件的权限。然而，这一点并没有被检查，该文件只被打开用于阅读。

function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {

	$default_headers = array(
		'Name'        => 'Plugin Name',
		'PluginURI'   => 'Plugin URI',
		'Version'     => 'Version',
		'Description' => 'Description',
		'Author'      => 'Author',
		'AuthorURI'   => 'Author URI',
		'TextDomain'  => 'Text Domain',
		'DomainPath'  => 'Domain Path',
		'Network'     => 'Network',
		'RequiresWP'  => 'Requires at least',
		'RequiresPHP' => 'Requires PHP',
		'UpdateURI'   => 'Update URI',
		// Site Wide Only is deprecated in favor of Network.
		'_sitewide'   => 'Site Wide Only',
	);

	$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );

	// Site Wide Only is the old header for Network.
	if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
		/* translators: 1: Site Wide Only: true, 2: Network: true */
		_deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), '<code>Site Wide Only: true</code>', '<code>Network: true</code>' ) );
		$plugin_data['Network'] = $plugin_data['_sitewide'];
	}
	$plugin_data['Network'] = ( 'true' === strtolower( $plugin_data['Network'] ) );
	unset( $plugin_data['_sitewide'] );

	// If no text domain is defined fall back to the plugin slug.
	if ( ! $plugin_data['TextDomain'] ) {
		$plugin_slug = dirname( plugin_basename( $plugin_file ) );
		if ( '.' !== $plugin_slug && false === strpos( $plugin_slug, '/' ) ) {
			$plugin_data['TextDomain'] = $plugin_slug;
		}
	}

	if ( $markup || $translate ) {
		$plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
	} else {
		$plugin_data['Title']      = $plugin_data['Name'];
		$plugin_data['AuthorName'] = $plugin_data['Author'];
	}

	return $plugin_data;
}

常见问题

FAQs

如何使用get_users获取所有用户列表？
要使用` get_users `函数获取所有用户列表，可以按照以下步骤进行：

1. 使用` get_users `函数调用获取用户列表：
```
$users = get_users();
```
2. 您可以按需使用参数来过滤结果。例如，您可以通过角色、用户ID、用户登录名等过滤用户列表。以下是一个根据用户角色为过滤条件的示例：
```
$users = get_users( array(
    'role' => 'subscriber' // 将角色名称替换为您要过滤的角色
) );
```
在上述示例中，将` role `参数设置为所需的角色名称来过滤用户列表。

3. 您可以使用循环遍历获取的用户列表，并访问每个用户的属性。例如，以下示例将显示每个用户的用户名和电子邮件地址：
```
foreach( $users as $user ) {
    echo '用户名：' . $user->user_login . ', 电子邮件：' . $user->user_email . ;
}
```
在上述示例中，通过` $user->user_login `和` $user->user_email `访问每个用户的用户名和电子邮件地址。

请注意，` get_users `函数默认返回所有用户，并可以根据需要使用更多参数进行过滤。您可以参阅WordPress官方文档中的` get_users `函数文档，了解更多可用参数和用法示例。

总结起来，使用` get_users `函数获取所有用户列表的步骤是：
1. 调用` get_users `函数获取用户列表。
2. 使用可选的过滤参数，根据需要过滤用户列表。
3. 使用循环遍历用户列表，并访问每个用户的属性。
如何使用WP_PLUGIN_DIR和WP_PLUGIN_URL定义插件的目录和URL？
在WordPress中，可以使用WP_PLUGIN_DIR和WP_PLUGIN_URL常量来定义插件的目录路径和URL。

1. `WP_PLUGIN_DIR`：这是一个常量，用于定义插件的目录路径（文件系统路径）。您可以使用以下代码在插件文件中访问该常量：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
```
在上述代码中，将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量，您可以获取插件文件的完整路径。

2. `WP_PLUGIN_URL`：这是一个常量，用于定义插件的URL（用于在网页上访问插件文件）。以下是一个使用该常量的示例：
```
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
同样，请将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量，您可以获取插件在网页上的完整URL。

请注意，`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量在WordPress版本2.6之后引入。从WordPress 5.5版本开始，这两个常量被标记为过时（deprecated），因为WordPress更倾向于使用新的插件文件结构。如果您正在开发新插件，建议使用新的插件文件结构和相关函数。

在新的插件文件结构中，可以使用以下函数来获取插件的目录路径和URL：

- `plugin_dir_path()`：获取插件目录路径。
- `plugin_dir_url()`：获取插件URL。

这些函数会自动将插件的版本、多站点和SSL等考虑因素纳入计算。

总结起来，使用`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量定义插件的目录和URL的方法是：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
但请注意，这两个常量已被标记为过时，建议使用新的插件文件结构和相关函数来获取插件的路径和URL。
如何使用PHP在WordPress中添加自定义功能？
使用PHP在WordPress中添加自定义功能可以通过以下方式实现：
- 创建一个自定义插件，将功能代码添加到插件中。
- 使用WordPress的钩子系统，将自定义功能绑定到适当的钩子上。
- 在主题文件中添加自定义功能代码，例如functions.php文件。
- 使用WordPress的短代码功能，将自定义功能封装为短代码。
- 使用WordPress的插件或主题编辑器，将自定义功能代码添加到适当的位置。
下面是一个实操示例。

要在WordPress中添加自定义功能，可以按照以下步骤使用PHP编写并添加自定义功能：
1. 打开WordPress安装目录中的主题文件夹，通常位于wp-content/themes/下，找到正在使用的主题文件夹。
2. 在主题文件夹中，可以创建一个名为functions.php的文件。如果该文件已经存在，可以直接编辑它。
3. 在functions.php文件中，可以使用PHP代码添加自定义功能。以下是一些常见的示例：
```
// 添加自定义功能示例

// 1. 创建自定义短代码
function custom_shortcode() {
    return '这是我的自定义短代码内容';
}
add_shortcode('custom', 'custom_shortcode');

// 2. 自定义小工具
function custom_widget() {
    echo '这是我的自定义小工具内容';
}
register_widget('custom_widget');

// 3. 自定义菜单
function custom_menu() {
    register_nav_menu('custom-menu', '自定义菜单');
}
add_action('after_setup_theme', 'custom_menu');

// 4. 自定义页面模板
function custom_page_template() {
    /* Template Name: 自定义模板 */
    // 自定义模板的内容和样式
}
```
4. 编辑完functions.php文件后，保存并上传到WordPress主题文件夹中。
请注意，修改主题文件可以在主题更新时丢失，因此建议在进行任何更改之前备份functions.php文件。此外，为避免不必要的错误和冲突，建议在添加自定义功能前先了解WordPress开发文档和最佳实践，以确保正确、安全地实现所需的自定义功能。
如何进行WordPress数据库查询优化？
进行WordPress数据库查询优化可以通过以下方式实现：
- 使用WordPress提供的内置查询函数，例如 WP_Query 、 get_posts 等。
- 使用适当的查询参数和过滤器，减少查询次数和数据量。
- 编写自定义的数据库查询语句，使用适当的索引和缓存。
- 优化数据库服务器配置和性能。
- 定期清理和优化数据库表。
如何使用do_action来触发一个钩子函数？
使用 do_action 函数可以触发一个钩子函数。do_action 函数的参数与要触发的钩子函数的参数相同。

例如，触发save_post钩子函数的代码如下：
```
do_action( 'save_post', $post_ID, $post );
```
这里，$post_ID 和 $post 是传递给钩子函数的参数。

如何使用wp_get_current_user获取当前登录用户的信息？

使用 wp_get_current_user 获取当前登录用户的信息：

$current_user = wp_get_current_user();  
  
// 获取当前用户的ID  
$user_id = $current_user->ID;  
  
// 获取当前用户的用户名  
$user_login = $current_user->user_login;  
  
// 获取当前用户的邮箱  
$user_email = $current_user->user_email;  
  
// 获取当前用户的显示名称  
$display_name = $current_user->display_name;

get_plugin_data

常见问题

相关文章