Module:IPAddress/doc

This is a documentation subpage for Module:IPAddress.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used in MediaWiki:Newarticletext and MediaWiki:Blockedtext, and on approximately 192,000 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 own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This module can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

Functions are not "local", so other modules can require this module and call them directly. We return an object with 3 small stub functions to call the real ones so that the functions can be called from templates also.

Only dotted decimal notation for IPv4 supported. Does not support dotted hexadecimal, dotted octal, or single-number formats (see IPv4#Address_representations).

Unit tests at Module:IPAddress/testcases