typisttech/wp-admin-tabs

使用面向对象的方法为WordPress管理仪表板创建标签式导航

0.3.1 2017-10-29 07:50 UTC

This package is auto-updated.

Last update: 2024-09-05 05:41:20 UTC


README

Latest Stable Version Total Downloads Build Status codecov Scrutinizer Code Quality PHP Versions Tested StyleCI License Donate via PayPal Hire Typist Tech

使用面向对象的方法为WordPress管理仪表板创建标签式导航。

安装

应通过composer安装,有关如何安装composer的详细信息,请参阅https://getcomposer.org.cn/

$ composer require typisttech/wp-admin-tabs

您应将所有WP Admin Tabs类放在自己的命名空间下,以避免类名冲突。

用法

示例

Screenshot example

$adminTabCollection = new AdminTabCollection();
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php')),
    new AdminTab('Users', admin_url('users.php')),
    new AdminTab('Tab A', admin_url('users.php')),
    new AdminTab('Tab B', admin_url('users.php')),
);

// This echos the tabs:
$adminTabCollection->render();

// This returns the HTML string of the tabs:
$html = $adminTabCollection->toHtml();

AdminTab

__construct(string $menuTitle, string $url)

AdminTab构造函数。

  • @param string $menuTitle 此标签的菜单标题。
  • @param string $url 此标签的URL。
new AdminTab('Blog', 'https://typist.tech');

new AdminTab('Blog', admin_url('plugins.php'));

AdminTabCollection

add(AdminTab ...$adminTabs)

添加管理员标签。

  • @param AdminTab[] ...$adminTabs 要添加的管理员标签。
$adminTabCollection = new AdminTabCollection();

// Add single admin tab.
$adminTabCollection->add(
    new AdminTab('Users', admin_url('users.php'))
);

// Add multiple admin tabs.
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php'))
);

render()

使用echo渲染标签。

$adminTabCollection = new AdminTabCollection();
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php')),
    new AdminTab('Users', admin_url('users.php'))
);

$adminTabCollection->render();

toHtml(): string

将标签转换为HTML字符串,不使用echo

$adminTabCollection = new AdminTabCollection();
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php')),
    new AdminTab('Users', admin_url('users.php'))
);

$adminTabCollection->toHtml();

常见问题解答

这是一个插件吗?

不,这是一个应该成为您插件一部分的包。

当wp.org插件团队告诉我清理vendor文件夹时,我该怎么做?

通过以下命令重新安装包。此包仅将必要的文件导出到dist

$ composer install --no-dev --prefer-dist --optimize-autoloader

两个不同的插件可以同时使用这个包吗?

是的,如果将所有WP Admin Tabs类放在自己的命名空间下以避免类名冲突。

你有没有使用这个包的实际例子?

请看这里

在此添加您自己的插件

这看起来很棒。我能在哪里找到更多类似的好东西?

支持

喜欢wp-admin-tabs?帮助我维护它,这里的捐款可以帮助我。

为什么你不雇佣我?

准备好接受自由职业WordPress工作了。通过此处的联系方式表单或通过电子邮件info@typist.tech联系我

你想以其他方式帮忙吗?想成为赞助商吗?

联系方式:Tang Rufus

开发

要设置一个可开发的开发者版本,您应该运行以下命令

$ composer create-project --keep-vcs --no-install typisttech/wp-admin-tabs:dev-master
$ cd wp-admin-tabs
$ composer install

运行测试

WP Admin TabsCodeception 上运行测试,并依赖于 wp-browser 提供WordPress集成。在测试之前,您需要在本地安装WordPress并添加一个 codeception.yml 文件。请参阅 *.suite.example.yml 以获取 Local by Flywheel 的配置示例。

实际运行测试

$ composer test

我们还测试了所有PHP文件是否符合 PSR-2: 编码风格指南 以及部分 WordPress 编码标准

使用 $ composer check-style 检查代码风格。

反馈

请提供反馈! 我们希望尽可能让这个包在尽可能多的项目中变得有用。请提交一个 问题 并指出您喜欢和不喜欢的地方,或者复制该项目并提出建议。 没有问题太小。

变更日志

请参阅 CHANGELOG 了解最近的变化。

安全

如果您发现任何与安全相关的问题,请通过电子邮件 wp-admin-tabs@typist.tech 联系,而不是使用问题跟踪器。

贡献

请参阅 CONTRIBUTINGCODE_OF_CONDUCT 了解详细信息。

鸣谢

WP Admin TabsTypist Tech 的项目,由 Tang Rufus 维护,他是 雇佣 的自由职业开发者。

贡献者名单的完整列表可以在 这里 找到。

许可协议

WP Admin Tabs自由软件基金会 下以GPLv2(或更高版本)授权。请参阅 许可证文件 了解更多信息。