详解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&amp;mysql(三)
Oct 09 PHP
完美解决令人抓狂的zend studio 7代码提示(content Assist)速度慢的问题
Jun 20 PHP
深入file_get_contents函数抓取内容失败的原因分析
Jun 25 PHP
php curl获取网页内容(IPV6下超时)的解决办法
Jul 16 PHP
通过table标签,PHP输出EXCEL的实现方法
Jul 24 PHP
ThinkPHP上使用多说评论插件的方法
Oct 31 PHP
浅谈php+phpStorm+xdebug配置方法
Sep 17 PHP
Symfony2创建页面实例详解
Mar 18 PHP
php array_key_exists() 与 isset() 的区别
Oct 24 PHP
Laravel框架使用Redis的方法详解
May 30 PHP
PHP中localeconv()函数的用法
Mar 26 PHP
laravel7学习之无限级分类的最新实现方法
Sep 30 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
星际争霸秘籍
2020/03/04 星际争霸
用HTML/JS/PHP方式实现页面延时跳转的简单实例
2016/07/18 PHP
PHP实现防盗链的方法分析
2017/07/25 PHP
PHP设计模式之建造者模式定义与用法简单示例
2018/08/13 PHP
细品javascript 寻址,闭包,对象模型和相关问题
2009/04/27 Javascript
jquery easyui的tabs使用时的问题
2010/03/23 Javascript
基于jquery ajax 用户无刷新登录方法详解
2012/04/28 Javascript
js螺旋动画效果的具体实例
2013/11/15 Javascript
浅析Javascript中“==”与“===”的区别
2014/12/23 Javascript
详谈javascript中DOM的基本属性
2015/02/26 Javascript
JavaScript中的setMilliseconds()方法使用详解
2015/06/11 Javascript
浅谈Node.js中的定时器
2015/06/18 Javascript
jsonp跨域请求数据实现手机号码查询实例分析
2015/12/12 Javascript
JS中使用 after 伪类清除浮动实例
2017/03/01 Javascript
详解Vue2.0里过滤器容易踩到的坑
2017/06/01 Javascript
详解webpack 入门总结和实践(按需异步加载,css单独打包,生成多个入口文件)
2017/06/20 Javascript
基于rem的移动端响应式适配方案(详解)
2017/07/07 Javascript
基于Nodejs的Tcp封包和解包的理解
2018/09/19 NodeJs
微信小程序实现卡片左右滑动效果的示例代码
2019/05/01 Javascript
Layui带搜索的下拉框的使用以及动态数据绑定方法
2019/09/28 Javascript
ant-design表单处理和常用方法及自定义验证操作
2020/10/27 Javascript
Python内置函数之filter map reduce介绍
2014/11/30 Python
python列出目录下指定文件与子目录的方法
2015/07/03 Python
Python实现的建造者模式示例
2018/08/06 Python
python 读取二进制 显示图片案例
2020/04/24 Python
CSS3的RGBA中关于整数和百分比值的转换
2015/08/04 HTML / CSS
戴森美国官网:Dyson美国
2016/09/11 全球购物
Perfume’s Club意大利官网:欧洲美妆电商
2019/05/03 全球购物
为女性购买传统的印度服装和婚纱:Kalkifashion
2019/07/22 全球购物
《九色鹿》教学反思
2014/02/27 职场文书
股东合作协议书范本
2014/04/14 职场文书
大学生村官考核材料
2014/05/23 职场文书
多媒体教室标语
2014/06/26 职场文书
财务经理岗位职责
2015/01/31 职场文书
企业办公室主任岗位职责
2015/04/01 职场文书
2016年党校科级干部培训班学习心得体会
2016/01/06 职场文书