在WordPress中,短代码是一种简化的标记,它允许用户在内容中插入特定的功能或内容,而不需要编写任何HTML或PHP代码。add_shortcode()
函数是WordPress内置的一个功能,用于注册短代码并定义其处理函数。
以下是如何使用 add_shortcode()
函数来创建和使用短代码的步骤:
步骤 1: 定义短代码处理函数
首先,你需要定义一个PHP函数,这个函数将负责处理短代码并返回相应的输出。
function my_shortcode_handler($atts, $content = null, $tag = '') {
// 解析短代码属性
$atts = shortcode_atts(
array(
'attribute1' => 'default_value1', // 默认值
'attribute2' => 'default_value2', // 默认值
),
$atts,
$tag
);
// 根据属性生成输出
$output = '<div>';
$output .= 'Attribute 1: ' . esc_html($atts['attribute1']) . '<br>';
$output .= 'Attribute 2: ' . esc_html($atts['attribute2']) . '<br>';
$output .= 'Content: ' . wp_kses_post($content);
$output .= '</div>';
// 返回输出
return $output;
}
步骤 2: 注册短代码
接下来,你需要使用 add_shortcode()
函数来注册你的短代码处理函数。这通常在主题的 functions.php
文件中完成。
add_shortcode('my_shortcode', 'my_shortcode_handler');
这里的 'my_shortcode'
是你希望使用的短代码名称,而 'my_shortcode_handler'
是你定义的处理函数。
步骤 3: 使用短代码
现在,短代码已经注册好了,你可以在WordPress的文章、页面或自定义文章类型的内容中使用它。
[my_shortcode attribute1="value1" attribute2="value2"]
This is the content inside the shortcode.
[/my_shortcode]
这将输出类似于以下内容:
<div>
Attribute 1: value1<br>
Attribute 2: value2<br>
Content: This is the content inside the shortcode.
</div>
完整示例
将以下代码添加到你的主题的 functions.php
文件中:
function my_shortcode_handler($atts, $content = null, $tag = '') {
$atts = shortcode_atts(
array(
'attribute1' => 'default_value1',
'attribute2' => 'default_value2',
),
$atts,
$tag
);
$output = '<div>';
$output .= 'Attribute 1: ' . esc_html($atts['attribute1']) . '<br>';
$output .= 'Attribute 2: ' . esc_html($atts['attribute2']) . '<br>';
$output .= 'Content: ' . wp_kses_post($content);
$output .= '</div>';
return $output;
}
add_shortcode('my_shortcode', 'my_shortcode_handler');
然后,你可以在编辑器中使用 [my_shortcode]
短代码,并根据需要传递属性和内容。