Membuat lisensi dikendalikan memperbarui sistem: melakukan Update

() translation by (you can also view the original English article)

Dalam tutorial pertama dua seri, kami telah membangun sebuah plugin untuk mengelola lisensi perangkat lunak. Dalam bagian 1, kami membangun tool administrasi yang diperlukan untuk menambahkan produk dan lisensi, dan di bagian 2, kami menciptakan sebuah API yang plugin dan tema dapat digunakan untuk mengakses informasi lisensi dan produk.

Sekarang, saatnya untuk mengikat semua bersama-sama dan membuat WordPress tema dan WordPress plugin yang menggunakan server lisensi untuk memeriksa pembaruan. Untuk melakukan ini, kita akan menciptakan sebuah class yang dapat dipakai ke WordPress plugin atau tema kode untuk membuat tema atau plugin yang menggunakan situs WordPress menjalankan plugin WP lisensi Manager kami untuk memeriksa pembaruan.

Dalam tutorial ini, Anda akan belajar tentang topik-topik berikut:

Bagaimana untuk menghubungkan ke sistem pembaruan tema WordPress.
Bagaimana untuk menghubungkan ke sistem update plugin WordPress (ya, dua-duanya terpisah — tetapi sama — dan harus dialamatkan satu-satu).
Bagaimana memanggil API eksternal dari WordPress.

Fungsi kita akan menciptakan dalam tutorial ini mengharuskan kita untuk menggali lebih dalam bagaimana WordPress bekerja di belakang layar, yang membuat tutorial ini sedikit lebih maju daripada dua yang pertama dalam seri. Namun, kita akan pergi melalui setiap langkah secara menyeluruh, jadi jika Anda telah mengikuti tutorial ini jauh, tidak harus menjadi tidak masalah menyelesaikan satu ini.

Seperti dalam bagian sebelumnya, Anda dapat mengikuti tutorial menulis kode Anda sendiri seperti kita pergi, atau download class akhir dan menggunakannya sebagai referensi.

Mari kita mulai.

1. menyiapkan lingkungan pengujian

Untuk membangun lisensi manajer klien class dan untuk menguji, Anda membutuhkan lingkungan pengujian dengan komponen-komponen berikut:

Server WordPress yang menjalankan plugin WP lisensi Manager yang dibuat di bagian 1 dan 2 dari seri tutorial. Kita akan menyebutnya license server.
Server WordPress untuk menjalankan plugin dan tema yang akan diperbarui. Kita akan menyebutnya tes server.
Sebuah tema untuk pengujian sistem pembaruan.
Sebuah plugin untuk pengujian sistem pembaruan.

Anda dapat menggunakan salah satu dari kamu yang ada tema dan plugin untuk pengujian, atau membuat placeholder tanpa konten riil atau fungsionalitas selain update, mengikuti petunjuk di bawah ini.

Langkah 1: Buat WordPress Tema untuk pengujian

Dalam wp-content/themes, membuat sebuah direktori baru yang disebut hello-world-theme (misalnya).

Dalam direktori tersebut, menambahkan file style.css dengan judul tema yang standar. Hal ini diperlukan untuk WordPress menemukan tema.

/*
Theme Name: Hello World Theme
Description: A test theme that says Hello.
Version: 0.1
*/

Menambahkan sebuah file index.php. Ini bisa kosong, atau Anda dapat menggunakan pengganti berikut HTML:

<html>
    <head>
        <title>Hello, World</title>
    </head>
    <body>
        <h1>Hello, World!</h1>
    </body>
</html>

Untuk pengujian lisensi manajer klien class, kita masih perlu functions.php file. Ini adalah dimana Anda akan menginisialisasi class yang akan dibuat dalam tutorial ini-untuk saat ini, Anda dapat meninggalkan file kosong.

Dengan konfigurasi ini minimal, WordPress akan menerima tema tanpa kesalahan. Aktifkan sekarang.

Sekali Anda telah memutuskan pada tema untuk menggunakan, tambahkan produk untuk menggambarkannya pada license server. Memanggil produk baru "Hello World Theme" dan ditetapkan nomor versi untuk sesuatu yang lebih tinggi dari 0,1 kita didefinisikan di header tema di atas.

Tandai bagian "post slug" bagian produk Permalink (hello-world-theme) karena akan digunakan sebagai ID Produk ketika berbicara dengan lisensi manager API.

Langkah 2: Buat sebuah Plugin untuk pengujian

Membuat plugin kosong tes yang bahkan lebih cepat daripada menciptakan tema tes. Semua yang Anda butuhkan adalah file PHP dengan bare-bones plugin header.

Dalam wp-content/plugins, membuat sebuah direktori yang disebut hello-world-plugin dan dalam hal ini, file, hello-world.php, dengan konten berikut:

<?php
/*
Plugin Name: Hello World Plugin
Description: A test plugin that says Hello.
Version: 0.1
*/

Plugin adalah sekarang siap jadi pergi ke depan dan mengaktifkannya.

Seperti yang Anda lakukan untuk tema, menciptakan produk untuk plugin ini pada server lisensi manajer. Memanggil Produk "Hello World Plugin"-ini akan memberikan Anda id (slug) hello-world-plugin — dan mengatur nomor versi untuk sesuatu yang lebih tinggi dari 0,1 didefinisikan dalam plugin header.

Sekarang bahwa Anda telah mengatur lingkungan pengujian Anda dan memiliki sebuah plugin dan tema siap untuk di testing, saatnya untuk memulai dengan lisensi manajer klien class itu sendiri.

2. menyiapkan License Manager Client Class

Mari kita mulai menciptakan License Manager Client class dengan membangun fungsi umum yang dibagikan oleh tema dan plugin. Seperti yang kita perlu menguji kode dalam beberapa konteks, kita akan mulai dengan tema dan menambahkan hal-hal tertentu di plugin setelah pembaruan tema bekerja.

Langkah 1: Membuat License Manager Client Class dan menginisialisasi itu

Dalam tema direktori (hello-world-theme), menambahkan class baru yang disebut Wp_License_Manager_Client (menggunakan file nama class-wp-license-manajer-client.php). Kelas ini akan menyelenggarakan semua kode yang terkait dengan memeriksa lisensi dan penanganan tema update.

Sebagai file class ini dimaksudkan untuk dimasukkan dalam sejumlah WordPress tema dan plugin, surround dengan cek class_exists. Dengan cara ini, jika ada banyak diinstal plugin dan tema yang menggunakan kelas ini, mereka tidak akan merusak sistem dengan mencoba untuk membuat class berkali-kali.

<?php
if ( ! class_exists( 'Wp_License_Manager_Client' ) ) {

    class Wp_License_Manager_Client {
    
    }

}

Mari kita lanjutkan dengan beberapa inisialisasi sebelum pindah ke fungsi sebenarnya.

Pertama, tambahkan beberapa variabel yang akan diinisialisasi dalam konstruktor class. Komentar kode menjelaskan variabel, dan saya akan menyebutkan mereka lagi ketika kita menggunakannya dalam kode.

/**
 * The API endpoint. Configured through the class's constructor.
 *
 * @var String  The API endpoint.
 */
private $api_endpoint;

/**
 * The product id (slug) used for this product on the License Manager site.
 * Configured through the class's constructor.
 *
 * @var int     The product id of the related product in the license manager.
 */
private $product_id;

/**
 * The name of the product using this class. Configured in the class's constructor.
 *
 * @var int     The name of the product (plugin / theme) using this class.
 */
private $product_name;

/**
 * The type of the installation in which this class is being used.
 *
 * @var string  'theme' or 'plugin'.
 */
private $type;

/**
 * The text domain of the plugin or theme using this class.
 * Populated in the class's constructor.
 *
 * @var String  The text domain of the plugin / theme.
 */
private $text_domain;

/**
 * @var string  The absolute path to the plugin's main file. Only applicable when using the
 *              class with a plugin.
 */
private $plugin_file;

Kemudian, tambahkan konstruktor untuk menetapkan variabel contoh ini:

/**
 * Initializes the license manager client.
 *
 * @param $product_id   string  The text id (slug) of the product on the license manager site
 * @param $product_name string  The name of the product, used for menus
 * @param $text_domain  string  Theme / plugin text domain, used for localizing the settings screens.
 * @param $api_url      string  The URL to the license manager API (your license server)
 * @param $type         string  The type of project this class is being used in ('theme' or 'plugin')
 * @param $plugin_file  string  The full path to the plugin's main file (only for plugins)
 */
public function __construct( $product_id, $product_name, $text_domain, $api_url,
                             $type = 'theme', $plugin_file = '' ) {
        // Store setup data
        $this->product_id = $product_id;
        $this->product_name = $product_name;
        $this->text_domain = $text_domain;
        $this->api_endpoint = $api_url;
        $this->type = $type;
        $this->plugin_file = $plugin_file;
    }
}

Untuk lebih memahami parameter ini digunakan untuk apa, dan link class ke tema Anda, buka file functions.php tema Anda dan membuat sebuah instance class Wp_License_Manager_Client:

<?php
require_once( 'class-wp-license-manager-client.php' );

if ( is_admin() ) {
    $license_manager = new Wp_License_Manager_Client(
        'hello-world-theme',
        'Hello World Theme',
        'hello-world-text',
        'https://<URL_TO_LICENSE_SERVER>/api/license-manager/v1'
    );
}

Mari kita pergi melalui kode baris demi baris:

Baris 2: Termasuk lisensi manajer class yang kita buat.

Baris 4: Lisensi manajer klien adalah hanya diperlukan dalam admin layar, sehingga untuk tidak membuat objek yang tidak perlu, memeriksa apakah pengguna adalah melihat salah satu WordPress admin layar atau tidak.

Baris 5-9: membuat instance Wp_License_Manager_Client yang menggunakan nilai parameter berikut:

hello-world-theme: slug (id) Produk (theme) pada license server.
Hello World Theme: nama tema. Ini akan digunakan untuk pengaturan layar dan lain situasi di mana kita perlu untuk merujuk pada produk oleh namanya.
Halo-world-text: teks domain tema Anda menggunakan untuk lokalisasi. Menggunakan domain teks yang sama untuk lisensi manajemen layar membuatnya lebih mudah untuk localizers untuk menerjemahkan seluruh tema sekaligus.
http://<URL_TO_LICENSE_SERVER>/api/license-manager/v1: ini adalah URL dengan api yang kami ciptakan dalam bagian sebelumnya dari seri tutorial. Mengganti URL_TO_LICENSE_SERVER dengan URL untuk situs WordPress di mana Anda menginstal plugin WP lisensi Manager.

Sisa dua parameter dalam konstruktor hanya diperlukan ketika class digunakan dengan sebuah plugin, jadi kita akan meninggalkan mereka ke nilai default untuk sekarang dan kembali kepada mereka kemudian dalam tutorial ketika kita pindah ke plugin update.

Langkah 2: Buat pengaturan layar untuk memasukkan kunci lisensi

Hal pertama yang pengguna harus dapat menggunakan lisensi manager API adalah lisensi key berlaku — dan cara untuk memasukkannya ke dalam tema.

Untuk ini, sekarang kita akan menciptakan layar pilihan baru.

Seperti yang kita telah menciptakan sejumlah serupa layar dalam bagian 1 dan 2 dari seri tutorial, aku akan pergi melalui kode hanya sebentar.

Perhatikan bahwa setiap bagian dari fungsionalitas yang masuk ke dalam lisensi manajer klien class harus diaktifkan dengan melampirkan salah satu class yang fungsi WordPress action atau filter. Dengan cara ini, segala sesuatu tetap bersih dan mudah untuk dikelila. Untuk menjaga hal-hal sesederhana mungkin untuk pengembang tema yang akan menggunakan class ini, saya telah meletakkan semua inisialisasi dalam konstruktor class.

Tambahkan pengaturan layar hook terkait ke konstruktor, tepat di bawah kode inisialisasi kami menambahkan di langkah sebelumnya:

// Add actions required for the class's functionality.
// NOTE: Everything should be done through actions and filters.
if ( is_admin() ) {
    // Add the menu screen for inserting license information
    add_action( 'admin_menu', array( $this, 'add_license_settings_page' ) );
    add_action( 'admin_init', array( $this, 'add_license_settings_fields' ) );
}

Kemudian, membuat fungsi dua yang disebutkan, add_license_settings_page dan add_license_settings_fields. Perhatikan bagaimana kami menggunakan variabel $product_name dan $text_domain dari konstruktor ketika menentukan judul untuk halaman pengaturan.

/**
 * Creates the settings items for entering license information (email + license key).
 */
public function add_license_settings_page() {
    $title = sprintf( __( '%s License', $this->text_domain ), $this->product_name );

    add_options_page(
        $title,
        $title,
        'read',
        $this->get_settings_page_slug(),
        array( $this, 'render_licenses_menu' )
    );
}

/**
 * Creates the settings fields needed for the license settings menu.
 */
public function add_license_settings_fields() {
    $settings_group_id = $this->product_id . '-license-settings-group';
    $settings_section_id = $this->product_id . '-license-settings-section';

    register_setting( $settings_group_id, $this->get_settings_field_name() );

    add_settings_section(
        $settings_section_id,
        __( 'License', $this->text_domain ),
        array( $this, 'render_settings_section' ),
        $settings_group_id
    );

    add_settings_field(
        $this->product_id . '-license-email',
        __( 'License e-mail address', $this->text_domain ),
        array( $this, 'render_email_settings_field' ),
        $settings_group_id,
        $settings_section_id
    );

    add_settings_field(
        $this->product_id . '-license-key',
        __( 'License key', $this->text_domain ),
        array( $this, 'render_license_key_settings_field' ),
        $settings_group_id,
        $settings_section_id
    );
}

Kedua fungsi yang dibuat di atas mendefinisikan sejumlah callback untuk render halaman pengaturan dan bidang pengaturan. Tambahkan fungsi callback:

/**
 * Renders the description for the settings section.
 */
public function render_settings_section() {
    _e( 'Insert your license information to enable updates.', $this->text_domain);
}

/**
 * Renders the settings page for entering license information.
 */
public function render_licenses_menu() {
    $title = sprintf( __( '%s License', $this->text_domain ), $this->product_name );
    $settings_group_id = $this->product_id . '-license-settings-group';

    ?>
        <div class="wrap">
            <form action='options.php' method='post'>

                <h2><?php echo $title; ?></h2>

                <?php
                    settings_fields( $settings_group_id );
                    do_settings_sections( $settings_group_id );
                    submit_button();
                ?>

            </form>
        </div>
    <?php
}

/**
 * Renders the email settings field on the license settings page.
 */
public function render_email_settings_field() {
    $settings_field_name = $this->get_settings_field_name();
    $options = get_option( $settings_field_name );
    ?>
        <input type='text' name='<?php echo $settings_field_name; ?>[email]'
           value='<?php echo $options['email']; ?>' class='regular-text'>
    <?php
}

/**
 * Renders the license key settings field on the license settings page.
 */
public function render_license_key_settings_field() {
    $settings_field_name = $this->get_settings_field_name();
    $options = get_option( $settings_field_name );
    ?>
        <input type='text' name='<?php echo $settings_field_name; ?>[license_key]'
           value='<?php echo $options['license_key']; ?>' class='regular-text'>
    <?php
}

Untuk meminimalkan resiko kesalahan ketik ketika mengetik nama bidang pengaturan, saya telah membuat fungsi helper, get_settings_field_name, yang digunakan di seluruh snipet kode di atas. Fungsi helper lain, get_settings_page_slug, digunakan untuk menentukan path ke layar pengaturan.

Tambahkan fungsi dua itu pada akhir class untuk membuat kode berjalan tanpa kesalahan:

/**
 * @return string   The name of the settings field storing all license manager settings.
 */
protected function get_settings_field_name() {
    return $this->product_id . '-license-settings';
}

/**
 * @return string   The slug id of the licenses settings page.
 */
protected function get_settings_page_slug() {
    return $this->product_id . '-licenses';
}

Fungsi menggunakan $product_id dimasukan dalam konstruktor untuk membuat bidang pengaturan dan pengaturan halaman siput. Dengan cara ini, setiap tema atau plugin yang menggunakan class akan mendapatkan pengaturan mereka sendiri dan tidak akan ada konflik.

Halaman pengaturan siap dan tampak seperti ini:

Langkah 3: Menambahkan pengingat untuk pengguna

Sangat mudah bagi pengguna untuk melewatkan suasana seperti ini dan akhirnya bertanya-tanya mengapa tema tidak memperoleh pembaruan. Itulah mengapa itu adalah ide yang baik untuk membuat pengingat yang akan ditampilkan di admin, sampai pengguna mengkonfigurasi tema dan memasuki lisensi key.

Saatnya untuk action WordPress lain. action admin_notices digunakan untuk semua WordPress pemberitahuan dan kesalahan, karena itu pas untuk keperluan kami.

Dalam konstruktor, tepat di bawah dua action kami menambahkan sebelumnya, tambahkan:

1	// Add a nag text for reminding the user to save the license information
2	add_action( 'admin_notices', array( $this, 'show_admin_notices' ) );

Kemudian, tambahkan fungsi, show_admin_notices:

/**
 * If the license has not been configured properly, display an admin notice.
 */
public function show_admin_notices() {
    $options = get_option( $this->get_settings_field_name() );

    if ( !$options || ! isset( $options['email'] ) || ! isset( $options['license_key'] ) ||
        $options['email'] == '' || $options['license_key'] == '' ) {

        $msg = __( 'Please enter your email and license key to enable updates to %s.', $this->text_domain );
        $msg = sprintf( $msg, $this->product_name );
        ?>
            <div class="update-nag">
                <p>
                    <?php echo $msg; ?>
                </p>

                <p>
                    <a href="<?php echo admin_url( 'options-general.php?page=' . $this->get_settings_page_slug() ); ?>">
                        <?php _e( 'Complete the setup now.', $this->text_domain ); ?>
                    </a>
                </p>
            </div>
        <?php
    }
}

Fungsi pertama cek jika opsi yang telah ditetapkan. Jika tidak ada pilihan item atau salah satu dari dua kolom yang harus diisi kosong, ini menunjukkan pemberitahuan dan link ke halaman pengaturan tema lisensi dimana pengguna dapat menyelesaikan setup. class, update-nag, mendefinisikan tampilan pemberitahuan.

Berikut adalah apa "nag" seperti apa, muncul di bagian atas dasbor admin:

Reminder for updating the license settings

Sekarang, untuk membuat nag pergi, mari kita menempatkan dalam informasi lisensi.

Pertama, kunjungi server lisensi WordPress admin area dan menciptakan lisensi baru untuk tema tes (Hello World Theme). Setelah Anda mengklik Add License, Anda akan melihat daftar lisensi.

Salin kunci lisensi yang dihasilkan oleh plugin manajer lisensi. Kemudian, kembali ke situs tes Anda dan mengkonfigurasi pengaturan lisensi tema dengan memasukkan alamat email Anda dan lisensi key yang disalin dari server lisensi manajer.

Nag Anda sudah pergi dan setting theme di tempat pengujian fungsionalitas yang akan kita buat berikutnya.

3. berkomunikasi dengan API lisensi Manager

Dengan framework dasar di tempat, mari kita lihat berkomunikasi dengan lisensi manager API.

Langkah 1: Tambahkan fungsi untuk memanggil API

Pertama, menambahkan fungsi untuk memanggil API lisensi Manager. Fungsi mengambil parameter kedua: metode API atau tindakan untuk memanggil server lisensi manajer, dan sebuah array dengan parameter untuk action:

//
// API HELPER FUNCTIONS
//

/**
 * Makes a call to the WP License Manager API.
 *
 * @param $method   String  The API action to invoke on the license manager site
 * @param $params   array   The parameters for the API call
 * @return          array   The API response
 */
private function call_api( $action, $params ) {
    $url = $this->api_endpoint . '/' . $action;

    // Append parameters for GET request
    $url .= '?' . http_build_query( $params );

    // Send the request
    $response = wp_remote_get( $url );
    if ( is_wp_error( $response ) ) {
        return false;
    }
  	
    $response_body = wp_remote_retrieve_body( $response );
    $result = json_decode( $response_body );
	
    return $result;
}

Baris 13: Membuat URL untuk memanggil, menggunakan URL base dimasikan sebagai parameter konstruktor ($api_endpoint), dan action dimasukan sebagai parameter ($method).

Baris 16: Menggunakan http_build_query fungsi PHP untuk membuat string parameter URL dikodekan dan menambahkan untuk request GET.

Baris 19: Menggunakan WordPress built-in HTTP fungsi wp_remote_get untuk mengirim sebuah GET request ke URL yang dihasilkan pada baris sebelumnya.

Baris 20-22: melakukan beberapa kesalahan asas untuk melihat jika terjadi kesalahan. Kami akan menambahkan fungsi is_api_error berikutnya.

Baris 24-25: membaca respon dan mengurai dari JSON encoded string ke array yang berisi data yang diterima dari server lisensi.

Baris 27: Mengembalikan respon.

Selanjutnya, tambahkan fungsi memeriksa kesalahan. Penanganan sangat kasar dan tidak pergi ke setiap detail tentang apa yang salah — hanya cukup untuk mengetahui jika ada kesalahan atau tidak:

/**
 * Checks the API response to see if there was an error.
 *
 * @param $response mixed|object    The API response to verify
 * @return bool     True if there was an error. Otherwise false.
 */
private function is_api_error( $response ) {
    if ( $response === false ) {
        return true;
    }

    if ( ! is_object( $response ) ) {
        return true;
    }

    if ( isset( $response->error ) ) {
        return true;
    }

    return false;
}

Langkah 2: Tambahkan fungsi untuk mengambil lisensi dan Update informasi

Sekarang bahwa kita telah menciptakan fungsi untuk berbicara dengan API, kita dapat menggunakannya untuk menghubungi server lisensi untuk mendapatkan beberapa informasi tentang tema atau plugin.

Tambahkan fungsi berikut untuk memanggil action info:

/**
 * Calls the License Manager API to get the license information for the
 * current product.
 *
 * @return object|bool   The product data, or false if API call fails.
 */
public function get_license_info() {
    $options = get_option( $this->get_settings_field_name() );
    if ( ! isset( $options['email'] ) || ! isset( $options['license_key'] ) ) {
        // User hasn't saved the license to settings yet. No use making the call.
        return false;
    }

    $info = $this->call_api(
        'info',
        array(
            'p' => $this->product_id,
            'e' => $options['email'],
            'l' => $options['license_key']
        )
    );

    return $info;
}

Baris 8: Mengambil lisensi manajer klien pilihan.

Baris 9 – 12: memverifikasi bahwa lisensi key dan email pilihan telah ditetapkan. Jika kita tidak punya mereka, memanggil API akan membuang-buang waktu — kita sudah tahu bahwa permintaan akan gagal.

Baris 14-21: Memanggil action info lisensi manager API dengan parameter berikut:

p: Produk ID didefinisikan dalam konstruktor Wp_License_Manager_Client.
e: alamat email pemilik lisensi, membaca dari pengaturan.
l: kunci lisensi, membaca dari pengaturan.

Baris 23: Mengembalikan data lisensi. Data akan mencakup bidang-bidang berikut:

name: Nama Produk (tema atau plugin).
description: Deskripsi produk.
version: versi saat ini tersedia di server.
package_url: URL download untuk produk. Ini adalah sebuah URL untuk mendapatkan API action pada server lisensi manajer.
Last_updated: Kapan produk telah diperbarui.
description_url: sebuah URL untuk halaman yang dapat digunakan untuk menampilkan informasi lebih lanjut tentang produk.
tested: tertinggi versi WordPress yang produk telah diuji (diperlukan hanya untuk plugin).
banner_low: resolusi rendah (reguler) versi produk banner gambar (hanya diperlukan untuk plugin).
banner_high: versi resolusi tinggi (retina) gambar banner Produk (hanya diperlukan untuk plugin).

Selanjutnya, mari kita gunakan fungsi untuk memeriksa apakah ada update yang menunggu untuk di-download. Tambahkan fungsi berikut:

/**
 * Checks the license manager to see if there is an update available for this theme.
 *
 * @return object|bool  If there is an update, returns the license information.
 *                      Otherwise returns false.
 */
public function is_update_available() {
    $license_info = $this->get_license_info();
    if ( $this->is_api_error( $license_info ) ) {
        return false;
    }

    if ( version_compare( $license_info->version, $this->get_local_version(), '>' ) ) {
        return $license_info;
    }

    return false;
}

Baris 8: Permintaan informasi produk yang menggunakan fungsi get_license_info yang baru Anda buat.

Baris 9 – 11: jika terjadi kesalahan saat membuat panggilan API, kembalikan nilai false. Ini juga akan ide yang baik untuk menunjukkan kesalahan pengguna-untuk menjaga hal-hal sederhana, aku meninggalkan bahwa fungsi untuk sekarang.

Baris 13: Menggunakan version_compare PHP untuk melihat apakah nomor versi yang diterima dari server lebih tinggi dari nomor versi lokal.

Baris 14: Jika update tersedia, kembalikan data lisensi. Dengan kembali data segera, kami menyimpan diri kita perlu melakukan panggilan API tambahan untuk mendapatkan data lagi.

Untuk menyelesaikan fungsi ini, kita masih perlu untuk menerapkan fungsi untuk mengambil nomor versi lokal, digunakan pada barus 13. Plugin dan tema data yang diakses sedikit berbeda, sehingga fungsi akan memiliki implementasi yang terpisah untuk keduanya:

/**
 * @return string   The theme / plugin version of the local installation.
 */
private function get_local_version() {
    if ( $this->is_theme() ) {
        $theme_data = wp_get_theme();
        return $theme_data->Version;
    } else {
        $plugin_data = get_plugin_data( $this->plugin_file, false );
        return $plugin_data['Version'];
    }
}

Baris 2: Mendapatkan data tema saat ini.

Baris 3: Membaca versi dan mengembalikannya.

Baris 5: Plugin data dibaca menggunakan fungsi berbeda, get_plugin_data, yang menggunakan nama berkas utama plugin sebagai pengenal. Kami akan menetapkan variabel $this-> plugin_file, kemudian ketika mengintegrasikan ke plugin uji kami.

Baris 6: Mengembalikan nomor versi plugin.

Tambahkan is_theme fungsi untuk memeriksa jenis produk yang dalam yang kami beroperasi:

1	private function is_theme() {
2	return $this->type == 'theme';
3	}

Kami sekarang telah menciptakan fungsi-fungsi yang diperlukan untuk menyambung ke server lisensi dan memeriksa jika ada versi yang lebih baru yang tersedia. Selanjutnya, ini adalah waktu untuk benar-benar menarik bagian: mengikat ini ke WordPress memperbarui fungsi.

4. Bagaimana WordPress memeriksa pembaruan

Framework untuk membangun sistem update theme dan plugin ini di tempat. Saatnya untuk mulai menggali lebih dalam ke dalam fungsi pembaruan WordPress.

Pada action admin_init (dan sejumlah lain, yang lebih spesifik, action), jika cukup waktu telah berlalu sejak pemeriksaan Pemutakhiran Terakhir, membandingkan WordPress Plugin dan tema terhadap versi host di WordPress.org Plugin dan tema direktori untuk melihat apakah baru Versi telah dirilis.

Setelah cek, WordPress menyimpan hasil ke transient situs: update_themes untuk tema dan update_plugins untuk plugin.

Kemudian, ketika Anda mengunjungi halaman update (atau halaman tema dan plugin), WordPress memeriksa ini transien untuk melihat dan menandai tema dan plugin yang memiliki update yang tersedia.

Ketika Anda melihat kode untuk fungsi ini (yang dapat Anda temukan di wp-includes/update.php) Anda dapat melihat bahwa ini telah dirancang untuk bekerja dengan direktori resmi dan tidak ada lagi: tidak ada hook untuk menentukan server untuk memeriksa terhadap atau untuk sniffing request sebelum dikirim.

Tapi itu belum berhenti pengembang plugin dan tema dari menggunakan server lisensi mereka sendiri — dan itu tidak akan menghentikan kita baik.

Solusinya terletak pada cara hasil update memeriksa disimpan. Saya sebutkan di atas bahwa hasil pencarian update disimpan dalam transien. Dan tepat pada awal set_site_transient fungsi WordPress, kita menemukan:

/**
 * Filter the value of a specific site transient before it is set.
 *
 * The dynamic portion of the hook name, $transient, refers to the transient name.
 *
 * @since 3.0.0
 *
 * @param mixed $value Value of site transient.
 */
$value = apply_filters( 'pre_set_site_transient_' . $transient, $value );

Filter ini memberi kami akses ke isi data update plugin dan tema sebelum disimpan, hanya dalam waktu untuk menambahkan data kami sendiri untuk itu!

5. mengaitkan ke WordPress Theme update

Mari kita mulai menerapkan pembaruan kita sendiri memeriksa kode, mulai dari tema.

Langkah 1: Buat Filter ke Hook ke pemeriksaan pemutakhiran tema

Seperti yang kita lihat di atas, ketika WordPress telah selesai memeriksa tema pembaruan dari WordPress.org direktori tema, menyimpan informasi tentang tema membutuhkan update di transien yang disebut update_themes.

Untuk memeriksa pembaruan kita sendiri dan menambahkan data ke transient sebelum disimpan, kami akan menghubungkan fungsi kita sendiri untuk filter, pre_set_site_transient_update_themes. Dalam fungsi ini, kami akan memanggil server lisensi untuk memeriksa pembaruan tema ini, dan kemudian, jika ada update yang tersedia, menambahkan informasi di transien.

Pertama, tambahkan filter pada akhir konstruktor Wp_License_Manager_Client's:

1	if ( $type == 'theme' ) {
2	// Check for updates (for themes)
3	add_filter( 'pre_set_site_transient_update_themes', array( $this, 'check_for_update' ) );
4	}

Kemudian, membuat fungsi, check_for_update:

/**
 * The filter that checks if there are updates to the theme or plugin
 * using the WP License Manager API.
 *
 * @param $transient    mixed   The transient used for WordPress
 *                          	theme / plugin updates.
 *
 * @return mixed        The transient with our (possible) additions.
 */
public function check_for_update( $transient ) {
    if ( empty( $transient->checked ) ) {
        return $transient;
    }

    $info = $this->is_update_available();
    if ( $info !== false ) {

        if ( $this->is_theme() ) {
            // Theme update
            $theme_data = wp_get_theme();
            $theme_slug = $theme_data->get_template();

            $transient->response[$theme_slug] = array(
                'new_version' => $info->version,
                'package' => $info->package_url,
                'url' => $info->description_url
            );
        } else {
            // Plugin updates will be added here.
        }
    }

    return $transient;
}

Baris 10-13: $transient->checked adalah sebuah array dengan semua tema yang saat ini terinstal dan nomor versi mereka (tema stylesheet sebagai key) dan versi sebagai nilai. Jika Anda adalah untuk memeriksa pembaruan untuk beberapa tema sekaligus, Anda dapat menggunakan array untuk mengumpulkan data dan mengirimkannya untuk server lisensi Anda. Dalam versi ini sederhana, namun, kami hanya memverifikasi bahwa array tidak kosong dan melanjutkan.

Baris 15 – 16: Periksa jika ada update yang tersedia untuk produk ini (theme) pada server lisensi kami, menggunakan fungsi is_update_available yang kita buat sebelumnya. Fungsi mengembalikan informasi produk jika versi pada server lisensi lebih tinggi dari yang diinstal dan false jika tidak ada update yang tersedia.

Baris 18: Periksa apakah ini adalah tema atau plugin. Pada titik ini, kita akan hanya berfokus pada tema pembaruan, jadi aku telah meninggalkan cabang lain yang kosong untuk saat ini.

Baris 20-21: menemukan tema "slug" untuk menggunakannya sebagai key untuk menandai tema saat ini membutuhkan update.

Baris 23-27: masukkan informasi yang berhubungan dengan tema update ke dalam sementara $response array, menggunakan tema slug sebagai key.

new_version: versi tema pada server.
package: URL untuk men-download paket tema. Seperti WordPress harus mampu untuk men-download tema langsung dari URL ini, kami menciptakan lisensi manager untuk mengembalikan URL terbentuk sepenuhnya dalam informasi lisensi, termasuk pengguna email alamat dan lisensi key.
url: URL halaman untuk menampilkan informasi tentang tema. Parameter ini digunakan ketika mengklik untuk informasi lebih lanjut di halaman Themes.

Baris 33: Mengembalikan sementara sehingga dapat menyimpan WordPress — dengan tema kami memperbarui informasi yang ditambahkan untuk itu.

Dan hanya itu! Anda sekarang telah membangun sistem update lengkap untuk host sendiri WordPress tema. Mari kita menguji fungsionalitas dan kemudian bergerak pada untuk update plugin.

Langkah 2: Menguji pembaruan tema

Sebelum pindah ke update plugin, mari kita menguji fungsionalitas untuk melihat update in action.

Memperbarui tema yang Anda gunakan untuk pengujian akan menimpa tema, jadi sebagai hal pertama, membuat file zip baru menggunakan file. Kemudian upload zip file ke Amazon S3 seperti yang kita lakukan pada bagian 2 dari seri tutorial.

Selanjutnya, log in ke server lisensi dan mengedit Hello World Theme informasi produk, memastikan menggunakan file zip Anda hanya meng-upload ke Amazon S3 dan produk nomor versi lebih tinggi dari salah satu tema yang terinstal secara lokal.

Simpan perubahan dan kepala kembali ke server tes untuk menguji update.

Pada tes server, klik pada Dashboard > Updates. WordPress sekarang akan melakukan panggilan API untuk memeriksa jika ada tema membutuhkan update. Jika tidak ada yang terjadi, bisa jadi bahwa cek sebelumnya telah hanya terjadi dan WordPress masih menunggu untuk batas waktu di antara versi cek untuk sukses. Dalam hal ini, menunggu satu menit dan klik Check Again untuk memaksa cek.

Sekarang, Anda akan melihat tema Anda dalam daftar tema yang dapat diperbarui.

Hello World Theme is in need of an update

Selanjutnya, mencoba melakukan update. Jika semuanya berjalan baik — sebagaimana mestinya-Anda akan melihat output berikut. Secara default, rincian tidak Tampilkan kecuali ada kesalahan, jadi Anda harus klik Show Details untuk melihat apa yang terjadi di update.

Perhatikan bagaimana tema tidak download dari WordPress.org tetapi agak lisensi manajer server sendiri.

6. mengaitkan untuk WordPress Plugin update

Dengan tema update dilakukan dan diuji, kami hampir selesai dengan tutorial. Sebagian besar dari kode yang akan dibutuhkan untuk memperbarui plugin sudah di tempat. Tetapi ada beberapa perbedaan dan penambahan diperlukan, jadi mari kita pergi untuk bekerja dan menambahkan dukungan untuk plugin kelas lisensi manajer klien kami.

Langkah 1: Masukan Client Class di Plugin Anda

Salin file class-wp-license-manajer-client.php ke folder sumber plugin tes Anda. Kemudian, di tempat yang cocok di plugin, tempat kode inisialisasi berikut.

Jika Anda menggunakan plugin kosong tes, hanya drop ke dalam berkas utama plugin, tepat di bawah plugin header. Ingatlah untuk mengganti <URL_TO_LICENSE_SERVER>dengan server URL.

require_once( 'class-wp-license-manager-client.php' );

if ( is_admin() ) {
    $license_manager = new Wp_License_Manager_Client(
        'hello-world-plugin',
        'Hello World Plugin',
        'hello-world-plugin-text',
        'http://<URL_TO_LICENSE_SERVER>/api/license-manager/v1',
        'plugin',
        __FILE__
    );
}

Sebagian besar parameter yang sama ketika initializing class untuk digunakan dengan tema — dengan berbeda, produk nilai spesifik (misalnya hello-world-plugin daripada hello-world-theme).

Dua parameter tidak digunakan ketika membuat suatu tema, jadi mari kita melihat mereka:

$type (dengan nilai plugin) memberitahu Wp_License_Manager_Client contoh menggunakan plugin fungsi tertentu.
$plugin_file (terakhir parameter) digunakan untuk mengambil plugin pengidentifikasi untuk meminta data plugin seperti versi sekarang. Ketika inisialisasi ini dilakukan di kelas utama plugin, kita dapat menggunakan __FILE__.

Langkah 2: Memeriksa pembaruan Plugin

Sebelumnya dalam tutorial ini, kita hook class Wp_License_Manager_Client kami untuk mencari perubahan dalam update_themes sementara dengan menempatkan baris add_filter pada akhir konstruktor. Update plugin akan ditangani dengan sama, hanya menggunakan update_plugins sementara bukan update_themes.

Jadi, tepat setelah filter yang ada, tambahkan kode spesifik plugin (baris 1-3 sudah hadir dalam konstruktor, jadi saya memasukan mereka di sini untuk menunjukkan mana kode baru harus pergi):

if ( $type == 'theme' ) {
    // Check for updates (for themes)
    add_filter( 'pre_set_site_transient_update_themes', array( $this, 'check_for_update' ) );
} elseif ( $type == 'plugin' ) {
    // Check for updates (for plugins)
    add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_for_update' ) );
}

Ketika Anda melihat kode di atas, filter baru menggunakan fungsi yang sama seperti yang kami menambahkan untuk tema, check_for_update.

Sebelumnya, ketika kita menciptakan fungsi check_for_update, kami meninggalkan satu cabang lain kosong, menunggu untuk diisi dengan kode untuk menangani plugin update. Sekarang, mari kita menambahkan konten ke bagian tersebut. Berikut adalah seluruh fungsi dengan plugin yang berhubungan dengan kode ditambahkan mulai dari baris 27:

/**
 * The filter that checks if there are updates to the theme or plugin
 * using the License Manager API.
 *
 * @param $transient    mixed   The transient used for WordPress theme updates.
 * @return mixed        The transient with our (possible) additions.
 */
public function check_for_update( $transient ) {
    if ( empty( $transient->checked ) ) {
        return $transient;
    }

    if ( $this->is_update_available() ) {
        $info = $this->get_license_info();

        if ( $this->is_theme() ) {
            // Theme update
            $theme_data = wp_get_theme();
            $theme_slug = $theme_data->get_template();

            $transient->response[$theme_slug] = array(
                'new_version' => $info->version,
                'package' => $info->package_url,
                'url' => $info->description_url
            );
        } else {
            // Plugin update
            $plugin_slug = plugin_basename( $this->plugin_file );

            $transient->response[$plugin_slug] = (object) array(
                'new_version' => $info->version,
                'package' => $info->package_url,
                'slug' => $plugin_slug
            );
        }
    }

    return $transient;
}

Melihat kode, ada baiknya untuk melihat bahwa sementara fungsi yang sama, sekarang kita sedang menangani berbeda transient, update_plugins daripada update_themes. Salah satu cara ini menunjukkan adalah bahwa sementara data dalam update_themes disimpan sebagai array, update_plugins menggunakan objek (baris 30)!

Panggilan untuk API lisensi Manager kami yang sama ketika menggunakan tema, tapi data yang disimpan untuk sementara sedikit berbeda — berdasarkan apa WordPress mengharapkan untuk menemukan di transien.

Dengan kode ini di tempat, Anda dapat sudah menguji pembaruan dengan cara yang sama kita lakukan dengan tema (buat zip file, meng-upload ke S3, mengedit properti produk). Pastikan nomor versi plugin pada server lisensi lebih tinggi daripada yang diinstal, dan navigasikan ke server tes Updates halaman. Pembaruan untuk Hello World Plugin harus muncul:

update for the Hello World Plugin appears

Ketika Anda memutahirkan plugin, Anda akan melihat bahwa itu adalah download dari server Anda sendiri seperti tema.

Tapi kita belum cukup selesai: jika Anda melihat informasi plugin dalam screenshot di atas, Anda akan melihat "Kompatibilitas dengan WordPress 4.0.1" mengatakan "Tidak diketahui". Juga, jika Anda klik View version 0.2 details, pesan kesalahan ditampilkan.

Mari kita memperbaiki hal ini.

Langkah 3: Sediakan informasi Plugin

Untuk mengumpulkan informasi yang menunjukkan tentang plugin, WordPress menggunakan fungsi yang disebut plugins_api. Secara default, fungsi memanggil API WordPress.org, seperti cek versi. Namun, tidak seperti memeriksa versi, fungsi ini berisi tiga filter kuat: plugins_api_args untuk mengedit parameter dikirim ke API, plugins_api untuk mengganti default permintaan API, dan plugins_api_result untuk mengedit hasil diterima dari API.

Kita akan menggunakan plugins_api karena memberikan kita tingkat terbesar mengontrol fungsi: ketika WordPress memulai panggilan API plugin untuk mendapatkan informasi tentang plugin saat ini, fungsi kita akan melompat dan menangani request menggunakan server lisensi bukan WordPress.org. Seluruh permintaan akan ditinggalkan untuk WordPress untuk di proses.

Pertama, tambahkan filter dalam konstruktor Wp_License_Manager_Client plugin di cabang else tertentu:

1	// Showing plugin information
2	add_filter( 'plugins_api', array( $this, 'plugins_api_handler' ), 10, 3 );

Kemudian, tambahkan fungsi:

/**
 * A function for the WordPress "plugins_api" filter. Checks if
 * the user is requesting information about the current plugin and returns
 * its details if needed.
 *
 * This function is called before the Plugins API checks
 * for plugin information on WordPress.org.
 *
 * @param $res      bool|object The result object, or false (= default value).
 * @param $action   string      The Plugins API action. We're interested in 'plugin_information'.
 * @param $args     array       The Plugins API parameters.
 *
 * @return object   The API response.
 */
public function plugins_api_handler( $res, $action, $args ) {
    if ( $action == 'plugin_information' ) {

        // If the request is for this plugin, respond to it
        if ( isset( $args->slug ) && $args->slug == plugin_basename( $this->plugin_file ) ) {
            $info = $this->get_license_info();

            $res = (object) array(
                'name' => isset( $info->name ) ? $info->name : '',
                'version' => $info->version,
                'slug' => $args->slug,
                'download_link' => $info->package_url,

                'tested' => isset( $info->tested ) ? $info->tested : '',
                'requires' => isset( $info->requires ) ? $info->requires : '',
                'last_updated' => isset( $info->last_updated ) ? $info->last_updated : '',
                'homepage' => isset( $info->description_url ) ? $info->description_url : '',

                'sections' => array(
                    'description' => $info->description,
                ),

                'banners' => array(
                    'low' => isset( $info->banner_low ) ? $info->banner_low : '',
                    'high' => isset( $info->banner_high ) ? $info->banner_high : ''
                ),

                'external' => true
            );

            // Add change log tab if the server sent it
            if ( isset( $info->changelog ) ) {
                $res['sections']['changelog'] = $info->changelog;
            }

            return $res;
        }
    }

    // Not our request, let WordPress handle this.
    return false;
}

Baris 16: Periksa Plugin API action yang diminta. Kami sedang hanya tertarik pada plugin_information, jadi jika WordPress meminta sesuatu yang lain, kita hanya mengembalikan nilai false dan membiarkan permintaan pergi semua jalan ke WordPress.org.

Baris 19: Periksa apakah request tentang plugin saat ini. Jika ya, kita akan mengambil permintaan dan menanganinya. Jika tidak, mengembalikan nilai false sehingga kita tidak memotong request API plugin-plugin lainnya.

Baris 20: Menghubungi server lisensi kami untuk mengambil informasi untuk produk saat ini.

Baris 22-48: mengumpulkan semua data plugin yang kami dapatkan dari info request. Sekarang, kami akhirnya menggunakan semua bidang yang dikembalikan oleh API.

Baris 50: Mengembalikan object result.

Untuk menguji fungsi ini, mengedit produk Hello World Plugin pada server lisensi Anda dan menambahkan nilai untuk semua bidang pengaturan produk. Selain pengaturan ditetapkan sebelumnya, masukkan yang berikut, menetapkan nilai-nilai untuk apa pun yang Anda suka — kami hanya menguji...

Tested with WordPress version: versi WordPress tertinggi Anda telah diuji plugin pada.
Requires WordPress version: versi WordPress minimum yang diperlukan untuk menjalankan plugin Anda.
Last Updated: Tanggal terakhir update ke plugin ini, dalam format YYYY-MM-DD.
Banner low and Banner high: bidang ini mendefinisikan normal (rendah) dan retina (tinggi) versi banner yang ditampilkan di atas layar informasi plugin. Sisipkan URL untuk gambar ukuran berikut: 772 x 250 untuk rendah dan 1544 x 500 untuk tinggi.

Simpan produk dan kepala kembali ke halaman Updates situs pengujian. Sekarang, Anda akan melihat bahwa ada bidang kompatibilitas versi WordPress tidak lagi tidak diketahui, dan ketika Anda klik pada Lihat Versi 0.2 rincian, Anda akan melihat popup ini:

Kesimpulan

Kami sekarang telah menciptakan sepenuhnya fungsional, lisensi dikendalikan WordPress plugin dan tema update sistem. Itu masih agak dasar, tapi sudah dapat digunakan untuk melewati update untuk pengguna internal organisasi Anda atau pelanggan plugin dan tema premium Anda.

Mudah-mudahan, Anda juga belajar sesuatu yang baru tentang bekerja dengan WordPress Plugin dan tema dan dapat menggunakan pengetahuan dalam menciptakan proyek Anda sendiri.