13. Sử dụng WordPress Options API toàn tập

Options API là tập hợp một số hàm được định nghĩa sẵn trong core của WordPress, ở bài Xây dựng WordPress plugin nâng cao, thì tôi cũng đã hướng dẫn bạn sử dụng hai phương thức quan trọng đã làm nên sức mạnh của Options API là hàm add_option() & delete_option(). Nhưng tôi lại không giải thích quá nhiều về nó, và hứa hẹn với bạn sẽ giải thích chi tiết và chuyên sâu ở một bài khác. Vậy thì ở bài Sử dụng WordPress Options API toàn tập này bạn sẽ biết tất tần về nó, cũng như sử dụng nó như thế nào trong quá trình lập trình WordPress.

1/ WordPress Options API là gì?

Trước khi bắt tay vào sử dụng nó thì bạn cần phải dành ra ít phút tìm hiểu xem nó là gì? cách thức hoạt động của nó mạng lại điều gì.

Options API là tập hợp một số hàm được định nghĩa sẵn trên hệ thống của WordPress. Nó sẽ cung cấp cho bạn các phương thức để thao tác với cơ sở dữ liệu ở table wp_options và trong trường hợp bạn sử dụng hệ thống multisite (Nhiều website sử dụng chung user).

Như tôi đã nhắc lại ở trên thì bạn đã được học cách sử dụng 2 hàm do Options API cung cấp, nhưng lại chưa biết rõ nó hỗ trợ bao nhiêu tham số, và các tham số đó hoạt động ra sao. Ngay bây giờ tôi & bạn sẽ cùng tìm hiểu rõ hơn về nó nhé.

2/ Các phương thức trong Options API

Có tổng cộng là 8 phương thức và nó sẽ được áp dụng cho hai trường hợp.

Trường hợp thứ nhất sử dụng một website duy nhất và trường hợp thứ hai sử dụng cho phần multisite, ở trong bài này thì trọng tâm sẽ xoay quanh làm việc với trường hợp thứ nhất, còn phần multisite tôi sẽ hướng dẫn bạn ở một bài khác.

Danh sách các phương thức:

Trường hợp nhứ nhất: Áp dụng cho một website duy nhất

· add_option(): Thêm vào table wp_options một field chứa giá trị nào đó.

· delete_option(): Delete field vừa được thêm vào

· get_option(): Lấy giá trị của field từ table wp_options đổ dữ liệu vào website

· update_option(): Cập nhật giá trị các field vừa thêm vào

Trường hợp nhứ hai: Áp dụng cho multisite

· add_site_option()

· delete_site_option()

· get_site_option()

· update_site_option()

Như vậy, ở phần này bạn chỉ cần quan tâm tới trường hợp đầu tiên là đủ rồi hen.

2/ Phương thức add_option() trong Options API

Phương thức cũng có thể định nghĩa là hàm nhé bạn, các bạn đừng nhẫm lần về khái niệm này nha.

Phương thức này giúp bạn thêm vào table wp_options một dòng (field) nào đó.

Cú pháp:

1	add_option( $option, $value, $deprecated, $autoload );

Tham số:

Phương thức add_option() có tất cả là 4 tham số , và các tham số sẽ có từng nhiệm vụ khác nhau như sau.

· $option: Tên field mà bạn muốn thêm vào table wp_options

· $value: Giá trị của field mà bạn muốn thêm vào.

· $deprecated: Giá trị này đã bị loại bỏ và không còn sử dụng từ phiên bản 2.3

· $autoload: – Nếu giá trị ở đây là YES nó sẽ được tự động load ngay khi bạn vừa tải trang bởi phương thức wp_load_alloptions().

Bây giờ sẽ đi đến ví dụ đầu tiền mà tôi nghĩ là bạn sẽ làm được vì tôi đã trình bày ví dụ này một lần rồi.

Đâu tiên bạn cần phải tạo ra một plugin mới có tên là Lionel Options API Demo, cấu trúc folder thì tôi sẽ mượn lại cấu trúc folder ở bài Sử dụng Filter Hook toàn tập.

Cấu trúc plugin

– images – includes — frontend.php — backend.php – views – lionel-options.php

Nội dung file lionel-options.php:

<?php

/**

* @package Lionel Options API Demo

* @version 0.1

Plugin Name: Lionel Options API Demo

Plugin URI: http://laptrinhweb.org

Description: Đây là một plugin dùng để tương tác vói Options API.

Author: Lionel

Version: 0.1

Author URI: None

define('LIONEL_OPTIONS_PLUGIN_URL', plugin_dir_url(__FILE__));

define('LIONEL_OPTIONS_PLÙGIN_DIR', plugin_dir_path(__FILE__));

define('LIONEL_OPTIONS_INCLUDES_DIR', plugin_dir_path(__FILE__));

if(!is_admin()){

require LIONEL_OPTIONS_INCLUDES_DIR. 'includes/frontend.php';

new LionelFrontend();

}else{

require LIONEL_OPTIONS_INCLUDES_DIR. 'includes/backend.php';

new LionelBackend();

}

Vậy tham số thứ nhất có nhiệm vụ gì ? xin thưa nó chính là giá trị nằm trong ở trong colum( cột) option_name thuộc table wp_options.

Còn tham số thứ hai là giá trị nằm trong colum option_value cũng thuộc table wp_options luôn nha. Bạn có thể vào phpmyadmin sau đó click vào table wp_options, sẽ thấy ở colum option_id có id bằng 1 sẽ có option_name là siteurl và giá trị ở option_value sẽ là tên đường dẫn website mà bạn khai báo trong trang admin.

Kế tiếp 3 colum trên sẽ là colum autoload có giá trị mặc định là yes, field nào mà có giá trị là yes thì nó sẽ tự động load mọi giá trị khi bạn truy cập vào bất cứ trang nào trên website của bạn. Còn nếu có giá trị bằng no thì field đó sẽ không được nạp vào hệ thống WordPress.

Do đó tôi muốn các bạn lưu ý ở phần này một cách cẩn trọng, nếu bạn active plugin thì nó sẽ có giá trị là yes và khi bạn deactive thì field nằm trong cột autoload sẽ có giá trị là no. Về vấn đề này thì tôi cũng đã có hướng dẫn rồi hen, bạn có thể xem lại bài cũ nếu như quên.

Ví dụ trong bài này tôi sẽ không sử dụng các phương thức hỗ trợ active , deactive , uninstall mà tôi đã hướng bạn các bài trước đó là register_activation_hook, register_deaction_hook, register_uninstall_hook. Mà tôi sẽ giới thiệu đến bạn một Hook mới có tên là admin_init, Hook này thường được khởi tạo và gọi đầu tiên trong quá trình xử lý các dữ liệu trong admin.

Có nghĩa là khi bạn đã active plugin rồi, sau đó bạn muốn cập nhật giá trị thêm vào plugin thì không cần phải deactive và kích hoạt lại plugin nửa, vì Hook admin_init đã tự động nạp giá trị mà bạn vừa thêm vào plugin vào hệ thống WordPress.

Luyên thuyên nãy giờ đủ rồi, giờ tôi sẽ bắt tay vào ví dụ.

Chắc hẳn bạn còn nhớ là khi xử lý plugin thì nó sẽ chia ra làm 2 phần, phần xử lý hiển thị dữ liệu ngoài trang chủ và phần xử lý dữ liệu trong trang admin. Ở ví dụ này thì chúng ta sẽ chỉ cần làm việc với file backend.php mà thôi.

Tôi sẽ tạo ra một phương thức add_new_option() để thực thi thao tác thêm vào table wp_options một field có tên là lionel_options_verion có chứa giá trị là 1.0.

Nội dung file backend.php:

<?php

class LionelBackend {

public function __construct(){

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

add_option('lionel_options_version', '1.0', '', 'yes');

}

Sau khi đã có phương thức add_new_options thì lúc này bạn cần phải thực thi hành động của nó để đưa dữ liệu vào table wp_options. Để gọi một Hook lên làm việc thì bạn sẽ sử dụng phương thức add_action() và gọi đến Hook admin_init.

Do tôi đã tạo plugin mới nên bạn cần phải active rồi mới có thể truy cập vào http://localhost/phpmyadmin/ để kiểm tra, nhưng trước tiên nếu trước đó bạn đã active plugin Lionel Filter Hook mà tôi đã hướng dẫn ở bài trước thì bạn cần vô hiệu nó đị , rồi mới được active plugin mới này, vì nó sẽ gặp lỗi trùng tên class và hệ thống sẽ không cho bạn active plugin mới.

lionel-add-new-option-api

Truy cập vào phpmyadmin bạn tìm đến database wp và click vào table wp_options, click vào cột option_id để nó sắp xếp thứ tự id theo chiều giảm bạn sẽ thấy field mới là lionel_options _version đã được thêm vào.

Lúc này thì tôi sẽ thử thêm một array (mảng) xem nó có nhận giá trị mới này không, ngay tại phương thức add_new_option() tôi bổ sung đoạn code sau.

<?php

class LionelBackend {

public function __construct(){

add_action('admin_init', array($this, 'add_new_options'));

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

Tôi sẽ thêm field lionel_options_course chứa giá trị là một chuỗi nội dung. bạn quay lại trang admin bấm F5 để Hook admin_init khởi tạo lại và nạp thêm giá trị mới vào table wp_options.

lionel-add-new-option-api-in-array

Bạn có thể kiểm tra xem đoạn chuỗi kia có đúng như nội dung mà bạn khai báo trong mảng hay không bằng hàm unserialize(), chuyển một chuỗi hoặc một đối tượng nào đó sang mảng.

<?php

class LionelBackend {

public function __construct(){

add_action('admin_init', array($this, 'add_new_options'));

$tmp = 'a:3:{s:6:"course";s:13:"WordPress 4.x";s:6:"author";s:7:"Lionel";s:7:"website";s:15:"laptrinhweb.org";}';

$tmp = unserialize($tmp);

echo '<pre>';

print_r($tmp);

echo '</pre>';

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

Bạn copy giá trị của field lionel_options_course và cho nó vào một biến tạm với tên bất kì do bạn tự đặt, tôi đặt $tmp chứa giá trị của chuỗi vừa copy xong. Do nó đang là một chuỗi kí tự nên bạn không thể in nó ra bằng cách dùng hàm echo(), bạn cần phải sử dụng hàm print_r().

Kết quả: Bạn F5 trang admin và phần head sẽ xuất hiện nội dung.

Array

(

[course] => WordPress 4.x

[author] =>Lionel

[website] => laptrinhweb.org

)

Đúng như mảng mà bạn đã khai báo ở trong code. Như vậy thông qua ví dụ này chắc hẳn bạn đã nắm rõ cách hoạt động, khai báo và sử dụng phương add_action rồi đúng không.

2/ Phương thức get_option() trong Options API

Phương thức get_option() này khá là đơn giản, nó chỉ có một nhiệm vụ duy nhất là rất ra giá trị các của field mà bạn chỉ định.

Cú pháp:

1	get_option( $option, $value);

Tham số:

Phương thức này có tất cả là hai tham số như sau.

· $option: Tên của field mà bạn muốn lấy giá trị nằm trong table wp_options.

· $value: Giá trị mặc định nếu giá trị không tồn tại

Tham số đầu tiên chính là giá trị nằm trong colum option_name và tham số thứ hai là giá trị nằm trong colum option_value, còn nếu trường hợp tham số đầu tiên không tồn tại hoặc không chính xác thì nó sẽ lấy giá trị mặc định mà bạn truyền ở tham số thứ hai.

Tôi sẽ tạo ra phương thức get_current_option() để ví dụ về vấn đề này và tôi có đoạn code như sau.

<?php

class LionelBackend {

public function __construct(){

//=====================================================

// Hook admin_init được ưu tiên khởi tạo ngay khi truy cập trang admin

//=====================================================

add_action('admin_init', array($this, 'get_current_option'));

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

//=====================================================

// Phương thức get_current_option

//=====================================================

public function get_current_option(){

$showOptions = get_option('lionel_options_version', '2.0');

echo $showOptions;

}

Do bạn sẽ phải show nội dung nên bạn cần phải tạo $showOptions để hứng giá trị của nó, ở ví dụ này tôi muốn lấy ra giá trị thuộc field lionel_options_version, nên tham số đầu tiên tôi sẽ điền vào là nó, ở tham số thứ hai tôi điền vào là 2.0 , để nếu lỡ như field mà tôi lấy không tồn tại thì hệ thống sẽ lấy giá trị mặc định này để show kết quả ra.

Bạn F5 trình duyệt thì sẽ thấy phần đầu website sẽ hiện giá trị là 1.0 tức là giá trị chính xác bạn đã khai báo ở trong field lionel_options_version, còn nếu giờ bạn sửa thành lionel_options_version1, thì nó sẽ hiện kết quả là 2.0 tức là giá trị mặc định mà bạn đã khai báo sẵn.

Lúc bấy giờ câu hỏi đăt ra là, đã lấy ra được giá trị là con số rồi, vậy thì có lấy ra được giá trị là một chuỗi hay không? Câu trả lời là hoàn toàn có thể nhé.

Tôi lại tạo thêm một phương thức mới là get_current_array_option(), nó có nhiệm vụ lấy giá trị trong một chuỗi thuộc một field mà bạn muốn lấy.

<?php

class LionelBackend {

public function __construct(){

//=====================================================

// Hook admin_init được ưu tiên khởi tạo ngay khi truy cập trang admin

//=====================================================

add_action('admin_init', array($this, 'get_current_array_option'));

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

//=====================================================

// Phương thức get_current_option

//=====================================================

public function get_current_option(){

$showOptions = get_option('lionel_options_version', '2.0');

echo $showOptions;

}

//=====================================================

// Phương thức get_current_array_option

//=====================================================

public function get_current_array_option(){

$ksArr = array(

'course' => 'WordPress 4.2',

'author' => 'Himura Lionel',

'website' => 'www.laptrinhweb.org'

);

$showOptions = get_option('lionel_options_course', $ksArr);

echo '<pre>';

print_r($showOptions);

echo '</pre>';

}

Do nó có giá trị là array khi thêm vào csld sẽ được chuyển sang một chuỗi, nên bạn cần phải khai báo phần giá trị mặc định của nó là một array để nếu có lỗi gì đó nó sẽ gọi tới giá trị mặc định đó.

Kết quả trình duyệt sẽ trả về cho bạn giá trị mảng giống như giá trị mà bạn đã khai báo lúc thêm dữ liệu vào.

Array

(

[course] => WordPress 4.x

[author] =>Lionel

[website] => laptrinhweb.org

)

Nếu tên field không tồn tại thì nó sẽ hiển thị kết quả.

Array

(

[course] => WordPress 4.2

[author] => Himura Lionel

[website] => www.laptrinhweb.org

)

3/ Phương thức update_option() trong Options API

Cái tên nói lên tất cả nha, phương thức update_option() giúp bạn cập nhật giá trị mới trong field do bạn chỉ định.

Cú pháp:

1	update_option( $option, $new_value );

Tham số:

Bao gồm tất cả là hai tham số.

· $option: Tên field muốn chỉnh sửa trong table wp_options.

· $new_value: Giá trị mới của field, giá trị được lữu trữ ở cột option_value trong table wp_options.

Như vậy phương thức này có cách thức hoạt động gần giống như get_option, khác nhau ở chỗ, cái kia lấy ra giá trị được chỉ định, còn cái này thì cập nhật giá trị mới cho field được chỉ định.

Tôi tạo ra phương thức update_current_option(), tôi muốn thay đổi giá trị bên trong field lionel_options_version từ 1.0 thành giá trị 4.0 và tôi có đoạn code thực hiện việc thay đổi như sau.

<?php

class LionelBackend {

public function __construct(){

//=====================================================

// Hook admin_init được ưu tiên khởi tạo ngay khi truy cập trang admin

//=====================================================

add_action('admin_init', array($this, 'update_current_option'));

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

//=====================================================

// Phương thức get_current_option

//=====================================================

public function get_current_option(){

$showOptions = get_option('lionel_options_version', '2.0');

echo $showOptions;

}

//=====================================================

// Phương thức get_current_array_option

//=====================================================

public function get_current_array_option(){

$ksArr = array(

'course' => 'WordPress 4.2',

'author' => 'Himura Lionel',

'website' => 'www.laptrinhweb.org'

);

$showOptions = get_option('lionel_options1_course', $ksArr);

echo '<pre>';

print_r($showOptions);

echo '</pre>';

}

//=====================================================

// Phương thức update_current_option

//=====================================================

public function update_current_option(){

$updateOptions = update_option('lionel_options_version', '4.0');

}

Bạn kiểm tra bằng cách vào phpmyadmin, tìm đến table wp_options xem giá trị của field được chí định có thay đổi giống như hình không.

lionel-update-options-api

Còn nếu tôi muốn thay đổi giá trị của field lionel_options_course thì làm sao ? do nó là một mảng sau khi được nạp vào csdl sẽ bị luân chuyển thành một chuỗi. Tôi sẽ bổ sung đoạn code trên như sau.

<?php

class LionelBackend {

public function __construct(){

//=====================================================

// Hook admin_init được ưu tiên khởi tạo ngay khi truy cập trang admin

//=====================================================

add_action('admin_init', array($this, 'update_current_option'));

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

//=====================================================

// Phương thức get_current_option

//=====================================================

public function get_current_option(){

$showOptions = get_option('lionel_options_version', '2.0');

echo $showOptions;

}

//=====================================================

// Phương thức get_current_array_option

//=====================================================

public function get_current_array_option(){

$ksArr = array(

'course' => 'WordPress 4.2',

'author' => 'Himura Lionel',

'website' => 'www.laptrinhweb.org'

);

$showOptions = get_option('lionel_options1_course', $ksArr);

echo '<pre>';

print_r($showOptions);

echo '</pre>';

}

//=====================================================

// Phương thức update_current_option

//=====================================================

public function update_current_option(){

$ksArr = array(

'course' => 'WordPress 4.2',

'author' => 'Himura Lionel',

'website' => 'www.laptrinhweb.org'

);

$updateOptions = update_option('lionel_options_version', '4.0');

$updateOptions = update_option('lionel_options_course', $ksArr);

}

Lúc này bạn cần phải F5 lại trang admin để nó nhận giá trị mới mà plugin vừa nạp vào hệ thống csdl của WordPress, sau đó bạn cần phải F5 lại trang phpmyadmin để kiểm tra giá trị của field lionel_options_course.

Kết quả: a:3:{s:6:”course”;s:13:”WordPress 4.2″;s:6:”author”;s:14:”Himura Lionel”;s:7:”website”;s:19:”www.laptrinhweb.org”;}, bạn có thể thấy rằng nội dung chuỗi này tương ứng với mảng mà bạn vừa khai báo ở trên.

Như vậy, thông qua ví dụ nhỏ này thì bạn cũng đã nắm rõ cách làm việc của phương thức update_option(), kế tiếp chúng ta sẽ tìm hiểu đến phương thức cuối cùng trong bài hôm nay.

4/ Phương thức delete_option() trong Options API

Phương thức thì phải gọi là quá đơn giản vì nó chỉ có duy nhất một tham số được truyền vào mà thôi.

Bây giờ tôi muốn xóa đi 2 field mà tôi đã truyền vào table wp_options, và tôi có đoạn code xử lý như sau.

<?php

class LionelBackend {

public function __construct(){

//=====================================================

// Hook admin_init được ưu tiên khởi tạo ngay khi truy cập trang admin

//=====================================================

add_action('admin_init', array($this, 'delete_all_option'));

}

//=====================================================

// Phương thức add_new_options

//=====================================================

public function add_new_options(){

$ksArr = array(

'course' => 'WordPress 4.x',

'author' => 'Lionel',

'website' => 'laptrinhweb.org'

);

add_option('lionel_options_version', '1.0', '', 'yes');

add_option('lionel_options_course', $ksArr, '', 'yes');

}

//=====================================================

// Phương thức get_current_option

//=====================================================

public function get_current_option(){

$showOptions = get_option('lionel_options_version', '2.0');

echo $showOptions;

}

//=====================================================

// Phương thức get_current_array_option

//=====================================================

public function get_current_array_option(){

$ksArr = array(

'course' => 'WordPress 4.2',

'author' => 'Himura Lionel',

'website' => 'www.laptrinhweb.org'

);

$showOptions = get_option('lionel_options1_course', $ksArr);

echo '<pre>';

print_r($showOptions);

echo '</pre>';

}

//=====================================================

// Phương thức update_current_option

//=====================================================

public function update_current_option(){

$ksArr = array(

'course' => 'WordPress 4.2',

'author' => 'Himura Lionel',

'website' => 'www.laptrinhweb.org'

);

$updateOptions = update_option('lionel_options_version', '4.0');

$updateOptions = update_option('lionel_options_course', $ksArr);

}

//=====================================================

// Phương thức delete_all_option

//=====================================================

public function delete_all_option(){

delete_option('lionel_options_version');

delete_option('lionel_options_course');

}

Khá là đơn giản, bạn F5 lại trang admin và vào phpmyadmin kiểm tra thì sẽ thấy không còn tồn tại 2 field này nửa. với phương thức này bạn có thể xóa bất cứ field nào bạn thích, nhưng đừng xóa tùm lum là die cả website luôn đấy nhé.

4/ Kết bài

Bài viết khá dài , do đó tôi cũng đã trình bày đầy đủ các phương thức mà Options API hỗ trợ bạn trong quá trình xây dựng plugin, Sau khi kết thúc bài Sử dụng WordPress Options API toàn tập, thì bạn đã biết cách thức khai báo và sử dụng các phương thức bên trong Options API. Nó được sử dụng phổ biến trong quá trình bạn viết mới một plugin. hẹn gặp lại bạn ở bài tiếp theo nhé, chào thân ái và quyết thắng.

Series Navigation<< Tạo mới WordPress admin menu page Sử dụng WordPress Setting API toàn tập – P1 >>

Nguồn: laptrinhweb.org

Previous12. Tạo mới WordPress admin menu page Next14. Sử dụng WordPress Setting API toàn tập – P1

Last updated 4 years ago