PHPackages                             hamstar/wikimate - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. hamstar/wikimate

ActiveLibrary[API Development](/categories/api)

hamstar/wikimate
================

Wikimate is a wrapper for the MediaWiki API that aims to be very easy to use.

v1.1.0(2y ago)6124.1k↓31.6%26[13 issues](https://github.com/hamstar/Wikimate/issues)MITPHP

Since Jun 13Pushed 1y ago7 watchersCompare

[ Source](https://github.com/hamstar/Wikimate)[ Packagist](https://packagist.org/packages/hamstar/wikimate)[ Docs](https://github.com/hamstar/Wikimate)[ RSS](/packages/hamstar-wikimate/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (1)Versions (10)Used By (0)

Wikimate
========

[](#wikimate)

Wikimate is a PHP wrapper for the [MediaWiki Action API](https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page)that aims to be very easy to use. It currently consists of three classes:

- **Wikimate** – Serves as a loader and manager for different wiki objects (e.g. pages).
- **WikiPage** – Provides an interface to getting/editing pages or sections of them.
- **WikiFile** – Provides an interface to downloading/uploading files and getting their properties.

The [latest released version](https://github.com/hamstar/Wikimate/releases) of Wikimate is v1.1.0, released on July 30, 2023. It requires PHP v5.3 or newer and MediaWiki v1.27 or newer. See [CHANGELOG.md](CHANGELOG.md) for the detailed version history.

Installation
------------

[](#installation)

**Requirements: [PHP](https://php.net), and [Composer](https://getcomposer.org).**

Before anything else, since Wikimate is written in PHP, a server-side language, you will need to have PHP installed to run it. Install it with your preferred package management tool (for example, on Ubuntu Linux you can run: `sudo apt-get install php`)

The recommended way to install this library is with Composer. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.

Install Composer by following the instructions [here](https://getcomposer.org/doc/00-intro.md).

Then, run the following command in your project's folder to download Wikimate and initialise it:

```
composer require hamstar/Wikimate
```

(or `composer.bat require hamstar/Wikimate` if you're on Windows).

To use Wikimate within another project, you can add it as a Composer dependency by adding the following to your existing `composer.json` file:

```
{
    "require": {
        "hamstar/Wikimate": "^1.1"
    }
}
```

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at [getcomposer.org](https://getcomposer.org).

Usage
-----

[](#usage)

In your script file (e.g. `index.php`), include the project's `autoload.php` file, and create a new `Wikimate` object with the target wiki's API address. Then provide a username and password to Wikimate's `login` method, to log in to that wiki.

```
require __DIR__.'/vendor/autoload.php';

$api_url = 'https://example.com/w/api.php';
$username = 'bot';
$password = 'password';

$wiki = new Wikimate($api_url);

// You can also pass the domain name:
// $wiki->login($username, $password, $domainName)
if ($wiki->login($username, $password))
	echo 'Success: user logged in.' ;
else {
	$error = $wiki->getError();
	echo "Wikimate error: ".$error['auth'];
}
```

This example uses echo statements to output any potential errors. You should get a meaningful error message if the authentication fails. Assuming you were able to log in, you're now ready to fully use the API.

See [USAGE.md](USAGE.md) for detailed example code to perform common tasks.

Contributing
------------

[](#contributing)

As an open source project, Wikimate welcomes community contributions. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute.

License
-------

[](#license)

This project is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for details.

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance23

Infrequent updates — may be unmaintained

Popularity42

Moderate usage in the ecosystem

Community24

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 57.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~417 days

Recently: every ~189 days

Total

9

Last Release

1023d ago

Major Versions

v0.15.0 → v1.0.02021-09-05

### Community

Maintainers

![](https://www.gravatar.com/avatar/01380bcf65defbd54ec6500c688c442d3ef1e40920722a4fbd7c221356ce09ca?d=identicon)[galtomer](/maintainers/galtomer)

---

Top Contributors

[![Xymph](https://avatars.githubusercontent.com/u/22516539?v=4)](https://github.com/Xymph "Xymph (203 commits)")[![waldyrious](https://avatars.githubusercontent.com/u/478237?v=4)](https://github.com/waldyrious "waldyrious (94 commits)")[![hamstar](https://avatars.githubusercontent.com/u/141157?v=4)](https://github.com/hamstar "hamstar (32 commits)")[![samwilson](https://avatars.githubusercontent.com/u/213655?v=4)](https://github.com/samwilson "samwilson (8 commits)")[![MhdSyrwan](https://avatars.githubusercontent.com/u/730201?v=4)](https://github.com/MhdSyrwan "MhdSyrwan (7 commits)")[![nineff](https://avatars.githubusercontent.com/u/3100873?v=4)](https://github.com/nineff "nineff (3 commits)")[![zserghei](https://avatars.githubusercontent.com/u/3897530?v=4)](https://github.com/zserghei "zserghei (1 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![devlet](https://avatars.githubusercontent.com/u/2111730?v=4)](https://github.com/devlet "devlet (1 commits)")[![wyster](https://avatars.githubusercontent.com/u/341694?v=4)](https://github.com/wyster "wyster (1 commits)")[![zhaofengli](https://avatars.githubusercontent.com/u/2189609?v=4)](https://github.com/zhaofengli "zhaofengli (1 commits)")[![bennlich](https://avatars.githubusercontent.com/u/704368?v=4)](https://github.com/bennlich "bennlich (1 commits)")

### Embed Badge

![Health badge](/badges/hamstar-wikimate/health.svg)

```
[![Health](https://phpackages.com/badges/hamstar-wikimate/health.svg)](https://phpackages.com/packages/hamstar-wikimate)
```

###  Alternatives

[razorpay/razorpay

Razorpay PHP Client Library

2024.8M44](/packages/razorpay-razorpay)[pubnub/pubnub

This is the official PubNub PHP SDK repository.

1314.6M17](/packages/pubnub-pubnub)[culqi/culqi-php

Cliente Culqi API para PHP

41356.8k1](/packages/culqi-culqi-php)[ahmadawais/sendy-php-api

Sendy PHP API Wrapper: Complete API interfacing.

8673.5k](/packages/ahmadawais-sendy-php-api)[epayco/epayco-php

Epayco API client for PHP

25187.2k3](/packages/epayco-epayco-php)[yunchuang/appstore-connect-api

sdk for appstore connect api

3865.3k](/packages/yunchuang-appstore-connect-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)