JS 过滤器

custom_get_img_color

主题已使用较为先进的主色调提取方法，因此不建议基础用户重写它。对外提供此过滤器的意义在于：当你认为主题主色调提取方法不满足您的高级需求时，你再手动改写它

基础信息

名称：custom_get_img_color
类型：过滤器（filter）
作用：替换“获取图片颜色”的方法

过滤器参数

考虑到获取主色调可能是异步行为，因此被过滤的是 Function 类型，通过回调来得到数据

其他：参数可使用 console.log(参数); 查看具体内容

返回：新 Function，新 Function 接收一个参数用于回调数据：

使用示例

无论什么图片，获取主色调时总是得到浅蓝色

1
add_filter('custom_get_img_color',function(original_function, url){
2
    return function(resolve){
3
        // 根据url图片地址，使用其他算法得到颜色。例子中写死颜色
4
        var rgb_color = [32,160,255];
5
        // 将颜色回调进行后续处理
6
        resolve(rgb_color);
7
    }
8
});

text_to_speech_exclude

基础信息

名称：text_to_speech_exclude
类型：过滤器（filter）
作用：在文章朗读时，去除文章内无需朗读的标签

过滤器参数

其他： 参数可使用 console.log(参数); 查看具体内容

使用示例

增加朗读时需要排除的类型：1、类名为”tips”的元素。2、包含删除线的”s”标签元素

1
add_filter("text_to_speech_exclude",function(original_selectors){
2
    original_selectors.push( ".tips" );
3
    original_selectors.push( "s" );
4
    return original_selectors;
5
})

text_to_speech_max_chars

基础信息

名称：text_to_speech_max_chars
类型：过滤器（filter）
作用：文章朗读功能分段合成每段文字最大数量。
注：文章朗读功能是在线合成，文章字数较长时，合成会占用很长时间，用户等待较长。因此将文章字数拆解短，可减少首次等待时间。但越短，网络请求次数就会越多。

• 根据合成 API 的要求，每段最大不允许超过 2048。
• 若网络环境较差，设置更大的数值可避免出现文章内容朗读时段落丢失的情况

过滤器参数

其他： 参数可使用 console.log(vars)查看具体内容

使用示例

每段文字使用最大数量，减少合成次数，尽量少的请求网络：

1
add_filter("text_to_speech_max_chars",function(){
2
    return 2048;
3
})

check_color_can_use_dark

基础信息

名称：check_color_can_use_dark
类型：过滤器（filter）
作用：检查是否使用暗色模式

过滤器参数

其他： 参数可使用 console.log(参数);看具体内容

使用示例

若当前是 sample.php 模板，则不使用暗色模式

1
add_filter("check_color_can_use_dark",function( default_result ){
2
    return pandastudio_framework.$('#wrapper').attr('data-page-template') == "sample.php" || default_result;
3
});

enable_highlight.js

基础信息

名称：enable_highlight.js
类型：过滤器（filter）
作用：允许主题默认引入 highlight.js 并自动高亮文章代码

过滤器参数

其他： 参数可使用 console.log(参数); 查看具体内容

使用示例

完全禁用代码高亮（在使用第三方高亮插件发生冲突时，请使用下面的方式禁用）

1
add_filter("enable_highlight.js",function(){
2
    return false;
3
});

get_avatar_url

基础信息

名称：get_avatar_url
类型：过滤器（filter）
作用：脚本处理 Gravatar 头像时进行二次过滤（和 PHP 钩子完全一致）

过滤器参数

其他： 参数可使用 var_dump(参数); 查看具体内容