评论框代码php,个性化 WordPress 评论框

对大多数人而言，WordPress 的评论框(留言表单)也许没有多少需要自定义的地方。我恰好想在提交评论按钮前面加一段话，顺便参考别的资料总结一下。

文中介绍的方法和代码基于 WordPress 3.3.1，至于以后会不会根据更新情况修改，这个很难说。如果有修改，会在文后说明。阅读此文需要对 PHP 有一点点了解，另外还需要知道 WordPress 主题的构建方法。嗯，实际上一般用法只需要依葫芦画瓢即可。

0. 此文涵盖的内容

文中介绍的方法仅仅是修改 WordPress 默认的评论框内容，也就是默认已有定义的那些元素，不会增加新的域或按钮。仅仅是“修改”，而不是“重建”。所用方法基于 WordPress Codex 中 comment_form  一节的参数和 filter。

1. 背景

文中的方法分为两种：a. 修改参数; b. 使用 filter。涉及到的文件都在theme文件夹中(位于 /wp-content/theme/ 目录)。每种方法只涉及到一个特定的文件。这样就不需要修改 WordPress 核心文件了，那样会很麻烦：每次升级 WordPress 都需要重新修改，而且容易引起错误。

前一种方法只涉及到 comments.php 文件。大多数主题都会有这个文件。虽然并不是一定要有 comments.php 文件，只不过这是 WordPress 推荐的方式。

第二种方法只需要修改 functions.php 文件。同样的，大多数主题都会有这个文件。主题自定义的功能都在这个文件中。与上面不同的是，如果你的主题中没有这个文件，你可以自己创建一个。

2. 评论框简史

在版本 3 之前，整个 WordPress 评论框的全部代码都是在主题的 comments.php 文件中的。这使得修改它非常的方便。不过带来的问题就是让主题看起来有些乱。

开发人员也注意到了这个问题，然后从 WordPrss 3 开始，评论框就被精简为一个函数了，直接在主题的相应位置调用此函数：

从此，基本上所有的主题都会直接使用此函数生成默认的评论框，顶多就是在 CSS 样式定义上各有各的风格。一切变得极其简洁。

然而问题也随之而来：如果有人想要改变评论框，那就需要多动动脑子了。

3. 两种方法

有两种方法可以对评论框进行自定义，能完成的任务也一样。要采用哪一种方法一方面看你要干什么，另一方面就看个人的喜好了。

注意：方法 2 是我个人非常推荐的方法，会覆盖掉方法 1。

方法 1: 在 comments.php 中更改 COMMENT_FORM() 调用

这个方法用于以下场景是比较合适的：

修改评论框的所有细节

修改评论框中各字段(field)的标记，包括标签(label)

其实，要完成想我开头提到的那种修改目的，这个方法也是很好的

这个方法是通过给通常的评论框函数调用

增加一些细节来实现修改的。这些细节通过参数来传递给该函数。要改变什么细节，就指定相应的参数。例如：

其中，

$args：可选，是一个数组(array())，包含用于评论框的字符串和字段等的配置内容，如果不写该参数，就使用默认的(见下面)；

$post_id：可选，指定要在 ID 为 $post_id 的文章下产生该评论框，如果不写该参数，就会使用当前文章的 ID(即在每篇文章下产生该文章的评论框)

以类似下面的形式定义上面的参数 $args 数组 array() ：

$args = array(

'parameter_name' => 'value',

'another_parameter' => 'value'

));

默认的参数数组内容如下(via)：

$args = array(

'id_form' => 'commentform',

'id_submit' => 'submit',

'title_reply' => __( 'Leave a Reply' ),

'title_reply_to' => __( 'Leave a Reply to %s' ),

'cancel_reply_link' => __( 'Cancel Reply' ),

'label_submit' => __( 'Post Comment' ),

'comment_field' => '

' . _x( 'Comment', 'noun' ) . '

',

'must_log_in' => '

' . sprintf( __( 'You must be logged in to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( ) ) ) ) . '

',

'logged_in_as' => '

' . sprintf( __( 'Logged in as %2$s. Log out?' ), admin_url( 'profile.php' ), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( ) ) ) ) . '

',

'comment_notes_before' => '

' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '

',

'comment_notes_after' => '

' . sprintf( __( 'You may use these HTML tags and attributes: %s' ), ' ' . allowed_tags() . '' ) . '

',

'fields' => apply_filters( 'comment_form_default_fields', array(

'author' => '

' . '' . __( 'Name', 'domainreference' ) . ' ' . ( $req ? '*' : '' ) . '

',

'email' => '

' . __( 'Email', 'domainreference' ) . ' ' . ( $req ? '*' : '' ) . '

',

'url' => '

' . __( 'Website', 'domainreference' ) . '' . '

' ) ) );

能够使用的参数基本上包括了评论框的各个方面的细节。WordPress Codex entry on comment_form() 中对可用的参数有较为全面的介绍，并指明了参数的默认值(也就是不做修改时的样子)。

省事的话，也可以不定义参数数组 $args = array(…，而是直接将要修改的某个参数放在数组里直接调用。如下面的例子。

例如，默认情况下，在评论框的下面有一行字提示用户可以在评论时使用某些 HTML 代码，存储这些提示文字的参数是 comment_notes_after。想修改为别的提示，比如指向网站上某个说明页面的链接(如隐私政策页面)，就可以直接将原始函数调用改为：

'comment_notes_after' => '

请访问我们的 隐私政策 页面。

'

));

?>

再例如，可以通过下面的形式，将默认的评论框标题 Leave a Reply 改写为别的，甚至可以是中文字符：

<?php comment_form(array('title_reply'=>'雁过留声，人过留名')); ?>

如果需要设置多个参数，需要在每个参数后面使用英文半角的逗号( , )隔开(最后一个参数后除外)。

如果要修改评论框的字段( fields )就稍微麻烦一些(此类应用建议使用下面的方法 2)。需要在上面参数数组 array 的里面创建一个字段数组(下面例子中将其命名为(赋值给) $fields )，然后通过 filter 来调用它。新数组 $fields 将被 ‘fields’ 参数调用。下面的例子中在 $fields 数组中指定了 author 字段的内容(包含了显示它所需要的所有 HTML 代码)：

$fields = array(

'author' => '

' . '' . __( 'Your Name' ) . '

'

);

));

?>

这样就可以更加精细地控制评论框中“作者”(author)的显示方式。上例中将默认的标签 “Name” 改成了 “Your Name”，并将默认值(value)设置成了“Your First and Last Name”。现在只需要在参数数组 array 中调用该字段定义即可：

$fields = array(

'author' => '

' . '' . __( 'Your Name' ) . '

'

);

'fields' => apply_filters( 'comment_form_default_fields', $fields ),

'comment_notes_after' => '

请访问我们的 隐私政策 页面。

'

));

?>

其中的一句：

apply_filters( 'comment_form_default_fields', $fields )

就是告诉 WordPress 要使用你提供的代码(这里使用 $fields 变量来定义)来替换评论框的默认字段 comment_form_default_fields。需要注意的是，上面的代码中 $fields 里只定义了 author 字段，所以如果你将上面的代码应用到自己的主题的话，评论框显示出来就只有“姓名”那个栏目了。当然，你也可以比照这个例子继续编写其它字段，email(邮件地址)和 url(网站地址)的代码。

这里给个直接修改参数形式的，稍作修改的评论框三个字段的修改代码，其中按照 HTML5 的建议增加了 placeholder。

comment_form(

array(

'fields' => array(

'author' => '

昵称 *

',

'email' => '

邮箱 *

',

'url' => '

站点

'

)

)

);

方法 2: 在 functions.php 中使用 HOOK FILTER

这种方法比较适合于

省略或改写字段(姓名、邮件、网址)

当你想使用更加贴近核心也是最彻底的方法的时候

该方法采用 WordPress 的滤器(filters)来实现。使用 filter，可以在评论框最后输出之前对其进行修改(所以会覆盖掉在 comments.php 中的修改)。

这个就需要在主题的 functions.php 文件中操作了。将编写的代码放到 functions.php 文件的结尾即可(如果结尾有 ?>，则应放在 ?> 之前)。

如果你的主题没有 functions.php 文件，自己创建一个就行了(简单的 Windows 记事本程序就可以操作了)，但是要注意的是，自己创建的时候应该先在该文档中输入下面的代码做为开头，

然后另起一行输入自定义的代码。先创建一个函数(function)来定义需要进行的操作。不过似乎只能用来操作(修改显示方式等)字段(fields)，比如三个输入内容 author(姓名)、email(电邮)和 url(网址)。

例如，移除某字段：

add_filter('comment_form_default_fields', 'mytheme_remove_commentform_fields');

function mytheme_remove_commentform_fields($fields){

$fields['email'] = ''; // 后面的参数留空表示移除 email 字段

$fields['url'] = ''; // 移除 website 字段

return $fields;

}

程序的名称就随意啦，只要保证上面一行 add_filter 中调用的与之一致就行了。

再比如修改 author 字段的形式：

function alter_comment_form_fields($fields){

$fields['author'] = '

' . '' . __( 'Your name, please' ) . ' ' . ( $req ? '*' : '' ) .

'

';

$fields['email'] = ''; // 移除 email 字段

$fields['url'] = ''; // 移除 website 字段

return $fields;

}

需要注意的是，如果要修改某个字段，必须将该字段相关的所有部分 —— 标签、输入框等 —— 都定义在里面，否则……自己看看就知道了。

实际上也可以通过挂钩 filter 来增加新的字段。只不过，如果没有相应的 WordPress 数据库操作，新加的字段并不会存储到数据库中，只能是个摆设。新加字段的方法是：

function my_fields($fields) {

$fields['new'] = '

新字段' ' . ( $req ? '*' : '' ) . '

';

return $fields;

}

add_filter('comment_form_default_fields','my_fields');

这里给个采用 filter 方式的，稍作修改的评论框三个字段的修改代码，与前面参数传递方式那个实现的操作是一模一样的，只不过这个要用在 functions.php 文件里头。

function alter_comment_form_fields($fields){

$fields['author'] = '

昵称 *

';

$fields['email'] = '

邮箱 *

';

$fields['url'] = '

站点

';

return $fields;

}

add_filter('comment_form_default_fields','alter_comment_form_fields');

直接将上面的代码放到你的 functions.php 文件中，稍作修改即可。不过，如果要改变评论框出现的位置，那还是需要动一下 comments.php 文件的。(更新)非常感谢 Muze 指出上面代码中的错误，现已更正。

实际上，将下面的代码保存下来，随时可以往里面填写东西来实现修改(每行前面的 // 表示注释掉改行，即让它不起作用，所以，要用的话就把 // 删掉)：

function alter_comment_form_fields($fields){

//$fields['author'] = ''; //removes name field

//$fields['email'] = ''; //removes email field

//$fields['url'] = ''; //removes website field

return $fields;

}

add_filter('comment_form_default_fields','alter_comment_form_fields');

后记

写这个的时候查了查资料，参考了2篇文章：

如果你有什么建议和疑问，请在下方留言。©