Wordpress Plugin

Hướng dẫn viết plugin cho WordPress !

Bạn đang cần thông tin hướng dẫn viết plugin cho Wordpress ? Rất đơn giản, Jam đã tổng kết và trình bày trong bài viết sau đây !

Xin chào các bạn, nếu bạn đang có ý tưởng trở thành người lập trình trên mã nguồn WordPress hoặc đang muốn học cách tạo một plugin cho WordPress thì xin mời các bạn tham khảo thông tin sau đây, với WordPress mọi thứ đều đơn giản, ai cũng có thể tạo được plugin cho riêng mình.

Thành phần chính của một plugin

Tất cả các plugin của WordPress đều đóng lại dưới dạng Zip và trong đó có chứa folder cùng với tên của plugin, ví dụ như plugin Restrict author posting của tôi chẳng hạn, nó sẽ có folder là Restrict-author-posting và được đóng Zip lại.

Trong folder đó, ta có thành phần bắt buộc như sau:

  1. Một file với tên plugin, ví dụ restrict-author-posting.php
  2. Một file readme.txt

File readme.txt dùng để cho WordPress.org đọc khi bạn submit plugin lên trên thư viện WordPress plugin, trường hợp không có thì 100% plugin của bạn bị từ chối, còn file plugin-name.php là để khai báo thêm thông tin và để cài đặt chạy trên trang WordPress.

File readme.txt

File này bắt buộc nếu submit lên WordPress.org, trong đó khai báo các thông tin sau:

=== Tên Plugin ===
Contributors: mcjambi ( đây là nickname của Jam tại WordPress.org )
Donate link: https://www.jamviet.com/ ( đây là đường dẫn donate cho tác giả )
Tags: tag, đây là tag (đây là tag dùng để nhóm plugin lại, hoặc tìm kiếm, chả khác gì tag trong bài viết cả, đánh thoải mái)
Requires at least: 3.0.1 ( phiên bản thấp nhất để chạy )
Tested up to: 3.4 ( đây là phiên bản mới nhất mà plugin bạn hỗ trợ )
Stable tag: 4.3 ( phiên bản plugin tốt nhất của bạn )
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

DÒng này dùng để mô tả ngắn cho plugin, đề nghị các bạn không cho quá dài, khoảng 120 chữ OKey !

== Description ==

Đây là đoạn mô tả dài cho plugin, các bạn có thể cho mã HTML vào đây, dài bao nhiêu cũng được !

== Installation ==

Hướng dẫn cài đặt, thông thường thì ta không cần thông tin này nếu không có gì đặc biệt ! 
Upload to plugins folder and active in admin, ô kê :D !

== Screenshots ==

1. Ảnh chụp màn hình 1 nói về ...
2. Ảnh chụp màn hình thứ 2 là ...

== Changelog ==

= 1.1 =
Thay đổi của các version !
= 1.0 =
Thay đổi của các version !

== Upgrade Notice ==

= 1.1 =
Fixed lỗi X, lỗi Y trên thiết bị Z ...
= 1.0 =
Lần đầu publish !

Các bạn cũng cần xem thêm thông tin đầy đủ tại đây: https://wordpress.org/plugins/about/readme.txt

Thông tin trong file readme.txt là thông tin bắt buộc khi bạn submit lên thư mục plugin của WordPress.org, trường hợp bạn không publish lên đó, hãy bỏ qua file này, ta đi tiếp sang file sau:

File thực thi của plugin

File này thường sẽ trùng tên với tên của plugin, các bạn làm vậy để cho không lẫn với plugin khác, hoặc sau này dễ dàng chỉnh sửa kẻo lại chả biết nó ở đâu thế nào …

File này giống như file mồi index trong PHP, sẽ được WordPress include vào trong code để chạy, cho nên bạn có thể thoải mái include các thư viện khác trong file này, nhưng trước khi làm điều đó, hãy khai báo một số thông tin như sau:

<?php
/*
Trong thẻ chú thích này, WordPress đọc thông tin của plugin như sau:
Plugin Name: Restrict Author Posting
Plugin URI: https://www.jamviet.com/2015/05/restrict-author-posting.html
Description: This plugin help you to add restriction posting to editor/author in your blog.
Author: Jam Việt
Version: 2.1
Tags:    restrict user, banned user, user role, posting to category
Author URI: https://www.jamviet.com
Donate link: https://www.jamviet.com/2015/05/restrict-author-posting.html

Bạn có thể chú thích thoải mái sau khai báo trên ! cái gì cũng được !
*/

do_something_with_php or WordPress hook :D hehe !
?>

Chỉ cần bằng đó là đủ, các bạn chú ý các trường dữ liệu được phân tách bởi dấu xuống dòng, nên đừng xuống dòng linh tinh trong khi đang gán dữ liệu, dưới trích dẫn thì thêm thông tin nào cũng được, đơn giản là WordPress chỉ cần lấy vài trường trong đó còn lại là không lấy tiếp nữa.

Cấu trúc dữ liệu trong một plugin của Jam
Cấu trúc dữ liệu trong một plugin của Jam

File thực thi chính của plugin được đặt vào một folder cùng với file readme.txt, sau đó được nén ZIP và sẵn sàng cho cài đặt rồi đấy !

Các bạn có thể cài thử bằng cách vào Admin > Plugin > Cài plugin mới > Upload plugin > trỏ về file zip ta vừa nén với folder và các file trên lại, xem thử.

Download plugin mẫu tại đây plugin mẫu !

Plugin mẫu sau khi cài đặt
Plugin mẫu sau khi cài đặt

Chúc các bạn thành công !

TÁC GIẢ:

Tôi là Jam, thâm niên 7 năm thiết kế website và làm SEO. Hãy theo dõi blog của tôi để nhận được nhiều chia sẻ thú vị xung quanh chủ đề công nghệ.

Có 2 bình luận !

Trả lời

Email của bạn sẽ không được hiển thị công khai. Các trường bắt buộc được đánh dấu *