Bagaimana cara menghentikan fungsi yang digunakan dalam plugin?

Salah satu fungsi yang saya gunakan dalam plugin saya adalah mencemari lingkup global dengan nama yang dapat bertabrakan dengan fungsi lain (digunakan dalam plugin lain). Jadi, saya kira saya harus mencela itu. Tetapi bagaimana saya harus melakukannya?

function foo() {
    echo 'bar';
}

Saya sadar _deprecate_function() tetapi akan berterima kasih atas contoh yang menunjukkan semua langkah yang harus saya ambil untuk menghapus fungsi dari inti plugin saya.

Ref: https://developer.wordpress.org/reference/functions/_deprecated_function/

Selain jawaban oleh @Welcher:

Ada beberapa contoh " kuburan " yang baik di inti, di mana " fungsi mati ".

Anda dapat menggunakannya sebagai pedoman, misalnya tentang dokumentasi.

Berikut adalah salah satu contoh untuk di permalink_link()bawah iniwp-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();
}

Inilah dokumentasi sebaris untuk _deprecated_functionfungsi yang menjelaskan argumen input:

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

Penghentian tidak selalu sama dengan penghapusan, biasanya berarti bahwa item ditandai untuk penghapusan EVENTUAL dari API. Apakah ini metode yang akan dipanggil secara eksternal - seperti oleh plugin atau pengembang lain? Jika metode ini hanya digunakan oleh plugin secara internal, Anda mungkin dapat menghapusnya dengan aman dengan fungsi nama yang lebih baik.

Jika tidak, saya akan membuat fungsi dengan nama yang lebih baik dan memanggil orang yang memanggilnya dengan __doing_it_wrongpanggilan - membacanya di dalam kodeks. Ini akan memberi pengembang lain waktu untuk memperbarui referensi mereka ke metode dan Anda dapat dengan aman menghapus metode di versi selanjutnya.

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

Semoga ini membantu!

Anda membuat plugin baru dan menyarankan pengguna Anda untuk bermigrasi karena plugin saat ini adalah EOL.

Tidak ada yang lebih menyebalkan daripada pengaya plugin dan tema mengubah API publik mereka dan mencoba memperlakukannya sebagai "sekadar peningkatan kecil" Tidak ada alasan untuk memecah situs karena masalah yang sebenarnya tidak dipengaruhi oleh pengguna Anda.

Saya akan menyarankan sesuatu seperti:

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

Ini memiliki efek menunjukkan peringatan penghentian dalam log bersama dengan jejak tumpukan. Biasanya ini hanya akan berfungsi jika pencatatan diaktifkan di WordPress.

Operator ternary ada di sana karena konstanta E_USER_DEPRECATED hanya diperkenalkan dalam PHP 5.3.0. Dalam versi yang lebih lama, kita bisa kembali ke peringatan pengguna sederhana.

Dari manual PHP tentang konstanta kesalahan :

E_DEPRECATED Pemberitahuan waktu berjalan. Aktifkan ini untuk menerima peringatan tentang kode yang tidak akan berfungsi di versi mendatang.

Alasan saya tidak suka menggunakan _doing_it_wrong atau __deprecated_function adalah bahwa fungsi-fungsi ini hanya ditujukan untuk inti WordPress. Dari referensi kode pada fungsi-fungsi tersebut:

Akses fungsi ini ditandai pribadi. Ini berarti tidak dimaksudkan untuk digunakan oleh plugin atau pengembang tema, hanya di fungsi inti lainnya. Itu tercantum di sini untuk kelengkapan.