如何弃用插件中使用的功能？

我在插件中使用的功能之一是使用可能与另一个功能（在另一个插件中使用）相冲突的名称来污染全局范围。所以，我想我应该弃用它。但是我应该怎么做呢？

function foo() {
    echo 'bar';
}

我知道，_deprecate_function()但对于一个示例，该示例显示了我应采取的所有步骤，以从插件的核心中删除该功能，将不胜感激。

参考：https : //developer.wordpress.org/reference/functions/_deprecated_function/

除了@Welcher的答案：

核心中有一些很好的“ 墓地 ”示例，其中“ 功能消失了 ”。

您可以将它们用作准则，例如关于文档。

下面是一个这样的例子permalink_link()下wp-includes/deprecated.php

/**
 * Print the permalink of the current post in the loop.
 *
 * @since 0.71
 * @deprecated 1.2.0 Use the_permalink()
 * @see the_permalink()
 */
function permalink_link() {
        _deprecated_function( __FUNCTION__, '1.2', 'the_permalink()' );
        the_permalink();
}

这_deprecated_function是解释输入参数的函数的内联文档：

/**
 * Mark a function as deprecated and inform when it has been used.
 *
 * There is a hook deprecated_function_run that will be called that can be used
 * to get the backtrace up to what file and function called the deprecated
 * function.
 *
 * The current behavior is to trigger a user error if WP_DEBUG is true.
 *
 * This function is to be used in every function that is deprecated.
 *
 * @since 2.5.0
 * @access private
 *
 * @param string $function    The function that was called.
 * @param string $version     The version of WordPress that deprecated the function.
 * @param string $replacement Optional. The function that should have been called. 
 *                            Default null.
 */

弃用并不总是等同于被删除，这通常意味着该项目已标记为可从API进行有效删除。这是一种可以在外部调用的方法吗？就像其他插件或开发人员一样吗？如果此方法仅由插件内部使用，则可以安全地删除它，并使用更好的名称函数替换它。

如果没有，我将创建一个命名更好的函数，并使用一个调用来命名错误的一个函数__doing_it_wrong-在法典中阅读该函数，这将使其他开发人员有时间更新其对该方法的引用，并且可以安全地删除其中的方法。更高的版本。

function badly_named() {

    __doing_it_wrong( 'badly_named', 'This method has been deprecated in favor of better_named_function' );

    /**
     * Call the better named method
     */
     better_named_function();
}

希望这可以帮助！

您创建了一个新插件，并建议您的用户迁移到该插件，因为当前的插件是EOL。

没有什么比让插件和主题作者更改其公共API并尝试将其视为“只是另一个小的升级”更令人讨厌的了。由于您的用户实际上没有受到影响，因此没有理由中断站点。

我建议类似的东西：

/**
 * @deprecated Please use good_function_name() instead
 * @since x.y.z Marked deprecated in favor of good_function_name()
 * @see good_function_name()
 */
function bad_function_name() {
    trigger_error(
        'The ' . __FUNCTION__ . ' function is deprecated. ' .
        'Please use good_function_name() instead.',
        defined( 'E_USER_DEPRECATED' ) ? E_USER_DEPRECATED : E_USER_WARNING
    );

    return good_function_name();
}

这具有在日志中显示弃用警告以及堆栈跟踪的效果。自然，这仅在WordPress中启用日志记录时才有效。

三元运算符在那里，因为E_USER_DEPRECATED常量仅在PHP 5.3.0中引入。在旧版本中，我们可以改用简单的用户警告。

从PHP手册中获取错误常量：

E_DEPRECATED运行时通知。启用此功能可接收有关在以后的版本中将不起作用的代码的警告。

我不喜欢使用_doing_it_wrong或__deprecated_function的原因是这些功能仅适用于WordPress核心。从这些功能的代码参考中：

该功能的访问被标记为私有。这意味着它不打算由插件或主题开发人员使用，只能在其他核心功能中使用。为了完整性，这里列出了它。