# 友情链接

**Repository Path**: xbcode-plugin/xbLinks

## Basic Information

- **Project Name**: 友情链接
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-13
- **Last Updated**: 2026-04-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 插件简介

**xbLinks** 是一个用于管理“友情链接”的插件。

你可以把它理解成：

- **在后台维护友情链接列表**
- **控制哪些链接显示、哪些隐藏**
- **设置链接名称、网址、图标和打开方式**
- **按排序规则决定前台展示顺序**

适合用于：

- 企业官网
- 产品官网
- 导航站
- 合作伙伴展示页
- 需要展示推荐网站或关联站点的页面

## 这个插件能做什么

安装后，你可以在后台完成这些操作：

- **添加友情链接**：录入站点名称和链接地址
- **修改友情链接**：随时更新名称、地址、图标等信息
- **删除友情链接**：移除不再需要展示的链接
- **启用 / 停用**：控制某条链接是否对前台生效
- **设置打开方式**：新窗口打开，或当前窗口打开
- **排序管理**：让重要链接排在前面

## 适合谁使用

这份文档尽量按普通人的阅读习惯来写，适合：

- **网站管理员**：负责维护网站内容
- **运营人员**：需要经常调整友情链接展示
- **产品或项目负责人**：想知道插件大概怎么用
- **开发人员**：快速了解插件结构和接入方式

## 安装方式

本插件使用项目的**标准插件安装流程**。

如果你的系统已经接入插件市场或插件安装能力，一般只需要：

1. 在后台找到插件管理
2. 找到 **友情链接 / xbLinks**
3. 点击安装
4. 安装完成后刷新后台菜单

安装时插件会创建一张数据表：

- **`xb_links`**：用于保存友情链接数据

该表主要保存以下信息：

- 站点名称
- 链接地址
- 站点图标
- 排序
- 状态
- 打开方式
- 创建时间 / 更新时间

## 后台入口

安装完成后，后台菜单中会出现：

- **通用管理 -> 友情链接**

进入后，你会看到友情链接列表页，可以直接进行新增、修改、删除和状态切换。

## 如何新增一个友情链接

进入 **通用管理 -> 友情链接** 后：

1. 点击 **添加链接**
2. 填写表单内容
3. 保存后即可出现在友情链接列表中

你通常需要填写以下字段：

### 1. 站点名称

就是前台展示给用户看的名称。

示例：

- 积木云
- 示例官网
- 合作伙伴平台

### 2. 链接地址

填写完整网址，必须是标准 URL。

正确示例：

- `https://example.com`
- `https://www.example.com/docs`

注意：

- **必须带 `http://` 或 `https://`**
- 如果地址格式不正确，系统会提示错误

### 3. 状态

用于控制该链接是否启用：

- **开启**：允许前台展示
- **关闭**：保留数据，但前台不展示

如果你只是暂时不想显示某个链接，建议直接关闭状态，不必删除。

### 4. 打开方式

支持两种方式：

- **新窗口打开**：点击后在新标签页打开
- **当前窗口打开**：点击后直接跳转当前页面

大多数情况下，友情链接更适合使用 **新窗口打开**。

### 5. 站点图标

这是可选项。

建议上传对方网站的 Logo 或图标，便于前台展示时更直观。

建议：

- 图片尽量清晰
- 建议接近正方形
- 后台说明里推荐尺寸为 **300 × 300 像素**

如果不上传图标，通常也不会影响基本使用，只是前台可能只显示文字。

### 6. 排序

排序值通常用于控制显示先后。

一般规则可以理解为：

- **数值越小，越靠前**
- 数值越大，越靠后

如果你希望某个友情链接排在最前面，可以把它的排序设置得更小一些。

## 列表页能做什么

在友情链接列表页中，你可以直接完成以下操作：

- **查看全部友情链接**
- **修改某条友情链接**
- **删除友情链接**
- **快速修改排序**
- **快速切换状态**

也就是说，日常维护基本都可以在列表页直接完成，不需要反复进入复杂页面。

## 前台会如何展示

这个插件本身主要负责**管理友情链接数据**。

根据当前代码逻辑：

- 前台通常会读取**已启用**的友情链接
- 前台展示顺序会参考**排序字段**
- 如果有图标，前台可以同时显示**图标 + 文字**
- 如果没有图标，也可以只显示文字链接

简单理解：

- **后台负责维护数据**
- **前台负责把启用的数据展示出来**

## 常见使用建议

### 建议 1：链接地址一定要完整

不要只填写：

- `example.com`

建议填写：

- `https://example.com`

否则可能无法通过系统校验。

### 建议 2：不要随便删除，优先停用

如果只是阶段性不展示某个友情链接，建议：

- 先把状态改成**关闭**

这样以后还可以再次启用，不需要重新录入。

### 建议 3：统一图标风格

如果友情链接较多，建议图标风格尽量统一，例如：

- 都使用方形 Logo
- 都使用透明背景 PNG
- 尺寸尽量一致

这样前台会更整齐。

### 建议 4：排序预留间隔

不要把排序值都写成连续数字，例如 1、2、3、4。

更推荐：

- 10
- 20
- 30
- 40

这样后面临时插入新链接时更方便调整。

## 常见问题

### 安装后在哪里找？

安装成功后，一般在：

- **通用管理 -> 友情链接**

### 为什么新增后前台没显示？

可以优先检查这几项：

- 该链接是否已设置为**开启**
- 链接是否被前台页面正确读取
- 排序是否正常
- 前台模板是否已经接入友情链接展示逻辑

### 链接地址为什么保存失败？

常见原因是地址格式不正确。

请确认：

- 是否填写了完整 URL
- 是否包含 `http://` 或 `https://`

### 图标不上传可以吗？

可以。

图标是可选字段，不影响链接本身的保存与使用。

## 给开发者的简短说明

如果你是开发人员，下面这些信息会比较有用：

- **数据表**：`xb_links`
- **后台控制器**：`app/admin/controller/LinksController.php`
- **核心接口层**：`api/LinksApi.php`
- **数据验证器**：`app/validate/LinksValidate.php`
- **菜单配置**：`config/menu.php`
- **安装入口**：`api/Install.php`

当前插件的核心字段包括：

- `name`：站点名称
- `url`：链接地址
- `icon`：站点图标
- `sort`：排序
- `status`：状态，`10` 为关闭，`20` 为开启
- `target`：打开方式，支持 `_blank` 和 `_self`

插件内部已经提供友情链接数据读取与缓存能力，适合前台直接按“启用状态”读取后进行展示。

## 总结

如果你只想快速理解这个插件，可以记住一句话：

**xbLinks 就是一个专门用来在后台维护友情链接，并把启用链接提供给前台展示的插件。**

它的使用方式很简单：

- 安装插件
- 进入后台友情链接管理
- 添加站点名称和网址
- 按需设置图标、状态、打开方式和排序
- 让前台展示启用的数据