详解WordPress中用于合成数组的wp_parse_args()函数


Posted in PHP onDecember 18, 2015

wp_parse_args() 函数是 WordPress 核心经常用到的函数,它的用途很多,但最主要用来给一个数组参数(args)绑定默认值。

因为 wp_parse_args() 函数返回的一定是一个数组,所以他会把传入查询字符串和对象(object)自动转换成数组,给了使用者更加方便的条件,也增加了兼容性。

常见的 query_posts()、wp_list_comments() 和 get_terms() 函数都使用了 wp_parse_args() 函数来帮它给数组参数添加默认值。

用法

wp_parse_args( $args, $defaults );

参数

$args

(数组 | 字符串)(必须)查询字符串、对象或者数组参数,用来绑定默认值。

默认值:None

查询字符串:

type=post&posts_per_page=5&cat=1

数组:

array( 'type' => 'post', 'posts_per_page' => 5, 'cat' => '1' )

$defaults

(数组)(可选)数组参数的默认参数。

默认值:空字符串

例子

function explain_parse_args( $args = array() ){
 
  //$args 的默认值
  $defaults = array(
    'before' => '<div class="box">',
    'after' => '</div>',
    'echo' => true,
    'text' => 'wp_parse_args() 函数演示'
  );
 
  //绑定默认值
  $r = wp_parse_args( $args, $defaults );
 
  $output = $r['before'] . $r['text'] . $r['after'];
  if( !$r['echo'] ) return $output;
  echo $output;
}
 
//没有参数
explain_parse_args();//打印:<div class="box">wp_parse_args() 函数演示</div>
 
//字符串参数
$output = explain_parse_args( 'text=字符串参数&before=<div class="box-2">&echo=0' );
echo $output;//打印:<div class="box-2">字符串参数</div>
 
//数组参数
explain_parse_args( array( 'text' => '数组参数', 'before' => '<div class="box-3">' ) );//打印:<div class="box-3">数组参数</div>
还有另一种不使用第二个 $defaults 参数的用法,就是帮你把一个查询字符串、对象或者数组的变量直接转换成通用的数组,避免判断类型。

//字符串
$array = wp_parse_args( 'text=测试另一种用法&type=字符串' );
var_dump( $array );
/*
  array(2) {
    ["text"]=>
      string(21) "测试另一种用法"
    ["type"]=>
      string(9) "字符串"
  }
*/
 
//对象(object)
class args_obj{
 
  public $text = '测试另一种用法';
 
  public $type = '对象(object)';
 
  function func(){
    //转换成数组的时候对象里边的函数会被忽略
  }
 
}
$obj = new args_obj;
var_dump( $obj );
/*
object(args_obj)#2175 (2) {
  ["text"]=>
    string(21) "测试另一种用法"
  ["type"]=>
    string(18) "对象(object)"
}
*/

wp_parse_args函数源代码详解
wp_parse_args 函数的源代码比较简单,
依附于PHP 内置函数get_object_vars、array_merge与WordPress的wp_parse_str函数来实现,
以下是该函数的源代码:

/**
 * Merge user defined arguments into defaults array.
 *
 * This function is used throughout WordPress to allow for both string or array
 * to be merged into another array.
 *
 * @since 2.2.0
 *
 *第一个参数可以是 字符串、数组或对象(obj)
 * @param string|array $args Value to merge with $defaults
 *第二个参数为默认的预设值数组,必须是数组
 * @param array $defaults Array that serves as the defaults.
 *返回值将是一个数组
 * @return array Merged user defined values with defaults.
 */
function wp_parse_args( $args, $defaults = '' ) {
 if ( is_object( $args ) )
 //将接收的对象(obj)转换为数组
 $r = get_object_vars( $args );
 elseif ( is_array( $args ) )
 //如果是数组则不转换
 $r =& $args;
 else
 //将接收的字符串转换为数组
 wp_parse_str( $args, $r );
 if ( is_array( $defaults ) )
 return array_merge( $defaults, $r );
 return $r;
}

其中get_object_vars函数是用来返回由对象属性组成的关联数组。
array_merge函数用是将两个或多个数组的单元合并起来,一个数组中的值附加在前一个数组的后面。返回作为结果的数组。

PHP 相关文章推荐
用PHP实现的生成静态HTML速度快类库
Mar 31 PHP
file_get_contents获取不到网页内容的解决方法
Mar 07 PHP
CI(CodeIgniter)框架中的增删改查操作
Jun 10 PHP
Zend Framework教程之Loader以及PluginLoader用法详解
Mar 09 PHP
php实现xml与json之间的相互转换功能实例
Jul 07 PHP
全面解析PHP验证码的实现原理 附php验证码小案例
Aug 17 PHP
ThinkPHP中类的构造函数_construct()与_initialize()的区别详解
Mar 13 PHP
PHP文件管理之实现网盘及压缩包的功能操作
Sep 20 PHP
PHP单例模式模拟Java Bean实现方法示例
Dec 07 PHP
PHP中define() 与 const定义常量的区别详解
Jun 25 PHP
Laravel jwt 多表(多用户端)验证隔离的实现
Dec 18 PHP
THINKPHP5分页数据对象处理过程解析
Oct 28 PHP
WordPress中用于获取文章信息以及分类链接的函数用法
Dec 18 #PHP
解决ThinkPHP下使用上传插件Uploadify浏览器firefox报302错误的方法
Dec 18 #PHP
详解 PHP加密解密字符串函数附源码下载
Dec 18 #PHP
PHP封装的字符串加密解密函数
Dec 18 #PHP
WordPress中用于获取及自定义头像图片的PHP脚本详解
Dec 17 #PHP
几个优化WordPress中JavaScript加载体验的插件介绍
Dec 17 #PHP
简介WordPress中用于获取首页和站点链接的PHP函数
Dec 17 #PHP
You might like
德生PL450的电路分析和低放电路的改进办法
2021/03/02 无线电
php preg_match_all结合str_replace替换内容中所有img
2008/10/11 PHP
探讨:php中在foreach中使用foreach ($arr as &amp;$value) 这种类型的解释
2013/06/24 PHP
curl和libcurl的区别简介
2015/07/01 PHP
PHP实现发送邮件的方法(基于简单邮件发送类)
2015/12/17 PHP
yii2带搜索功能的下拉框实例详解
2016/05/12 PHP
nodejs批量修改文件编码格式
2015/01/22 NodeJs
js实现的页面矩阵图形变换特效
2016/01/26 Javascript
浅谈jquery设置和获得checkbox选中的问题
2016/08/19 Javascript
微信小程序封装http访问网络库实例代码
2017/05/24 Javascript
jQuery+Ajax请求本地数据加载商品列表页并跳转详情页的实现方法
2017/07/12 jQuery
jQuery实现html双向绑定功能示例
2017/10/09 jQuery
jQuery表单选择器用法详解
2019/08/22 jQuery
JavaScript实现移动端带transition动画的轮播效果
2020/03/24 Javascript
python实现向ppt文件里插入新幻灯片页面的方法
2015/04/28 Python
git进行版本控制心得详谈
2017/12/10 Python
浅析Python装饰器以及装饰器模式
2018/05/28 Python
Matplotlib中文乱码的3种解决方案
2018/11/15 Python
python+opencv实现阈值分割
2018/12/26 Python
python3 打印输出字典中特定的某个key的方法示例
2019/07/06 Python
PyQt 图解Qt Designer工具的使用方法
2019/08/06 Python
python3应用windows api对后台程序窗口及桌面截图并保存的方法
2019/08/27 Python
Python使用Slider组件实现调整曲线参数功能示例
2019/09/06 Python
python实现批量处理将图片粘贴到另一张图片上并保存
2019/12/12 Python
浅谈tensorflow之内存暴涨问题
2020/02/05 Python
怎么快速自学python
2020/06/22 Python
pycharm 如何取消连按两下shift出现的全局搜索
2021/01/15 Python
html5+css3气泡组件的实现
2014/11/21 HTML / CSS
测控技术与仪器个人求职信范文
2013/12/30 职场文书
网络技术专业求职信
2014/07/13 职场文书
创新社会管理心得体会
2014/09/12 职场文书
综合素质自我评价怎么写
2014/09/14 职场文书
企业法人授权委托书范本
2014/09/23 职场文书
家庭财产分割协议范文
2014/11/24 职场文书
民主评议党员个人总结
2015/02/13 职场文书
Java 多态分析
2022/04/26 Java/Android