Membuat Plugin WordPress: Penghitung Kata

2 min read

Disclaimer
Saya bekerja di AWS, semua opini adalah dari saya pribadi. (I work for AWS, my opinions are my own.)
Membuat Plugin WordPress: Penghitung Kata
Membuat Plugin Penghitung Kata (Logo: WordPress)

TeknoCerdas.com – Salam cerdas untuk kita semua. Salah satu keunggulan utama pada WordPress adalah kemudahannya untuk dikembangkan melalui sistem plugin. Pada tulisan kali ini TeknoCerdas akan membahas bagaimana membuat plugin penghitung kata pada WordPress.

Plugin yang dibuat adalah plugin yang sangat sederhana dimana fungsinya adalah menampilkan sebuah pesan tentang jumlah kata yang ada pada sebuah post. Contoh tampilan terlihat seperti dibawah ini.

Number of Words: ??

Pesan diatas akan ditampilkan pada bagian bawah setelah isi dari sebuah post.

Tujuan utama dari plugin ini hanya mendemonstrasikan bagaimana melakukan manipulasi sebuah isi dari post menggunakan plugin. Tampilan dari plugin ini akan dikesampingkan demi kejelasan tujuan ini.

Daftar Isi

Persiapan Membuat Plugin WordPress

Sebelum mulai membuat plugin WordPress Penghitung Kata beberapa prasyarat yang harus dipenuhi agar dapat memahami tulisan ini dengan baik.

  • Memiliki pemahaman dasar tentang WordPress.
  • Memiliki pemahaman dasar penggunaan Plugin pada WordPress.
  • Memiliki pemahaman tentang PHP sebagai bahasa pemrograman untuk membuat plugin WordPress.
  • Memiliki pemahaman dasar tentang Docker. (Opsional)
  • Memiliki pemahaman dasar tentang Git dan GitHub. (Opsional)

Jika anda tidak memiliki prasyarat diatas tenang saja, silahkan lanjutkan membaca. Karena mungkin banyak informasi baru yang diperoleh meskipun tanpa mencoba langsung tutorial ini.

Mempersiapkan Instalasi WordPress Melalui Docker

Anda dapat melewati tahap ini jika memang sudah memiliki instalasi WordPress yang sudah berjalan di komputer anda.

Tahap ini perlu dilakukan jika anda ingin memulai WordPress dari kondisi awal atau tidak ingin mengutak-atik yang sudah ada.

Download kode sumber tutorial ini dengan menggunakan Git.

$ git clone https://github.com/rioastamal-examples/wordpress-plugin-penghitung-kata.git

File docker-compose.yml adalah file konfigurasi YAML untuk docker compose. Cukup lakukan docker-compose up maka WordPress dan MySQL akan siap diakses pada http://localhost:8080.

Direktori wordpress/ adalah direktori untuk menyimpan instalasi WordPress yang dijalankan oleh docker compose.

File src/teknocerdas_word_counter adalah file plugin WordPress untuk menghitung kata. File ini harus disalin ke direktori wp-content/plugins/ agar dapat berjalan.

Membuat File Plugin Penghitung Kata

Langkah pertama adalah buatlah sebuah file bernama teknocerdas_word_counter.php didalam direktori wp-content/plugins/. Isi dari file tersebut adalah sebagai berikut.

<?php
/**
 * @package TeknoCerdas_Word_Counter
 * @version 1.0.0
 */
/*
Plugin Name: TeknoCerdas Word Counter
Plugin URI: https://teknocerdas.com
Description: A plugin to count number of words in a post.
Author: Rio Astamal
Version: 1.0.0
Author URI: https://rioastamal.net
*/

add_action( 'the_post', 'teknocerdas_word_counter', 1 );

function teknocerdas_word_counter( $post ) {
    $no_html_content = strip_tags($post->post_content);

    $post->post_content = $post->post_content . sprintf(
                          '<div class="teknocerdas-word-counter">Number of words: <strong>%s</strong></div>',
                          str_word_count($no_html_content));
}

Sangat sederhana bukan? Karena itu tidak perlu dibuatkan direktori khusus cukup sebuah file saja.

Pada plugin Penghitung Kata terdapat sebuah fungsi bernama teknocerdas_word_counter. Fungsi tersebut dipasang pada hook yang bernama the_post.

Secara singkat Hook adalah sebuah cara untuk memodifikasi WordPress melalui tempat atau tempat yang telah disediakan. WordPress menyediakan sangat banyak hook yang dapat dilihat pada https://developer.wordpress.org/plugins/hooks/.

Salah satu hook tersebut adalah the_post. Dimana dengan memasang hook pada the_post isi dari sebuah post dapat dimodifikasi.

add_action adalah cara untuk memasang hook tanpa perlu mengembalikan nilai. Sehingga argumen yang dikirimkan ke fungsi teknocerdas_word_counter dapat diubah secara langsung dan akan berimplikasi ke objek WP_Post.

Untuk menghitung kata dilakukan pembersihan terlebih dahulu isi dari post dari semua HTML tags menggunakan fungsi PHP strip_tags(). Kemudian baru dihitung jumlah katanya menggunakan str_word_count().

Langkah terakhir adalah mengubah isi dari objek WP_Post dengan mengubah nilai properti post_content dengan menambahkan jumlah kata yang sudah dihitung.

Mengaktifkan Plugin Penghitung Kata

Setelah selesai membuat file plugin, maka langkah berikutnya adalah mengakktifkanya melalui halaman Plugins. Dapat terlihat bahwa plugin yang dibuat telah muncul di daftar plugin.

WordPress plugin penghitung kata
Plugin Penghitung Kata ada pada daftar plugin

Informasi yang tertera pada plugin tersebut diambil WordPress dari file komentar yang ada pada teknocerdas_word_counter.php.

Aktifkan plugin tersebut untuk agar dapat dilihat hasilnya ketika melihat sebuah post.

Uji Coba Plugin Penghitung Kata

Setelah plugin aktif maka pergi ke salah satu post yang ada. Pada contoh TeknoCerdas menggunakan post default berjudul “Hello World!” yang otomatis dibuat setelah instalasi.

Uji coba WordPress plugin penghitung kata
Uji coba WordPress plugin penghitung kata

Dapat terlihat pada gambar diatas plugin sukses melakukan perubahan pada post. Dimana dibawah isi dari post ditambahkan pesan “Number of Words: 15”.

Ternyata membuat sebuah WordPress plugin cukup mudah bukan?

Kode Sumber

Kode sumber untuk tutorial ini dapat anda lihat pada tautan github berikut:

https://github.com/rioastamal-examples/wordpress-plugin-penghitung-kata

Repository tersebut berisi file plugin dan konfigurasi YAML yang dibahas pada tutorial ini.