详解WordPress中创建和添加过滤器的相关PHP函数

apply_filters()（创建过滤器）
apply_filters() 函数用来创建一个过滤器，大多数被用在函数中，是 WordPress 插件机制中非常重要的一个函数，能让其它的主题和插件对一个值进行修改过滤。

用法

apply_filters( $tag, $value, $var... );

参数

$tag

（字符串）（必须）过滤器的名字。

默认值：None

$value

（混合）（必须）要过滤的值，如果没人过滤则直接返回这个值。

$var

（混合） （可选）传给过滤函数额外的变量参数，辅助过滤函数对返回值进行操作，可以添加无限个。

返回值

（混合）过滤后的值，如果没人过滤则直接返回 $value 的值。

例子

没人过滤：

echo apply_filters( 'test', '可以被修改的值' );

打印结果：

可以被修改的值

有人过滤：

function test_func(){
  return '修改值';
}
add_filter( 'test', 'test_func' );
echo apply_filters( 'test', '可以被修改的值' );

打印结果：

修改值

接收参数：

function test_func(){
  return '修改值';
}
add_filter( 'test', 'test_func' );
function test_func2( $text ){
  return $text . '2';
}
add_filter( 'test', 'test_func2' );
echo apply_filters( 'test', '可以被修改的值' );

多个参数：

function test_func( $text, $var, $var2 ){
  return '修改值' . $var1 . $var2;
}
add_action( 'test', 'test_func', 10, 3 );
echo apply_filters( 'test', '可以被修改的值', '辅助值1', '辅助值2' );

其它

此函数位于：wp-includes/plugin.php

add_filter()（添加过滤器）
add_filter() 可以挂载一个函数到指定的过滤器上。

用法

add_filter( $tag, $function_to_add, $priority, $accepted_args );

参数

$tag

（字符串）（必须）所挂载的过滤器名字（和目标 apply_filters() 函数的 $tag 属性一样）。

默认值：None

$function_to_add

（回调）（必须）要挂载的回调函数，参考 PHP 回调函数类型文档。

默认值：None

$priority

（整数）（可选）执行顺序，越小函数越先被执行。

默认值：10

$accepted_args

（整数）（可选）回调函数接收的参数数量，设置多个可以接收更多 apply_filters() 函数传进来的参数。

默认值：1

返回值

（布尔）总是 True

例子

function test_func( $text, $var1, $var2 ){
  return $text . $var1 . $var2;
}
add_action( 'test', 'test_func', 10, 3 );
echo apply_filters( 'test', '参数2', '参数3', '参数4' );

打印：

test参数2参数3

其它

该函数位于：wp-includes/plugin.php

赞 (0)

相关推荐

  • WordPress开发中自定义菜单的相关PHP函数使用简介

    函数意义 wp_nav_menu () 自定义菜单显示函数 register_nav_menu () 自定义菜单注册函数 – 单数 register_nav_menus () 自定义菜单注册函数 – 复数 (很蛋疼的一个复数形式) 以下举例均用 register_nav_menus () 这个复数形式,以免混淆. 使用位置 register_nav_menus () function.php 文件中,用于注册自定义菜单在后台的代码调用名称和后台显示名称. wp_nav_menu () 主题任意你

  • 编写PHP脚本清除WordPress头部冗余代码的方法讲解

    wordpress头部的代码非常多,包括WordPress版本,前后文.第一篇文章.主页meta信息等各种冗余代码,这些对博主来说是没有意义的,也对网站的安全有一定的影响,也一度不知道这些代码是有什么作用.怎么来的和怎么删除. wordpress头部清理代码如下 将以下代码插入到你functions.php的文件头部,除WordPress头部大量冗余信息 <?php //remove_action( 'wp_head', 'wp_enqueue_scripts', 1 ); remove_act

  • WordPress主题制作中自定义头部的相关PHP函数解析

    header_image() header_image() 函数是 WordPress 自定顶部图像的标准接口函数,该函数可以自动判断后台设置,并返回字符串形式的用户自定义顶部图像地址.本文主要涉及该函数的详解及使用. [Display header image path.] 即,显示顶部图像地址. 使用 复制代码 代码如下: <img src="<?php header_image(); ?>" width="<?php echo $header_i

  • WordPress中用于创建以及获取侧边栏的PHP函数讲解

    register_sidebar()(创建侧边栏) 建立一个侧边栏,用来放置小工具.这个函数使用的时候请放在一个函数里,挂载到 "widgets_init" 钩子. 用法 register_sidebar( $args ); 参数 $args (字符串 | 数组)(可选)要创建的侧边栏的参数. 默认值: $args = array( 'name' => __( 'Sidebar name', 'theme_text_domain' ), 'id' => 'unique-si

  • 讲解WordPress中用于获取评论模板和搜索表单的PHP函数

    comments_template()(获取评论模板) comments_template() 函数用来获取评论模板,一般只能用在文章或者页面上,如果不是文章或者页面将无法显示. 用法 comments_template( $file, $separate_comments ); 参数 $file (字符串)(可选)要评论模板文件. 默认值:/comments.php(当前主题根目录的 comments.php 文件). $separate_comments (布尔)(可选)是否根据评论的类型区

  • WordPress中调试缩略图的相关PHP函数使用解析

    the_post_thumbnail the_post_thumbnail 在 WordPress 中主要用来打印文章中设定的缩略图,而 get_the_post_thumbnail 函数可以将你需要的 HTML 代码以字符串的形式返回. the_post_thumbnail 函数的使用 the_post_thumbnail( $size , $attr) 函数参数 $size 是指你想要的缩略图类型 默认是 'post-thumbnail' 也就是特色图像 $attr 图像img标签中的属性设

  • WordPress中用于获取搜索表单的PHP函数使用解析

    get_search_form 函数在 WordPress 中是用来提取预设的搜索表单或者默认的搜索表单的.因为官方这个函数没有中文的,所以我就简单写了一下. 描述 get_search_form 函数在 WordPress 中是用来提取自定义搜索表单或者默认的搜索表单的. 显示自定义表单还是显示默认表单,完全取决于您的主题中是否有search.php文件, 如果有该文件,则自动调用该文件,如果没有则显示默认的搜索表单. 使用 <?php get_search_form($echo = true

  • 详解WordPress中用于更新和获取用户选项数据的PHP函数

    update_user_option()函数 update_user_option()函数作用利用全局博客权限更新用户选项. 用户选项类似于用户元数据,唯一的不同之处在于用户选项支持全局博客选项.如果'global'参数为False(默认情况下),update_user_option会预先将WordPress表前缀改成选项名称. [函数使用] <?php update_user_option( $user_id, $option_name, $newvalue, $global ) ?> [函

  • WordPress中编写自定义存储字段的相关PHP函数解析

    WordPress中编写自定义存储字段的相关PHP函数解析

    WordPress 的自定义字段就是文章的 meta 信息(元信息),利用这个功能,可以扩展文章的功能,是学习 WordPress 插件开发和主题深度开发的必备知识,方便给文章储存一些额外的自定义内容. 自定义字段不光给插件开发者使用,WordPress 的特色图像.自定义页面模板等功能的信息都储存在自定义字段的表单里边. 在文章编辑器界面的 "自定义栏目" 板块可以管理除了名字开头是 "_" 的字段(没有 "自定义栏目" 板块请在右上角的 &q

  • 解析WordPress中控制用户登陆和判断用户登陆的PHP函数

    登陆函数:wp_signon() 函数介绍: wp_signon()函数用于授权给用户登陆wordpress并可记住该用户名称.该函数取代了wp_login.WordPress 2.5版本起启用. 函数使用: <?php wp_signon( $credentials, $secure_cookie ) ?> 参数说明: $credentials (array) (可选) 登陆用户信息. Default: None $secure_cookie (boolean) (可选) 决定是否使用安全c

随机推荐