README

描述

WordPress Pro插件广告显示库。

安装

$ composer require publishpress/wordpress-version-notices

加载库

该库现在通过由 lib PublishPress 版本加载生成器 生成的特殊包含文件和 Versions 类自动加载。

您只需在插件或主题的主要上下文中加载 vendor/autoload.php 文件，无需任何 WP 钩子，包括 plugins_loaded。

顶部公告

add_filter(\PublishPress\WordpressVersionNotices\Module\TopNotice\Module::SETTINGS_FILTER, function ($settings) {
    $settings['dumb-plugin-one'] = [
        'message' => 'You\'re using Dumb Plugin One Free. Please, %supgrade to pro%s.',
        'link'    => 'http://example.com/upgrade',
        'screens' => [
            [
                'base'      => 'edit',
                'id'        => 'edit-post',
                'post_type' => 'post',
            ],
        ]
    ];

    return $settings;
});

参数

• message: 输入横幅的相应消息，在 '%s' 之间添加按钮文本。此字符串将用作 sprint 的格式。
• link: 按钮的完整链接。
• screen: 用于决定应显示横幅的页面的一组屏幕参数。数组中的每个项目可以是布尔值，也可以是一个键值数组，指定从屏幕（WP_Screen）对象中所需的参数。您可以通过在数组中添加一个 true 项来绕过库的筛选算法。这允许您创建自己的函数来检查屏幕并返回布尔值。

菜单链接

add_filter(\PublishPress\WordpressVersionNotices\Module\MenuLink\Module::SETTINGS_FILTER, function ($settings) {
    $settings['dumb-plugin-one'] = [
        'label' => 'Upgrade',
        'link'    => 'http://example.com/upgrade',
        'parent' => 'parent-menu-alias'
    ];

    return $settings;
});

如果插件有可选的父菜单（在禁用某些模块的情况下），您可以指定一组有效的菜单作为父菜单。找到的第一个父菜单被用作父菜单。

add_filter(\PublishPress\WordpressVersionNotices\Module\MenuLink\Module::SETTINGS_FILTER, function ($settings) {
    $settings['dumb-plugin-one'] = [
        'label' => 'Upgrade',
        'link'    => 'http://example.com/upgrade',
        'parent' => [
            'parent-menu-alias-1',
            'parent-menu-alias-2',
            'parent-menu-alias-3',
        ]
    ];

    return $settings;
});

参数

• label: 输入菜单项的相应标签。
• link: 菜单链接的完整链接。
• parent: 我们应该添加链接的父菜单。字符串或数组。

测试

创建一个专用于测试的新 WordPress 安装。

确保将文件 .env.testing.dist 复制为 .env.testing 并根据您的环境更新变量。

使用 composer 安装依赖项

$ composer install

或

$ composer update

运行脚本

$ composer test

脚本是为 *nix 系统实现的。未针对 Windows 适配。

许可

许可: GPLv3 或更高版本