概要
Options APIは、データベースにデータを保存するためのシンプルで標準化された方法です。このAPIを使用すると、オプションの作成、アクセス、更新、削除が簡単に行えます。すべてのデータは、指定されたカスタム名の下でwp_optionsテーブルに保存されます。
このページには、Options APIを使用するために必要な技術文書が含まれています。デフォルトのオプションのリストは、オプションリファレンスにあります(Codexバージョンへのリンク、HelpHubへのコンテンツ移行を待っています)。
_site_
関数は、基本的にその対応する関数と同じです。唯一の違いは、WP Multisiteの場合で、オプションがネットワーク全体に適用され、データが指定されたカスタム名の下でwp_sitemetaテーブルに保存されることです。
関数リファレンス
オプションの追加/削除:
オプションの取得/更新:
例
// Create an option to the database
add_option( $option, $value = , $deprecated = , $autoload = 'yes' );
// Removes option by name.
delete_option( $option );
// Fetch a saved option
get_option( $option, $default = false );
// Update the value of an option that was already added.
update_option( $option, $newvalue );
カテゴリ別の利用可能なオプション
ディスカッション
blacklist_keys
: コメントにこれらの単語が含まれている場合、そのコメントはスパムとしてマークされます。1行につき1つの単語またはIP。単語の内部でも一致するため、「press」は「WordPress」と一致します。
デフォルト: NULL
データ型:文字列(複数行の可能性あり)comment_max_links
: このオプションの値以上を含む場合、コメントをキューに保持します。
デフォルト: 2
データ型:整数comment_moderation
: コメントが表示される前に、管理者が常にそのコメントを承認する必要があります。
1:はい
0:いいえ(デフォルト)
データ型:整数comments_notify
: 誰かがコメントを投稿したときに私にメールを送信します。
1:はい(デフォルト)
0:いいえ
データ型:整数default_comment_status
: コメントを許可します(個別の投稿で上書き可能)
open: コメントを許可(デフォルト)
closed: コメントを禁止
データ型:文字列default_ping_status
: 他のブログからのリンク通知を許可します(ピンバックとトラックバック)。
open: 他のブログからのピンバックとトラックバックを許可(デフォルト)
closed: 他のブログからのピンバックとトラックバックを禁止
データ型:文字列default_pingback_flag
: 記事からリンクされているブログに通知を試みます(投稿が遅くなります)。
1:はい(デフォルト)
0:いいえ
データ型:整数moderation_keys
: コメントにこれらの単語が含まれている場合、そのコメントはモデレーションキューに保持されます。1行につき1つの単語またはIP。単語の内部でも一致するため、「press」は「WordPress」と一致します。
デフォルト: NULL
データ型:文字列(複数行の可能性あり)moderation_notify
: コメントがモデレーションのために保持されているときに私にメールを送信します。
1:はい(デフォルト)
0:いいえ
データ型:整数require_name_email
: コメントが表示される前に、コメントの著者は自分の名前とメールを記入する必要があります。
1:はい(デフォルト)
0:いいえ
データ型:整数thread_comments
: WPネイティブのスレッド(ネスト)コメントを有効にします。
1:はい
0:いいえ(デフォルト)
データ型:整数thread_comments_depth
: コメントのスレッドレベルの数を設定します。
1から
10: レベル
デフォルト: 5
データ型:整数show_avatars
: アバター表示
1:(デフォルト)アバターを表示
0:アバターを表示しない
データ型:整数avatar_rating
: 最大評価
G:(デフォルト)すべての視聴者に適しています
PG:おそらく攻撃的、通常は13歳以上の視聴者向け
R:17歳以上の成人向け
X:さらに成熟した内容
データ型:文字列avatar_default
: デフォルトアバター
mystery:(デフォルト)ミステリーマン
blank:空白
gravatar_default:Gravatarロゴ
identicon:Identicon(生成)
wavatar:Wavatar(生成)
monsterid:MonsterID(生成)
retro:Retro(生成)
データ型:文字列close_comments_for_old_posts
: 古い記事のコメントを自動的に閉じる
1:はい
0:いいえ(デフォルト)
データ型:整数close_comments_days_old
: x日以上古い記事のコメントを自動的に閉じる
デフォルト: 14
データ型:整数show_comments_cookies_opt_in
: コメントフォームにクッキーのオプトインチェックボックスを表示し、コメントクッキーを有効にします
1:はい(4.9.8以降のデフォルト)
0:いいえ
データ型:整数page_comments
: コメントをページに分割します
1:はい(デフォルト)
0:いいえ
データ型:整数comments_per_page
:
デフォルト: 50
データ型:整数default_comments_page
:
デフォルト: ‘newest’
データ型:文字列comment_order
:
asc:(デフォルト)
desc:
データ型:文字列comment_whitelist
: コメントの著者は以前に承認されたコメントを持っている必要があります
1:はい(デフォルト)
0:いいえ
データ型:
一般
admin_email
:管理者のメール
デフォルト: ‘[email protected]’
データ型:文字列blogdescription
:ブログのキャッチフレーズ
デフォルト: ‘__(‘Just another WordPress weblog’)’
データ型:文字列blogname
:ブログのタイトル
デフォルト: ‘__(‘My Blog’)’
データ型:文字列comment_registration
: コメントするにはユーザーが登録し、ログインする必要があります
1:はい
0:いいえ(デフォルト)
データ型:整数date_format
:デフォルトの日付形式
デフォルト: ‘__(‘F j, Y’)’
データ型:文字列default_role
: ブログに登録するユーザーのデフォルトの役割。
subscriber(デフォルト)
administrator
editor
author
contributor
データ型:文字列gmt_offset
: ブログ内の時間はこの値によって異なる必要があります。
-6:GMT -6(中央時間、米国)
0:GMT(グリニッジ標準時)
デフォルト:date(‘Z’) / 3600
データ型:整数home
:ブログのアドレス(URL)
デフォルト: wp_guess_url()
データ型:文字列(URI)
データ型:文字列(URI)デフォルト `````wp_guess_url()
start_of_week
: 週の開始日。
0:日曜日
1:月曜日(デフォルト)
2:火曜日
3:水曜日
4:木曜日
5:金曜日
6:土曜日
データ型:整数time_format
: デフォルトの時間形式
デフォルト: ‘__(‘g:i a’)’
データ型:文字列timezone_string
: タイムゾーン
デフォルト: NULL
データ型:文字列users_can_register
: 誰でも登録可能
1:はい
0:いいえ(デフォルト)
データ型:整数
リンク
データ型:文字列デフォルト `````('F j, Y g:i a')
links_recently_updated_prepend
:
デフォルト 空
データ型:文字列links_recently_updated_append
デフォルト 空
データ型:文字列links_recently_updated_time
デフォルト: 120
データ型:整数
メディア
thumbnail_size_w
:
デフォルト: 150
データ型:整数thumbnail_size_h
:
デフォルト: 150
データ型:整数thumbnail_crop
: サムネイルを正確な寸法にトリミングします(通常、サムネイルは比率に基づいています)
1:はい(デフォルト)
0:いいえ
データ型:整数medium_size_w
:
デフォルト: 300
データ型:整数medium_size_h
デフォルト: 300
データ型:整数large_size_w
デフォルト: 1024
データ型:整数large_size_h
デフォルト: 1024
データ型:整数embed_autourls
: すべてのプレーンテキストURLを自動的に埋め込むことを試みます
デフォルト: 1
データ型:整数embed_size_w
デフォルト: NULL
データ型:整数embed_size_h
デフォルト: 600
データ型:整数
その他
hack_file
:レガシーmy-hacks.php
ファイルサポートを使用します
1:はい
0:いいえ(デフォルト)
データ型:整数html_type
:ブログページのデフォルトMIMEタイプ(text/html,text/xml+htmlなど)
デフォルト: ‘text/html’
データ型:文字列(MIMEタイプ)secret
: インストール中に作成された秘密の値で、塩漬けなどに使用されます。
デフォルト: wp_generate_password(64)
データ型:文字列(MD5)upload_path
: このフォルダーにアップロードを保存します(WordPressルートに対して相対的)
デフォルト: NULL
データ型:文字列(相対パス)upload_url_path
: アップロードフォルダーへのURLパス(デフォルトでは空になります - 「すべての設定」画面で編集可能)
データ型:文字列(URLパス)uploads_use_yearmonth_folders
: アップロードを月ごとおよび年ごとのフォルダーに整理します
1:はい(デフォルト)
0:いいえ(セーフモードのデフォルト)
データ型:整数use_linksupdate
: リンクの更新時間を追跡します
1:はい
0:いいえ(デフォルト)
データ型:整数
パーマリンク
permalink_structure
: ブログのパーマリンクの希望する構造。一部の例:/%year%/%monthnum%/%day%/%postname%/
: 日付と名前に基づく/archives/%post_id%/
: 数値/%postname%/
: 投稿名に基づく
デフォルト: NULL
データ型:文字列category_base
: ブログカテゴリのパーマリンクのデフォルトカテゴリベース。
デフォルト: NULL
データ型:文字列tag_base
: ブログタグのパーマリンクのデフォルトタグベース。
デフォルト: NULL
データ型:文字列
プライバシー
blog_public
:
1:私のブログをすべての人に見えるようにしたい、検索エンジン(Google、Sphere、Technoratiなど)やアーカイバーを含む。(デフォルト)
0:検索エンジンをブロックしたいが、通常の訪問者は許可したい。
データ型:整数
読み込み
blog_charset
: ページとフィードのエンコーディング。ブログを書く際の文字エンコーディング(UTF-8が推奨されます)。
デフォルト:UTF-8
データ型:文字列gzipcompression
: ブラウザが要求した場合、WordPressは記事を圧縮する必要があります(gzip)。
1:はい
0:いいえ(デフォルト)
データ型:整数page_on_front
: フロントページに表示されるページのID。show_on_front
の値がpageである必要があります。
データ型:整数page_for_posts
: 投稿を表示するページのID。show_on_front
の値がpageであるときに便利です。
データ型:整数posts_per_page
: ブログページに表示される投稿の最大数。
デフォルト: 10
データ型:整数posts_per_rss
: RSSフィードに表示される投稿の最大数。
デフォルト: 10
データ型:整数rss_language
: RSSフィードの言語(メタデータ目的のみ)
デフォルト:en
データ型:文字列(ISO二文字言語コード)rss_use_excerpt
: RSSフィードで投稿の全文の代わりに抜粋を表示します
1:はい
0:いいえ(デフォルト)
データ型:整数show_on_front
: フロントページに表示する内容
posts:最新の投稿(デフォルト)
page:静的ページ(page_on_frontを参照)
データ型:文字列
テーマ
template
: 現在アクティブなテーマのスラッグ(パスによってアクセスされる方法、例:/wp-content/themes/my-theme
(my-theme
がこのオプションの値になります)。
デフォルト: ‘default’
データ型:文字列stylesheet
: 現在アクティブなスタイルシート(style.css)のスラッグ(パスによってアクセスされる方法、例:/wp-content/themes/my-style
(my-styleがこのオプションの値になります)
デフォルト: ‘default’
データ型:文字列
執筆
default_category
: 投稿がデフォルトで入るカテゴリのID
デフォルト: 1
データ型:整数default_email_category
: メール経由で書かれた投稿がデフォルトで入るカテゴリのID
デフォルト: 1
データ型:整数default_link_category
: リンクがデフォルトで入るカテゴリのID
デフォルト: 2
データ型:整数default_post_edit_rows
: 投稿ボックスのサイズ(行数)
デフォルト: 10
データ型:整数mailserver_login
: WordPressにメールで投稿するためのメールサーバーのユーザー名
デフォルト: ‘[email protected]’
データ型:文字列mailserver_pass
: WordPressにメールで投稿するためのメールサーバーのパスワード
デフォルト: ‘password’
データ型:文字列mailserver_port
: WordPressにメールで投稿するためのメールサーバーポート
デフォルト: 110
データ型:整数mailserver_url
: WordPressにメールで投稿するためのメールサーバー
デフォルト: ‘mail.example.com’
データ型:文字列ping_sites
: 新しい投稿を公開すると、WordPressは自動的に次のサイト更新サービスに通知します。これについての詳細は更新サービスを参照してください。複数のサービスURLは改行で区切ります。blog_public
の値が1である必要があります。
デフォルト: ‘http://rpc.pingomatic.com/’
データ型:文字列(複数行の可能性あり)use_balanceTags
: 無効にネストされたXHTMLを自動的に修正します
1:はい
0:いいえ(デフォルト)
データ型:整数use_smilies
::-)
や:P
のような絵文字を表示時にグラフィックに変換します
1:はい(デフォルト)
0:いいえ
データ型:整数use_trackback
: トラックバックの送受信を有効にします
1:はい
0:いいえ(デフォルト)enable_app
: Atom Publishing Protocolを有効にします
1:はい
0:いいえ(デフォルト)
データ型:整数enable_xmlrpc
: WordPress、Movable Type、MetaWeblog、Blogger XML-RPC出版プロトコルを有効にします
1:はい
0:いいえ(デフォルト)
データ型:整数
未分類
active_plugins
: プラグインのmain.phpファイルのパスを含む文字列の配列を返します。パスはプラグインフォルダーに対して相対的です。配列内のパスの例:/mainpage.php
。
デフォルト: array()
データ型:配列advanced_edit
:
デフォルト: 0
データ型:整数recently_edited
:
デフォルト: NULL
データ型:image_default_link_type
:
デフォルト: ‘file’
データ型:‘file’, ‘none’image_default_size
:
デフォルト: NULL
データ型:‘thumbnail’, ‘medium’, ‘large’またはカスタムサイズimage_default_align
:
デフォルト: NULL
データ型:‘left’, ‘right’, ‘center’, ‘none’sidebars_widgets
: アクティブおよび非アクティブウィジェットのリスト(サイドバーの状態の配列)を返します。
デフォルト:
データ型:配列sticky_posts
:
デフォルト: array()
データ型:widget_categories
:
デフォルト: array()
データ型:widget_text
:
デフォルト: array()
データ型:widget_rss
:
デフォルト: array()
データ型:
すべての設定画面
WordPress 3.0では、設定 > その他の画面が削除され、一部のオプションにアクセスできなくなりました(例: upload_url_path
)。すべての設定画面を使用して、上記のほとんどすべてのオプションを表示および変更できます。/wp-admin/options.php
にアクセスすることで利用可能です。