Bài 4: Bắt đầu viết plugin cho WordPress

Trong bài này, mình sẽ hướng dẫn cho các bạn cách bố trí các thư mụ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 đọc bài viết trong serie lập trình plugin WordPress 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ư biết cần phải chuẩn bị những kiến thức và công cụ cần thiết gì trước khi bước vào giai đoạn bắt đầu viết plugin cho WordPress 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 đầu tiên bạn phải làm trong quá trình viết plugin. Cấu trúc thư mục đóng vai trò tương tự như nền móng của một ngôi nhà, nền móng có chắc chắn thì bạn mới tiếp tục xây tiếp phần bên trên được.

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. 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 wp-content/plugins, 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.

thu-muc-plugins-cua-wordpress

Thư mục plugins của WordPress

Tên của plugin

Phần tên của plugin bạn phải suy nghĩ và đặt ra trước, tên của plugin phải thể hiện rõ được công dụng của plugin mà bạn có ý định tạo. Ở đây chỉ là phần hướng dẫn viết plugin nên mình 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. 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. 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.

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, 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.

dat-ten-thu-muc-cua-plugin

Đặt tên cho thư mục của plugin

Đố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, chúng ta 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 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. 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. Nếu bạn tự viết plugin với mục đích tự dùng thì không cần tạo tập tin readme.txt.

cau-truc-thu-muc-va-tap-tin-cho-plugin

Cấu trúc thư mục và các tập tin của plugin

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 tạo giống như bên dưới nhưng nhớ thay đổi thông tin 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 vì 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.

thong-tin-plugin-moi-viet-trong-ban-dieu-khien

Thông tin của plugin hiển thị trong bảng điều khiển

Qua bài viết này, bạn đã biết được cách tạo thư mục và các tập tin, cách đặt tên cho plugin như thế nào là hợp lý cũng như 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.

Mình không hướng dẫn bất kỳ một đoạn code nào trong bài này bởi vì mình muốn các bạn tìm hiểu thêm các chuẩn mà WordPress đã đặt ra trong khi viết code cho WordPress và bạn cần phải tuân thủ theo các quy tắc này.

Hy vọng rằng bạn sẽ nắm được mọi thứ để sau khi hoàn thành xong series này bạn có thể tự tạo cho mình một plugin như ý.

Nguồn: thachpham.com

Cám ơn bạn đã xem bài chia sẻ về học Lập trình plugin cho WordPress. Nếu bạn thấy bài viết này hay và có ích thì hãy chia sẻ lên Google+ hoặc Facebook nha. Hẹn gặp các bạn ở bài sau.

Xem tiếp bài trong series<< Bài 3: Tổng quan về lập trình plugin cho WordPressBài 5: Viết code cho plugin WordPress >>

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

×