当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/wp star rating」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ)
 
(関連項目: Category:wp3.8)
 
(他の1人の利用者による、間の2版が非表示)
1行目: 1行目:
 
{{Stub}}
 
{{Stub}}
  
== Description ==
+
<div id="Description">
Outputs a HTML element with the star rating exposed on a 0-5 scale in half star increments (i.e. 1, 1.5, 2 stars). Optionally, if specified, the number of ratings may also be displayed in the title attribute by passing the <tt>$number</tt> parameter.
+
== 説明 ==
 +
</div>
 +
0〜5 の 0.5 単位 (例: 星 1 個、 1.5 個、 2 個等) で表示される星の評価数を HTML エレメントとして出力します。オプションとして、評価数が指定されていれば、 <tt>$number</tt> パラメーターを引き渡すことでタイトル属性に表示させることも可能です。
  
By default, only works in admin screens.
+
デフォルトでは、管理画面でのみ使えるようになっています。
  
== Usage ==
+
<div id="Usage">
%%%<?php wp_star_rating( $args ); ?>%%%
+
== 使用法 ==
== Parameters ==
+
</div>
{{Parameter|$args|array|array of arguments|optional|0 stars}}
+
<?php wp_star_rating( $args ); ?>
=== Arguments ===
+
*'''rating''' - The numeric rating value 0-5 in 0.5 increments. (or 0-100 percent rating for percent type calls) Default 0.
+
*'''type''' - Acceptable values are 'percent' or the default 'rating'.
+
*'''number''' - Quantity of submitted ratings, displays as part of title attribute text on hover.
+
  
== Return Value ==
+
<div id="Parameters">
{{Return||none|directly echoes content}}
+
== パラメーター ==
 +
</div>
 +
{{Parameter|$args|array|引数の array|optional|星 0 個}}
  
Results in a star rating like this:
+
<div id="Arguments">
 +
=== 引数 ===
 +
</div>
 +
*'''rating''' - 数字の評価値。 0 から 5 まで 0.5 づつの増加 (または 0 から 100 パーセントの評価)。デフォルト値は 0。
 +
*'''type''' - <tt>'percent'</tt> または <tt>'rating'</tt>。デフォルト値は <tt>'rating'</tt>。
 +
*'''number''' - 送信された評価数。 タイトル属性のテキスト上に hover で表示される。
 +
 
 +
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
 +
{{Return||none|内容をそのまま戻す}}
 +
 
 +
星の評価結果は以下のように表示されます:
  
 
[[File:star-rating.png]]
 
[[File:star-rating.png]]
  
== Examples ==
+
<div id="Examples">
 +
== 例 ==
 +
</div>
 
<pre><? php $args = array(
 
<pre><? php $args = array(
 
   'rating' => 3.5,
 
   'rating' => 3.5,
31行目: 45行目:
 
</pre>
 
</pre>
  
The above code outputs the following HTML:
+
上記のコードは以下の HTML を出力します:
  
 
<pre><div class="star-rating" title="3.5 rating based on 1,234 ratings"><div class="star star-full"></div><div class="star star-full"></div><div class="star star-full"></div><div class="star star-half"></div><div class="star star-empty"></div></div>
 
<pre><div class="star-rating" title="3.5 rating based on 1,234 ratings"><div class="star star-full"></div><div class="star star-full"></div><div class="star star-full"></div><div class="star star-half"></div><div class="star star-empty"></div></div>
 
</pre>
 
</pre>
  
== Notes ==
+
<div id="Notes">
In order to use this function on the front end, your template must include the <tt>wp-admin/includes/template.php</tt> file and enqueue the appropriate dashicons CSS font information. Example CSS:
+
== 注 ==
 +
</div>
 +
この関数をフロントエンドで使用するためには、テンプレートが <tt>wp-admin/includes/template.php</tt> ファイルを含み、適切なダッシュアイコンの CSS フォント情報が enqueue されている必要があります。 CSS の例:
  
 
<pre style="overflow-x: auto;">
 
<pre style="overflow-x: auto;">
82行目: 98行目:
 
</pre>
 
</pre>
  
Note the font data in the above CSS has been omitted for clarity. This data must be included in working code. Refer to <tt>wp-admin/css/dashicons.css</tt>
+
説明を明確化するために、上記 CSS 内のフォントデータは省略されています。このデータは実働コードに含まれている必要があります。 <tt>wp-admin/css/dashicons.css</tt> を参照してください。
  
== Change Log ==
+
<div id="Change Log">
Since: [[Version 3.8|3.8]]
+
== 改訂履歴 ==
 +
</div>
 +
[[Version 3.8]] にて導入されました。
  
== Source File ==
+
<div id="Source File">
<tt>wp_star_rating()</tt> is located in {{Trac|wp-admin/includes/template.php|tags/{{CurrentVersion}}|0}}
+
== ソースファイル ==
 +
</div>
 +
<tt>wp_star_rating()</tt> {{Trac|wp-admin/includes/template.php}} にあります。
  
== Related ==
+
<div id="Related">
&nbsp;
+
== 関連項目 ==
 +
</div>
  
 +
[http://jameskoster.co.uk/work/using-wordpress-3-8s-dashicons-theme-plugin/ Using WordPress 3.8's dashicons in your theme or plugin - James Koster]
  
{{原文|wp_star_rating|140793}}<!--  19:31, January 26, 2014 Djkaz  版 -->
+
{{原文|Function_Reference/wp_star_rating|140793}}<!--  19:31, January 26, 2014 Djkaz  版 -->
 
+
  
 
{{Tag Footer}}
 
{{Tag Footer}}
[[Category:Functions]]
+
 
[[Category:New_page_created]]
+
[[Category:wp3.8]]

2015年5月12日 (火) 09:33時点における最新版

このページ「関数リファレンス/wp star rating」はまだ書きかけで、情報が不足しています。続きを書いて WordPress を手助けしましょう.


0〜5 の 0.5 単位 (例: 星 1 個、 1.5 個、 2 個等) で表示される星の評価数を HTML エレメントとして出力します。オプションとして、評価数が指定されていれば、 $number パラメーターを引き渡すことでタイトル属性に表示させることも可能です。

デフォルトでは、管理画面でのみ使えるようになっています。

使用法

<?php wp_star_rating( $args ); ?>

パラメーター

$args
array) (optional) 引数の array
初期値: 星 0 個

引数

  • rating - 数字の評価値。 0 から 5 まで 0.5 づつの増加 (または 0 から 100 パーセントの評価)。デフォルト値は 0。
  • type - 'percent' または 'rating'。デフォルト値は 'rating'
  • number - 送信された評価数。 タイトル属性のテキスト上に hover で表示される。

戻り値

(none) 
内容をそのまま戻す

星の評価結果は以下のように表示されます:

star-rating.png

<? php $args = array(
   'rating' => 3.5,
   'type' => 'rating',
   'number' => 1234,
);
wp_star_rating( $args ); ?>

上記のコードは以下の HTML を出力します:

<div class="star-rating" title="3.5 rating based on 1,234 ratings"><div class="star star-full"></div><div class="star star-full"></div><div class="star star-full"></div><div class="star star-half"></div><div class="star star-empty"></div></div>

この関数をフロントエンドで使用するためには、テンプレートが wp-admin/includes/template.php ファイルを含み、適切なダッシュアイコンの CSS フォント情報が enqueue されている必要があります。 CSS の例:

@font-face {
	font-family: "dashicons";
	src: url("../fonts/dashicons.eot");
}

@font-face {
	font-family: "dashicons";
	src: url(data:application/x-font-woff;charset=utf-8;base64,/* !! Large amount of data removed, see wp-includes/css/dashicons.css for complete data !! */) format("woff"),
		url("../fonts/dashicons.ttf") format("truetype"),
		url("../fonts/dashicons.svg#dashicons") format("svg");
	font-weight: normal;
	font-style: normal;
}

.star-rating .star-full:before {
    content: "\f155";
}

.star-rating .star-half:before {
    content: "\f459";
}

.star-rating .star-empty:before {
    content: "\f154";
}

.star-rating .star {
    color: #0074A2;
    display: inline-block;
    font-family: dashicons;
    font-size: 20px;
    font-style: normal;
    font-weight: 400;
    height: 20px;
    line-height: 1;
    text-align: center;
    text-decoration: inherit;
    vertical-align: top;
    width: 20px;
}

説明を明確化するために、上記 CSS 内のフォントデータは省略されています。このデータは実働コードに含まれている必要があります。 wp-admin/css/dashicons.css を参照してください。

改訂履歴

Version 3.8 にて導入されました。

ソースファイル

wp_star_rating()wp-admin/includes/template.php にあります。

Using WordPress 3.8's dashicons in your theme or plugin - James Koster

最新英語版: WordPress Codex » Function_Reference/wp_star_rating最新版との差分


関数リファレンステンプレートタグ目次もご覧ください。