This Lua module is used in system messages, and onapproximately 5,030,000 pages, or roughly 8% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's/sandbox or/testcases subpages, or in your ownmodule sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on thetalk page before implementing them.
Thismodule is rated asbeta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected.
Thismodule is rated asready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned onhelp pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed throughsandbox testing rather than repeated trial-and-error editing.
This module contains functions to find the target of aredirect page.
Main
The main function accepts the name of a single page. It determines if the page is a redirect; if so it looks up the page, extracts the target, and returns the target name as text. Its usage is{{#invoke:redirect|main|page-name}}. Ifpage-name does not exist or is not a redirect thenpage-name is returned. Ifpage-name is blank then blank is returned.
The function normally neither takes nor gives square brackets, so to show the result as a link use[[{{#invoke:redirect|main|page-name}}]].
If the parameterbracket is given a nonblank value, brackets will be passed on if present.
Examples
{{#invoke:redirect|main|WP:AFC}} → Wikipedia:Articles for creation
If you want to use the main function from another Lua module, you may want to use the luaMain function. This provides the same functionality as the main function, but doesn't require that a frame object be available.
To use this, first load the module.
localmRedirect=require('Module:Redirect')
Then use the function with the following syntax:
mRedirect.luaMain(rname,bracket)
rname is the name of the redirect page, and ifbracket is anything but false or nil, the module will produce a link rather than just a page name.
IsRedirect
The isRedirect function is used from wiki pages to find out if a given page is a redirect or not. If the page is a redirect, the function returns "yes", and if not the output is blank. Its usage is{{#invoke:redirect|isRedirect|page-name}}.
Examples
{{#invoke:redirect|isRedirect|WP:AFC}} → yes
{{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}} →
{{#invoke:redirect|isRedirect|Wikipedia:Articles for rumination}} →
LuaIsRedirect
The isRedirect can be accessed from other Lua modules in the same way as the main function:
The getTarget function fetches the target page name of a redirect page, and is only usable from Lua. If the page specified is a redirect, then the target is returned; otherwise the function returns nil.
To use it, first load the module.
localmRedirect=require('Module:Redirect')
Then use the function with the following syntax:
mRedirect.getTarget(page)
page can be either the name of the redirect page as a string, or amw.title object.
See also
phab:T68974 - Provide a standard way to get the target of a redirect page
-- This module provides functions for getting the target of a redirect page.localp={}-- Gets a mw.title object, using pcall to avoid generating script errors if we-- are over the expensive function count limit (among other possible causes).localfunctiongetTitle(...)localsuccess,titleObj=pcall(mw.title.new,...)ifsuccessthenreturntitleObjelsereturnnilendend-- Gets the name of a page that a redirect leads to, or nil if it isn't a-- redirect.functionp.getTargetFromText(text)localtarget=string.match(text,"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)%]%]")orstring.match(text,"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)|[^%[%]]-%]%]")returntargetandmw.uri.decode(target,'PATH')end-- Gets the target of a redirect. If the page specified is not a redirect,-- returns nil.functionp.getTarget(page,fulltext)-- Get the title object. Both page names and title objects are allowed-- as input.localtitleObjiftype(page)=='string'ortype(page)=='number'thentitleObj=getTitle(page)elseiftype(page)=='table'andtype(page.getContent)=='function'thentitleObj=pageelseerror(string.format("bad argument #1 to 'getTarget'".." (string, number, or title object expected, got %s)",type(page)),2)endifnottitleObjthenreturnnilendlocaltargetTitle=titleObj.redirectTargetiftargetTitletheniffulltextthenreturntargetTitle.fullTextelsereturntargetTitle.prefixedTextendelsereturnnilendend--[[-- Given a single page name determines what page it redirects to and returns the-- target page name, or the passed page name when not a redirect. The passed-- page name can be given as plain text or as a page link.---- Returns page name as plain text, or when the bracket parameter is given, as a-- page link. Returns an error message when page does not exist or the redirect-- target cannot be determined for some reason.--]]functionp.luaMain(rname,bracket,fulltext)iftype(rname)~="string"ornotrname:find("%S")thenreturnnilendbracket=bracketand"[[%s]]"or"%s"rname=rname:match("%[%[(.+)%]%]")orrnamelocaltarget=p.getTarget(rname,fulltext)localret=targetorrnameret=getTitle(ret)ifrettheniffulltextthenret=ret.fullTextelseret=ret.prefixedTextendreturnbracket:format(ret)elsereturnnilendend-- Provides access to the luaMain function from wikitext.functionp.main(frame)localargs=require('Module:Arguments').getArgs(frame,{frameOnly=true})returnp.luaMain(args[1],args.bracket,args.fulltext)or''end-- Returns true if the specified page is a redirect, and false otherwise.functionp.luaIsRedirect(page)localtitleObj=getTitle(page)ifnottitleObjthenreturnfalseendiftitleObj.isRedirectthenreturntrueelsereturnfalseendend-- Provides access to the luaIsRedirect function from wikitext, returning 'yes'-- if the specified page is a redirect, and the blank string otherwise.functionp.isRedirect(frame)localargs=require('Module:Arguments').getArgs(frame,{frameOnly=true})ifp.luaIsRedirect(args[1])thenreturn'yes'elsereturn''endendreturnp
