Z-BlogPHP

https://github.com/zblogcn/zblogphp
Admin
Z-BlogPHP is an open-source blogging platform featuring a lightweight design, fast performance,...
Tokens:17,149
Snippets:136
Trust Score:9.4
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### User Info Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Example JSON response when fetching user information.

```json
{
  "code": 200,
  "data": {
    "member": {
      "ID": 1,
      "Name": "admin",
      "Level": 1,
      "Email": "admin@example.com",
      "Intro": "网站管理员",
      "Articles": 156,
      "Pages": 10,
      "Comments": 45,
      "Url": "https://your-blog.com/author/1.html",
      "Avatar": "https://your-blog.com/zb_users/avatar/1.png",
      "StaticName": "admin"
    }
  }
}
```

--------------------------------

### Tag List Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Example JSON response when fetching a list of tags.

```json
{
  "code": 200,
  "data": {
    "list": [
      {
        "ID": 1,
        "Name": "PHP",
        "Alias": "php",
        "Count": 45,
        "Url": "https://your-blog.com/tags/php/"
      },
      {
        "ID": 5,
        "Name": "JavaScript",
        "Alias": "javascript",
        "Count": 32,
        "Url": "https://your-blog.com/tags/javascript/"
      }
    ],
    "pagebar": {"AllCount": 86, "PageAll": 5}
  }
}
```

--------------------------------

### Category List Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Example JSON response when fetching a list of categories.

```json
{
  "code": 200,
  "data": {
    "list": [
      {
        "ID": 1,
        "Name": "默认分类",
        "Alias": "default",
        "Count": 25,
        "Order": 0,
        "Level": 0,
        "ParentID": 0,
        "Url": "https://your-blog.com/category/default/",
        "AllCount": 25
      },
      {
        "ID": 2,
        "Name": "技术分享",
        "Alias": "tech",
        "Count": 48,
        "Level": 0,
        "Url": "https://your-blog.com/category/tech/",
        "AllCount": 78
      }
    ],
    "pagebar": {}
  }
}
```

--------------------------------

### Comment List Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Example JSON response when fetching a list of comments.

```json
{
  "code": 200,
  "data": {
    "list": [
      {
        "ID": 456,
        "LogID": 123,
        "Content": "非常有用的文章！",
        "AuthorID": 2,
        "PostTime": 1699800000,
        "ParentID": 0,
        "RootID": 0,
        "Author": {
          "ID": 2,
          "Name": "visitor",
          "Avatar": "https://your-blog.com/zb_users/avatar/0.png"
        }
      }
    ],
    "pagebar": {"AllCount": 15}
  }
}
```

--------------------------------

### Sidebar Module Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

JSON structure returned by module list endpoints.

```json
{
  "code": 200,
  "data": {
    "list": [
      {
        "ID": 1,
        "FileName": "calendar",
        "Name": "日历",
        "Content": "<div class=\"calendar\">...</div>",
        "Type": "ul",
        "SourceType": "system",
        "NoRefresh": false
      },
      {
        "ID": 5,
        "FileName": "archives",
        "Name": "文章归档",
        "SourceType": "system"
      }
    ]
  }
}
```

--------------------------------

### System Information Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

JSON structure returned by system information endpoints.

```json
{
  "code": 200,
  "data": {
    "zbp": {
      "name": "我的博客",
      "subname": "记录生活点滴",
      "host": "https://your-blog.com/",
      "version": "1.7.5.3540",
      "manage_count": 50,
      "display_count": 10,
      "comment_display_count": 10,
      "zblogphp": "Z-BlogPHP 1.7.5 Optimus"
    },
    "is_logged_in": true,
    "current_member": {
      "ID": 1,
      "Name": "admin",
      "Level": 1
    }
  }
}
```

--------------------------------

### GET /zb_system/api.php?mod=post&act=list

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves a paginated list of articles or pages.

```APIDOC
## GET /zb_system/api.php?mod=post&act=list

### Description
Fetches a list of posts with support for pagination, sorting, and filtering.

### Method
GET

### Endpoint
/zb_system/api.php?mod=post&act=list

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Current page number
- **perpage** (integer) - Optional - Items per page
- **sortby** (string) - Optional - Field to sort by
- **order** (string) - Optional - Sort direction (ASC/DESC)
- **cate_id** (integer) - Optional - Category filter
- **with_relations** (string) - Optional - Comma-separated relations to include

### Response
#### Success Response (200)
- **list** (array) - Array of post objects
- **pagebar** (object) - Pagination metadata
```

--------------------------------

### Get User List API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Fetches a list of users, filterable by level and sortable by article count.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=member&act=list\n&level=4\n&sortby=Articles\n&order=DESC" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### GET /zb_system/api.php?mod=upload&act=get

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves information about a specific attachment by ID.

```APIDOC
## GET /zb_system/api.php?mod=upload&act=get

### Description
Fetches details for a specific attachment.

### Method
GET

### Endpoint
/zb_system/api.php?mod=upload&act=get

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the attachment
```

--------------------------------

### Attachment API Response Example

Source: https://context7.com/zblogcn/zblogphp/llms.txt

JSON structure returned by attachment API endpoints.

```json
{
  "code": 200,
  "message": "操作成功",
  "data": {
    "upload": {
      "ID": 51,
      "Name": "screenshot.png",
      "SourceName": "screenshot_20240115.png",
      "MimeType": "image/png",
      "Size": 256000,
      "PostTime": 1705307400,
      "Url": "https://your-blog.com/zb_users/upload/2024/01/screenshot.png"
    }
  }
}
```

--------------------------------

### Get Tag List API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Fetches a list of tags, sortable by count in descending order, with pagination.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=tag&act=list\n&sortby=Count\n&order=DESC\n&perpage=20"
```

--------------------------------

### Get Single Tag API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves a specific tag by its ID or name.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=tag&act=get&id=5"
curl "https://your-blog.com/zb_system/api.php?mod=tag&act=get&name=PHP"
```

--------------------------------

### Get Current User Info API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves information about the currently logged-in user. Requires an API token for authorization.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=member&act=get" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Article Comments API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Fetches comments for a specific article, with options for pagination and including related author information.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=comment&act=list\n&post_id=123\n&page=1\n&perpage=20\n&with_relations=Author"
```

--------------------------------

### Get Current User Permissions API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves the permissions of the currently logged-in user. Requires an API token for authorization.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=member&act=get_auth" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Specific User Info API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves information about a specific user by their ID. Requires administrative privileges and an API token.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=member&act=get&id=2" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### List of Font Icon Class Names

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

These are examples of available icon class names. Select the appropriate class name to use with the font icon span tag.

```Text
#icon-tubiaozhizuomoban1
```

```Text
#icon-tubiaozhizuomoban
```

```Text
#icon-shouji
```

```Text
#icon-tubiao7
```

```Text
#icon-dingweixiao
```

```Text
#icon-home
```

```Text
#icon-telephone
```

```Text
#icon-mark
```

```Text
#icon-menu
```

```Text
#icon-github-fill
```

```Text
#icon-douyin
```

```Text
#icon-zhihu
```

```Text
#icon-playbtn
```

```Text
#icon-kefu
```

```Text
#icon-paixu2
```

```Text
#icon-yuyin
```

```Text
#icon-ziyuan2
```

```Text
#icon-ziyuan3
```

```Text
#icon-dianhua
```

```Text
#icon-appqzone
```

```Text
#icon-feed
```

```Text
#icon-filter
```

```Text
#icon-ios
```

```Text
#icon-android
```

```Text
#icon-xingxing
```

```Text
#icon-back
```

```Text
#icon-weibiaoti1
```

```Text
#icon-icon_sign_email
```

```Text
#icon-icon1
```

```Text
#icon-QQ
```

```Text
#icon-sina
```

```Text
#icon-delete
```

```Text
#icon-Null-data
```

```Text
#icon-jia
```

```Text
#icon-jian
```

```Text
#icon-taiyang
```

```Text
#icon-sleepmode
```

```Text
#icon-uniEB5C
```

```Text
#icon-icon_duihao-xian
```

```Text
#icon-checktriangle
```

```Text
#icon-top1
```

```Text
#icon-sousuo
```

```Text
#icon-edit
```

```Text
#icon-settings
```

```Text
#icon-down
```

```Text
#icon-agreement
```

```Text
#icon-privacy
```

```Text
#icon-information
```

```Text
#icon-close
```

```Text
#icon-refuse
```

```Text
#icon-selection
```

```Text
#icon-increase
```

```Text
#icon-collection
```

```Text
#icon-upward
```

```Text
#icon-top
```

```Text
#icon-history
```

```Text
#icon-next
```

```Text
#icon-eye_protection
```

```Text
#icon-voice
```

```Text
#icon-nickname
```

```Text
#icon-movie
```

```Text
#icon-problem
```

```Text
#icon-cancel
```

```Text
#icon-geniecalling
```

```Text
#icon-faimlyalbum
```

```Text
#icon-search
```

```Text
#icon-instruction
```

--------------------------------

### Get Pending Comments API (Management Mode)

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieves comments that are pending review. Requires an API token for authorization.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=comment&act=list\n&manage=1\n&ischecking=1" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Custom API Endpoint for Z-BlogPHP

Source: https://context7.com/zblogcn/zblogphp/llms.txt

This PHP code defines custom API endpoints for Z-BlogPHP. 'api_custom_get' handles GET requests, performing authentication and returning custom data. 'api_custom_post' handles POST requests, requiring admin authentication and processing provided parameters.

```php
// 自定义API接口文件：api/custom.php
function api_custom_get() {
    global $zbp;

    ApiCheckAuth(false, 'view');

    $data = array(
        'custom_field' => 'custom_value',
        'timestamp' => time()
    );

    return array(
        'data' => $data
    );
}

function api_custom_post() {
    global $zbp;

    ApiCheckAuth(true, 'admin');

    $param = GetVars('param', 'POST');

    // 处理逻辑...

    return array(
        'message' => '操作成功',
        'data' => array('result' => true)
    );
}

```

--------------------------------

### POST /zb_system/api.php?mod=system&act=save_setting

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Updates system configuration settings.

```APIDOC
## POST /zb_system/api.php?mod=system&act=save_setting

### Description
Saves system settings such as blog name and display counts.

### Method
POST

### Endpoint
/zb_system/api.php?mod=system&act=save_setting

### Parameters
#### Request Body
- **ZC_BLOG_NAME** (string) - Optional - Blog name
- **ZC_BLOG_SUBNAME** (string) - Optional - Blog subname
- **ZC_DISPLAY_COUNT** (integer) - Optional - Number of items to display
- **ZC_COMMENT_AUDIT** (boolean) - Optional - Whether to enable comment audit
```

--------------------------------

### Manage System Information and Settings

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieve system status or update configuration settings via API.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=system&act=basic_info"
```

```bash
curl "https://your-blog.com/zb_system/api.php?mod=system&act=get_info" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```bash
curl "https://your-blog.com/zb_system/api.php?mod=system&act=get_setting" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```bash
curl -X POST "https://your-blog.com/zb_system/api.php?mod=system&act=save_setting" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ZC_BLOG_NAME": "我的博客",
    "ZC_BLOG_SUBNAME": "记录生活点滴",
    "ZC_DISPLAY_COUNT": 10,
    "ZC_COMMENT_AUDIT": true
  }'
```

--------------------------------

### 使用 GetList 获取文章列表

Source: https://context7.com/zblogcn/zblogphp/llms.txt

GetList 支持通过位置参数或数组参数进行筛选，推荐在 1.7 及以上版本使用数组参数以获得更强的可读性。

```php
<?php
// 基本用法：获取10篇最新文章
$articles = GetList(10);
foreach ($articles as $article) {
    echo $article->Title . "\n";
}

// 获取指定分类的文章
$articles = GetList(10, 2);  // 分类ID为2

// 获取指定作者的文章
$articles = GetList(10, null, 1);  // 作者ID为1

// 使用数组参数（1.7+推荐方式）
$articles = GetList(array(
    'count' => 10,                  // 获取数量
    'cate' => 2,                    // 分类ID
    'category' => 2,                // 分类ID（别名）
    'auth' => 1,                    // 作者ID
    'author' => 1,                  // 作者ID（别名）
    'date' => '2024-01',            // 日期筛选（年月）
    'tags' => array(1, 5),          // 标签ID数组
    'search' => '关键词',            // 搜索关键词
    'post_type' => 0,               // 文章类型
    'post_status' => 0,             // 文章状态
    'only_ontop' => false,          // 仅置顶文章
    'only_not_ontop' => true,       // 排除置顶文章
    'has_subcate' => true,          // 包含子分类
    'is_related' => 123,            // 获取相关文章（文章ID）
    'where_custom' => array(        // 自定义条件
        array('>', 'log_ViewNums', 100)
    ),
    'order_custom' => array(        // 自定义排序
        'log_ViewNums' => 'DESC'
    )
));

// 遍历文章列表
foreach ($articles as $article) {
    echo "<article>\n";
    echo "  <h2><a href=\"{$article->Url}\">{$article->Title}</a></h2>\n";
    echo "  <div class=\"meta\">\n";
    echo "    <span>作者: {$article->Author->Name}</span>\n";
    echo "    <span>分类: {$article->Category->Name}</span>\n";
    echo "    <span>发布于: {$article->Time('Y-m-d')}</span>\n";
    echo "  </div>\n";
    echo "  <div class=\"intro\">{$article->Intro}</div>\n";
    echo "</article>\n";
}
```

--------------------------------

### Manage Sidebar Modules

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieve and configure sidebar modules via API.

```bash
curl "https://your-blog.com/zb_system/api.php?mod=module&act=list"
```

```bash
curl "https://your-blog.com/zb_system/api.php?mod=module&act=list&type=user"
```

```bash
curl "https://your-blog.com/zb_system/api.php?mod=module&act=get&filename=calendar"
```

```bash
curl "https://your-blog.com/zb_system/api.php?mod=module&act=list_sidebar"
```

```bash
curl "https://your-blog.com/zb_system/api.php?mod=module&act=list_sidebar&id=1"
```

```bash
curl -X POST "https://your-blog.com/zb_system/api.php?mod=module&act=set_sidebar" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d "sidebar=calendar|archives|tags|links"
```

--------------------------------

### POST /zb_system/api.php?mod=upload&act=post

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Uploads a new file to the system.

```APIDOC
## POST /zb_system/api.php?mod=upload&act=post

### Description
Uploads a file to the server.

### Method
POST

### Endpoint
/zb_system/api.php?mod=upload&act=post

### Parameters
#### Request Body
- **file** (file) - Required - The file to upload
```

--------------------------------

### POST /zb_system/api.php?mod=post&act=post

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Creates or updates an article.

```APIDOC
## POST /zb_system/api.php?mod=post&act=post

### Description
Creates a new article or updates an existing one if an ID is provided.

### Method
POST

### Endpoint
/zb_system/api.php?mod=post&act=post

### Request Body
- **ID** (integer) - Optional - Required for updates
- **Title** (string) - Required - Article title
- **Content** (string) - Required - HTML content
- **CateID** (integer) - Optional - Category ID

### Response
#### Success Response (200)
- **post** (object) - The created or updated post object
```

--------------------------------

### POST /zb_system/api.php?mod=member&act=login

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Authenticates a user and returns a token for subsequent API requests.

```APIDOC
## POST /zb_system/api.php?mod=member&act=login

### Description
Authenticates a user with username and password to retrieve an access token.

### Method
POST

### Endpoint
/zb_system/api.php?mod=member&act=login

### Request Body
- **username** (string) - Required - The user's login name
- **password** (string) - Required - The user's password
- **savedate** (integer) - Optional - Token expiration in days

### Request Example
{
  "username": "admin",
  "password": "your_password",
  "savedate": 30
}

### Response
#### Success Response (200)
- **code** (integer) - Status code
- **message** (string) - Status message
- **data** (object) - Contains user info, token, and expiration time

#### Response Example
{
  "code": 200,
  "message": "操作成功",
  "data": {
    "user": {
      "ID": 1,
      "Name": "admin"
    },
    "token": "YWRtaW58fHwxNjk5...",
    "expire_time": 1702012800
  }
}
```

--------------------------------

### Retrieve Post Lists

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Fetch articles or pages with support for pagination, sorting, and category filtering.

```bash
# 获取文章列表（默认按发布时间倒序）
curl "https://your-blog.com/zb_system/api.php?mod=post&act=list"

# 带分页和排序参数
curl "https://your-blog.com/zb_system/api.php?mod=post&act=list\
&page=1\
&perpage=10\
&sortby=PostTime\
&order=DESC\
&cate_id=2\
&with_relations=Author,Category,Tags"

# 响应示例
{
  "code": 200,
  "message": "OK",
  "data": {
    "list": [
      {
        "ID": 123,
        "Title": "我的第一篇文章",
        "Intro": "这是文章摘要...",
        "Content": "<p>这是文章内容...</p>",
        "PostTime": 1699776000,
        "ViewNums": 1024,
        "CommNums": 15,
        "Url": "https://your-blog.com/post/123.html",
        "Author": {
          "ID": 1,
          "Name": "admin",
          "Avatar": "https://your-blog.com/zb_users/avatar/1.png"
        },
        "Category": {
          "ID": 2,
          "Name": "技术分享",
          "Url": "https://your-blog.com/category/tech/"
        }
      }
    ],
    "pagebar": {
      "AllCount": 156,
      "PerPageCount": 10,
      "PageAll": 16,
      "PageNow": 1,
      "PageNext": 2
    }
  }
}
```

--------------------------------

### Create/Edit User API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Use this endpoint to create new users or edit existing ones. Requires an API token for authorization.

```bash
curl -X POST "https://your-blog.com/zb_system/api.php?mod=member&act=post" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "newuser",
    "Password": "secure_password",
    "PasswordRe": "secure_password",
    "Email": "user@example.com",
    "Level": 4,
    "Alias": "new-user"
  }'
```

--------------------------------

### Create or Edit Posts

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Submit a POST request to create a new article or update an existing one by providing an ID.

```bash
# 创建新文章
curl -X POST "https://your-blog.com/zb_system/api.php?mod=post&act=post" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Title": "新文章标题",
    "Content": "<p>这是文章的正文内容，支持HTML格式。</p>",
    "Intro": "这是文章摘要",
    "CateID": 2,
    "Tag": "PHP,Z-BlogPHP,博客开发",
    "Type": 0,
    "Status": 0,
    "Alias": "my-new-article",
    "PostTime": "2024-01-15 10:30:00"
  }'

# 编辑已有文章（提供ID即为编辑）
curl -X POST "https://your-blog.com/zb_system/api.php?mod=post&act=post" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ID": 123,
    "Title": "更新后的标题",
    "Content": "<p>更新后的内容</p>",
    "IsTop": 1
  }'

# 响应示例
{
  "code": 200,
  "message": "操作成功",
  "data": {
    "post": {
      "ID": 124,
      "Title": "新文章标题",
      "Url": "https://your-blog.com/post/my-new-article.html",
      "Status": 0,
      "PostTime": 1705307400
    }
  }
}
```

--------------------------------

### Manage Categories

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Retrieve category information using various identifiers like ID, alias, or name.

```bash
# 获取分类列表
curl "https://your-blog.com/zb_system/api.php?mod=category&act=list"

# 获取单个分类（支持ID、别名、名称）
curl "https://your-blog.com/zb_system/api.php?mod=category&act=get&id=2"
curl "https://your-blog.com/zb_system/api.php?mod=category&act=get&alias=tech"
curl "https://your-blog.com/zb_system/api.php?mod=category&act=get&name=技术分享"
```

--------------------------------

### Apply Icon via Unicode

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

Use the iconfont class and the specific Unicode character code to display an icon on the page.

```html
<span class="iconfont">&#x33;</span>
```

--------------------------------

### Register Plugin and Hooks in Z-BlogPHP

Source: https://context7.com/zblogcn/zblogphp/llms.txt

This PHP code demonstrates how to register a plugin, its activation/deactivation functions, and various hooks for extending Z-BlogPHP's functionality. Ensure these functions are defined within your plugin's main file.

```php
<?php
// 插件主文件：plugin_name_main.php

// 注册插件激活/停用函数
RegisterPlugin("plugin_name", "ActivePlugin_plugin_name", "InstallPlugin_plugin_name", "UninstallPlugin_plugin_name");

// 注册钩子
Add_Filter_Plugin('Filter_Plugin_ViewPost_Template', 'plugin_name_ViewPost');
Add_Filter_Plugin('Filter_Plugin_Post_Save', 'plugin_name_PostSave');
Add_Filter_Plugin('Filter_Plugin_API_Extend_Mods', 'plugin_name_AddApiMods');

// 插件激活函数
function ActivePlugin_plugin_name() {
    global $zbp;
    // 创建配置
    $zbp->Config('plugin_name')->option1 = 'default_value';
    $zbp->SaveConfig('plugin_name');
}

// 文章查看钩子 - 修改模板
function plugin_name_ViewPost(&$template) {
    global $zbp;
    // 可以在这里修改使用的模板
    // $template = 'custom_single';
}

// 文章保存钩子
function plugin_name_PostSave(&$post) {
    global $zbp;
    // 文章保存前的处理
    if (empty($post->Intro)) {
        // 自动生成摘要
        $post->Intro = SubStrUTF8(strip_tags($post->Content), 200);
    }
    return true;
}

// 添加自定义API模块
function plugin_name_AddApiMods() {
    return array(
        'custom' => ZBP_PATH . 'zb_users/plugin/plugin_name/api/custom.php'
    );
}

```

--------------------------------

### Authenticate with Z-BlogPHP API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Use the login endpoint to obtain a token for subsequent authenticated requests. The token can be passed via the Authorization header or as a query parameter.

```bash
# 用户登录获取Token
curl -X POST "https://your-blog.com/zb_system/api.php?mod=member&act=login" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "admin",
    "password": "your_password",
    "savedate": 30
  }'

# 响应示例
{
  "code": 200,
  "message": "操作成功",
  "data": {
    "user": {
      "ID": 1,
      "Name": "admin",
      "Level": 1,
      "Url": "https://your-blog.com/author/1.html",
      "Avatar": "https://your-blog.com/zb_users/avatar/1.png"
    },
    "token": "YWRtaW58fHwxNjk5...(Base64编码)",
    "expire_time": 1702012800
  }
}

# 使用Token进行API请求（两种方式）
# 方式1: Authorization Header
curl -H "Authorization: Bearer YOUR_TOKEN" \
  "https://your-blog.com/zb_system/api.php?mod=post&act=list"

# 方式2: 请求参数
curl "https://your-blog.com/zb_system/api.php?mod=post&act=list&token=YOUR_TOKEN"
```

--------------------------------

### Retrieve Articles with GetPost

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Use the GetPost function to fetch article objects using various criteria.

```php
<?php
// 通过ID获取文章
$post = GetPost(123);
echo $post->Title;
echo $post->Content;
echo $post->Url;

// 通过标题或别名获取
$post = GetPost('my-article-alias');

// 使用数组参数（1.7+推荐方式）
$post = GetPost(array(
    'id' => 123,                    // 按ID查询
    'alias' => 'article-alias',     // 按别名查询
    'title' => '文章标题',           // 按标题查询
    'titleoralias' => 'keyword',    // 标题或别名匹配
    'post_type' => 0,               // 文章类型：0=文章，1=页面
    'post_status' => 0,             // 状态：0=公开，1=草稿，2=审核
    'only_article' => true,         // 仅查询文章
    'only_page' => false,           // 仅查询页面
    'where_custom' => array(        // 自定义条件
        array('=', 'log_AuthorID', 1)
    )
));

// 获取文章属性
if ($post->ID) {
    echo "标题: " . $post->Title . "\n";
    echo "作者: " . $post->Author->Name . "\n";
    echo "分类: " . $post->Category->Name . "\n";
    echo "发布时间: " . $post->Time('Y-m-d H:i') . "\n";
    echo "浏览次数: " . $post->ViewNums . "\n";
    echo "评论数: " . $post->CommNums . "\n";
    echo "链接: " . $post->Url . "\n";

    // 获取标签
    foreach ($post->Tags as $tag) {
        echo "标签: " . $tag->Name . "\n";
    }
}
```

--------------------------------

### Create/Edit Category API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Use this endpoint to create new categories or edit existing ones. Requires an API token for authorization.

```bash
curl -X POST "https://your-blog.com/zb_system/api.php?mod=category&act=post" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "前端开发",
    "Alias": "frontend",
    "Intro": "前端开发相关文章",
    "ParentID": 2,
    "Order": 1
  }'
```

--------------------------------

### Style iconfont logo

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

CSS rules for styling the main logo container and its subtitle.

```css
.main .logo { margin-top: 0; height: auto; } .main .logo a { display: flex; align-items: center; } .main .logo .sub-title { margin-left: 0.5em; font-size: 22px; color: #fff; background: linear-gradient(-45deg, #3967FF, #B500FE); -webkit-background-clip: text; -webkit-text-fill-color: transparent; }
```

--------------------------------

### Include Iconfont JavaScript

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

This script tag should be included to load the icon font definitions. Ensure the path to 'iconfont.js' is correct for your project.

```HTML
<script src="./iconfont.js"></script>
```

--------------------------------

### Declare @font-face

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

Define the font family and source URLs for the iconfont files.

```css
@font-face {
  font-family: 'iconfont';
  src: url('iconfont.woff2?t=1649813786709') format('woff2'),
       url('iconfont.woff?t=1649813786709') format('woff'),
       url('iconfont.ttf?t=1649813786709') format('truetype');
}
```

--------------------------------

### Include Font-Class Stylesheet

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

Link the generated iconfont CSS file to the project to enable font-class usage.

```html
<link rel="stylesheet" href="./iconfont.css">
```

--------------------------------

### General Icon CSS

Source: https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/style/fonts/demo_index.html

Include this CSS code once in your project to define the base styling for icons. It sets the size, alignment, and fill properties.

```CSS
<style>
.icon {
  width: 1em;
  height: 1em;
  vertical-align: -0.15em;
  fill: currentColor;
  overflow: hidden;
}
</style>
```

--------------------------------

### Create/Edit Tag API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Use this endpoint to create new tags or edit existing ones. Requires an API token for authorization.

```bash
curl -X POST "https://your-blog.com/zb_system/api.php?mod=tag&act=post" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "Vue.js",
    "Alias": "vuejs",
    "Intro": "Vue.js前端框架相关"
  }'
```

--------------------------------

### Conditional Logic (if/elseif/else) in ZBlogPHP

Source: https://github.com/zblogcn/zblogphp/blob/master/standards/模板语法说明.md

Implement conditional rendering based on variable values. Supports standard if, elseif, and else clauses, closed with {/if}.

```zblogphp
{if $i==1}
    i=1
{elseif $i==2}
    i=2
{else}
    i=else
{/if}
```

--------------------------------

### Z-BlogPHP 模板引擎语法

Source: https://context7.com/zblogcn/zblogphp/llms.txt

模板引擎支持变量输出、条件判断、循环控制以及 PHP 代码嵌入。使用 {template} 和 {module} 标签可实现模板与模块的复用。

```html
<!-- 嵌入其他模板 -->
{template:header}

<!-- 嵌入模块 -->
{module:calendar}

<!-- 输出变量 -->
<h1>{$zbp->name}</h1>
<p>{$article.Title}</p>

<!-- 定义变量（不输出） -->
{$now=time()}
{$greeting="欢迎访问"}

<!-- 引用常量 -->
<link rel="stylesheet" href="{#ZC_BLOG_HOST#}zb_users/theme/default/style/style.css">

<!-- if 条件判断 -->
{if $article.IsTop > 0}
    <span class="top-badge">置顶</span>
{elseif $article.Status == 1}
    <span class="draft-badge">草稿</span>
{else}
    <span class="normal-badge">普通</span>
{/if}

<!-- foreach 循环 -->
{foreach $articles as $article}
<article class="post">
    <h2><a href="{$article.Url}">{$article.Title}</a></h2>
    <div class="meta">
        <span class="author">{$article.Author.Name}</span>
        <span class="date">{$article.Time('Y-m-d')}</span>
        <span class="category">{$article.Category.Name}</span>
    </div>
    <div class="content">{$article.Intro}</div>

    <!-- 输出标签 -->
    {foreach $article.Tags as $tag}
        <a href="{$tag.Url}" class="tag">{$tag.Name}</a>
    {/foreach}
</article>
{/foreach}

<!-- for 循环 -->
{for $i = 1; $i <= 5; $i++}
    <span class="star">★</span>
{/for}

<!-- 调用函数 -->
{GetList(5)}
{date('Y-m-d H:i:s')}

<!-- 模板注释 -->
{* 这里是注释，不会输出到页面 *}

<!-- 嵌入PHP代码 -->
{php}
    global $zbp;
    $customVar = $zbp->option['ZC_BLOG_NAME'];
    echo "博客名称: " . $customVar;
{/php}

<!-- 分页导航 -->
{if $pagebar.PageAll > 1}
<nav class="pagination">
    {if $pagebar.PagePrevious}
        <a href="{$pagebar.UrlPrevious}">上一页</a>
    {/if}
    <span>第 {$pagebar.PageNow} / {$pagebar.PageAll} 页</span>
    {if $pagebar.PageNext}
        <a href="{$pagebar.UrlNext}">下一页</a>
    {/if}
</nav>
{/if}

{template:footer}
```

--------------------------------

### Retrieve Single Post Details

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Fetch specific post details by ID, with an optional flag to increment view counts.

```bash
# 获取单篇文章
curl "https://your-blog.com/zb_system/api.php?mod=post&act=get&id=123"

# 获取并增加浏览次数
curl "https://your-blog.com/zb_system/api.php?mod=post&act=get\
&id=123\
&viewnums=true\
&with_relations=Author,Category,Tags"

# 响应示例
{
  "code": 200,
  "message": "OK",
  "data": {
    "post": {
      "ID": 123,
      "Title": "Z-BlogPHP开发指南",
      "Intro": "本文介绍Z-BlogPHP的开发基础...",
      "Content": "<h2>概述</h2><p>Z-BlogPHP是...</p>",
      "Type": 0,
      "Status": 0,
      "AuthorID": 1,
      "CateID": 2,
      "PostTime": 1699776000,
      "CreateTime": 1699700000,
      "UpdateTime": 1699800000,
      "ViewNums": 1025,
      "CommNums": 15,
      "Alias": "zblogphp-dev-guide",
      "Url": "https://your-blog.com/post/zblogphp-dev-guide.html",
      "TagsName": "PHP,博客,CMS",
      "TagsCount": 3,
      "CommentPostKey": "abc123def456",
      "Tags": [
        {"ID": 1, "Name": "PHP", "Url": "https://your-blog.com/tags/php/"},
        {"ID": 5, "Name": "博客", "Url": "https://your-blog.com/tags/blog/"}
      ]
    }
  }
}
```

--------------------------------

### Include Template in ZBlogPHP

Source: https://github.com/zblogcn/zblogphp/blob/master/standards/模板语法说明.md

Use the template tag to embed one template file within another. Ensure the TEMPLATE_NAME is correctly specified.

```zblogphp
{template:TEMPLATE_NAME}
```

--------------------------------

### User Management API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

APIs for managing users, including retrieval, creation, editing, deletion, and permission checks.

```APIDOC
## GET /zb_system/api.php?mod=member&act=get

### Description
Retrieves information about the currently logged-in user or a specified user.

### Method
GET

### Endpoint
https://your-blog.com/zb_system/api.php?mod=member&act=get

### Parameters
#### Query Parameters
- **id** (integer) - Optional - The ID of the user to retrieve. If omitted, returns the current user.

## GET /zb_system/api.php?mod=member&act=list

### Description
Retrieves a list of users.

### Method
GET

### Endpoint
https://your-blog.com/zb_system/api.php?mod=member&act=list

### Parameters
#### Query Parameters
- **level** (integer) - Optional - Filter users by level.
- **sortby** (string) - Optional - Field to sort by (e.g., 'Articles').
- **order** (string) - Optional - Sort order ('ASC' or 'DESC').

## POST /zb_system/api.php?mod=member&act=post

### Description
Creates or edits a user.

### Method
POST

### Endpoint
https://your-blog.com/zb_system/api.php?mod=member&act=post

### Parameters
#### Request Body
- **Name** (string) - Required - The username.
- **Password** (string) - Required - The user's password.
- **PasswordRe** (string) - Required - Password confirmation.
- **Email** (string) - Required - The user's email address.
- **Level** (integer) - Optional - The user's level.
- **Alias** (string) - Optional - The user's alias.

### Request Example
```json
{
  "Name": "newuser",
  "Password": "secure_password",
  "PasswordRe": "secure_password",
  "Email": "user@example.com",
  "Level": 4,
  "Alias": "new-user"
}
```

## GET /zb_system/api.php?mod=member&act=get_auth

### Description
Retrieves the current user's permissions.

### Method
GET

### Endpoint
https://your-blog.com/zb_system/api.php?mod=member&act=get_auth

## POST /zb_system/api.php?mod=member&act=logout

### Description
Logs the current user out.

### Method
POST

### Endpoint
https://your-blog.com/zb_system/api.php?mod=member&act=logout

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **data** (object) - Contains user information.
  - **member** (object) - User details.
    - **ID** (integer) - User ID.
    - **Name** (string) - Username.
    - **Level** (integer) - User level.
    - **Email** (string) - User email.
    - **Intro** (string) - User introduction.
    - **Articles** (integer) - Number of articles written by the user.
    - **Pages** (integer) - Number of pages created by the user.
    - **Comments** (integer) - Number of comments made by the user.
    - **Url** (string) - URL to the user's profile.
    - **Avatar** (string) - URL to the user's avatar.
    - **StaticName** (string) - Static name of the user.

### Response Example
```json
{
  "code": 200,
  "data": {
    "member": {
      "ID": 1,
      "Name": "admin",
      "Level": 1,
      "Email": "admin@example.com",
      "Intro": "网站管理员",
      "Articles": 156,
      "Pages": 10,
      "Comments": 45,
      "Url": "https://your-blog.com/author/1.html",
      "Avatar": "https://your-blog.com/zb_users/avatar/1.png",
      "StaticName": "admin"
    }
  }
}
```
```

--------------------------------

### For Loop in ZBlogPHP

Source: https://github.com/zblogcn/zblogphp/blob/master/standards/模板语法说明.md

Execute a block of code a specific number of times. The loop structure is similar to standard C-style for loops, closed with {/for}.

```zblogphp
{for $i  =  1 ;  $i  <=  10 ;  $i ++}
  <p>这是第{$i}次？</p>
{/for}
```

--------------------------------

### Include Module in ZBlogPHP

Source: https://github.com/zblogcn/zblogphp/blob/master/standards/模板语法说明.md

Use the module tag to embed a module into the current template. The MODULE_NAME must correspond to an existing module.

```zblogphp
{module:MODULE_NAME}
```

--------------------------------

### Call Function in ZBlogPHP

Source: https://github.com/zblogcn/zblogphp/blob/master/standards/模板语法说明.md

Execute a PHP function within the template. Arguments can be passed as needed.

```zblogphp
{FUNCTION_NAME(FUNCTION_ARGUMENTS)}
```

--------------------------------

### Post Comment API

Source: https://context7.com/zblogcn/zblogphp/llms.txt

Publishes a new comment on an article. Requires an API token for authorization.

```bash
curl -X POST "https://your-blog.com/zb_system/api.php?mod=comment&act=post" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "LogID": 123,
    "Content": "这篇文章写得很好，感谢分享！",
    "ParentID": 0
  }'
```
Tokens:
Raw