TGM插件激活

要求和推荐WordPress主题插件(以及其他插件)的最佳方式。

配置TGMPA以与主题/插件一起使用

这个TGM插件激活该库有一个易于使用的API来引用插件和设置配置选项。考虑以下代码(摘自示例.php).

重要事项-请注意:

以下代码可能稍有过时-下载包将始终包含最新和最完整的版本。实际示例.php该文件还包含了一些更详细的示例,说明如何配置来自不同来源和不同slug的插件。

<?php(电话)
/***包括TGM_Plugin_Activation类。*/
需要一次 目录名( __文件__ ) . “/class-tgm-plugin-activation.php”;

添加操作(_A)( “tgmpa_register”, “my_theme_register_required_plugins” );

/***注册此主题所需的插件。**<剪/>**此函数被挂接到tgmpa_init中,该函数在*TGM_Plugin_Activation类构造函数。*/
功能 my_theme_register所需插件() {
	/**插件数组的数组。必需的键是名称和slug。*如果来源不是来自.org repo,那么来源也是必需的。*/
	$个插件 = 阵列(

		//这是一个如何包含与主题捆绑的插件的示例。		阵列(
			“名称”               => “TGM示例插件”, //插件名称。			“段塞”               => 'tgm示例插件', //插件slug(通常是文件夹名称)。			'源'             => 获取样式表目录() . '/lib/plugins/tgm-example-plugin.zip', //插件源代码。			“必需”           => 真的, //如果为false,则插件仅为“推荐”而非必需。			'版本'            => '', //例如1.0.0。如果已设置,则活动插件必须是此版本或更高版本。如果插件版本高于安装的插件版本,则会通知用户更新插件。			'强制激活'   => , //如果为true,则插件在主题激活时激活,并且在主题切换之前无法停用。			'强制激活' => , //如果为true,则插件在主题切换时被停用,这对特定于主题的插件很有用。			'外部url'       => '', //如果设置,则覆盖默认API URL并指向外部URL。			“可调用”        => '', //如果设置,将检查此可调用项的可用性,以确定插件是否处于活动状态。		),

		//这是一个如何从WordPress插件库中包含插件的示例。		阵列(
			“名称”      => '好友新闻',
			“鼻涕虫”      => '好友新闻',
			“必需”  => ,
		),
		
		//<剪/>	);

	/**配置设置数组。根据需要修改每一行。**TGMPA将很快开始提供本地化文本字符串。如果你已经有我们标准的翻译*字符串可用,请允许我们访问这些翻译或通过*用带有翻译的.po文件发送pull请求。**如果要自定义字符串,请仅取消注释配置数组中的字符串。*/
	$配置 = 阵列(
		“id”           => “tgmpa”,                 //多个TGMPA实例的散列通知的唯一ID。		'默认路径' => '',                      //绑定插件的默认绝对路径。		'菜单'         => 'tgmpa-安装插件', //菜单段塞。		'parent_slug'  => '主题.php',            //父菜单段塞。		“功能”   => '编辑主题选项',    //查看插件安装页面所需的功能应该是与所使用的父菜单相关联的功能。		'有通知(_N)'  => 真的,                    //是否显示管理员通知。		“可解雇”  => 真的,                    //如果为false,则用户无法消除该nag消息。		'解除msg'  => '',                      //如果“dissustable”为false,则此消息将输出在nag的顶部。		'是自动的' => ,                   //安装后是否自动激活插件。		'消息'      => '',                      //要在插件表之前输出的消息。		/*“strings”=>数组(“page_title”=>__(“安装所需插件”,“theme-slug”),“menu_title”=>__(“安装插件”,“theme-slug”),//<snip></剪刀>'nag_type'=>'updated',//确定管理通知类型-只能是'updated_nag'、'update-nag'或'error'。)*/
	);

	tgmpa(千兆帕)( $个插件, $配置 );

}

插件参数

每个插件都可以接受一组参数,如下所示(需要红色的参数,有时需要橙色的参数):

参数 类型 细节
名称 一串 2.0.0版 插件的名称。
段塞 一串 2.0.0版 插件slug,通常是保存插件的文件夹的名称。
必修的 布尔值 2.0.0版 要么真的。默认为.
如果设置为真的,插件将显示为必修的.
如果设置为或未设置,插件将显示为推荐.
来源 一串 2.0.0版 插件的源代码。
如果您正在引用插件,则需要此参数不是来自WordPress插件库。
您可以通过此参数引用捆绑插件或互联网上其他地方的插件。
对于捆绑插件,这应该是.zip文件的路径。对于外部插件,是指向.zip文件的直接url。
版本 一串 第2.2.0版 插件所需的最低版本。
如果您需要插件的最低版本才能使主题或插件工作,则此参数非常有用。
如果用户安装了插件,但不符合指定的最低版本,则会显示一条通知,要求他们将插件更新到最新版本。
注意:此参数为必修的如果你想让用户用更新的插件更新插件捆绑的版本。
强制_激活 布尔值 第2.2.0版 要么真的。默认为.
如果设置为真的,它强制指定的插件在当前主题(或插件)处于活动状态时始终处于活动状态。只有在切换主题或停用插件后,才能停用插件。
强制_激活 布尔值 第2.2.0版 要么真的。默认为.
如果设置为真的,它强制在切换当前主题时停用指定的插件。这对于停用特定于主题的插件很有用。
外部url 一串 第2.2.0版 插件的外部URL。
默认情况下,从WordPress插件库引用的插件通过thickbox覆盖链接到其插件信息。此参数覆盖此默认行为,并允许您为插件指定替代URL,单击后将在新选项卡/窗口中打开该插件。
可调用(_C) 字符串|数组 第2.5.0版 高级功能。如果一个插件可以安装在两个或多个不同的slug下,例如使用不同slug的基本版本和高级版本,那么它可能无法正确识别为活动的。
通过设置可调用(_C)到任一函数函数_名称从插件或类方法-数组(“类”、“方法”)-与操作和过滤器的连接方式类似,TGMPA仍然可以识别插件处于活动状态。

配置选项

该库还有一组配置选项供您在全局范围内操作,如下所示:

选项 类型 细节
身份证件 一串 第2.5.0版 可选。TGMPA的主题/插件实例的唯一id。默认为“tgmpa”.
当有几个主题/插件使用TGMPA并且管理员通知之前已被解除时,这用于防止管理员通知未显示。
默认路径(_P) 一串 2.0版本 可选。捆绑插件的默认绝对路径。
通常,这将设置为如下内容:获取样式表目录()。'/插件/主题或类似主题的内容插件dir_path(__FILE_)。'插件/'用于插件。
如果设置此选项,请确保来源捆绑插件的参数也不包含路径。
菜单 一串 2.0.0版 可选。插件安装页面的菜单段塞。默认为'tgmpa-安装插件'.
实际插件安装页面的slug,因此使用默认值时,它将如下所示:?page=tgmpa-安装插件
父_插件 一串 第2.5.0版 可选。插件安装页面的父菜单段塞。默认为'主题.php'.
如果更改此设置,请确保同时更改能力选项设置为适合该父菜单的功能。

在v2.2.0-v2.3.6中有两个选项父菜单插入parent_url_slug。这些在v2.4.0中被删除,因为它们会导致主题检查器出现问题。这些选项以前提供的功能已在v2.5.0中通过父_插件选项与能力选项与主题检查器兼容。
能力 一串 第2.5.0版 可选。访问插件安装页面所需的功能。默认为'编辑主题选项'.
如果您更改父母_插头,请确保将其更改为适用于新父菜单的功能。
例如,如果您将此更改为选项-通用.php要使插件安装页面显示在设置菜单,适当的功能将是管理选项(_O).
有通知(_N) 布尔值 第2.1.0版 可选。要么真的。默认为真的.
如果真的,显示了所需/推荐插件的管理通知。

v2.2.0之前,此选项被调用通知.
可解雇的 布尔值 第2.4.0版 可选。要么真的。默认为真的.
如果真的,管理员管理员通知可以由用户取消。
解雇msg 一串 第2.4.0版 可选。如果可解雇的选项设置为false,则在列出所需/推荐的插件之前,将在管理通知的顶部输出此消息。此字符串将由筛选wp_kses_post().
是自动的(_A) 布尔值 第2.2.0版 可选。要么真的。默认为.
如果真的,插件将在成功安装后自动激活(对于单一和批量安装过程)。
消息 一串 第2.2.0版 输出插件表之前要包含的可选HTML内容。此字符串将由筛选wp_kses_post().
阵列 2.0.0版 可选。整个库中使用的可自定义字符串数组。
仅设置要自定义文本的字符串。您可以安全地删除任何未自定义的字符串。
字符串前缀为_n_noop()具有单数和复数形式(按顺序)。
此外,一些字符串将包含%秒/%1美元变量-查看每行末尾的注释,了解每个参数是什么。
拜托确保调整文本域(主题段塞)任何自定义字符串的文本域你的主题/插件。

行动呼吁:
TGMPA将很快开始提供本地化文本字符串。如果您已经有我们标准字符串的翻译,请帮助我们使TGMPA更好,方法是让我们能够访问这些翻译,或者通过发送一个拉请求.po型(和.mo)带有翻译的文件。
有关如何执行此操作的更多信息,请阅读贡献指南.
父菜单插入 一串 第2.2.0版 已弃用自2.4.0起。请参见父_插件.
parent_user_slug(父用户_子用户_插件) 一串 第2.2.0版 已弃用自2.4.0起。请参见父_插件.
通知 布尔值 2.0.0版 已弃用自2.2.0起。请参见有通知(_N).

返回页首