kunoichi/plugin-recommender

为WordPress主题推荐插件的PHP库。

1.0.0 2022-12-06 07:04 UTC

This package is auto-updated.

Last update: 2024-09-06 10:54:48 UTC


README

WordPress主题插件推荐器。

如何使用

在你的主题中,通过composer安装。

composer require kunoichi/plugin-recommender

然后,在functions.php中包含autoload.php

require_once __DIR__ . '/vendor/autoload.php';

现在你可以引用类Kunoichi\PluginRecommender

Kunoichi\PluginRecommender::bulk_add( [
  [
    slug        => 'jetpack',
    description => __( 'Because automattic recommends this plugin.', 'domain' ),
  ],
  [
    slug     => 'contact-form-7',
    priority => 100,
  ],
] );

属性

以下是可以为每个插件设置的属性列表。

slug

必需。这应该与WordPress.org相同。

source

可选。默认为wp。如果你提供了一些额外的仓库,设置其名称。当然,你需要一个额外的过滤器plugin_recommender_information来使其正常工作。

priority

可选。推荐的插件按降序排列。超过90表示“必需”,超过50表示“集成”,其他只是推荐。

description

可选。如果这项推荐需要一些说明来识别其效率,请写下。

API

Kunoichi\PluginRecommender::bulk_add( $settings )

批量加载设置。传递设置数组。

Kunoichi\PluginRecommender::add( $setting )

向推荐列表添加单个插件。

Kunoichi\PluginRecommender::load( $json_file_path )

表示$settings的JSON文件也可以使用。但是JSON尚未准备好进行翻译。

Kunoichi\PluginRecommender::load()

只需将recommendations.json放在你的主题目录中。

Kunoichi\PluginRecommender::set_title( $string )
Kunoichi\PluginRecommender::set_menu_title( $string )
Kunoichi\PluginRecommender::set_description( $string )

更改页面标题、菜单标题和描述。

许可证

GPL 3.0或更高版本。