Returns the word filters the current user has set up for their news feeds.

You do not need to apply the filters client-side. The server will return matched_filter in newsfeed.get and newsfeed.getGroups for any posts that match a filter. Your app then only needs to render some sort of placeholder, displaying the filter name, and optionally letting the user see the post anyway.

This method requires the following permissions: newsfeed.

Parameters

include_expired
boolean

Whether to also return expired filters.

By default false.

Result

An array of objects:

id
integer (positive)

Identifier of the filter.

name
string

The user-visible name of the filter.

words
array of strings

Words (case-insensitive) that match this filter.

contexts
array of strings

Which contexts this filter applies in:

  • friends — the default (friends) news feed
  • groups — the groups news feed
expiry_date
integer

If this filter is temporary, the unixtime when it expires.

Errors

Global errors may occur when calling this method.