# 函数参考 # 函数参考 本框架的公共函数在：`application\common.php` 如果是自定义公共函数，请写在：`application\function.php` 以下列举部分函数，具体用法及其他函数请参考源码。 ## is\_signin > 含义：判断是否登录 > 返回：0或用户id ## get\_file\_path($id) > 含义：获取附件路径 > 返回：附件路径，如果无附件，则返回一张空图片路径 参数类型含义$idint附件id## get\_files\_path($ids) > 含义：批量获取附件路径 > 返回：附件路径 参数类型含义$idarray附件id## get\_file\_name > 含义：获取附件名称 > 返回：附件名称 参数类型含义$idint附件id## get\_thumb > 含义：获取附件缩略图路径 > 返回：缩略图路径，如果无缩略图，则返回原图路径 参数类型含义$idint附件id## get\_avatar > 含义：获取用户头像路径 > 返回：头像路径，如果无头像，则返回默认头像路径 参数类型含义$uidint用户id，不传该参数则获取当前用户id## parse\_attr > 含义：解析配置，按每行为一个数组元素组合成数组 > 返回：数组 参数类型含义$valuestring配置值## parse\_array > 含义：将一维数组解析成键值相同的数组 > 返回：数组 参数类型含义$arrarray一维数组## hook > 含义：监听钩子 > 返回：无 参数类型含义$namestring钩子名称$paramsstring传入参数$extrastring额外参数$oncestring只获取一个有效返回值## module\_config > 含义：显示模块配置页面，或获取或设置插件配置 > 返回：mixed 具体用法，请参考模块开发中的[方法参考](https://www.kancloud.cn/ming5112/dolphinphp/%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_menage > 含义：显示插件的管理页面 > 返回：mixed 具体用法请参考[方法参考](https://www.kancloud.cn/ming5112/dolphinphp/%E6%8F%92%E4%BB%B6-%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_config > 含义：获取或设置某个插件配置参数 > 返回：mixed 具体用法请参考[方法参考](https://www.kancloud.cn/ming5112/dolphinphp/%E6%8F%92%E4%BB%B6-%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_action > 含义：执行插件动作 > 返回：mixed 具体用法请参考[方法参考](https://www.kancloud.cn/ming5112/dolphinphp/%E6%8F%92%E4%BB%B6-%E6%96%B9%E6%B3%95%E5%8F%82%E8%80%83.md) ## plugin\_action\_exists > 含义：检查插件控制器是否存在某操作 > 返回：bool 参数类型含义$namestring插件名$controllerstring控制器$actionstring动作## plugin\_model\_exists > 含义：检查插件模型是否存在 > 返回：bool 参数类型含义$namestring插件名## plugin\_validate\_exists > 含义：检查插件验证器是否存在 > 返回：bool 参数类型含义$namestring插件名## get\_plugin\_validate > 含义：获取插件验证类实例 > 返回：object 参数类型含义$namestring插件名## get\_plugin\_model > 含义：获取插件模型实例 > 返回：object 参数类型含义$namestring插件名## get\_plugin\_class > 含义：获取插件类名 > 返回：string ## plugin\_url > 含义：生成插件操作链接 > 返回：string 参数类型含义$urlstring链接：插件名称/控制器/操作$paramarray参数$modulestringadmin需要登录验证，index不需要登录验证## public\_url > 含义：生成插件操作链接(不需要登陆验证) > 返回：string 参数类型含义$urlstring链接：插件名称/控制器/操作$paramarray参数## get\_client\_ip > 含义：获取客户端IP地址 > 返回：mixed 参数类型含义$typeint返回类型 0 返回IP地址 1 返回IPV4地址数字$advbool是否进行高级模式获取## format\_bytes > 含义：格式化字节大小 > 返回：string 参数类型含义$sizeint字节数$delimiterstring数字和单位分隔符## format\_time > 含义：时间戳格式化 > 返回：string 参数类型含义$timeint时间戳$formatstring输出格式，默认为Y-m-d H:i## format\_linkage > 含义：格式化联动数据，array('a', 'b')将格式化为array(array('key' => 0, 'value' => 'a'), array('key' => 1, 'value' => 'b')) > 返回：string 参数类型含义$dataarray要格式化的数据## get\_auth\_node > 含义：获取用户的数据授权节点 > 返回：array|bool 参数类型含义$uidint用户id$groupstring权限分组，可以以点分开模型名称和分组名称，如user.group## check\_auth\_node > 含义：检查用户的某个节点是否授权 > 返回：bool 参数类型含义$uidint用户id$groupstring权限分组，可以以点分开模型名称和分组名称，如user.group$nodeint需要检查的节点id## get\_nickname > 含义：获取用户昵称 > 返回：string 参数类型含义$uidint用户id## action\_log > 含义：记录行为日志，并执行该行为的规则 > 返回：bool|string 参数类型含义$actionstring行为标识$modelstring触发行为的模型名$record\_idint触发行为的记录id$user\_idint执行行为的用户id$detailsstring详情## get\_location > 含义：获取当前位置 > 返回：array ## packet\_exists > 含义：查询数据包是否存在，即是否已经安装 > 返回：array 参数类型含义$namestring数据包名## load\_assets > 含义：返回静态资源路径代码，可用于模板 > 返回：string 参数类型含义$assetsstring资源名称$typestring资源类型：css或js## parse\_name > 含义：字符串命名风格转换 > 返回：string 参数类型含义$namestring字符串$typestring转换类型，0 将Java风格转换为C的风格 1 将C风格转换为Java的风格## index\_url > 含义：生成前台入口url > 返回：string 用法和ThinkPHP自带的url方法一致，参数也一致。 > 注意：1.0.5以后，请使用home\_url()代替index\_url() ## admin\_url > 含义：生成后台入口url > 返回：string 用法和ThinkPHP自带的url方法一致，参数也一致。 ## htmlpurifier > 含义：html安全过滤 > 返回：string 参数类型含义$htmlstring要过滤的内容