SubredditWiki¶

class praw.models.reddit.subreddit.SubredditWiki(subreddit)¶

Provides a set of wiki functions to a Subreddit.

__getitem__(page_name)¶

Lazily return the WikiPage for the Subreddit named page_name.

This method is to be used to fetch a specific wikipage, like so:

wikipage = reddit.subreddit("test").wiki["proof"]
print(wikipage.content_md)

__init__(subreddit)¶

Initialize a SubredditWiki instance.

Parameters:: subreddit (Subreddit) – The subreddit whose wiki to work with.
Return type:: None

__iter__()¶

Iterate through the pages of the wiki.

This method is to be used to discover all wikipages for a subreddit:

for wikipage in reddit.subreddit("test").wiki:
    print(wikipage)

create(*, content, name, reason=None, **other_settings)¶

Create a new WikiPage.

Parameters:

name (str) – The name of the new WikiPage. This name will be normalized.
content (str) – The content of the new WikiPage.
reason (str | None) – The reason for the creation.
other_settings (Any) – Additional keyword arguments to pass.

Return type:

WikiPage

To create the wiki page "praw_test" in r/test try:

reddit.subreddit("test").wiki.create(
    name="praw_test", content="wiki body text", reason="PRAW Test Creation"
)

revisions(**generator_kwargs)¶

Return a ListingGenerator for recent wiki revisions.

Additional keyword arguments are passed in the initialization of ListingGenerator.

To view the wiki revisions for "praw_test" in r/test try:

for item in reddit.subreddit("test").wiki["praw_test"].revisions():
    print(item)

Return type:: Iterator[dict[str, Redditor | WikiPage | str | int | bool | None], None]
Parameters:: generator_kwargs (Any)