---
url: https://docs.zblogcn.com/php/dev-examples/magic/category-get.md
description: >-
  通过 Filter_Plugin_Category_Get 接口在 Z-BlogPHP 读取分类未定义属性时返回自定义虚拟属性，如 SEO
  标题、扩展配置等场景。
---

# 分类虚拟属性读取接口

在 Z-BlogPHP 中读取分类对象上未被系统定义的属性时（例如模板中访问 `$category->SeoTitle`），会触发 `Filter_Plugin_Category_Get` 接口，插件可借此为分类对象扩展只读的虚拟属性。

## 接口信息

| 接口 | 参数 | 说明 |
| --- | --- | --- |
| `Filter_Plugin_Category_Get` | `&$this, $method` | 干预 Category 类 Get 方法的接口 |

## 完整案例

下例为分类对象添加虚拟属性 `SeoTitle`，优先读取 Metas 中保存的 SEO 标题，未设置时回退为分类名：

```php
<?php

RegisterPlugin("demoAPP", "ActivePlugin_demoAPP");

function ActivePlugin_demoAPP()
{
    Add_Filter_Plugin('Filter_Plugin_Category_Get', 'demoAPP_Category_Get');
}

function demoAPP_Category_Get(&$category, $name)
{
    if ($name == 'SeoTitle') {
        // 动态设置 RETURN 信号，本次读取使用本回调的返回值
        SetPluginSignal('Filter_Plugin_Category_Get', __FUNCTION__, PLUGIN_EXITSIGNAL_RETURN);
        $seo = isset($category->Metas->demo_seo_title) ? $category->Metas->demo_seo_title : '';
        return $seo != '' ? $seo : $category->Name;
    }
}
```

## 注意事项

* 只在读取系统内部未处理的属性名时触发：`Url`、`Symbol`、`Level`、`Parent`、`Template`、`AllCount` 等内置虚拟属性各有专门的处理分支，`Name`、`Alias` 等普通字段直接从数据中返回，都不会走到本接口。
* 只有回调内动态设置 `PLUGIN_EXITSIGNAL_RETURN` 信号后返回值才会生效，否则系统继续按默认逻辑处理该属性。
* 不要在注册时静态传入 `PLUGIN_EXITSIGNAL_RETURN`，否则所有未定义属性的读取都会返回本回调的值，影响其他属性的正常读取。
* 回调中不要读取与 `$name` 同名的属性，避免递归死循环。