详解WordPress中简码格式标签编写的基本方法


Posted in PHP onDecember 22, 2015

WordPress 简码是一种类似于论坛标签的东西,格式类似于把尖括号换成中括号的 Html 标签。简码很多人叫做短代码,但官方的翻译应该是简码,在这里纠正一下。

简码的开发的逻辑比较简单,主要就是添加、删除和判断,会在本文全部介绍。

简码格式

简码的格式非常灵活,可以是有属性、无属性、闭合、非闭合等等:

[example]

[example]内容[/example]

[example attr="属性" attr-hide="1"]内容[/example]

[example "属性"]

添加简码

添加简码需要使用 add_shortcode() 函数,两个属性,第一个为简码名,第二个是简码的回调函数。

add_shortcode( $tag, $func );

例如添加名为 test 的简码,回调 Bing_shortcode_test() 函数:

function Bing_shortcode_test( $attr, $content ){
  return 'Hello World!';
}
add_shortcode( 'test', 'Bing_shortcode_test' );

在文章中添加 [test] 就会输出 “Hello World!”。

从上边的例子可以看到,简码的回调函数需要接收两个参数。第一个是简码所有的属性,通过数组储存;第二个是简码的内容(闭合简码中的内容)。

移除简码

remove_shortcode() 函数可以移除一个简码,只需要指定简码的名称即可移除。

remove_shortcode( 'test' );

remove_all_shortcodes() 函数用来移除当前添加的所有简码。

remove_all_shortcodes();

判断简码

关于判断简码,有两个函数,shortcode_exists() 函数判断简码是否存在。

remove_all_shortcodes();
if( shortcode_exists( 'test' ) ) echo '简码 test 存在';//False
add_shortcode( 'test', 'Bing_shortcode_test' );
if( shortcode_exists( 'test' ) ) echo '简码 test 存在';//True

还有一个 has_shortcode() 函数,判断字符串中是否出现某某简码。

$content = '测试测试测试测试测试测试测试测试';
if( has_shortcode( $content, 'test' ) ) echo '字符串中有 test 简码';//False
$content = '测试测试测试测[test]测试[/test]试测试测试测试测试';
if( has_shortcode( $content, 'test' ) ) echo '字符串中有 test 简码';//True

执行简码

do_shortcode() 函数用来在字符串中查找简码,并在简码处调用之前添加的回调函数,把简码执行成需要的内容。

WordPress 添加的钩子:

add_filter( 'the_content', 'do_shortcode', 11 );

例子:

function Bing_shortcode_test( $attr, $content ){
  return 'Hello World!';
}
add_shortcode( 'test', 'Bing_shortcode_test' );
$content = '测试测试测试测[test]试测试测试测试测试';
echo do_shortcode( $content );//测试测试测试测Hello World!试测试测试测试测试

简码属性

简码支持各种格式的属性,接受给简码回调函数的第一个参数。如果你要给参数设置默认值,可以使用 shortcode_atts() 函数:

function Bing_shortcode_test( $attr, $content ){
  extract( shortcode_atts( array(
    'url' => 'http://www.bgbk.org',
    'hide' => false,
    'text' => '点击隐藏 / 显示'
  ), $attr ) );
  $hide = $hide ? ' style="display:none;"' : '';
  return '<a href="' . $url . '"' . $hide . '>' . $text . '</a>';
}
add_shortcode( 'test', 'Bing_shortcode_test' );

只有页面中使用了简码的时候才加载脚本
而在开发的过程中,有时会遇到这种问题:简码模块需要加载 JS 或者 CSS 脚本,而当页面没有使用简码的时候就会造成资源浪费。

比如下边的这个 Google 地图插件:

//添加简码
function Bing_add_google_map( $atts, $content ){
  //content...
}
add_shortcode( 'google_map', 'Bing_add_google_map');
 
//挂载脚本
function Bing_add_javascript(){
  wp_enqueue_script( 'map_scripts' );
}
add_action( 'wp_enqueue_scripts', 'Bing_add_javascript' );

只有在页面中使用了 [google_map] 简码的时候才需要加载脚本,这怎么做到呢?

其实很简单,只需要在简码函数触发的时候在页脚挂载脚本即可。

//添加简码
function Bing_add_google_map( $atts, $content ){
  $GLOBALS['google_map_shortcode'] = true;
  return '地图的代码';
}
add_shortcode( 'google_map', 'Bing_add_google_map');
 
//挂载脚本
function Bing_add_javascript(){
  global $google_map_shortcode;
  if( isset( $google_map_shortcode ) && $google_map_shortcode ) wp_enqueue_script( 'map_scripts' );
}
add_action( 'wp_footer', 'Bing_add_javascript' );

总结

简码是个非常强大的功能,对文章内容是一种很好的扩展,利用好可以让添加某些东西变的方便快捷。

关于简码的函数都在:wp-includes/shortcode.php 文件里,有能力的朋友可以阅读一下,了解原理。

PHP 相关文章推荐
php session和cookie使用说明
Apr 07 PHP
PHP开发环境配置(MySQL数据库安装图文教程)
Apr 28 PHP
PHP 强制性文件下载功能的函数代码(任意文件格式)
May 26 PHP
PHP面向接口编程 耦合设计模式 简单范例
Mar 23 PHP
php除数取整示例
Apr 24 PHP
PHP实现图片压缩的两则实例
Jul 19 PHP
php实现根据字符串生成对应数组的方法
Sep 22 PHP
PHP图片处理之图片旋转和图片翻转实例
Nov 19 PHP
thinkphp的URL路由规则与配置实例
Nov 26 PHP
CakePHP框架Model函数定义方法示例
Aug 04 PHP
thinkphp5.1 文件引入路径问题及注意事项
Jun 13 PHP
什么是PHP7中的孤儿进程与僵尸进程
Apr 14 PHP
WordPress中转义HTML与过滤链接的相关PHP函数使用解析
Dec 22 #PHP
WordPres对前端页面调试时的两个PHP函数使用小技巧
Dec 22 #PHP
WordPress主题中添加文章列表页页码导航的PHP代码实例
Dec 22 #PHP
解析WordPress中函数钩子hook的作用及基本用法
Dec 22 #PHP
WordPress中使主题支持小工具以及添加插件启用函数
Dec 22 #PHP
配置eAccelerator和XCache扩展来加速PHP程序的执行
Dec 22 #PHP
PHP使用mkdir创建多级目录的方法
Dec 22 #PHP
You might like
全国FM电台频率大全 - 1 北京市
2020/03/11 无线电
PHP 面向对象 PHP5 中的常量
2010/05/05 PHP
PHP为表单获取的URL 地址预设 http 字符串函数代码
2010/05/26 PHP
PHP使用array_fill定义多维数组的方法
2015/03/18 PHP
超强多功能php绿色集成环境详解
2017/01/25 PHP
js setattribute批量设置css样式
2009/11/26 Javascript
jquery鼠标滑过提示title具体实现代码
2013/08/06 Javascript
jQuery实现菜单式图片滑动切换
2015/03/14 Javascript
jQuery实现表格行上移下移和置顶的方法
2015/05/22 Javascript
Ionic快速安装教程
2016/06/03 Javascript
浅谈jquery上下滑动的注意事项
2016/10/13 Javascript
jQuery实现表格与ckeckbox的全选与单选功能
2016/11/24 Javascript
源码分析Vue.js的监听实现教程
2017/04/23 Javascript
angular.js指令中transclude选项及ng-transclude指令详解
2017/05/24 Javascript
JavaScript中Hoisting详解 (变量提升与函数声明提升)
2017/08/18 Javascript
详解Axios统一错误处理与后置
2018/09/26 Javascript
优化Vue中date format的性能详解
2020/01/13 Javascript
[07:49]2014DOTA2国际邀请赛 Newbee夺冠后采访xiao8坦言奖金会上交
2014/07/23 DOTA
Python 3.6 性能测试框架Locust安装及使用方法(详解)
2017/10/11 Python
Python字典的核心底层原理讲解
2019/01/24 Python
python实现websocket的客户端压力测试
2019/06/25 Python
修改 CentOS 6.x 上默认Python的方法
2019/09/06 Python
使用keras2.0 将Merge层改为函数式
2020/05/23 Python
python json.dumps() json.dump()的区别详解
2020/07/14 Python
Python如何执行系统命令
2020/09/23 Python
幼儿园义卖活动方案
2014/01/17 职场文书
副总经理岗位职责
2014/03/16 职场文书
技术合作协议书范本
2014/04/18 职场文书
银行授权委托书样本
2014/10/13 职场文书
先进工作者事迹材料
2014/12/23 职场文书
2015年助理工程师工作总结
2015/04/03 职场文书
通知的写法
2015/04/23 职场文书
安全教育培训制度
2015/08/06 职场文书
投资入股协议书
2016/03/22 职场文书
python使用PySimpleGUI设置进度条及控件使用
2021/06/10 Python
HTML5基础学习之文本标签控制
2022/03/25 HTML / CSS