详解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 相关文章推荐
Zend引擎的发展 [15]
Oct 09 PHP
PHP生成带有雪花背景的验证码
Oct 09 PHP
PHP中cookies使用指南
Mar 16 PHP
php heredoc和phpwind的模板技术使用方法小结
Mar 28 PHP
PHP 服务器配置(使用Apache及IIS两种方法)
Jun 01 PHP
PHP 如何获取二维数组中某个key的集合
Jun 03 PHP
PHP中__autoload和Smarty冲突的简单解决方法
Apr 08 PHP
深入分析PHP优化及注意事项
Jul 04 PHP
php安装php_rar扩展实现rar文件读取和解压的方法
Nov 17 PHP
PHP实现的日历功能示例
Sep 01 PHP
php获取用户真实IP和防刷机制的实例代码
Nov 28 PHP
深入学习微信网址链接解封的防封原理visit_type
Aug 15 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
在命令行下运行PHP脚本[带参数]的方法
2010/01/22 PHP
Thinkphp中的volist标签用法简介
2014/06/18 PHP
php查询whois信息的方法
2015/06/08 PHP
根据key删除数组中指定的元素实现方法
2017/03/02 PHP
YUI Compressor压缩JavaScript原理及微优化
2013/01/07 Javascript
JS+JSP checkBox 全选具体实现
2014/01/02 Javascript
JS调试必备的5个debug技巧
2014/03/07 Javascript
JS+CSS实现带有碰撞缓冲效果的竖向导航条代码
2015/09/15 Javascript
jQuery点击输入框显示验证码图片
2016/05/19 Javascript
Vue父子模版传值及组件传值的三种方法
2017/11/27 Javascript
angular 实现的输入框数字千分位及保留几位小数点功能示例
2018/06/19 Javascript
基于vue+echarts 数据可视化大屏展示的方法示例
2020/03/09 Javascript
js实现无缝轮播图效果
2020/03/09 Javascript
python sqlobject(mysql)中文乱码解决方法
2008/11/14 Python
python改变日志(logging)存放位置的示例
2014/03/27 Python
零基础写python爬虫之抓取糗事百科代码分享
2014/11/06 Python
python获取各操作系统硬件信息的方法
2015/06/03 Python
有趣的python小程序分享
2017/12/05 Python
Python实现统计英文文章词频的方法分析
2019/01/28 Python
pyqt5 实现 下拉菜单 + 打开文件的示例代码
2019/06/20 Python
简单了解Python3 bytes和str类型的区别和联系
2019/12/19 Python
浅谈django 模型类使用save()方法的好处与注意事项
2020/03/28 Python
Opencv图像处理:如何判断图片里某个颜色值占的比例
2020/06/03 Python
Python使用windows设置定时执行脚本
2020/11/12 Python
使用CSS3来制作消息提醒框
2015/07/12 HTML / CSS
Charlotte Tilbury英国官网:英国彩妆品牌
2017/05/26 全球购物
2013的个人自我评价
2013/12/26 职场文书
影视动画专业个人的自我评价
2013/12/31 职场文书
主题实践活动总结
2014/05/08 职场文书
微电影大赛策划方案
2014/06/05 职场文书
单位授权委托书范本
2014/09/26 职场文书
公司表扬信格式
2015/05/04 职场文书
小学家庭教育心得体会
2016/01/14 职场文书
详解CSS故障艺术
2021/05/25 HTML / CSS
一文搞懂php的垃圾回收机制
2021/06/18 PHP
Web应用开发TypeScript使用详解
2022/05/25 Javascript