API:Langbacklinks

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki version: 1.18

GET request to find all pages that link to the given language link.

API documentation[edit]


(main | query | langbacklinks)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that link to the given language link.

Can be used to find all links with a language code, or all links to a title (with a given language). Using neither parameter is effectively "all language links".

Note that this may not consider language links added by extensions.

Parameters:
lbllang

Language for the language link.

lbltitle

Language link to search for. Must be used with lbllang.

lblcontinue

When more results are available, use this to continue.

lbllimit

How many total pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
lblprop

Which properties to get:

lllang
Adds the language code of the language link.
lltitle
Adds the title of the language link.
Values (separate with | or alternative): lllang, lltitle
Default: (empty)
lbldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

Example[edit]

GET request[edit]

Get pages linking to a given language link.

Response[edit]

{
    "batchcomplete": "",
    "query": {
        "langbacklinks": []
    }
}

Sample code[edit]

Python[edit]

#!/usr/bin/python3

"""
    langbacklinks.py
    MediaWiki API Demos
    Demo of `Langbacklinks` module: Get pages linking to a given language link
    MIT License
"""

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

PARAMS = {
    "action": "query",
    "list": "langbacklinks",
    "lbltitle": "Test",
    "lbllang": "fr",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

print(DATA)

PHP[edit]

<?php

/*
    langbacklinks.php
    MediaWiki API Demos
    Demo of `Langbacklinks` module: Get pages linking to a given language link
    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "query",
    "list" => "langbacklinks",
    "lbltitle" => "Test",
    "lbllang" => "fr",
    "format" => "json"
];

$url = $endPoint . "?" . http_build_query( $params );

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );

$result = json_decode( $output, true );
var_dump( $result );

JavaScript[edit]

/*
    langbacklinks.js
    MediaWiki API Demos
    Demo of `Langbacklinks` module: Get pages linking to a given language link
    MIT License
*/

var url = "https://en.wikipedia.org/w/api.php"; 

var params = {
    action: "query",
    list: "langbacklinks",
    lbltitle: "Test",
    lbllang: "fr",
    format: "json"
};

url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});

fetch(url)
    .then(function(response){return response.json();})
    .then(function(response) {console.log(response);})
    .catch(function(error){console.log(error);});

MediaWiki JS[edit]

/*
	langbacklinks.js
	MediaWiki API Demos
	Demo of `Langbacklinks` module: Get pages linking to a given language link
	MIT License
*/

var params = {
		action: 'query',
		list: 'langbacklinks',
		lbltitle: 'Test',
		lbllang: 'fr',
		format: 'json'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	console.log( data );
} );

Possible errors[edit]

Code Info
missingparam The lang parameter must be set.

Parameter history[edit]

  • v1.20: Introduced dir

Additional notes[edit]

  • This module can be used to find all pages that link to the given language link. It finds all links using a language code, or all links to a given title (with a given language). Using neither parameter is effectively All Language Links.

See also[edit]

  • API:Links - Returns all links from the given pages.
  • API:Langlinks - Gets a list of all language links from the provided pages to other languages.