• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「テンプレート:Parameter」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(関数のパラメータ説明テンプレ。en:Template:Parameter 02:54, 13 January 2008 HEngel 版をコピー)
 
(日本語に合わせて修正、ざっくりとテンプレートの使い方を説明。)
1行目: 1行目:
 
; <tt>{{{1}}}</tt>
 
; <tt>{{{1}}}</tt>
: (''{{{2}}}'') (''{{{4|required}}}'') {{{3}}}
+
: ''{{{2}}}'') (''{{{4|必須}}}''{{{3}}}
:: Default: {{{5|''None''}}}<noinclude>
+
:: 初期値: {{{5|''なし''}}}<noinclude>
== Notes ==
+
 
This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called:
+
<div class="template-description">
<pre><nowiki>{{Parameter|$something|string|This is a string.|optional|bah}}</nowiki></pre>
+
== このテンプレートの説明 ==
The usage of this template is below:
+
<!-- This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: -->
 +
この[[Project:Template 一覧|テンプレート]]は、関数リファレンスやテンプレートタグのパラメータ説明を整形して表示するものです。<br />
 +
テンプレートの呼び方の例:
 +
<pre><nowiki>{{Parameter|パラメータ名|文字列|ここに説明文。|任意|ここに初期値}}</nowiki></pre>
 +
 
 +
<!-- The usage of this template is below: -->
 +
使い方:
 
<pre><nowiki>{{Parameter|name|datatype|description|importance|default}}</nowiki></pre>
 
<pre><nowiki>{{Parameter|name|datatype|description|importance|default}}</nowiki></pre>
Let's take a closer look at the parameters..
+
 
; name
+
<!-- Let's take a closer look at the parameters.. -->
: The name of the parameter.
+
パラメータの説明:
; datatype
+
; 1. name
: The datatype that should be given for this parameter when called.
+
: <!-- The name of the parameter. -->パラメータ名
; description
+
; 2. datatype
: A short description of the parameter.
+
: <!-- The datatype that should be given for this parameter when called. -->そのパラメータの[[テンプレートタグ/タグパラメータの渡し方#Types_of_parameters|型]] (以下の日本語名は[http://www.php.net/manual/ja/language.types.intro.php PHPマニュアル]に倣ってみました)
; importance
+
:* boolean: 論理値
: Set this parameter to ''optional'' if the parameter is optional. Otherwise, do not declare this parameter—it defaults to ''required''.
+
:* integer: 整数
; default
+
:* string: 文字列
: If this parameter is optional, <tt>default</tt> is the value that will be used if the parameter is not declared.
+
:* array: 配列
 +
; 3. description
 +
: <!-- A short description of the parameter. -->パラメータの説明
 +
; 4. importance
 +
: <!-- Set this parameter to ''optional'' if the parameter is optional. Otherwise, do not declare this parameter—it defaults to ''required''.-->任意のパラメータである場合は「任意」と入力。入力しないときの初期値は「必須」。
 +
; 5. default
 +
: <!-- If this parameter is optional, <tt>default</tt> is the value that will be used if the parameter is not declared. -->任意のパラメータである場合に、このパラメータが指定されなかったときの初期値。
  
 
{{原文|Template:Parameter|53035}}<!-- 02:54, 13 January 2008 HEngel 版 -->
 
{{原文|Template:Parameter|53035}}<!-- 02:54, 13 January 2008 HEngel 版 -->
  
 
[[en:Template:Parameter]]
 
[[en:Template:Parameter]]
 +
</div>
 
</noinclude>
 
</noinclude>

2010年3月3日 (水) 20:27時点における版

{{{1}}}
{{{2}}}) (必須) {{{3}}}
初期値: なし

このテンプレートの説明

このテンプレートは、関数リファレンスやテンプレートタグのパラメータ説明を整形して表示するものです。
テンプレートの呼び方の例:

{{Parameter|パラメータ名|文字列|ここに説明文。|任意|ここに初期値}}

使い方:

{{Parameter|name|datatype|description|importance|default}}

パラメータの説明:

1. name
パラメータ名
2. datatype
そのパラメータの (以下の日本語名はPHPマニュアルに倣ってみました)
  • boolean: 論理値
  • integer: 整数
  • string: 文字列
  • array: 配列
3. description
パラメータの説明
4. importance
任意のパラメータである場合は「任意」と入力。入力しないときの初期値は「必須」。
5. default
任意のパラメータである場合に、このパラメータが指定されなかったときの初期値。

最新英語版: WordPress Codex » Template:Parameter最新版との差分