RiPro-V5 主题短代码完整使用手册（含 Gutenberg 与经典编辑器说明）

目录

1. 简介
2. 编辑器中的短代码插入方式
   　2.1 古腾堡编辑器（Gutenberg）
   　2.2 经典编辑器（Classic Editor）
3. 短代码列表
   　3.1 [rihide] — 付费可见内容
   　3.2 [ri-reply-hide] — 评论后可见内容
   　3.3 [ri-login-hide] — 登录后可见内容
   　3.4 [ri-video] — 视频播放器
   　3.5 [ri-buttons] — 自定义按钮
   　3.6 [ri-alerts] — 提示框（Alerts）
   　3.7 [ri-accordions] — 折叠内容（Accordion）
4. 技术说明（模板加载机制）
5. 常见问题（FAQ）
6. 总结

1. 简介

本文档汇总了 Ripro 主题中由 Codestar Framework（CSF）创建的所有短代码组件，包括付费内容、评论可见、视频播放器、提示框、折叠内容、按钮组件等。

本文将详细介绍每个短代码的功能、使用方法、参数列表以及示例展示方式。

2. 编辑器中的短代码插入方式

2.1 古腾堡（Gutenberg）编辑器

主题代码中包含：

'gutenberg'      => array(
    'title'       => '添加隐藏内容',
    'description' => '添加隐藏内容',
    'icon'        => 'screenoptions',
    'category'    => 'widgets',
    'keywords'    => array('shortcode', 'ripro', 'insert', 'hide'),
    'placeholder' => '在此处编写简码...',
),

这代表：

✔ Gutenberg 中会出现一个可选择的“短代码区块”

用户可在区块面板中搜索：

• ripro
• shortcode
• hide

来找到对应短代码。

✔ 点击区块后，会弹出 CSF 的字段，直接填写即可插入短代码

例如填写 [rihide] 的内容即可自动插入。

2.2 经典编辑器

主题代码也注册了：

'show_in_editor' => true,

这表示：

✔ 在经典编辑器（TinyMCE）工具栏会上出现一个按钮

按钮名称：

• 添加付费隐藏内容
• 添加内容组件

点击后会出现短代码选择器，选择一个组件 → 自动插入短代码格式到编辑器中。

3. 短代码列表

3.1 [rihide] — 付费可见内容

功能描述

将部分内容隐藏，用户需要：

• 付费
• 或具有下载权限

才能查看。

使用方式

古腾堡：添加区块 → 搜索“隐藏内容”
经典编辑器：点击“添加付费隐藏内容”

参数

无额外参数，仅包裹内容。

示例

[rihide]
这里是付费可见内容
[/rihide]

3.2 [ri-reply-hide] — 评论后可见内容

描述

用户必须在本文章下评论一次，才可查看。

示例

[ri-reply-hide]
评论后才会显示的隐藏内容
[/ri-reply-hide]

3.3 [ri-login-hide] — 登录后可见内容

描述

游客无法查看，必须登录。

示例

[ri-login-hide]
会员专属内容，登录后可见
[/ri-login-hide]

3.4 [ri-video] — 视频播放器

参数说明

示例

[ri-video url="https://domain.com/video.mp4" pic="https://domain.com/cover.jpg"]

3.5 [ri-buttons] — 自定义按钮

参数列表

示例

[ri-buttons color="success" href="https://ripro.site"]
点击进入
[/ri-buttons]

3.6 [ri-alerts] — 提示框（Alerts）

参数

示例

[ri-alerts color="danger"]
这是一个红色警告提示！
[/ri-alerts]

3.7 [ri-accordions] — 折叠内容（Accordion）

此短代码是 Repeater 类型，可插入多个折叠项。

参数

每一项包含：

• title
• content（支持 HTML）

示例

[ri-accordions]
[ri-accordions_item title="标题一"]内容一[/ri-accordions_item]
[ri-accordions_item title="标题二"]内容二[/ri-accordions_item]
[/ri-accordions]

（最终插入由 CSF 自动生成）

4. 技术说明（模板加载机制）

所有短代码都采用：

ob_start();
get_template_part('template-parts/shortcode/xxxx', '', array(数据));
$html = ob_get_clean();

这意味着：

• 前端真正的 HTML 是通过模板文件渲染
• 开发者可编辑：
  /template-parts/shortcode/*
  来修改显示样式

这是最优雅、最可维护的方式。

5. 常见问题（FAQ）

❓ 1. 插入按钮为什么不出现？

必须启用：

• CSF
• 主题支持编辑器按钮
• 后台已开启短代码组件

❓ 2. Gutenberg 里找不到区块？

搜索关键词：
shortcode / ripro / hide / 按钮 / 提示框

❓ 3. 为什么短代码不生效？

检查：

• 是否启用了 Ripro 主题
• 是否启用 CSF
• 是否在文章中而非页面模板使用
• 付费类短代码必须开启商城功能（is_site_shop()）

6. 总结

本文档系统介绍了 Ripro 中所有短代码的：

• 功能
• 插入方式（Gutenberg + 经典编辑器）
• 参数说明
• 使用示例
• 技术渲染原理