详解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制作图型计数器的例子
Oct 09 PHP
Windows IIS PHP 5.2 安装与配置方法
Jun 08 PHP
PHP版 汉字转码的实现详解
Jun 09 PHP
php+mysqli实现将数据库中一张表信息打印到表格里的方法
Jan 28 PHP
php中json_encode不兼容JSON_UNESCAPED_UNICODE的解决方案
May 31 PHP
thinkPHP分组后模板无法加载问题解决方法
Jul 12 PHP
thinkPHP基于ajax实现的菜单与分页示例
Jul 12 PHP
PHP使用SWOOLE扩展实现定时同步 MySQL 数据
Apr 09 PHP
[原创]PHP实现生成vcf vcard文件功能类定义与使用方法详解【附demo源码下载】
Sep 02 PHP
PHP自定义函数实现assign()数组分配到模板及extract()变量分配到模板功能示例
May 23 PHP
Laravel框架模板继承操作示例
Jun 11 PHP
PHP实现创建一个RPC服务操作示例
Feb 23 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
如何在PHP程序中防止盗链
2008/04/09 PHP
linux环境apache多端口配置虚拟主机的方法深入介绍
2013/06/09 PHP
WebQQ最新登陆协议的用法
2014/12/22 PHP
Javascript实例教程(19) 使用HoTMetal(1)
2006/12/23 Javascript
文本框输入时 实现自动提示(像百度、google一样)
2012/04/05 Javascript
javascript闭包的高级使用方法实例
2013/07/04 Javascript
Javascript中数组sort和reverse用法分析
2014/12/30 Javascript
JavaScript操作select元素和option的实例代码
2016/01/29 Javascript
第十章之巨幕页头缩略图与警告框组件
2016/04/25 Javascript
bootstrap实现每隔5秒自动轮播效果
2016/12/20 Javascript
Vue 实用分页paging实例代码
2017/04/12 Javascript
深入解析nodejs HTTP服务
2017/07/25 NodeJs
js实现图片粘贴上传到服务器并展示的实例
2017/11/08 Javascript
jQuery实现的上传图片本地预览效果简单示例
2018/03/29 jQuery
基于Vue实现拖拽效果
2018/04/27 Javascript
Node批量爬取头条视频并保存方法
2018/09/20 Javascript
Python判断直线和矩形是否相交的方法
2015/07/14 Python
解决Python 爬虫URL中存在中文或特殊符号无法请求的问题
2018/05/11 Python
PHP实现发送和接收JSON请求
2018/06/07 Python
python超时重新请求解决方案
2019/10/21 Python
Flask之pipenv虚拟环境的实现
2019/11/26 Python
Python实现一个简单的毕业生信息管理系统的示例代码
2020/06/08 Python
浅谈keras中自定义二分类任务评价指标metrics的方法以及代码
2020/06/11 Python
python 常见的排序算法实现汇总
2020/08/21 Python
详解Selenium-webdriver绕开反爬虫机制的4种方法
2020/10/28 Python
css3实现波纹特效、H5实现动态波浪效果
2018/01/31 HTML / CSS
越南电子产品购物网站:FPT Shop
2017/12/02 全球购物
台湾最大银发乐活百货:乐龄网
2018/05/21 全球购物
怎样建立和理解非常复杂的声明?例如定义一个包含N 个指向返回 指向字符的指针的函数的指针的数组?
2013/03/19 面试题
生物技术研究生自荐信
2013/11/12 职场文书
播音主持女孩的自我评价分享
2013/11/20 职场文书
化工专业个人的求职信范文
2013/11/28 职场文书
采购内勤岗位职责
2015/04/13 职场文书
国际贸易实训总结
2015/08/03 职场文书
Vue3如何理解ref toRef和toRefs的区别
2022/02/18 Vue.js
Python实现数据的序列化操作详解
2022/07/07 Python