wp_star_rating()

WordPressのwp_star_rating()関数は、評価の星マークを表示するために使用されます。この関数は主にレビューや評価を視覚的に表現したい場合に使用されます。

構文

wp_star_rating( array $args = array() );

引数の説明

• $args (array) — 評価の星をカスタマイズするための引数の配列。

使用可能な$argsのキー:

• rating (float) — 評価の数値 (0〜5)。
• type (string) — 評価の種類。デフォルトは'rating'。
• number (int) — 評価に基づく投票数。
• echo (bool) — HTMLを出力するかどうか。デフォルトはtrue。

例 1: 基本的な星評価の表示

以下のコードはデフォルト設定で星評価を表示します。

<?php wp_star_rating( array( 'rating' => 4.5 ) ); ?>

例 2: 投票数を含む星評価の表示

評価に基づく投票数を追加表示します。

<?php wp_star_rating( array( 'rating' => 3.8, 'number' => 125 ) ); ?>

例 3: カスタム評価タイプの使用

カスタムタイプを指定して星評価を表示します。

<?php wp_star_rating( array( 'rating' => 4.2, 'type' => 'custom_type' ) ); ?>

例 4: HTML出力を無効にして結果を取得

評価のHTMLを出力せずに変数として取得します。

<?php
$html = wp_star_rating( array( 'rating' => 4.0, 'echo' => false ) );
echo $html;
?>

例 5: 投稿メタデータから評価を取得

投稿メタデータを使用して動的に星評価を表示します。

<?php
$rating = get_post_meta( get_the_ID(), 'post_rating', true );
wp_star_rating( array( 'rating' => $rating ) );
?>

注意事項

• 評価値は必ず0〜5の範囲内で指定してください。
• echoをfalseに設定すると、HTML出力は行われず、戻り値として結果が返されます。
• この関数はデフォルトのスタイルが適用されますが、必要に応じてCSSを使用してカスタマイズできます。