前言
各位朋友们好,我是字节曜的编辑寒烟似雪,今天为各位朋友们带来的是一个typecho插件
用Typecho写博客的朋友大概都有过这样的困扰:默认的文章字段只有标题、内容、分类、标签这些基础项,想给文章加个“来源链接”“作者简介”“封面图说明”这类个性化信息时,要么只能塞到内容里,要么就得改主题代码,麻烦又不灵活。今天就给大家安利一款解决这个痛点的神器——CustomFields 自定义字段插件,无需复杂开发,就能轻松为文章添加各类自定义字段,让你的内容管理效率翻倍!
一、插件简介:CustomFields 能帮我们做什么?
CustomFields 是由开发者马春杰开发的一款开源 Typecho 插件,核心功能就是为文章(或页面)添加自定义字段。比如你是摄影博主,想给每篇作品添加“拍摄设备”“拍摄地点”“后期软件”等信息;又或者你是资源分享博主,需要给文章加“资源链接”“提取码”“有效期”等字段,这些需求都能通过它轻松实现。
这款插件的优势在于配置简单(只需JSON格式定义字段)、兼容性强(支持各类Typecho主题)、更新方便(支持Git拉取更新),无论是新手还是有一定技术基础的用户,都能快速上手。
二、安装步骤:两种方式任选,新手也能搞定
CustomFields 提供了手动安装和SSH安装两种方式,大家可以根据自己的服务器操作习惯选择,两种方式都很简单,下面一步步给大家讲清楚。
方式1:手动安装(适合新手,无技术门槛)
这种方式不需要任何命令操作,跟着步骤点鼠标就行:
- 下载插件:访问 CustomFields 的 GitHub 仓库(地址:https://github.com/ma3252788/CustomFields),点击“Code”按钮,选择“Download ZIP”下载插件压缩包;
- 解压重命名:将下载的压缩包解压,得到一个以“CustomFields-main”或类似名称命名的文件夹,务必将其重命名为“CustomFields”(注意首字母大写,名称错误会导致插件无法识别);
- 上传插件:通过FTP工具或服务器文件管理器,将重命名后的“CustomFields”文件夹上传到你的 Typecho 站点根目录下的“usr/plugins/”目录中,最终路径应为“usr/plugins/CustomFields/”;
- 启用插件:登录 Typecho 后台,进入“控制台 → 插件”页面,在插件列表中找到“CustomFields”,点击下方的“启用”按钮;
- 初始配置:启用后,插件会显示“配置字段”按钮,点击进入配置页面,这一步我们后面详细讲。
方式2:SSH安装(推荐,方便后续更新)
如果你熟悉SSH命令操作,建议用这种方式,后续插件更新只需一行命令就能搞定,非常省心:
- 登录服务器:通过SSH工具(如Xshell、Putty)登录你的服务器;
- 进入插件目录:执行命令切换到 Typecho 的插件目录,命令如下(请将路径替换为你的站点实际路径):
cd /你的站点根目录/usr/plugins/ - 克隆插件仓库:执行Git克隆命令,将插件仓库下载到本地:
git clone https://github.com/ma3252788/CustomFields.git - 启用插件:后续步骤和手动安装一致,登录Typecho后台启用插件即可。
三、核心配置:JSON定义字段,简单易懂
CustomFields 的核心配置就是通过JSON格式定义自定义字段,很多朋友看到“JSON”可能会觉得复杂,但其实只要跟着示例写,完全不用懂代码也能配置。
配置入口
插件启用后,在“插件”页面找到“CustomFields”,点击其右侧的“配置字段”按钮,进入配置页面(页面中会有一个文本输入框,用于填写JSON配置)。
配置示例(必看)
下面给大家一个最常用的配置示例,比如我们要给文章添加“来源链接”“提取码”“作者备注”三个字段,JSON配置如下:
[{"name":"sourceUrl","label":"来源链接","description":"填写文章或资源的原始来源地址"},{"name":"extractCode","label":"提取码","description":"资源下载所需的提取码,无则留空"},{"name":"authorNote","label":"作者备注","description":"仅作者可见的补充说明信息"}]配置参数说明(逐个拆解)
每个字段都是一个JSON对象,包含3个核心参数,新手记好这几个参数就行:
- name:字段标识(必填,不能重复),用于后台存储和主题调用,建议用英文+驼峰命名(比如sourceUrl、extractCode),不要用中文或特殊符号;
- label:字段显示名称(必填),会在文章编辑页显示的字段标题(比如“来源链接”“提取码”),可以用中文;
- description:字段描述(可选),用于提示该字段的用途(比如“填写资源的原始来源地址”),帮助自己或其他编辑者理解字段含义。
配置完成后,点击“保存设置”按钮,自定义字段就配置好了!
四、使用说明:编辑页填字段,主题中调用
配置好字段后,就可以在文章编辑页使用了,后续在主题中调用这些字段也很简单。
步骤1:在文章编辑页填写字段
登录Typecho后台,进入“撰写文章”或“编辑文章”页面,在页面下方(或右侧,根据主题布局不同)会看到我们配置的自定义字段(比如“来源链接”“提取码”),直接在对应输入框中填写内容,和填写标题、内容一样简单,保存文章后,字段内容会一同存储。
步骤2:在主题中调用字段(关键步骤)
填写好的自定义字段内容,需要在主题模板中添加调用代码,才能在前台显示出来。调用代码非常简单,以默认主题为例,在文章详情页模板(post.php)中需要显示字段的位置,添加以下代码(以调用“来源链接”字段为例):
<?php if($this->fields->sourceUrl): ?>
<p>来源链接:<a href="<?php $this->fields->sourceUrl(); ?>" target="_blank"><?php $this->fields->sourceUrl(); ?></a></p>
<?php endif; ?>说明:将代码中的“sourceUrl”替换为你定义的字段标识(比如extractCode、authorNote),就能调用对应字段的内容。如果想让字段内容不显示为空,建议加上if($this->fields->字段标识)的判断。
五、插件更新:SSH方式一键更新,超方便
如果用SSH方式安装的插件,后续作者更新插件时,无需重新下载上传,只需两步就能完成更新:
- 通过SSH登录服务器,进入CustomFields插件目录:
cd /你的站点根目录/usr/plugins/CustomFields - 执行Git拉取更新命令:
git pull origin master
等待命令执行完成,插件就更新到最新版本了,是不是比手动下载上传省心多了?
六、实用资源:这些链接帮你少走弯路
最后给大家整理几个常用的资源链接,遇到问题或想了解更多细节时可以参考:
- 插件GitHub仓库:https://github.com/ma3252788/CustomFields(获取最新版本、提交问题);
- 插件作者主页:https://www.machunjie.com/opensource/1792.html(查看作者的详细介绍和使用说明);
- Gitee仓库(备用):https://gitee.com/public_sharing/CustomFields(GitHub访问慢时可选择这个)。
七、总结
CustomFields 绝对是 Typecho 用户提升内容管理灵活性的必备插件,无论是个人博客还是小型内容站点,只要有自定义字段的需求,它都能完美胜任。配置简单、使用方便、更新便捷,关键还是开源免费,新手也能快速上手。
如果你之前也被Typecho默认字段的局限性困扰,不妨赶紧试试这款插件,相信它能给你带来不一样的内容管理体验。如果在使用过程中遇到问题,欢迎在评论区交流,我们一起探讨解决!