PHP 过滤器

pf_page_suffix

基础信息

名称：pf_page_suffix
类型：过滤器（filter）
作用：主题页面、滚动图的钩子均与“页面后缀”有关。如：404 页面的后缀为_404,文章内容页的后缀为_single(post)等。这些后缀在显示页面主列以及显示顶部滚动图时，均会造成影响。因此，修改此过滤器需要非常谨慎。修改后，可能出现某个页面内容不是预期效果的问题。

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

将 404 页使用搜索页的后缀（将连带修改页面显示的部分内容变成搜索页）

1
add_filter('pf_page_suffix',function($suffix){
2
    return $suffix == '_404' ? '_search' : $suffix;
3
});

pf_sidebar_selectors

基础信息

名称：pf_sidebar_selectors
类型：过滤器（filter）
作用：用于定义边栏切换按钮及边栏内容

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

仅显示自定义边栏（要显示边栏内容需额外注册名为“my_sidebar”的边栏）

1
add_filter('pf_sidebar_selectors',function($tobe_filtered){
2
    return [
3
        'my_sidebar' => [
4
            'name' => '我的边栏',
5
            'html' => '<span>❤</span>'
6
        ]
7
    ];
8
});

pf_static_nav_logo

基础信息

名称：pf_static_nav_logo
类型：过滤器（filter）
作用：固定在顶部的导航条左侧 LOGO 显示的 HMTL 标签内容

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

忽略后台设置的 LOGO 参数，强制更换成自定义文本

1
add_filter('pf_static_nav_logo',function(){
2
    return "自定义HTML内容";
3
});

pf_header_image

基础信息

名称：pf_header_image
类型：过滤器（filter）
作用：主题页面顶部的图片

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

忽略后台设置的顶部图片参数，强制更换成自定义文本

1
add_filter('pf_header_image',function(){
2
    return "自定义HTML内容";
3
});

pf_the_modal_title

基础信息

名称：pf_the_modal_title
类型：过滤器（filter）
作用：输出（首页）模块标题 HTML

过滤器参数

类型标记可能的值：

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

例：根据标记组装自定义标题

1
add_filter("pf_the_modal_title",function($tobe_filtered_html, $original_text, $remark){
2
    if($remark == -1){
3
        return "<div class='custom-modal-title'>我的最新文章</div>";
4
    } else {
5
        return $tobe_filtered_html;
6
    }
7
},10,3);

pf_show_post_function

基础信息

名称：pf_show_post_function
类型：过滤器（filter）
作用：用于修改显示文章卡片的方法（名）

过滤器参数

类型标记可能的值：

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

文章分类 ID 是 8 的，使用自定义显示方式显示。其它仍然使用主题原始的卡片展示方式：

1
//替换输出方法
2
add_filter('pf_show_post_function',function($tobe_filtered,$ids,$remark){
3
    return $remark == 10 ? "my_custom_show_post_func" : $tobe_filtered;
4
},10,3);
5

6
//自定义输出方法
7
function my_custom_show_post_func($post_id=0,$type_id=0, $sn='') {
8
    $html = "<a href='".get_permalink($post_id)."'>".get_the_title($post_id)."</a>";
9
    echo $html;
10
}

pf_recommend_selectors

基础信息

名称：pf_recommend_selectors
类型：过滤器（filter）
作用：文章推荐模块（点赞最多、评论最多、阅读最多）的 Tab 选择器内容

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

除了点赞最多、评论最多、阅读最多以外，增加一个自定义的 Tab：

1
add_filter('pf_recommend_selectors',function($tobe_filtered){
2
    $tobe_filtered[] = "自定义<b>Tab</b>";
3
    return $tobe_filtered;
4
});

注：真实使用场景除了增加选择器按钮外，还应该增加 Panel 内容，详见pf_recommend_panels动作钩子

pf_frontpage_modal_query_args

基础信息

名称：pf_frontpage_modal_query_args
类型：过滤器（filter）
作用：首页模块数据查询参数过滤

过滤器参数

类型标记可能的值：

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

例：“大家喜欢”模块在首页设置成 12 篇文章

1
add_filter("pf_frontpage_modal_query_args",function($args, $type_id){
2
    // 类型标记为-2是“点赞最多(大家喜欢)”
3
    if ($type_id == -2) {
4
        //修改查询数量（参见WP_Query的参数说明）
5
        $args['posts_per_page'] = 12;
6
    }
7
    return $args;
8
},10,2);

pf_frontpage_modal_query_result_ids

基础信息

名称：pf_frontpage_modal_query_result_ids
类型：过滤器（filter）
作用：首页模块数据查询结果过滤

过滤器参数

类型标记可能的值：

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

使用示例

打乱首页最新文章的 id，让显示顺序也随机

1
add_filter('pf_frontpage_modal_query_result_ids',function($ids, $type_id){
2
    // 类型标记为-1是“最新文章”
3
    if ($type_id == -1) {
4
        shuffle($ids);
5
    }
6
    return $ids;
7
},10,2);

pf_the_modal_link

基础信息

名称：pf_the_modal_link
类型：过滤器（filter）
作用：输出（首页）模块“阅读更多”链接 HTML

过滤器参数

类型标记可能的值：

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

pf_slider_type

基础信息

名称：pf_slider_type
类型：过滤器（filter）
作用：对 slider 输出的类型进行过滤，默认有 card-flip 和 landscape 两种

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法

pf_slider_data

基础信息

名称：pf_slider_data
类型：过滤器（filter）
作用：对 slider 输出的数据进行过滤

过滤器参数

其他：

1. 参数可使用 var_dump(参数); 查看具体内容
2. 若接收 2 个及以上参数，在添加过滤器时务必跟上过滤器优先级（默认 10）以及参数数量，否则会报错。详见 WordPress 官方 add_filter 用法