概述

欢迎来到 XYCMS 插件开发参考手册,在此我们将涵盖插件开发的各个方面,让你能够从零开始开发一个完整的插件。

XYCMS 插件是扩展 XYCMS 产品核心功能的代码包,XYCMS 插件由.NET代码和其他文件(如图片、CSS和JavaScript等)组成。

通过插件可以扩展 XYCMS,在 XYCMS 已经提供的功能基础上构建额外的功能。例如,编写一个插件来控制对应栏目的内容模型,采用自定义的字段提交并显示内容文章;或者,可以编写一个插件,创建一个带有短信通知、支持第三方支付的全功能票务系统。

一个插件必须有的文件是:一个主文件(插件Id.dll)以及一个插件配置文件(插件Id.nuspec)。

插件开发基于.NET环境,使用Visual Studio开发工具,同时需要在项目中引用 SiteServer.Plugin 开发包(SDK)。

插件开发参考手册是关于插件以及插件是如何与 XYCMS 交互的。它将帮助您理解插件的工作机制,以及如何创建并升级插件。

这本手册涵盖了各种主题 —— 从插件类需要实现的方法到插件安全的最佳实践,再到用于构建插件的工具。

为什么需要插件?

如果 XYCMS 开发中有一个基本原则,那就是:不要修改 XYCMS 核心。这意味着你不会编辑核心 XYCMS 文件来为你的站点添加功能。这是因为,当 XYCMS 更新一个新版本时,它会覆盖所有的核心文件。因此,你希望添加的任何功能都应该通过使用 XYCMS 插件来实现。

XYCMS 插件可以是简单的,也可以是复杂的,这取决于你想做什么。最简单的插件由一个代码文件(.cs)以及一个配置文件(package.json)组成;代码文件只需要继承一个类并实现一个方法即可。

插件允许你在不触及 XYCMS 核心的情况下极大地扩展 XYCMS 的功能。

什么是插件?

XYCMS 插件是扩展 XYCMS 产品核心功能的代码包,XYCMS 插件由.NET代码和其他文件(如图片、CSS和JavaScript等)组成。

通过做你自己的插件,你正在扩展 XYCMS,也就是说,在 XYCMS 已经提供的基础上构建更多的功能。例如,您可以编写一个插件来显示站点上最近10篇文章的链接。

或者,使用插件内容模型,你可以编写一个插件创建一个功能齐全的票务系统。可能性是无限的!

我需要用什么工具来开发插件?

开发 XYCMS 插件需要使用Visual Studio开发工具,除此之外不需要其他工具。当然,你可以使用你喜爱的任意文本编辑器编辑插件文件。

插件开发基础

欢迎来到 XYCMS 插件开发参考手册,在此我们将涵盖插件开发的各个方面,让你能够从零开始开发一个完整的插件。

XYCMS 插件是扩展 XYCMS 产品核心功能的代码包,XYCMS 插件由.NET代码和其他文件(如图片、CSS和JavaScript等)组成。

通过插件可以扩展 XYCMS,在 XYCMS 已经提供的功能基础上构建额外的功能。例如,编写一个插件来控制对应栏目的内容模型,采用自定义的字段提交并显示内容文章;或者,可以编写一个插件,创建一个带有短信通知、支持第三方支付的全功能票务系统。

一个插件必须有的文件是:一个主文件(插件Id.dll)以及一个插件配置文件(插件Id.nuspec)。

插件开发基于.NET环境,使用Visual Studio开发工具,同时需要在项目中引用 SiteServer.Plugin 开发包(SDK)。