API Reference

Extend.Filter Class

Defined in lib/extend/filter.js:6

Description

This class is used to manage all filter plugins in Hexo.

Constructor

Extend.Filter

Defined in lib/extend/filter.js:6

This class is used to manage all filter plugins in Hexo.

Methods

apply

(type, [args], [callback], [context])
Defined in lib/extend/filter.js:87

Runs all filter plugins of a specified type.

Parameters

list

([type]) Object | Array
Defined in lib/extend/filter.js:24

Returns a list of filter plugins. Use type argument to get filter plugins of a specified type.

Parameters

Returns

register

([type=after_post_render], fn, [priority=10])
Defined in lib/extend/filter.js:59

Registers a filter plugin.

Parameters

  • type String optional

    The type of filter plugins.

  • fn Function
  • priority Number optional

    The execution priority of the plugin. It must be a positive number.

unregister

(type, [fn])
Defined in lib/extend/filter.js:154

Unregisters a filter plugin.

Parameters

  • type String
  • fn Function optional

    If fn is not defined, all filter plugins of the specified type will be unregistered.

Properties