PhilNa

数组重载在 WordPress 主题或插件设置中的应用

yinheli — Wed, 20 Jan 2010 23:17:42 +0800

现在大部分的 WordPress 主题和插件都有后台设置页面, 为主题或插件添加自定义的一些功能. 这些设置会将被保存到数据库中. 然后在主题或插件中使用它们. 通常人们都是用 global 这样的关键字将他们的设置声明为一个全局变量. 或者在各个页面上都使用 get_options 这样的函数去取得设置. 然而我觉得那样处理并不好. 这里我写了个自认为较好的办法. 欢迎大家批评指正.

该方法用到了数组重载. 数组重载是将对象作为数组使用的一个过程. 为了实现这个你需要用到 ArrayAccess 接口.

以下是 ArrayAccess 接口代码清单:

interface ArrayAccess  {
 
	/**
	 * @param offset 确定给定偏移量是否存在于数组中
	 */
	abstract public function offsetExists ($offset) {}
 
	/**
	 * @param offset 取得给定偏移量上的数据
	 */
	abstract public function offsetGet ($offset) {}
 
	/**
	 * @param offset 设置或替换给定偏移量上的数据
	 * @param value 要设置或替换的数据
	 */
	abstract public function offsetSet ($offset, $value) {}
 
	/**
	 * @param offset 置空给定偏移量上的数据
	 */
	abstract public function offsetUnset ($offset) {}
 
}

具体的实现办法如如下代码所示: 在这个类中我们用到了单件(例)模式.

/**
 * Get options
 *
 * @author yinheli
 *
 */
class PhilNaGetOpt implements ArrayAccess {
 
	/**
	 * 所有设置
	 *
	 * @var array
	 */
	private $philnaOpt = array();
 
	/**
	 * 获取设置对象
	 *
	 * @var PhilNaGetOpt
	 */
	private static $_instance;
 
	/**
	 * 从数据库中取得设置
	 *
	 * @return null
	 */
	private function __construct() {
		if ($r = get_option('philnaopt')) {
			$this->philnaOpt = $r;
			unset($r);
		}
	}
 
	/**
	 * 不许克隆
	 */
	private function __clone() {}
 
	/**
	 * 获取 PhilNaGetOpt 单一实例
	 *
	 * @return PhilNaGetOpt
	 */
	public static function getInstance() {
		if (!(self::$_instance instanceof self)) {
			self::$_instance = new self();
		}
		return self::$_instance;
	}
 
	/**
	 * 重新取得设置
	 *
	 * @return null
	 */
	public function reGet() {
		$this->__construct();
	}
 
	/**
	 * 给定的偏移量是否存在?
	 *
	 * @return bool
	 */
	public function offsetExists($key) {
		if (array_key_exists($key, $this->philnaOpt)) {
			return true;
		} else {
			return false;
		}
	}
 
	/**
	 * 返回给定偏移量上的数据
	 *
	 * @return null|mix
	 */
	public function offsetGet($key){
		if (array_key_exists($key, $this->philnaOpt)) {
			if (is_string($this->philnaOpt[$key])) {
				return stripslashes($this->philnaOpt[$key]);
			} else {
				return $this->philnaOpt[$key];
			}
		} else {
			return null;
		}
	}
 
	/**
	 * 设置给定偏移量上的数据
	 *
	 * @return bool|mix
	 */
	public function offsetSet($key, $val) {
		if (array_key_exists($key, $this->philnaOpt)) {
			$this->philnaOpt[$key] = $val;
			return $val;
		} else {
			return false;
		}
	}
 
	/**
	 * 置空给定偏移量上的数据
	 *
	 * @return bool
	 */
	public function offsetUnset($key) {
		if (array_key_exists($key, $this->philnaOpt)) {
			unset($this->philnaOpt[$key]);
			return true;
		} else {
			return false;
		}
	}
}

接下来我们我们只需要在代码的最开始时实例化刚刚的那个读取设置的类. 并将它存储到全局数组里. 例如在主题中. 我们可以在 functions.php 文件中首先做这样的事情.

1	$GLOBALS['philnaopt'] = PhilNaGetOpt::getInstance();

然后我们就不用理会其他的情况, 只需要在你需要的地方调用那个设置对象. 就像是使用数组一样. 而不用不考虑它是否存在着你需要的那个键值. 很多情况下它简化了我们的一些条件判断.

比如我们要判断是否需要显示首页通知

一般情况下. 我们的判断是:

// 取得设置
$opt = get_option('philnaopt');
 
// 判断是否有通知要显示
if (isset($opt['notice']) && $opt['notice']) {
	if (isset($opt['notice_content']) && $opt['notice_content']) {
		echo $opt['notice_content'];
	}
}

而是用新的办法后是这样的:

// 判断并显示通知
if ($GLOBALS['philnaopt']['notice'] && $GLOBALS['philnaopt']['notice_content']) {
	echo $GLOBALS['philnaopt']['notice_content'];
}

说明:
当然在很多人的代码中我经常看不到 isset() 这样的函数. 事实上, 如果在开启报告全部错误的情况下. 我们在判断一个数组中的值. 我们首先要判断是否存在相应的键值. 否则 PHP 会产生一个 NOTICE 级别的错误. 加isset()这样的判断在我看来是一种比较规范的写法.

使用数组重载来调用设置有一个最大好处是简化判断. 当然更主要的是它规范了代码, 避免了使用 global 这样不优雅的代码.

注意: 这个 PHP 特性只能使用在 PHP 版本 5.1.0 及其以上. 如果你使用古老的版本. 那只能作罢了.

用 eclipse 写 WordPress 主题和插件

yinheli — Tue, 12 Jan 2010 16:10:02 +0800

切换到 eclipse 有很长一段时间了. 这里推荐给 WordPress 主题作者和插件开发者, 当然如果你已经在使用或者计划使用其他更为强大的 IDE 开发工具的话可以跳过本文, 因为我这只介绍基本的使用方法, 旨在将大家引入一种更为便捷的开发环境. 当然对于非 WP 使用者而言这种方法同样适用.

Eclipse是著名的跨平台的自由集成开发环境(IDE)最初主要用来Java语言开发,但是目前亦有人通过插件使其作为其他计算机语言比如C++和Python的开发工具… More

下载和安装 eclipse

Eclipse 有多个版本, 主要是它们集成了不同的插件从而适用不同语言的开发者. 你可以到这里下载.

我使用的编程语言是 PHP 因此下载 Eclipse for PHP Developers 这个版本.

Eclipse 是绿色软件, 解压即可使用, 当然由于它是基于 Java 的, 你需要 Java 环境. 安装Java环境和设置path, 这些细节不再本文讨论范围. 不会的菜鸟们可以 Google 一下.

使用技巧

第一次启动 eclipse 是一个欢迎界面, 关掉欢迎标签后会看到多个透视图. 接下来我们就可以开始使用这个强大的开发工具了.

新建工程

点击工具栏左下方按钮或者功过 file(文件) 新建一个 PHP Project

给你建的工程起个名字, 注意工程的路径为本地 WordPress 根目录(接下来, 你就会看到这样做的好处), 然后直接点 finish 即可

调整字体

默认情况下 eclipse 在 windows 上的字体偏小. 我们需要适当调整一下, 我主要只修改三处
修改步骤:
点击菜单上的 Window -> Preferences, 在左边的 General 中点开 Apperance -> colors and Fonts
我的设置是:
Dialog Font 设置为微软雅黑
Text Editor Block Selection Font 和 Text Font 均设置为 Consolas

编辑器里面的字体原则上是使用等宽字体. 这样我们比较容易区分数字0和字母o这样比较接近的字符. windows 系统上默认是 Courier New. 我都看腻了. 试用了 Consolas 感觉还不错.

不推荐使用一些手写风格的字体, 漂亮的雅黑也最好不用, 我感觉那种字体用来编程看上去让眼睛很累. 网上有很多很漂亮的免费等宽字体下载. 大家可以去试试. 好的字体看上去舒服清晰, 敲代码时也让人心情愉悦些.

除了 Consolas 我还推荐的是 Linux 上面的 Mono

代码提示和自动完成

这个功能几乎是所有 IDE 都具备的, 给我们的编程提供了非常大的便利.

还记得刚刚在建立工程时把整个 WordPress 目录放进去的步骤吧, 就是为这个强大的提示和自动完成服务的.

代码提示: 鼠标放到个已经定义的函数上, 它的位置描述等等全部会提示出来. 按住 Ctrl单击那个函数, 我们就直接打开了那个函数所在的文件并自动转到那个函数的位置. 你很方便的查看那个函数具体是怎么编写的.

自动完成: 有时候我们记不清到底之前写过的变量或者函数时, 只需要写出那个函数或变量的前几个字符然后按住 alt+? 它会自动为您搜索.

常用快捷键

按键	功能	按键	功能
Ctrl+S	保存	Ctrl+T	快速显示当前类的继承结构
Ctrl+1	快速修复	Ctrl+Alt+Down	复制当前行到下一行
Ctrl+D	删除当前行	Ctrl+Alt+Up	复制当前行到上一行
Ctrl+W	关闭当前Editer	Ctrl+Shift+K	参照选中的Word快速定位到上一个
Ctrl+K	参照选中的Word快速定位到下一个	Ctrl+E	快速显示当前Editer的下拉列表
Ctrl+Q	定位到最后编辑的地方	Ctrl+Shift+F	格式化当前代码
Ctrl+L	定位到指定行	Ctrl+Shift+L	显示全部定义的快捷键
Ctrl+M	最大(小)化当前的Edit或View	Alt+Left	上一个编辑位置
Ctrl+Shift+M	查找函数	Alt+Right	下一个编辑位置
Ctrl+Shift+T	查找类	Alt+/	内容辅助功能
Ctrl+O	快速显示OutLine

* 不推荐修改原有的快捷键. 记住一些常用的就可以了

安装插件

Eclipse 有很多的插件, 但是对于写 WordPress 主题和插件的作者来说我推荐常装的插件是 Aptana. 用它来敲 Javascript 怎一个爽字了得.

事实上 Aptana 是个基于 eclipse 开发的 IDE, 同时它也提供一个 eclipse 的插件, 这样装了 Eclipse 的人就没有必要在重新安装一次 Aptana 了, 而只需要安装它提供的插件.

你可以选择两种方法来安装 Aptana 插件版. 1, 在线更新. 2, 下载 zip 文件. 你任选择一种即可. 到目前为止. 最新版zip的压缩文件约 35M. 我一般选择的是下载 zip 压缩包. 因为用迅雷下载这玩意很快. 比在线更新要快的多.

在线更新请按照 Aptana 提供的步骤来.

我简单介绍一下 zip 压缩包格式的安装.
点击菜单栏的 Help -> Install New Software… 在弹出的窗口中点击 add -> Archive… 选择你下载回来的压缩包. 然后一步一步安装即可.

装好这个插件后如果你经常用 javascript 框架写代码的话. 那我建议你安装 Aptana 的相关 Javascript 框架支持. 比如我安装了 jQuery. 我这里不再详细, 不怎么理解的请 Google 一下. 有很多的教程告诉你要这么装.

值得注意的是:
装好插件后要调整一下文件的打开方式, Window -> Preferences, General -> Eidtors -> File Associations. 找到 js 后缀. 将 Aptana JS Editor 设置为默认编辑器. 这样你才能用 Aptana 提供的强大提示和自动完成功能. 要不然你会莫名其妙的发现插件安装成功了. 怎么就没有我提到的功能呢? 如果你还安装了其他的什么高级编辑器同样需要这样处理一下. 否则就它是调用 eclipse 默认的编辑器的.

后续话题:

代码重构

SVN 版本控制

类似软件和工具

Zend Studio
Aptana

后记:

请原谅此文没有插图. 不要说无图无真相. 哈. 我是希望你亲自去体验.

上面提及的两个类似软件都是基于 eclipse 这个开源软件的. 都是一个内核. 不同的只是集成的插件不同. 由不同的公司,社区维护.

有人说使用 IDE 工具尤其是代码自动完成会造成人的惰性. 嗯. 我也觉得是这样. 其实我们现在流行使用 jQuery 和其他 javascript 框架. 甚至其它任何让人们可以偷懒的工具, 不也是同样的道理吗? 用的多了, 我们是感觉很方便的同时也忘却了很多该记住的东西. 这就跟一个厨师一般不会去关注锅碗瓢盆是怎么制造出来的而只是关注饭菜要怎么才美味一样. 另个可比的情况是: 我们很多人离开了 Dreamweaver 这种所见即所得的编辑工具后给个记事本就完全不会写 HTML 了. 所以如果你希望多了解编程, 还是一定要多去记忆一下东西的. IDE 只是一个便捷的快速的开发环境.

还有什么问题? 欢迎提交评论, 大家一起讨论.

文本编辑Notepad++( 4 )
让你高清无码( 5 )

阻止直接 POST 过来的 Spam

yinheli — Thu, 31 Dec 2009 22:30:30 +0800

几天前收到很多 spam, 居然大部分来自同一个 IP. 我只好在数据库里用 SQL 语句删掉. 再去看访问日志. 发现这个 IP 几乎是直接向我的 wp-comments-post.php 这个文件 POST 数据. 也就是说它根本没有访问文章. 我很气愤.

现在想到的解决方案是用 SESSION 来阻止. 写成插件 ( Stop post spam ). 本地测试有效. 但要是用了 HTML 静态缓存就不知到了. 可能会导致任何人都无法提交? 不过总的来说这个是不适合完全静态页面的, 除非我们的隐藏域设置为固定的值? 这个有恐怕无法到达很好的阻止作用. 两难啊. 唉. 反正我也不用缓存插件. 不管了. 交给爱折腾的人吧.

再和大家说说我的流程是怎样的.

插件激活后通过 StopPOSTSpam 类的构造函数挂载方法到 WordPress 自身的 HOOKs 上. (怎么听上去有点拗口… (- -!))

用到的钩子: init, template_redirect, comment_form, pre_comment_on_post

具体实现流程:

正常访问状态, 访客访问可以评论的页面(比如普通的日志页面), PHP 执行如下:

init 会将ready状态设置为 true.
到执行 template_redirect 的时候判断是否为评论的页面, 是则创建随机 SESSION 否则插件不再执行 Spam 判断
评论表达中通过 comment_form 这个 hook 添加刚刚创建的 SESSION 隐藏域.
提交评论的时候通过 pre_comment_on_post 这个 hook 判断 SESSION. 当然 ready 状态为 false 不判断.

直接POST数据时: 没有通过 template_redirect 这一步来生成 SESSION 当然是不能通过的. 它会被当成 spam 而阻止进一步向数据库提交.

最后祝大家元旦快乐, 我不想写感悟, 也不想总结. 反正这半年来过的真是不怎么样. 这算是2009最后一个小时的文章吧. 过几天的考试. 唉~ 我可能会死 ‘很惨’ . 有时间和爱心的朋友到时候可要过来安慰我啊…

下载这个插件.

Update:

在无法使用 session 的情况下改为判断来路. 不知是否试用于静态页面. 欢迎测试.

Google Ajax Custom Search

yinheli — Mon, 30 Nov 2009 08:32:29 +0800

好久没有关注 Google 自定义搜索. 今天上去一看很多地方都改掉了. Google 更偏向于使用他的 Ajax API. 好吧, 我也来研究一下. 基本来说文档还是很详尽的.

做了个小尝试. 利用 Google Ajax API 写了个 Google 自定义搜索. 可以用来搜索本站内容.

注意: 原则上 Google 要求保留它的 logo. 所以大家在使用的时候还是最后加上. 这也是对 Google 的一种尊重吧.

我写的 DEMO 在这里.

以后有时间考虑给主题加上吧. 也需要等到下一个主题了. 现在越来越觉的主题主题集成的东西太多. 非常不利于修改和维护. 而且代码也写得不优雅. 重来实在是没有时间.

无限级导航菜单

yinheli — Fri, 13 Nov 2009 19:51:15 +0800

上次看到有个 web 招聘笔试题里有个题大意是这样的: 是否尝试写过无限级的导航菜单? 我一时兴致就尝试写了一下.

要想兼容 IE(6/7/8) 系列还真的挺费事. 不得不动用 javascript 以及在 CSS 中使用 hacker. 对 Javascript 我只懂些皮毛. 要想做出些动画效果那几乎不可能. 只好用 jQuery 了.

我现在做了个DEMO. 要修改其动画效果只需要改改 js 中的鼠标效果即可. jQuery 自带的几个动画效果都可以. 当然你还可以发挥你的想象写些自定义动画.

DEMO

Comment Fetion Alert 2.0.0 dev 发布

yinheli — Mon, 02 Nov 2009 13:50:25 +0800

整个重新写过. 丰富了后台选项. 最重要的是去掉了对 curl 扩展的依赖. 很多的细节我也不多说了. 现在发布 dev 版本给大家测试. 有问题尽快提交给我. 我好做进一步的修正.

下载

补充:
我哥们 Grubylee 给我写了比较详细的说明. 移步看看

缓存头像的插件 cache avatar

yinheli — Thu, 29 Oct 2009 21:19:34 +0800

抽空写了个缓存头像的插件 – cache avatar

可以把讨论头像缓存到本地服务器. 随着博客越来越多 gravatar 的站点压力越来越大. 偶尔有头像下载缓慢的情况. 尤其在评论很多的情况下评论者头像往往是最后才载入完成. 因此对站点速度有点苛刻的朋友需要缓存一下评论头像.

插件后台可设置缓存时间.

需要的朋友可下载.

给首页的友情链接添加 nofollow

yinheli — Wed, 28 Oct 2009 15:09:37 +0800

介绍个简便的办法给用 wordpress 的朋友, 用来给首页的友情链接添加 nofollow. 只有几行代码,很简单. 如下:

/**
 * 给首页友情链接添加 nofollow
 *
 * 你可以举一反三, 用它来对友情链接做些修改
 *
 * @author yinheli
 * @link http://philna.com
 * @param array $links 链接
 * @return array 修改过的链接
 */
function myBookmarksInHomepage($links){
	/*判断是否为首页 你也可以用其他的判断用于其他的页面*/
	if(is_home()){
		/*历遍*/
		foreach ($links as &$value) {
			/*你可以添加其他的判断对来针对你需要修改的链接*/
			$value->link_rel = 'external nofollow';
		}
	}
	return $links;
}
add_filter('get_bookmarks','myBookmarksInHomepage');

把上面的代码放到主题的 functions.php 中即可.

你还可以多加些判断比如针对某个分类. 甚至只针对某个链接. 这应该是最灵活的处理办法了.

最后说明一下: 本站不交换链接, 所有以交换链接为名提交的评论将被删除. 你要是经常来我这里留言, 混熟了我自然会给你加上链接.

在 PhilNa2 中使用 Hook

yinheli — Mon, 05 Oct 2009 23:00:58 +0800

主题难免要修修改改. 在代码时我故意留了些可以个性化的 Hook 供大家使用.

实现方法是用 add_action 和 add_filter 函数. (更多相关信息请到官方查看文档). 比如我的文章中的声明, Google 广告, 页脚的备案等内容就是通过这种方法实现的.

下面以修改欢迎词为例简单说明:

本修改针对 PhilNa2 version 2.0.3

修改原理:
通过添加过滤器: add_filter函数实现.

首先打开app文件夹的template_functions.php文件找到welcome_msg函数部分, 大约在415行, 你会看到针对Google搜索过来的访客的欢迎词处理.

415	if($m = apply_filters('welcome_msg_google_search',$str))

因此要修改来自Google搜索访客的欢迎词可以使用如下代码:(你可以将一下代码放到主题根目录functions.php的最后面,当然也可另外建一个文件, 另外引入也行)

function my_welcome_msg_for_google($msg){
	$msg = '欢迎来自Google的朋友....';//这里写你想要显示的内容. 可以使用html
	return $msg;
}
add_filter('welcome_msg_google_search',my_welcome_msg_for_google);

其他的以此类推. 考虑到并非所有人都要修改一番, 这里不再列出所有可修改的 Hook 接口. 主题使用了很多中文注释, 很容易明白.

为什么要这么做? 主要是为了避免主题的频繁更新, 可能导致部分忠实用户的个性化修改麻烦. 写好函数后, 以后更新了, 再次导入引用就会相对方便些. 当然也了, 我的主题并不是团队合作更新, 可能更新的频率也不会高, 只是提供一种思路吧. 实在不喜欢的朋友, 还是建议直接修改源代码.

主题发布: PhilNa2 ( 122 )

博客一周岁

yinheli — Sun, 27 Sep 2009 01:00:51 +0800

不知不觉开博一年了, 我先自我祝贺一下.

记不得当时为什么开博, 可能是一时冲动, 和很多人一样. 我也曾在网络上各种地方混过. 但都不尽人意才转向独立博客, 之所以选用 wordpress 作为平台,是因为它用的人多. 方便交流. 也想更深入的学习一下 PHP .

现实

现实生活中的我其实我点自闭. 不善交际, 语言笨拙… 所以朋友也不多. 大部分’寂寞’的时光都是对着屏幕度过的. 但内心却渴望交流, 想要那种愉悦的环境. 可以嘻嘻哈哈谈天说地. 生活可以积极乐观向上… 这些简单的事情可让我实践起来却非常困难. 网络却给了一个不同的环境. 我开始对它痴迷…

回顾

这一年也没少折腾, 写过主题, 也写过插件. 尽管这一切做得并不完美. 但看到有人使用, 夸奖. 我心里还是非常高兴. 也正是这种成就感吧, 一直支持着写下去.

修修改改他人的主题开始厌烦了, 终于放手写了 PhilNa 这个仿微软的主题. 反响不错, 可惜我自己并不喜欢那种风格. 所以放弃了, 一直也没有更新. 也没有时间和精力去更新.

PhilNa2 是我喜欢的风格. 一个一个的盒子让内容很整齐. 很喜欢几米的漫画, 他的每幅画的旁边总有一句很普通但看上去很富哲理的话. 所以选用了几米的漫画作为头部背景. 并附加了 PhilNa say (随机一句话) 这样的小功能.

插件多是一时的冲动干出来的活. 一直没有管了. 也许实用价值并不大, 大家可以参考参考其中的代码吧.

展望

也许我会一直走下去, 零零碎碎的写. 这点精力我还是有的吧.

总结

这一年结交了不少朋友, 也学到了不少东西. 懒得讲废话了. 向所有评论者, 曾经帮助过我的朋友们致谢.

还要特别感谢亿家提供给我的免费空间. 感谢 Sandy 刀刀哥

PhilNa

数组重载在 WordPress 主题或插件设置中的应用

以下是 ArrayAccess 接口代码清单:

具体的实现办法如如下代码所示: 在这个类中我们用到了单件(例)模式.

比如我们要判断是否需要显示首页通知

Related Posts

用 eclipse 写 WordPress 主题和插件

下载和安装 eclipse

使用技巧

新建工程

调整字体

代码提示和自动完成

常用快捷键

安装插件

后续话题:

类似软件和工具

后记:

Related Posts

阻止直接 POST 过来的 Spam

再和大家说说我的流程是怎样的.

具体实现流程:

Related Posts

Google Ajax Custom Search

Related Posts

无限级导航菜单

Related Posts

Comment Fetion Alert 2.0.0 dev 发布

Related Posts

缓存头像的插件 cache avatar

Related Posts

给首页的友情链接添加 nofollow

Related Posts

在 PhilNa2 中使用 Hook

下面以修改欢迎词为例简单说明:

Related Posts

博客一周岁

现实

回顾

展望

总结

Random Posts