Làm thế nào để loại bỏ một chức năng được sử dụng trong một plugin?

Một trong những chức năng tôi đang sử dụng trong plugin của mình là gây ô nhiễm phạm vi toàn cầu với một tên có thể va chạm với một chức năng khác (được sử dụng trong một plugin khác). Vì vậy, tôi đoán tôi nên từ chối nó. Nhưng làm thế nào tôi nên đi về điều đó?

function foo() {
    echo 'bar';
}

Tôi biết _deprecate_function()nhưng sẽ rất biết ơn về một ví dụ hiển thị tất cả các bước tôi nên thực hiện để xóa chức năng khỏi lõi của plugin.

Tham chiếu: https://developer.wordpress.org/reference/fifts/_deprecated_feft/

Ngoài câu trả lời của @Welcher:

Có một số ví dụ " nghĩa địa " tốt trong lõi, trong đó "các chức năng sẽ chết ".

Bạn có thể sử dụng chúng làm hướng dẫn, ví dụ liên quan đến tài liệu.

Dưới đây là một ví dụ cho permalink_link()dướiwp-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();
}

Đây là tài liệu nội tuyến cho _deprecated_functionhàm giải thích các đối số đầu vào:

/**
 * 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.
 */

Khấu hao không phải lúc nào cũng được loại bỏ bằng nhau, điều đó thường có nghĩa là mục được đánh dấu để xóa SỰ KIỆN khỏi API. Đây có phải là một phương thức sẽ được gọi bên ngoài - như trong các plugin hoặc nhà phát triển khác không? Nếu phương thức này chỉ được sử dụng bởi plugin trong nội bộ, bạn có thể loại bỏ một cách an toàn thay thế nó bằng một chức năng tên tốt hơn.

Nếu không, tôi sẽ tạo ra hàm được đặt tên tốt hơn và gọi một hàm được gọi xấu bằng một __doing_it_wrongcuộc gọi - đọc về nó trong bộ mã Điều này sẽ cho các nhà phát triển khác có thời gian để cập nhật các tham chiếu của họ đến phương thức và bạn có thể gỡ bỏ phương thức một cách an toàn một phiên bản mới hơn.

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();
}

Hi vọng điêu nay co ich!

Bạn tạo một plugin mới và khuyên người dùng của bạn chuyển sang plugin đó vì plugin hiện tại là EOL.

Không có gì khó chịu hơn các tác giả plugin và chủ đề thay đổi API công khai của họ và cố gắng coi nó là "chỉ là một bản nâng cấp nhỏ". Không có lý do để phá vỡ các trang web vì một vấn đề người dùng của bạn thực sự không bị ảnh hưởng.

Tôi sẽ đề nghị một cái gì đó như:

/**
 * @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();
}

Điều này có tác dụng hiển thị cảnh báo khấu hao trong nhật ký cùng với dấu vết ngăn xếp. Đương nhiên, điều này sẽ chỉ hoạt động nếu đăng nhập được kích hoạt trong WordPress.

Toán tử ternary ở đó vì hằng số E_USER_DEPRECATED chỉ được giới thiệu trong PHP 5.3.0. Trong các phiên bản cũ hơn, chúng ta có thể quay lại cảnh báo người dùng đơn giản thay thế.

Từ hướng dẫn PHP về hằng số lỗi :

E_DEPRECATED Thông báo thời gian chạy. Cho phép điều này để nhận cảnh báo về mã sẽ không hoạt động trong các phiên bản trong tương lai.

Lý do tôi không thích sử dụng _doing_it_wrong hoặc __deprecated_function là các chức năng này chỉ dành cho lõi WordPress. Từ tham chiếu mã trên các chức năng đó:

Quyền truy cập của chức năng này được đánh dấu là riêng tư. Điều này có nghĩa là nó không dành cho các nhà phát triển plugin hoặc chủ đề sử dụng, chỉ trong các chức năng cốt lõi khác. Nó được liệt kê ở đây cho đầy đủ.