我爱水煮鱼» 沙发

自己动手写 WordPress 插件：后台选项

Denis — Tue, 29 Jul 2008 17:13:00 +0000

自从上一次谈到使用 WP-Cron 来进一步提高插件的效率之后，差不多有一个月没有跟新我这个插件教程了。好了今天介绍最后一篇：增加后台选项，以及其他的一些参考资料。

如果插件是给自己用，OK，可以把所有的地方都写死，不用很多参数，但是全世界人民对插件的需求是完全不同的，很多人是不懂代码，更多人是希望在后台简单点两下就能够配置出来自己要的效果出来。好吧，今天就给大家讲讲这方面的东东：

在 WordPress 中，创建后台选项的 API 是：
add_options_page(page_title, menu_title, access_level/capability, file, [function]);

其中 page_title 为页面标题，menu_title 为菜单标题，access_level/capability 为访问这个选项的最低权限用户，file 这里为选项的唯一标示符，function 为用于显示页面内容的函数。

然后怎么样把后台的数据保存起来和在插件中调用呢？其实我们前面的教程中已经使用到了

WordPress 是通过 API update_option($option_name, $newvalue) 把数据保存和到数据库中，并通过 API get_option($option) 取出。

好了，现在已经了解清楚了原理，下面我们谈谈给我们的沙发插件添加什么选项，嗯，就大家问我的几个问题添加下选项吧。第一个是，有些博客是开放注册的博客，而前面的版本是不统计注册用户的沙发的，第二个是有些帅哥喜欢显示更多的沙发，恩就给他个机会显示更多的沙发。

首先我们在插件最后添加以下代码用于制作后台选项界面：

function wp_sofa_options(){
	$message='更新成功';
	if($_POST['update_sofa_option']){
		$wp_sofa_exclude_saved = get_option("wp_sofa_exclude");
		$wp_sofa_exclude = $_POST['wp_sofa_exclude_option'];
		if ($wp_sofa_exclude_saved != $wp_sofa_exclude)
			if(!update_option("wp_sofa_exclude",$wp_sofa_exclude))
				$message='更新失败';
		$wp_sofa_number_saved = get_option("wp_sofa_number");
		$wp_sofa_number = $_POST['wp_sofa_number_option'];
		if($wp_sofa_number_saved != $wp_sofa_number)
			if(!update_option("wp_sofa_number",$wp_sofa_number))
				$message='更新失败';
		$wp_sofa_titles_saved = get_option("wp_sofa_titles");
		$wp_sofa_titles = $_POST['wp_sofa_titles_option'];
		if($wp_sofa_titles_saved != $wp_sofa_titles)
			if(!update_option("wp_sofa_titles",$wp_sofa_titles))
				$message='更新失败';
		update_sofa();
		echo ''. $message . '';
	}
?>
<div class=wrap>
<form method="post" action="">
<h2>沙发h2>
<fieldset name="wp_basic_options"  class="options">
<table>
<tr>
        <td valign="top" align="right">排除用户：td>
	<td><input type="text" name="wp_sofa_exclude_option" value="wp_sofa_exclude");  ?>" /> 输入需要排除用户的 ID，多个请用英文的 , 分开。td>
tr>
<tr>
        <td valign="top" align="right">个数：td>
        <td><input type="text" name="wp_sofa_number_option" value="wp_sofa_number"); ?>" /> 显示沙发的个数，尽量不要超过10个。td>
tr>
<tr>
        <td valign="top" align="right">沙发列表元素标题td>
	<td><input type="text" name="wp_sofa_titles_option" value="wp_sofa_titles") ?>" /> 显示沙发的个数，尽量不要超过10个。td>
tr>
table>
fieldset>
<p class="submit"><input type="submit" name="update_sofa_option" value="Update Options »" />p>
form>
div>
php
}

function wp_sofa_options_admin(){
	add_options_page('wp_safa', '沙发', 5,  __FILE__, 'wp_sofa_options');
}

add_action('admin_menu', 'wp_sofa_options_admin');

然后在对前面的 update_sofa 程序进行相应的修改，这里就不再详细的叙述了。

本次插件下载：wp-sofa-6.0.zip。

至此，这个制作插件的教程结束，本来应该还有一篇关于插件如何创建独立的数据表，但是没有相关的经验，就不写了。这个教程写得很乱，但是基本上看下来对你制作插件还是有一定的帮助的。如果你有什么意见，欢迎提出来。

另外我还有写一篇总结的文章，并给你推荐一个更多制作插件的文章列表。

>>>继续阅读全文 ...

自己动手写 WordPress 插件：使用 WP-Cron

Denis — Sat, 03 May 2008 14:52:15 +0000

上一节我们讲了如何利用 WordPress API 开发 WordPress 插件。这一节我们继续讲解 WordPress API，涉及的主题是 WP-Cron，就是在 WordPress 中安排任务。

如何在 WordPress 中安排任务，这是在 WordPress 2.1 中就引入的功能。本人针对这个功能翻译过一篇文章：如何在 WordPress 安排任务，建议大家在继续之前，好好阅读下那篇文章。

前面我们通过把沙发排名信息保存到数据库中，再有留言之后再进行更新，这样的操作来提高沙发插件的执行效率，今天来谈谈另外一种提高插件执行效率的方法，定时去更新沙发沙发的排名信息到数据库中来提高效率。

下面我们来讲解如何实现：
首先注释掉 sofa_comment_post 和 add_action('comment_post', 'sofa_comment_post');。

然后添加如下代码：

//创建自定义的更新沙发排名信息的事件，调用更新沙发排名信息的函数add_action('update_sofa_event', 'update_sofa');

//定义任务，调用更新沙发排名信息的事件
if (!wp_next_scheduled('update_sofa_event')) {
	wp_schedule_event( time(), 'hourly', 'update_sofa_event' );
}

//当插件被停止时候，移除更新沙发排名信息的事件
function update_sofa_deactivation(){
	wp_clear_scheduled_hook('update_sofa_event');
}

register_deactivation_hook(basename(__FILE__),' update_sofa_deactivation');

上面的函数注视已经非常清楚了，这里不多讲了，这里是每个小时，更新一次，如果你觉得太频繁了，可以改成每天，把 wp_schedule_event 函数中 hourly 改成 daily 即可。

至于为什么要添加插件停止事件，是因为我们使用 wp_schedule_event 添加的定时事件没有用函数 wp_clear_scheduled_hook 清除掉，在插件停用之后还会继续运行的。

这篇到此为止，如果你有什么问题请给我留言，下一片我们将讲解 Option。请继续关注，并提出你的宝贵意见。

>>>继续阅读全文 ...

自己动手写 WordPress 插件：使用 API

Denis — Sat, 03 May 2008 14:04:45 +0000

上两篇讲解了如河窗体化 WordPress 插件，今天我们来点高级点，如何使用 WordPress API 进行编写插件。其实我们在前面窗体化 WordPress 插件中已经部分涉及到这方面的知识。只是没有做详细的说明，所以认真看今天的内容也会对你以前的内容也会有所帮助。当然有什么问题，欢迎给我留言。

首先，什么是 WordPress 的 API？

在很早之前，我们需要添加一些新的功能，需要修改 WordPress 源代码，这是非常的郁闷，而现在有了 API （应用程序接口）之后，我们就能非常容易的添加和修改一些内置的功能。

WordPress 提供两种类型的 API：

Action（行为）：行为是一些能够由 WordPress 核心事件触发的函数。行为 hook 能够让你添加或移除由 WordPress 行为触发执行的函数。这些 hook 能够使插件在它们指定的行为被触发执行。
Filter（过滤器）：过滤器是修改 WordPress 存储在你数据库中的内容的函数。过滤器 hook 允许你为 WordPress 的不同类型的内容（通常为文本）添加或者移除过滤器。这些 hook 能够使你能够非常容易的修改内容或者文本。

关于 WordPress API 更多介绍请参考官方文档：Plugin API。下面我们来讲解一个实际的例子：根据 Action API 调整性能之后沙发四代。

首先，我们再重复一下 sofa 这个插件的基本逻辑：

查出含有留言的 Post 的 ID。
然后找出它们的第一条留言的留言者和其博客，帮把这些信息写到一个数组中。
对数组进行处理找出抢到沙发的三个留言者并获取他们的博客地址。
输出他们。

假设一个含有500篇日志的博客，一共有80%的日志含有留言，这样

第一步，将进行 1 次 SQL 查询。
第二步，将进行 500X80%=400 次 SQL 查询。
第三步，经进行 3 次 SQL 查询。

这样一个插件是非常耗费资源的。而对一个博客来说，留言数和浏览数数相比，是非常小的一个数据。所以我们是否可以把留言最多的人存到一个数据库中，当有人留言的时候，我们再对其进行更新呢？

答案是肯定，仔细在官方文档的 Action Reference 中找到 comment_post 这个 Action Hook。它是在留言保存到数据库之后进行的行为，这个正是我们所要的。于是我们对 Sofa 插件修改如下：

首先把原有的 get_sofa 函数修改为 update_sofa，并且把原来得输出沙发党前三名的循环改成获取前三名的数据存入数据中：

	$sofa = array(); //初始化写入数据库的沙发数组
	for($i=0; $i<3; $i++){
		$title="";
		if($i==0)	$title = "状元：";
		if($i==1)	$title = "榜眼：";
		if($i==2)	$title = "探花：";
		$q = "SELECT comment_author_url FROM $wpdb->comments WHERE comment_type ='' AND user_id = 0 AND comment_approved = '1' AND comment_author_url !='' AND comment_author = '$first_commentors_author[$i]' limit 1";
		$first_comment_url = $wpdb->get_results($q); //获取沙发党的博客
		if($first_comment_url){
			$sofa[$i] = $title . '" title="' . $first_commentors_author[$i].'">' . $first_commentors_author[$i] . '(' . $first_commentors["$first_commentors_author[$i]"].')';
		} else {
			$sofa[$i] = $title . $first_commentors_author[$i] . '('.$first_commentors["$first_commentors_author[$i]"] . ')';
		}
	}
	update_option('sofa',$sofa);	//把沙发排名数据更新到数据库中

然后重新创建一个 get_sofa 函数，这个函数这个时候是从数据库中获取沙发排名数据，然后输出。函数如下：

function get_sofa(){
	$output = ""; //初始化输出字符串	
	$output .= '';

	$sofa = get_option('sofa');	//从数据库中获取沙发排名数据

	if(!$sofa[0]){	//如果是第一次使用，把沙发排名数据写入数据库
		update_sofa();
		$sofa = get_option('sofa');	//重新获取
	}

	for($i=0; $i<count($sofa); $i++){
		$output .= ''. $sofa[$i] .'';
	}

	$output .= '';
	return $output;//输出沙发党前三甲
}

最后是这个篇教程的关键，当有人留言之后，更新沙发排名信息。函数很简单：

function sofa_comment_post ($comment_ID) {
	global $user_ID;
	if ( !$user_ID ){
		update_sofa();
	}
}

add_action('comment_post', 'sofa_comment_post');

关键在于 add_action(‘comment_post‘, ‘sofa_comment_post‘); 它是在用户留言成功之后执行 sofa_comment_post 这个函数，从而更新沙发排名数据到数据库中。

这篇到此为止，这篇完成的插件：wp-sofa-4.0，相信性能方面会有非常大的提升，本人会对自己以前开发的插件，会按照同样的方法或者下一章的方法进行更新，如果你是用我开发的插件，请注意关注本博客，注意更新。下一篇将会介绍另外一种更新沙发排名信息的方法，通过 WP-Cron 特性来实现定时更新。如果你有什么问题请给我留言。

>>>继续阅读全文 ...

Top First Commentors

Denis — Thu, 06 Mar 2008 09:37:36 +0000

English

The plugin will show the top first commentors (the numner is number is set by user) of your blog.

Installation and Usage:

Upload the file top-first-commentors.php to the /wp-content/plugins/ directory
Activate the plugin through the ‘Plugins’ menu in WordPress
Place in your templates
Navigate to Manage > Option > Top First Commentors to configure plugin output.
The plugin support widget, if you theme support widget, you can drop it to your sidebar.

Download: Top First Commentors

If you have any problem, please leave me a comment.

You can donate via payapl to support the plugin’s development,

中文

这个插件就是以前开发的那个关于沙发匪徒的插件。能够显示你博客沙发排名。把它改装下，能够给国外的沙发党使用，并且采用了 WordPress Object Cache. 速度应该有提升。

安装和使用：

上传文件 top-first-commentors.php 到 /wp-content/plugins/ 目录下
在插件菜单下激活插件
在模板文件中插入模板函数
在管理界面下，Manage > Option > Top First Commentors 中配置插件的输出
该插件也支持 Widget。

下载：: Top First Commentors

如果有什么问题，请给我留言。

>>>继续阅读全文 ...

自己动手写 WordPress 插件：窗体化插件 2

Denis — Sun, 18 Nov 2007 16:17:35 +0000

上一节我们讲解了如何窗体化插件的第一部分，今天我们将继续第二部分，如何给我们创建的 Widget 创建选项 Panel。

我想使用沙发二代的同学已经感觉现在很轻松了，如果主题支持，根本不用修改模板就能调用该插件。但是最求完美的同学会发现默认输出的 Title 是“最沙发的人”。有些比较追求个性的同学总是希望自己定义标题的。好吧，这一节，我们就完成这部分同学的愿望，能够自定义标题。并推出沙发三代！

如何自定义标题呢？其实就是在 Widget 能够提供一个选项的界面，让用户自己输入标题。好吧，搜索下或者看看别人的插件（偶经常这样写插件的，如果你的插件因此被我偷师了，算你倒霉！嘿嘿！），发现是通过 register_widget_control 这个 hook 绑定的。这样事情就变得很简单了。我们把选项的数据存储到一个名字叫做 widget_sofa option 中即可。修改如下：

在昨天创建的 widget_sidebar_sofa 的函数的最后中添加如下代码：

function widget_sofa_options() {
	$sofa_options = $new_sofa_options = get_option('widget_sofa'); //获取数据库中的 widget_sofa
	if ( $_POST["sofa_submit"] ) { //如果提交更新
		$new_sofa_options['title'] = strip_tags(stripslashes($_POST["sofa_title"]));
		if ( $sofa_options != $new_sofa_options ) { //如果有更新
			$sofa_options = $new_sofa_options;
			update_option('widget_sofa', $sofa_options);
		}
	}
	$title = attribute_escape($sofa_options['title']);
?>
	<p><label for="wp_sofa_title">php _e('Title:'); ?> <input style="width: 250px;" id="sofa_title" name="sofa_title" type="text" value="" />label>p>
	<input type="hidden" id="sofa_submit" name="sofa_submit" value="1" />
php
}

register_widget_control('WP-Sofa', 'widget_sofa_options', 300, 90);

上面这段代码就是创建一个 Widget 选项的界面。代码非常简单，也做注释，我这里也不多说了。

然后昨天的创建的 widget_sofa 函数中的 echo $before_widget; 中插入以下几行：


$sofa_options = get_option('widget_sofa');
$title = $sofa_options['title'];
if ( empty($title) ) $title = '最沙发的人';

这段代码是获取用户设置的标题，如果没有设置，则显示默认的“最沙发的人”。

好了，这节到此为止，下一节我们讲解 WordPress 的 API。请保持关注。沙发三代下载：wp-sofa-3.0.zip

>>>继续阅读全文 ...

自己动手写 WordPress 插件：窗体化插件 1

Denis — Sun, 18 Nov 2007 15:16:16 +0000

上一节我们通过一个很简单并且很有意义的插件 WP-Sofa 给大家讲解了如何自己动手开始写插件，今天将和大家讲解如和窗体化这个插件，并推出我们的沙发二代。

首先，什么是窗体化（widgetizing）呢？简单的说，窗体化就是让侧边栏适合 Widget 这个插件（从 2.2 开始，WordPress 已经内置了 Widget），它能让你非常容易就能够重新整理侧边栏的模块，而不需要手工去修改代码。

立刻就会跑出第二个问题，主题不支持 Widget，怎么办？能怎么办，不懂代码的，换一个主题咯，懂的修改代码让它支持咯，如何修改？看文章：窗体化侧边栏

废话说完了，那我们开始我们今天的主题：窗体化你的插件。

首先，我们让插件能够支持 Widget 只是一个额外的功能，原有的手工调用的功能还是要保持。所以我们把原有的代码作如下改动：
把原有的sofa 这个函数的函数名修改为 get_sofa。
把最后的 echo $output; 修改成 return $output;。
然后创建一个新的 sofa 函数。如下：

function sofa(){
	$output = get_sofa();
	echo $output;
}

这样保证了原来的 sofa 函数还能自动调用。

下面我们开始 widget 这个插件：

首先了解下基本的 Widget 语法：

php
function widget_myuniquewidget($args) {
       extract($args);
?>
       php echo $before_widget; ?>
       php echo $before_title . 'My Unique Widget' . $after_title; ?>
               Hello, World!
       php echo $after_widget; ?>
php
}
register_sidebar_widget('My Unique Widget', 'widget_myuniquewidget');
?>

上面的代码用用 register_sidebar_widget 注册函数自己之后，输出 widget 标题 ‘My Unique Widget’ 及內容 ‘Hello, World!’。

只要把标题替换成自己的标题，然后把 ‘Hello, World!’ 替换成自己的内容即可。

然后又从 WordPress Widgets 说明文档上知道：不要在插件导入之后执行任何代码，并使用 plugins_loaded 这个hook。从而得知 add_action 的对象是 plugins_loaded。

根据上面的分析，我们的 Sofa 的 widget 函数为：


function widget_sidebar_sofa() {
	function widget_sofa($args) {
	    extract($args);
		echo $before_widget;
		echo $before_title . '最沙发的人' . $after_title;
			$output = get_sofa();
			echo $output;
		echo $after_widget;
	}
	register_sidebar_widget('WP-Sofa', 'widget_sofa');
}

add_action('plugins_loaded', 'widget_sidebar_sofa');

OK，这节到此为止。哦，你错了，下一节我们将继续这个话题：窗体化插件 2，还有什么好讲的呢？到时候关注就行了，嘿嘿。根据 Underone 的建议把插件的名字改为最沙发的人，另外在抢沙发战役中屡屡败给某著名沙发党大猫和胡戈戈同学，所以该插件的作者名字也该成：抢不到沙发的人。如果你因此认为这是两个插件，本人不负任何责任。第二版下载地址：wp-sofa-2.0.zip。

>>>继续阅读全文 ...

自己动手写 WordPress 插件：开始

Denis — Sun, 18 Nov 2007 15:15:00 +0000

WordPress 之所以被广泛应用，一个很重要的原因，他很有多插件，多到什么程度呢，就像天上的星星一样多，哈哈，形容得真恶心，自己寒一个。今天开始给大家写一些原创性的文章：自己动手写插件，今天是第一篇，算是一个开始，从一个最简单插件开始，刚刚写好的，厉害吧！也是对阿里妈妈插件大赛的一个支持吧！

一个最简单的插件包括以下两部分：插件头信息和一个可在模板中使用的函数。那我们从第一步头信息开始：

自己动手写插件的第一步就是定义插件头信息：

/*
Plugin Name: WP 的沙发
Plugin URI: http://fairyfish.net/
Description: 本人代表广大 blogger 仅此插件献给沙发党以表彰他们对博客做出的杰出奉献
Version: 沙发一代
Author: 某低调沙发党
Author URI: http://fairyfish.net/
*/

这里我们定义了插件名称，版本，作者，下载地址，和简单的介绍。

插件的第二步是定义一个可在模板中使用的模板函数：

我开始的这个沙发插件非常简单，不会含有任何的任何的 filter 和 hook。所以我们这个插件实际上只需要对 WordPress 的 Comment 表进行查询，获取抢得沙发最多的三个留言者即可。

原本这个插件只需一条还算复杂的 SQL 语句即可搞定，但是著名的空间上盘古的 MySQL 的版本还是 4.0，泪奔，不支持 SQL 嵌套。算了还是贴出我写得很菜的 SQL 语句：

SELECT * , count( first_comments.comment_author ) AS comment_comments FROM ( SELECT * FROM ( SELECT comment_author, comment_post_id, comment_author_url FROM wp_comments WHERE comment_type = '' AND user_id =0 AND comment_approved = '1' ORDER BY comment_date )ordered_comments GROUP BY ordered_comments.comment_post_id )first_comments GROUP BY first_comments.comment_author ORDER BY comment_comments DESC LIMIT 3

既然不支持，按只有自己写了代码了，创建一个叫做 sofa 的函数。程序的代码非常简单，基本的逻辑如下：

查出含有留言的 Post 的 ID。
然后找出它们的第一条留言的留言者和其博客，帮把这些信息写到一个数组中。
对数组进行处理找出抢到沙发的三个留言者。
输出他们。

具体代码：

function sofa(){
	global $wpdb;

	$first_commentors = array(); //初始化沙发党数组

	$q = "SELECT DISTINCT comment_post_id FROM $wpdb->comments WHERE comment_type ='' AND user_id = 0 AND comment_approved = '1'";
	$have_comment_post_ids = $wpdb->get_results($q); //获取有留言的日志ID
	foreach ($have_comment_post_ids as $have_comment_post_id){
		$q = "SELECT comment_author FROM $wpdb->comments WHERE comment_type ='' AND user_id = 0 AND comment_approved = '1' AND comment_post_id = $have_comment_post_id->comment_post_id order by comment_date limit 1";
		$first_comment = $wpdb->get_results($q);  //获取沙发党
		array_push($first_commentors,$first_comment[0] -> comment_author); //添加进沙发党数组
	}

	$first_commentors = (array_count_values ($first_commentors)); //统计
	arsort($first_commentors); //排序

	$first_commentors_author = array_keys($first_commentors);//获取沙发党名字

	$output = ""; //初始化输出字符串
	$output .= '';
	for($i=0; $i<3; $i++){
		$title="";
		if($i==0)$title = "状元：";
		if($i==1)$title = "榜眼：";
		if($i==2)$title = "探花：";
		$q = "SELECT comment_author_url FROM $wpdb->comments WHERE comment_type ='' AND user_id = 0 AND comment_approved = '1' AND comment_author_url !='' AND comment_author = '$first_commentors_author[$i]' limit 1";
		$first_comment_url = $wpdb->get_results($q); //获取沙发党的博客
		if($first_comment_url){
			$output .= '" title="' . $first_commentors_author[$i].'">' . $title.$first_commentors_author[$i] . '(' . $first_commentors["$first_commentors_author[$i]"].')';
		} else {
			$output .= '' . $title.$first_commentors_author[$i] . '('.$first_commentors["$first_commentors_author[$i]"] . ')';
		}
	}
	$output .= '';
	echo $output;//输出沙发党前三甲
}
?>

然后在模板上（一般是在侧边拦侧）调用这个 sofa 函数即可。调用的方法为：

php if(function_exists('sofa')) { sofa(); } ?>

我们自己动手写插件的第一篇就到此为止，有任何问题请留言，但是抢沙发没有奖。
下一节我们讲讲如何窗体化（Widgetize）该插件，请大家保持关注，本人首次尝试写教程，如有不好的地方，欢迎大家提出批评和意见。

该插件演示请看本博客侧边栏订阅的下面！

这篇教程所实现的插件下载地址：WP-Sofa。并以此插件献给某著名沙发党大猫和胡戈戈同学。

>>>继续阅读全文 ...

我爱水煮鱼» 沙发

自己动手写 WordPress 插件：后台选项

相关日志

自己动手写 WordPress 插件：使用 WP-Cron

相关日志

自己动手写 WordPress 插件：使用 API

相关日志

Top First Commentors

English

中文

相关日志

自己动手写 WordPress 插件：窗体化插件 2

相关日志

自己动手写 WordPress 插件：窗体化插件 1

相关日志

自己动手写 WordPress 插件：开始

相关日志