WordPress 插件架構

Zeuxis  2010-07-05  Code Modifiy / Notes / Project

整個插件結構是以 WordPress 為基礎分離再整合出來的..記錄一下
不過應該有安全性的問題,因為 Plugin 路徑使用的不是絕對路徑
不過這種技術其實有些不好..因為是 Hook …

一共三個檔案:

  • index.php
  • plugin.php
  • plugin/get_content.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<?php
class Plugin {
	private static $plugin_folder = "plugin";
	private static $plugin_filter = array();
	private static $current_filter= array();
	private static $plugin_action = array();
	private static $merged_filter = array();
	
	public static function init($settings = array()) {
		if (is_array($settings) === true && empty($settings) === false) {
			foreach($settings as $k => $v) {
				self::$$k = $v;
			}
		}

		foreach(glob(self::$plugin_folder."/*") as $file_path) {
			require_once $file_path;
		}
	}
	
	public static function add_filter($tag, $function_name, $priority = 10, $total_arguments = 1) {
		$unique_id = self::get_unique_id($tag, $function_name, $priority);
		self::$plugin_filter[$tag][$priority][$unique_id] = array(
			'function' => $function_name,
			'total_arguments' => $total_arguments
		);
		unset(self::$merged_filter[$tag]);
	}
	
	public static function apply_filter($tag, $value) {
		$arguments = array();
		self::$current_filter[] = $tag;
		
		if (isset(self::$plugin_filter[$tag]) === false) {
			array_pop(self::$current_filter);
			return $value;
		}
		
		if (isset(self::$merged_filter[$tag]) === false) {
			ksort(self::$plugin_filter[$tag]);	// 優先櫂, 10 是最晚執行, 1 是最先執行
			$merged_filter[$tag] = true;
		}
		
		reset(self::$plugin_filter[$tag]);
		
		if (empty($arguments)) {
			$arguments = func_get_args();
		}

		foreach(self::$plugin_filter[$tag] as $priority) {
			foreach($priority as $filter) {
				if (is_null($filter['function']) === false) {
					$arguments[1] = $value;
					$value = call_user_func_array($filter['function'], array_slice($arguments, 1, (int) $filter['total_arguments']));
				}
			}
		}
		
		array_pop(self::$current_filter);
		
		return $value;
	}
	
	public static function remove_filter($tag, $function_name, $priority = 10) {
		$unique_id = self::get_unique_id($tag, $function_name, $priority);
		
		if (isset(self::$plugin_filter[$tag][$priority][$function_name]) === true) {
			unset(self::$plugin_filter[$tag][$priority][$function_name]);
			
			if (empty(self::$plugin_filter[$tag][$priority])) {
				unset(self::$plugin_filter[$tag][$priority]);
			}
			
			unset(self::$merged_filter[$tag]);
		}
	}
	
	public static function remove_all_filter($tag, $priority = false) {
		if (isset(self::$plugin_filter[$tag]) === true) {
			if ($priority !== false && isset(self::$plugin_filter[$tag][$priority])) {
				unset(self::$plugin_filter[$tag][$priority]);
			}else{
				unset(self::$plugin_filter[$tag]);
			}
		}
		
		if (isset(self::$merged_filter[$tag]) === true) {
			unset(self::$merged_filter[$tag]);
		}
	}
	
	public static function add_action($tag, $function_name, $priority = 10, $total_arguments = 1) {
		return self::add_filter($tag, $function_name, $priority, $total_arguments);
	}
	
	public static function do_action($tag, $argument = '') {
		if (isset(self::$plugin_action) === false) {
			self::$plugin_action = array();
		}
		
		if (isset(self::$plugin_action[$tag]) === false) {
			self::$plugin_action[$tag] = 1;
		}else{
			++self::$plugin_action[$tag];
		}
		
		self::$current_filter[] = $tag;
		
		if (isset(self::$plugin_filter[$tag]) === false) {
			array_pop(self::$current_filter);
			return;
		}
		
		$arguments = array();
		if (is_array($argument) === true && count($argument) === 1 && isset($argument[0]) && is_object($argument[0])) {
			$arguments[] = &$argument[0];
		}else{
			$arguments[] = $argument;
		}
		
		for($i=2; $i<func_num_args(); $i++) {
			$arguments[] = func_get_arg($i);
		}

		if (isset(self::$merged_filter[$tag]) === false) {
			ksort(self::$plugin_filter[$tag]);
			self::$merged_filter[$tag] = true;
		}
		
		reset(self::$plugin_filter[$tag]);
		
		foreach(self::$plugin_filter[$tag] as $priority) {
			foreach($priority as $filter) {
				if (is_null($filter['function']) === false) {
					call_user_func_array($filter['function'], array_slice($arguments, 0, (int) $filter['total_arguments']));
				}
			}
		}
		
		array_pop(self::$current_filter);
	}
	
	public static function remove_action($tag, $function_name, $priority = 10, $total_arguments = 1) {
		return self::remove_filter($tag, $function_name, $priority, $total_arguments);
	}
	
	public static function remove_all_actions($tag, $priority = false) {
		return self::remove_all_filter($tag, $priority);
	}
	
	private static function get_unique_id($tag, $object, $priority) {
		static $filter_id_counter = 0;
		
		if (is_string($object)) {
			return $object;
		}
		
		if (is_object($object)) {
			$object = array($object, '');
		}else{
			$object = (array) $object;
		}
		
		if (is_object($object[0])) {
			if (function_exists("spl_object_hash")) {
				return spl_object_hash($object[0]).$object[1];
			}else{
				$class_hash = get_class($object[0]).$object[1];
				
				// 如果內部有指定插件的識別碼,則將以 "類別名+識別碼" 返回
				if (isset($object[0]->filter_id) === true) {
					$class_hash .= $object[0]->filter_id;
				}else{					
					$class_hash .= isset(self::$plugin_filter[$tag][$priority]) ? count(self::$plugin_filter[$tag][$priority]) : $filter_id_counter;
					$object[0]->filter_id = $class_hash;
					++$filter_id_counter;
				}
				
				return $class_hash;
			}
		}else if ( is_string($object[0]) ) {
			return $object[0].$object[1];	// 物件的靜態呼叫
		}
	}	
	
}
?>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?php
require_once 'plugin.php';

$content = " This is a test ";

//
Plugin::init(array("plugin_folder" => "plugin"));

// 增加動作
Plugin::add_action('get_content', "show_bold_content");

// 基本測試
Plugin::add_filter("the_content", "trim");
Plugin::add_filter("the_content", function($value) { 
	return str_replace("test", "TEST", $value);
}, 10);

// 順序測試
// (輸出 This is a ABC test -> 受上面的暱名函數影響而變化 -> This is a ABC TEST)
Plugin::add_filter("the_content", "replace_test_to_abc_test", 1);

// 輸出結果 (filter)
echo Plugin::apply_filter("the_content", $content);
echo "<br />";

// 執行動作 (action)
Plugin::do_action('get_content', $content);
?>
1
2
3
4
5
6
7
8
9
<?php
function show_bold_content($content) {
	echo "<b>".$content."</b>";
}

function replace_test_to_abc_test($value) { 
	return str_replace("test", "ABC test", $value);
}
?>
© Copyright 2007 - 2023 by Zeuxis Lo.