/functions.php

Description

Literally WordPressのユーザー関数

Functions
lwp_ammount (line 50)
  • deprecated:
type lwp_ammount ([type $post = null])
  • type $post
lwp_bought_books (line 528)

購入した電子書籍のリストを返す

array lwp_bought_books ([string $status = "SUCCESS"], [int $user_id = null])
  • string $status: (optional) SUCCESS, Cancel, Errorのいずれか
  • int $user_id: (optional) 指定しない場合は現在のユーザー
lwp_buy_now (line 597)

購入ボタンを出力する

  • since: 0.3
void lwp_buy_now ([mixed $post = null], [string $btn_src = false])
  • mixed $post: (optional) 投稿オブェクトまたは投稿ID。ループ内では指定する必要はありません。
  • string $btn_src: (optional) 購入ボタンまでのURL nullを渡すと画像ではなくaタグになる
lwp_campaign_end (line 100)

キャンペーンの終了日を返す

string lwp_campaign_end ([object $post = null], [boolean $timestamp = false])
  • object $post: (optional)
  • boolean $timestamp: (optional) タイムスタンプ型で取得する場合はtrue
lwp_campaign_timer (line 633)

キャンペーンの終了日時をタグにして返す

string lwp_campaign_timer ([object $post = null], [ $prefix = null])
  • object $post
  • $prefix
lwp_currency_code (line 150)

現在設定されている通貨記号を返す

  • since: 0.8
string lwp_currency_code ()
lwp_currency_symbol (line 160)

現在設定されている通貨の実態を返す

string lwp_currency_symbol ()
lwp_discout_rate (line 678)

セール中の値引き率を返す

  • since: 0.8
string lwp_discout_rate ([object $post = null])
  • object $post
lwp_file_accessible (line 405)

ファイルオブジェクトを受け取り、それが現在のユーザーにとって アクセス可能かを返す

boolean lwp_file_accessible (object $file)
  • object $file
lwp_file_link (line 247)

ファイルへのリンクを返す

  • since: 0.3
string lwp_file_link (int $file_id)
  • int $file_id
lwp_get_accessibility (line 380)

ファイルのアクセス権を返す

  • return: owner, member, any, noneのいずれか
string lwp_get_accessibility (object $file)
  • object $file: ファイルオブジェクト
lwp_get_date (line 430)

ファイルの最終更新日を返す

string|void lwp_get_date (object $file, [boolean $registered = true], [boolean $echo = true])
  • object $file: ファイルオブジェクト
  • boolean $registered: (optional) 最終更新日ではなく登録日を欲しい場合はfalse
  • boolean $echo: (optional) 出力したくない場合はfalse
lwp_get_devices (line 297)

電子書籍のデバイス登録情報を返す

  • return: デバイス情報の配列。各要素はname(string), slug(string), valid(boolean)のキーを持つ
array lwp_get_devices ([ $post = null], object $post(optional))
  • object $post(optional): 投稿オブジェクト。指定しない場合は現在の投稿
  • $post
lwp_get_device_table (line 494)

対応端末のテーブルを返す

  • since: 0.8
string lwp_get_device_table ([object $post = null])
  • object $post
lwp_get_ext (line 281)

ファイルの拡張子を返す

string lwp_get_ext (object $file)
  • object $file
lwp_get_files (line 221)

投稿に所属するファイルを返す

array lwp_get_files ([string $accessibility = "all"], [object $post = null])
  • string $accessibility: (optional) ファイルのアクセス権限 all, owner, member, any
  • object $post: (optional)
lwp_get_file_devices (line 346)

ファイルオブジェクトを受け取り、対応しているデバイスを返す

  • return: デバイス名の配列。$slugをtrueにした場合、各要素は文字列ではなくnameとslugをキーに持つ配列となる。
array lwp_get_file_devices (object $file, [ $slug = false], boolean $slug(optional))
  • object $file
  • boolean $slug(optional): デバイスのスラッグが欲しい場合はtrue
  • $slug
lwp_get_file_list (line 447)

登録されているファイルのリストを返す

string lwp_get_file_list ([string $accessibility = "all"], [object $post = null])
  • string $accessibility
  • object $post
lwp_get_size (line 258)

ファイルサイズを取得する

string lwp_get_size (object $file)
  • object $file
lwp_get_tran (line 560)

投稿に紐づいたユーザーの購入詳細を返す

object lwp_get_tran (int $book_id, [int $user_id = null])
  • int $book_id
  • int $user_id: (optional) 指定しない場合は現在のユーザー
lwp_isbn (line 61)

電子書籍のISBNを返す

  • deprecated:
string lwp_isbn ([object $post = null])
  • object $post: (optional)ループ内で引数なしで使用すると、表示中の電子書籍のISBNを返します。
lwp_is_canceled (line 746)

購入がキャンセルされたか否かを返す。

  • deprecated:
boolean lwp_is_canceled ()
lwp_is_free (line 36)

対象とする電子書籍が0円かどうかを返す

ループ内で使用した場合は現在の投稿。

boolean lwp_is_free ([boolean $original = false], [object $post = null])
  • boolean $original: (optional) trueの場合は定価が無料のものを返す。falseの場合はキャンペーン期間を含める
  • object $post: (optional) 現在の投稿オブジェクト
lwp_is_owner (line 21)

ユーザーが電子書籍を所有しているか否かを返す

ループ内で引数なしで利用すると、現在ログイン中のユーザーが表示中の 電子書籍を購入済みかどうかを判断します。

  • since: 0.2
boolean lwp_is_owner ([object|int $post = null], [int $user_id = null])
  • object|int $post: (optional) 投稿オブジェクト
  • int $user_id: (optional) ユーザーID
lwp_is_sample (line 71)

指定された電子書籍ファイルオブジェクトが無料のものかどうかを返す

boolean lwp_is_sample (object $file)
  • object $file
lwp_is_success (line 760)

購入を完了して、成功したか否かを返す

  • deprecated:
boolean lwp_is_success ()
lwp_is_transaction_error (line 772)

購入処理にエラーがあったか否かを返す

  • deprecated:
boolean lwp_is_transaction_error ()
lwp_on_sale (line 86)

指定された投稿が指定された日付にキャンペーンを行っているかを返す

ループ内で引数なしで使用すると、現在表示してるいる投稿がキャンペーン中か否かを示す

booelan lwp_on_sale ([object|int $post = null], [string $time = null])
  • object|int $post
  • string $time
lwp_original_price (line 208)

電子書籍の定価を返す

int lwp_original_price ([object $post = null])
  • object $post: (optional)ループ内で引数なしで使用すると、表示中の電子書籍の定価を返します。
lwp_price (line 127)

電子書籍の価格を返す

ループ内で引数なしで使用すると、表示中の電子書籍の定価を返します。 キャンペーン中はキャンペーン価格を返します。

int lwp_price ([object $post = null])
  • object $post: (optional)
lwp_show_form (line 698)

購入用のフォームを返す

string lwp_show_form ([object $post = null], [string $btn_src = null])
  • object $post
  • string $btn_src: (optional) Src of "buy now" button.
lwp_the_price (line 172)

現在の価格を通貨記号付きで返す

  • since: 0.8
void lwp_the_price ([object $post = null])
  • object $post
lwp_user_bought_price (line 573)

ユーザーがこれまでに購入した総額を返す

void lwp_user_bought_price ([ $user_id = null])
  • $user_id
_lwp_post_meta (line 184)

電子書籍のカスタムフィールドを返す

string _lwp_post_meta (string $key, [int|object (optional) $post = null], [boolean $single = true])
  • string $key
  • boolean $single: (optional) 配列で取得する場合はfalse
  • int|object (optional) $post: ループ内で使用した場合は現在のポスト

Documentation generated on Wed, 17 Aug 2011 15:35:07 +0900 by phpDocumentor 1.4.3