如何在使用WordPress模板部件时获取$args参数提示？

可以实现，通过PHPDoc注释定义$args的参数规范，配合VSCode的PHP Intelephense插件就能在调用get_template_part()时获得参数提示，下面是两种可行方案：

方案一：直接在模板部件文件中添加PHPDoc注释 #

在你的按钮模板部件文件（比如template-parts/button.php）顶部，用PHPDoc注释明确$args的结构、必填项、默认值：

<?php
/**
 * 按钮模板部件
 *
 * @param array $args {
 *     按钮配置参数数组
 *
 *     @type string $text          按钮文字（必填）
 *     @type string $url           按钮链接地址（必填）
 *     @type string $class         额外CSS类名，默认空字符串
 *     @type string $target        链接打开方式，默认'_self'
 *     @type bool   $is_primary    是否启用主样式按钮，默认false
 * }
 */

// 合并默认参数
$args = wp_parse_args($args, [
    'class' => '',
    'target' => '_self',
    'is_primary' => false,
]);

// 校验必填参数
if (empty($args['text']) || empty($args['url'])) {
    return;
}
?>

<a href="<?php echo esc_url($args['url']); ?>"
   target="<?php echo esc_attr($args['target']); ?>"
   class="button <?php echo esc_attr($args['class']); ?> <?php echo $args['is_primary'] ? 'button-primary' : ''; ?>">
    <?php echo esc_html($args['text']); ?>
</a>

设置完成后，当你在主题文件中调用get_template_part()传入$args时，VSCode的Intelephense插件会读取模板部件的注释，自动弹出参数提示。

方案二：封装自定义调用函数（更稳定的提示体验） #

如果直接识别模板部件注释的提示不够灵敏，可以在主题的functions.php中封装一个专门调用按钮模板的函数，通过函数的PHPDoc注释来提供更可靠的提示：

<?php
/**
 * 渲染按钮模板部件
 *
 * @param array $args {
 *     按钮配置参数数组
 *
 *     @type string $text          按钮文字（必填）
 *     @type string $url           按钮链接地址（必填）
 *     @type string $class         额外CSS类名，默认空字符串
 *     @type string $target        链接打开方式，默认'_self'
 *     @type bool   $is_primary    是否启用主样式按钮，默认false
 * }
 */
function render_button($args) {
    get_template_part('template-parts/button', null, $args);
}

之后调用时直接使用render_button([])，VSCode会立即识别函数的注释，给出清晰的参数提示，体验比直接调用get_template_part()更流畅。

注意事项 #

• 确保VSCode已安装PHP Intelephense插件，这是识别PHPDoc注释并生成提示的核心工具；
• 模板部件中wp_parse_args()的默认参数要和PHPDoc注释里的默认值保持一致，避免出现逻辑冲突。

内容的提问来源于stack exchange，提问作者Sabshane