在WordPress中,add_shortcode()
函数用于注册一个新的短代码,这样你就可以在文章、页面或小工具中使用这个短代码来插入特定的内容或功能。以下是如何使用 add_shortcode()
函数的步骤:
-
确定短代码名称和回调函数:首先,你需要决定你的短代码将被称作什么(例如
[my_shortcode]
),以及当这个短代码被调用时应该执行哪个函数。 -
创建回调函数:这个函数将处理短代码,并返回你希望在页面上显示的内容。
-
使用
add_shortcode()
注册短代码:将短代码名称和回调函数名称传递给add_shortcode()
函数。
下面是一个简单的例子:
// 步骤 2: 创建回调函数
function my_shortcode_function($atts = [], $content = null, $tag = '') {
// 解析短代码属性
$atts = shortcode_atts(
array(
'title' => '默认标题', // 默认值
),
$atts,
$tag
);
// 返回你希望在页面上显示的内容
return '<h2>' . esc_html__($atts['title'], 'textdomain') . '</h2>' . wpautop($content);
}
// 步骤 3: 使用 add_shortcode() 注册短代码
add_shortcode('my_shortcode', 'my_shortcode_function');
在这个例子中,my_shortcode_function
是回调函数,它接收三个参数:
$atts
:一个包含短代码属性的关联数组。$content
:短代码之间的内容(如果有)。$tag
:短代码的标签名称。
shortcode_atts()
函数用于设置默认属性和覆盖它们(如果用户在短代码中提供了属性)。
esc_html__()
函数用于确保标题是安全的,可以安全地输出到HTML中。
wpautop()
函数用于将段落和换行符转换为适当的HTML标签。
要使用这个短代码,你可以在WordPress的文章或页面编辑器中添加以下内容:
[my_shortcode title="我的自定义标题"]
这是短代码的内容。
[/my_shortcode]
当你查看页面时,它将显示为:
<h2>我的自定义标题</h2>
<p>这是短代码的内容。</p>
确保将上述代码添加到你的主题的 functions.php
文件中,或者在一个专门的插件中。如果你正在使用一个插件,请确保在插件中使用 plugins_loaded
动作钩子来注册短代码。