とりさんのソフト屋さん

showRecommendationPage()の関数仕様

Recommendation PageプラグインのshowRecommendationPage()の関数仕様の説明。

使い方

 <?php showRecommendationPage( $tag_options=null, $show_options=null, $page_list=null); ?>

基本的に引数を与える必要はありません。

• $tag_options
  お勧めページリストを表示する際のHTMLタグを指定できます。
• $show_options
  お勧めページのタイトル・説明・moreリンク・表示数・複数/単一表示・デフォルト表示ページを管理画面の設定とは別に与えることが出来ます。
• $page_list
  お勧めページ・記事を独自に指定することが出来ます。

$tag_optionsの説明

文字列もしくは配列でオプションを渡します

• start

  一番初めに出力されるHTMLタグです。デフォルト:

  <ul>

• end

  一番最後に出力されるHTMLタグです。デフォルト:

  </ul>

• item_start

  各お勧めページの初めに出力されるタグです。デフォルト:

  <li>

• item_end

  各お勧めページの最後に出力されるタグです。デフォルト:

  </li>

• title_start
  お勧めページのタイトル表示の初めに出力されるタグです。デフォルト:無し
• title_end
  お勧めページのタイトル表示の最後に出力されるタグです。デフォルト:無し
• content_start
  お勧めページの説明表示の初めに出力されるタグです。デフォルト:無し
• content_end
  お勧めページの説明表示の最後に出力されるタグです。デフォルト:無し

以下の表のような順序で出力されます。

$show_optionsの説明

何も指定しない場合、管理画面の設定が使用されます。管理画面の設定とは違う表示の仕方をしたい場合にオプションの指定をしてください。

• rp_title(定数名:RP_TITLE)
  • 1: タイトルを出力しません(定数名:RP_TITLE_NOTHING)
  • 2: ページタイトルを出力します(定数名:RP_TITLE_PAGE)
  • 3: titleカスタムフィールドからタイトルを取得し出力します(定数名:RP_TITLE_ALLINONE)
  • 4: rp_titleカスタムフィールドからタイトルを取得し出力します(定数名:RP_TITLE_CUSTOM)
• rp_content(定数名:RP_CONTENT)

  指定した場合、後述のrp_contentpageやrp_contentpostに優先されます。ページや投稿記事の説明の表示の仕方を指定します。

  • 1: ページ説明を出力しません(定数名:RP_CONT_NOTHING)
  • 2: ページ説明にmoreを使用します(定数名:RP_CONT_MORE)
  • 3: ページ説明にページの全文を表示します(定数名:RP_CONT_ALL)
  • 4: ページ説明にdescriptionカスタムフィールドから説明を取得し表示します(定数名:RP_CONT_ALLINONE)
  • 5: ページ説明にrp_contentカスタムフィールドから説明を取得し表示します(定数名:RP_CONT_CUSTOM)
• rp_contentpage(定数名:RP_CONTENT_PAGE)
  • 1: ページ説明を出力しません(定数名:RP_CONT_NOTHING)
  • 2: ページ説明にmoreを使用します(定数名:RP_CONT_MORE)
  • 3: ページ説明にページの全文を表示します(定数名:RP_CONT_ALL)
  • 4: ページ説明にdescriptionカスタムフィールドから説明を取得し表示します(定数名:RP_CONT_ALLINONE)
  • 5: ページ説明にrp_contentカスタムフィールドから説明を取得し表示します(定数名:RP_CONT_CUSTOM)
• rp_contentpost(定数名:RP_CONTENT_POST)
  • 1: 投稿記事説明を出力しません(定数名:RP_CONT_NOTHING)
  • 2: 投稿記事説明にmoreを使用します(定数名:RP_CONT_MORE)
  • 3: 投稿記事説明に記事の全文を表示します(定数名:RP_CONT_ALL)
  • 4: 投稿記事説明にdescriptionカスタムフィールドから説明を取得し表示します(定数名:RP_CONT_ALLINONE)
  • 5: 投稿記事説明にrp_contentカスタムフィールドから説明を取得し表示します(定数名:RP_CONT_CUSTOM)
  • 6: 投稿記事説明に記事の抜粋から説明を取得し表示します(定数名:RP_CONT_ABSTRACT)
  • 7: 投稿記事説明に記事の抜粋から説明を取得しHTMLタグを取り除いて表示します(定数名:RP_CONT_ABSTRACT_NONHTML)
• rp_content_noc(定数名:RP_CONTENT_NUM)
  お勧めページ説明を出力する文字数を制限します。数値か空文字列にしてください。数値入力した場合は、HTMLタグは全て削除され文字数が制限されます。
• rp_multi(定数名:RP_MULTI)
  • 1: お勧めページを設定件数表示します。(定数名:RP_MULTI_MULTI)
  • 2: 最も多く選ばれた最初の1件しか表示しません。(定数名:RP_MULTI_SINGLE)
  • 3: 上位の選ばれたページから設定件数表示します。(定数名:RP_MULTI_MULTI_POP)
  • 4: ランダムで設定件数表示します。(定数名:RP_MULTI_RANDOM)
• rp_morelink_text(定数名:RP_MORE)
  お勧めページ説明の後に、お勧めページへのリンクに表示される文字列です。文字列で指定します。空文字列の場合は表示されません。
• rp_default_pages(定数名:RP_DEFAULT_PAGES)
  文字列でお勧めページが記事に設定されていない場合のデフォルトで表示するページをIDで指定します。(例: 23,28,50)
• rp_max(定数名:RP_MAX)
  数字でお勧めページの最大表示件数を指定します。

$page_listの説明

ページもしくは記事IDを,(カンマ)で連結した文字列で渡します。お勧めページとして強制的にこの引数で渡したページリストを表示することが出来ます。

使い方の例

最も選択されているページや記事から3件、ページは＜!–more–＞まで記事は抜粋を表示します。

<?php showRecommendationPage(null,'rp_multi=3&rp_contentpage=2&rp_contentpost=6&rp_max=3'); ?>

タイトルをh3タグで囲み、ランダムで3件本文無しで出力します。

<?php showRecommendationPage('start=&end=&item_start=&item_end=&title_start=<h3>&title_end=</h3>&content_start=&content_end=','rp_multi=4&rp_contentpost=1&rp_contentpage=1&rp_max=3'); ?>

ページID、357と517を強制的に出力しています。

<?php showRecommendationPage( null, null, '357,517'); ?>