Đây là bài viết tiếp theo trong serie hướng dẫn viết plugin cho WordPress một cách cơ bản nhất. Trong bài này mình sẽ thảo luận với các bạn về cách bố trí các thư mục, cũng như việc tạo các nội dung liên quan đến tập tin của plugin, cách đặt tên và mô tả các thông tin bắt buộc cho plugin của WordPress.
Nếu đây là lần đầu tiên bạn ghé đọc bài viết trong serie này thì xin mời bạn quay lại đọc từ bài đầu tiên để có những kiến thức cơ bản nhất về plugin cũng như bạn phải chuẩn bị trước những kiến thức và công cụ cần thiết trước khi tiến hành đi vào giai đoạn này.
Cấu trúc thư mục và tập tin
Tạo thư mục và tập tin là hai bước bạn phải làm đầu tiên trong quá trình viết plugin, cũng giống như việc xây nhà vậy, bạn phải tạo ra được một cái mống cố định rồi sau đó mới tiếp tục xây tiếp phần bên trên, ở đây cấu trúc thư mục đóng vai trò tương tự vậy.
Thư mục của plugin phải được đặt trong thư mục mà WordPress dành riêng cho các plugin hoạt động, bắt buộc bạn phải bỏ plugin vào thư mục này thì mới có thể kích hoạt và sử dụng, đường dẫn đó bạn có thể xem bên dưới.
wp-content/plugins
Như vậy, thư mục plugin của bạn phải được đặt bên trong thư mục plugins với đường dẫn như bên trên, sau đó các thư mục con và các tập tin sẽ được đặt nằm trong thư mục gốc plugin của bạn.
Tên của plugin
Phần tên của plugin phải được bạn suy nghĩ và đặt ra trước, tên của plugin phải thể hiện rõ công dụng của plugin mà bạn có ý định tạo. Nhưng ở đây chỉ là phần hướng dẫn viết plugin nên Sáu sẽ đặt tên cho plugin là My First Plugin Demo.
Tên của plugin phải rõ ràng và không được trùng tên với các plugin đã có sẵn, trước tiên bạn nên tìm kiếm trên Google xem tên bạn muốn đặt có hợp lý hay không. Có thể sử dụng nhiều từ để diễn tả cho tên của plugin nhằm tránh sự trùng lặp khi đặt tên.
Tên thư mục và tên của các tập tin
Tên của thư mục cũng là tên của plugin mà bạn viết thường không có dấu Tiếng Việt và các từ được nối với nhau bằng dấu gạch ngang. Như trong ví dụ bên trên thì mình sẽ đặt tên cho thư mục của plugin là my-first-plugin-demo. Tên của thư mục sẽ đại diện cho plugin của bạn, sau này nếu như bạn truy vấn tới các tập tin hình ảnh, css hay javascript trong thư mục của plugin thì bạn sẽ phải sử dụng đến tên này, WordPress gọi tên của thư mục chứa plugin là text-domain.
Đối với tên của tập tin PHP cũng vậy, bạn không được đặt trùng tên với các plugin khác. Thông thường bạn cũng sẽ lấy tên của thư mục chứa plugin đặt tên cho tập tin PHP chính của plugin. Một plugin phải có ít nhất một tập tin PHP, ngoài ra thì bạn có thể tạo thêm bao nhiêu tập tin PHP phụ cũng được.
Các tập tin cần thiết
Đối với mỗi plugin thì chỉ cần có ít nhất 2 tập tin, đó là tập tin PHP chính của plugin và tập tin readme.txt chứa thông tin về tên, thông tin các phiên bản cũng như các thông tin liên quan khác đối với plugin. Nếu như bạn tự viết plugin với mục đích là tự dùng thì bạn không cần tạo tập tin readme.txt. Mục đích của tập tin readme là để bạn upload plugin của mình lên trang chủ của WordPress.org mà Sáu sẽ viết bài hướng dẫn sau.
Bắt đầu viết code cho plugin
Đối với tập tin PHP chính của plugin, bạn phải đặt một vài ghi chú ở phía trên cùng của tập tin, những ghi chú này bao gồm tên của plugin, tên của tác giả, mô tả cho plugin, phiên bản hiện tại của plugin và đường dẫn trang chủ của plugin với trang chủ của tác giả. Cụ thể hơn, những phần cơ bản này bạn sẽ phải tạo giống như bên dưới, thay thông tin lại cho phù hợp với plugin của bạn.
<?php
/**
* Plugin Name: My First Plugin Demo // Tên của plugin
* Plugin URI: http://hocwp.net // Địa chỉ trang chủ của plugin
* Description: Đây là plugin đầu tiên mà tôi viết dành riêng cho WordPress, chỉ để học tập mà thôi. // Phần mô tả cho plugin
* Version: 1.0 // Đây là phiên bản đầu tiên của plugin
* Author: Sau Hi // Tên tác giả, người thực hiện plugin này
* Author URI: http://sauhi.com // Địa chỉ trang chủ của tác giả
* License: GPLv2 or later // Thông tin license của plugin, nếu không quan tâm thì bạn cứ để GPLv2 vào đây
*/
?>
Vậy là bây giờ bạn đã có thể vào bảng điều khiển và kích hoạt plugin rồi đấy. Đây là một plugin hoàn toàn mới và nó mới chỉ có tên chứ chưa có nội dung bên trong. Trước khi đi vào phần code cho plugin thì bạn nên đọc qua quy định về chuẩn lập trình plugin mà WordPress đã đề ra, bạn đang tham gia vào thế giới mã nguồn mở, bạn phải thực hiện mọi thứ theo quy ước chung của mọi người, điều này rất cần thiết để bạn làm việc theo nhóm và tăng khả năng mở rộng cho code của bạn.
Kết luận phần 2
Như vậy là bạn vừa hoàn thành xong bài viết thứ 2 trong serie hướng dẫn lập trình plugin cho WordPress. Qua bài viết này thì bạn đã biết được cách tạo thư mục và các tập tin cũng như cách đặt tên cho plugin như thế nào là hợp lý. Bạn đã biết cách tạo thông tin khai báo cho một plugin trước khi tiến hành đi vào phần code.
Sáu không hướng dẫn bất kỳ một đoạn code nào trong bài viết này bởi Sáu muốn bạn tìm hiểu thêm các chuẩn mà WordPress đã đặt ra trong khi viết code cho WordPress, bạn phải tuân thủ theo các quy tắc này.
- Chuẩn lập trình PHP với WordPress
- Chuẩn viết code HTML với WordPress
- Chuẩn viết CSS với WordPress
- Chuẩn viết Javascript với WordPress
Hy vọng rằng bạn sẽ nắm được mọi thứ và Sáu sẽ gặp lại bạn trong bài viết kế tiếp của serie này. Chỉ còn vài bài nữa thôi là bạn đã có thể tự tạo cho mình một plugin như ý rồi.