View source for Manual:Wikibot

{{notice|WikiBot is deprecated. If you are [[w:WP:CREATEBOT#PHP|creating a new PHP bot]], use [[Manual:Chris G's botclasses]].}}
{{Tool
|name          = Wikibot
|status        = experimental
|type1         = Bot
|type2         = 
|hook1         = 
|hook2         = 
|username      = 
|author        = [[User:Cobi|Cobi]], [[User:Tisane|Tisane]]
|description   = Configurable bot framework
|image         = 
|imagesize     = 
|version       = 1.0.0
|update        = 
|mediawiki     = 1.16+
|language      = PHP
|license       = GPL
|download      = {{ToolDownload|wikibot}}
|readme        = 
|changelog     = 
|parameters    = 
|tags          = 
|rights        = 
|example       = 
|compatibility = 
}}
:''Not to be confused with [[Manual:IRC RC Bot]]''
'''Wikibot''' is a [[PHP]]-based MediaWiki bot framework. It is based upon [[w:User:ClueBot/Source]], but is designed to be more configurable and flexible. Make sure that the appropriate subpage of the bot's userpage, e.g. [[User:MyBot/Run]], exists, or some bots may not work.

==Configuration==
The bot can be configured using the file wikibot.config.php. For instance, if you want to configure a bot username of <code>TestBot</code>, a bot password of <code>password</code>, and to have it edit testwiki.org, you might put the following configuration settings in wikibot.config.php:

<syntaxhighlight lang="php">
$wikibotSetting['user']['TestBot']['Testwiki'] = 'TestBot'; # Username
$wikibotSetting['pass']['TestBot']['Testwiki'] = 'password'; # Password
$wikibotSetting['apiurl']['*']['Testwiki'] = 'http://testwiki.org/w/api.php';
$wikibotSetting['queryurl']['*']['Testwiki'] = 'http://testwiki.org/w/query.php';
$wikibotSetting['indexurl']['*']['Testwiki'] = 'http://testwiki.org/w/index.php';
</syntaxhighlight>

*The first bracket contains the name of the configuration setting.
*The second bracket contains the name of the bot or the wildcard "*" to apply the setting to all bots.
*The third bracket contains the wiki name or the wildcard "*" to apply the setting to all wikis.
If there is any conflict between a wildcarded setting and a more specific setting, the more specific setting will prevail. For example, suppose you have the following:
<syntaxhighlight lang="php">
$wikibotSetting['user']['*']['*'] = 'AwesomeBot';
$wikibotSetting['user']['TestBot']['Testwiki'] = 'TestBot';
</syntaxhighlight>
In this example, the TestBot setting would override the less specific AwesomeBot setting for purposes of commands such as this:
<syntaxhighlight lang="php">
$user = getWikibotSetting( 'user', 'TestBot', 'Testwiki' );
</syntaxhighlight>

==Sample bot==
Here is a sample bot that uses this framework to edit the page "Sandbox" on testwiki.org:

<syntaxhighlight lang="php">
<?php
# This bot logs in to testwiki.org and edits the sandbox to say "Hello world!"

error_reporting( E_ALL | E_STRICT );
include 'wikibot.classes.php'; /* The wikipedia classes. */

$bot = 'TestBot';
$wiki = 'Testwiki';

$wpapi	= new wikipediaapi ( '', '', '', $bot, $wiki, true );
$wpq	= new wikipediaquery ( '', '', '', $bot, $wiki, true );
$wpi	= new wikipediaindex ( '', '', '', $bot, $wiki, true );
$user = getWikibotSetting( 'user', $bot, $wiki );
$pass = getWikibotSetting( 'pass', $bot, $wiki );
if ( $wpapi->login( $user, $pass ) != 'true' ) {
    echo "Login failure";
    die();
}
sleep( 1 );

var_dump( $wpapi->edit( 'Sandbox', 'Hello world!', 'This is a test', false, false, null, null, false ) );
</syntaxhighlight>

==See also==
*[[w:User:ClueBot/Source]] &mdash; The [[w:User:ClueBot|ClueBot]] source, upon which this framework is based
*[[Manual:Wikibot/RPEDIRCBot]]
*[[Manual:Wikibot/UploadBot]]