Module:String/doc/ja

警告:	このページは複数のウィキ間で共有されています。 このページへのすべての変更は、左側のサイドバーに列挙されているすべてのウィキに自動的にコピーされます。

このモジュールは、基礎的な文字列関数へのアクセスを提供することを目的としています。

ここで提供されているほとんどの関数は、名前付きのパラメーター、無名のパラメーター、またはその混合で呼び出せます。 名前付きパラメーターが使用される場合、MediaWiki はパラメーターの先頭または末尾の空白類を自動的に除去します。 使用目的に応じて、そのような空白類を残したり、除去したりすることが有利な場合があります。

グローバル オプション

ignore_errors

trueまたは1を設定した場合、エラーが発生しても、エラーメッセージではなく空の文字列が返されます。

error_category

エラーが発生した際に、エラーメッセージに含めるカテゴリ名を指定します。 既定のカテゴリは Category:Errors reported by Module String です。

no_category

trueまたは1に設定すると、エラーが発生しても記事がカテゴリに追加されなくなります。

このモジュールの動作確認用ユニットはModule:String/testcasesで利用できます。

len

この関数は、対象となる文字列の長さを返します。

使用法：

{{#invoke:String|len|対象文字列}}

または

{{#invoke:String|len|s= 対象文字列 }}

パラメーター：

s

対象となる文字列

sub

この関数は、対象となる文字列から指定された一部分を切り出したものを返します。

使用法：

{{#invoke:String|sub|対象文字列|起点となる位置|終点となる位置}}

または

{{#invoke:String|sub|s= 対象文字列 |i= 起点となる位置 |j= 終点となる位置 }}

パラメーター：

s

一部分を切り出す対象となる文字列

i

切り出す箇所の最初の文字です。既定値は1です。

j

切り出す箇所の最後の文字です。既定値は最後の文字です。

文字列の最初の文字は1です。 iまたはjが負の値である場合、文字列の後ろから数えて文字を選択すると解釈されます。 従って、-1を指定すると、文字列の最後の文字を指定することになります。

入力された値が、与えられた文字列の長さの範囲を超えている場合、エラーを返します。

match

この関数は、対象となる文字列から、指定されたパターンに合致する部分を切り出したものを返します。

使用法：

{{#invoke:String|match|対象となる文字列|パターン|検索開始位置|返す箇所|平文フラグ|非合致時の出力}}

または

{{#invoke:String|match|s= 対象となる文字列 |pattern= パターン |start= 検索開始位置 |match= 返す箇所 |plain= 平文フラグ |nomatch= 非合致時の出力 }}

パラメーター：

s

検索する文字列

pattern

文字列の中から探すパターン、もしくは文字列

start

検索を開始する位置です。 文字列の最初の文字は1です。 既定値は1です。

match

場合によっては、1つの文字列内で複数回パターンに合致することがあります。 これはその中でどの合致した箇所を返すかを指定するもので、最初に合致したものであればmatch = 1という風に指定します。 負の数が指定された場合は、後ろから数えて返されます。 つまりmatch = -1と指定すると、一番最後に合致したパターンを返します。 既定値は1です。

plain

パターンをLua式の正規表現としてではなく、通常のテキストとして解釈させるためのブール値です。 既定値はfalseです。

nomatch

合致しなかった場合、エラーではなく "nomatch" に指定した文字列を返します。

matchまたはstartが、与えられた文字列の長さの範囲を超えている場合、エラーを返します。 また、合致するものが見つからない場合もエラーとなります。 パラメータにignore_errors=trueを追加すると、エラーが発生した場合はエラーではなく空の文字列を返します。

Lua式の正規表現の書き方については、以下のページを参照してください。

• Lua reference: Patterns - バージョン5.1時点の情報です。
• Scribuntoのパターン
• ScribuntoのUnicode文字列パターン

pos

この関数は、対象となる文字列から、posに指定された位置にある1文字を返します。

使用法：

{{#invoke:String|pos|対象文字列|文字の位置}}

または

{{#invoke:String|pos|target= 対象文字列 |pos= 文字の位置 }}

パラメーター：

target

検索する文字列

pos

返す文字の位置

最初の文字の位置は1です。

負の値を指定した場合は、文字列の後ろから数えて文字を返します。 つまり、pos = -1と指定すると最後の文字を返します。

指定された値が0、もしくは文字列の長さより大きい値だった場合、エラーを返します。

find

この関数は、対象となる文字列から、指定されたパターンに合致する箇所を検索できます。

使用法：

{{#invoke:String|find|元文字列|対象文字列|検索開始位置|平文フラグ}}

または

{{#invoke:String|find|source= 元文字列 |target= 対象文字列 |start= 検索開始位置 |plain= 平文フラグ }}

パラメーター：

source

検索される文字列

target

検索する文字列またはパターン

start

元文字列の検索を開始する位置です。既定値は1です。

plain

パターンをLua式の正規表現としてではなく、通常のテキストとして解釈させるためのブール値です。既定値はtrueです。

この関数は、startの位置から検索し始めて、sourceの中で最初にtargetが出て来る位置を返します。 文字の位置は、最初の文字を1として数えます。 targetが見つからない場合は、0を返します。 sourceまたtargetが欠落ないし空が指定されている場合も、0を返します。

This function should be safe for UTF-8 strings.

replace

この関数は、元の文字列から指定されたパターンに合致する箇所を検索し、その箇所を別の文字列に置き換えたものを返します。

使用法：

{{#invoke:String|replace|元文字列|パターン|置換先文字列|置換回数|平文フラグ}}

または

{{#invoke:String|replace|source= 元文字列 |pattern= パターン |replace= 置換先文字列 |count= 置換回数 |plain= 平文フラグ }}

パラメーター：

source

検索される文字列

pattern

検索する文字列またはパターン

replace

置換テキスト

count

置換する回数です。既定では全て置換します。

plain

パターンをScribuntoのUString式（Unicode対応のLua式の正規表現）としてではなく、通常のテキストとして解釈させるためのブール値です。既定値はtrueです。

rep

文字列をn回繰り返します。

使用法：

{{#invoke:String|rep|文字列|回数}}

パラメーター：

source

繰り返す文字列

count

繰り返す回数です。

例えば{{#invoke:String|rep|こんにちは|3}}は「こんにちはこんにちはこんにちは」を返します。