- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
「クラスリファレンス/WP Theme」の版間の差分
提供: WordPress Codex 日本語版
(→パスと URL 用のメソッド: まで翻訳。他に ゆらぎ 修正。) |
(残りを和訳。) |
||
| 1行目: | 1行目: | ||
| − | {{ | + | {{CheckTrans}} |
== WP_Theme の役割<span id="Role_of_WP_Theme"></span> == | == WP_Theme の役割<span id="Role_of_WP_Theme"></span> == | ||
| 50行目: | 50行目: | ||
==== ファイルとイメージ<span id="Files_and_Images"></span> ==== | ==== ファイルとイメージ<span id="Files_and_Images"></span> ==== | ||
| − | ; get_screenshot( $uri ) : | + | ; get_screenshot( $uri ) : テーマのスクリーンショット画像の URL を返します。パラメータ <tt>$uri</tt> は返す URL の種類を指定します。<tt>'relative'</tt> を渡すと相対 URL、他なら絶対 URL です。 |
| − | ; get_files( $type, $depth, $search_parent ) : | + | ; get_files( $type, $depth, $search_parent ) : テーマのディレクトリにあるファイルの配列を返します。 |
| − | ; get_page_templates() : | + | ; get_page_templates() : ページテンプレートの連想配列を返します。キーがファイル名で、値が変換後のヘッダー名です。 |
==== 権限用のメソッド<span id="Permission_Methods"></span> ==== | ==== 権限用のメソッド<span id="Permission_Methods"></span> ==== | ||
| − | ; is_allowed() : | + | ; is_allowed() : テーマがネットワークで許可されているかを示す真偽値。シングルサイトのとき常に true を返します。 |
| − | ; get_allowed( $blog_id ) : | + | ; get_allowed( $blog_id ) : サイトまたはネットワークで許可されているテーマ名の配列。<tt>$blog_id</tt> のデフォルトは現在のブログです。このメソッドは内部で <code>get_allowed_on_network()</code> と <code>get_allowed_on_site( $blog_id )</code> の両方を呼び出します。 |
| − | ; get_allowed_on_network () : | + | ; get_allowed_on_network () : ネットワークで許可されているテーマ名の配列を返します。 |
| − | ; get_allowed_on_site( $blog_id ) : | + | ; get_allowed_on_site( $blog_id ) : サイトで許可されているテーマ名の配列を返します。 |
==== 並べ替え<span id="Sorting"></span> ==== | ==== 並べ替え<span id="Sorting"></span> ==== | ||
| − | ; sort_by_name( $themes ) : | + | ; sort_by_name( $themes ) : テーマを名前でソートします。 |
== 用例<span id="Examples"></span> == | == 用例<span id="Examples"></span> == | ||
| 69行目: | 69行目: | ||
=== カスタムページテンプレートを取得<span id="Get_Custom_Page_Templates"></span> === | === カスタムページテンプレートを取得<span id="Get_Custom_Page_Templates"></span> === | ||
| − | + | 次の小さなコードは現在有効なテーマの使用可能なカスタム[[ページテンプレート]]の全部を配列として返します。配列の要素はキーがテンプレート名、値がファイル名（テーマのサブディレクトリにあるカスタムページはフォルダ名とファイル名）です。 | |
<pre> | <pre> | ||
| 83行目: | 83行目: | ||
<?php print_r( wp_get_theme()->get_page_templates() ); ?> | <?php print_r( wp_get_theme()->get_page_templates() ); ?> | ||
| − | // | + | // 出力はこのようになるでしょう: |
Array | Array | ||
( | ( | ||
2018年6月9日 (土) 10:29時点における版
この項目「クラスリファレンス/WP Theme」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。
目次
WP_Theme の役割
WP_Theme は wp-includes/class-wp-theme.php にて定義されているクラスで、開発者がテーマを扱うインターフェイスを提供します。
メソッドとプロパティ
これは WP_Theme の正式なドキュメントです。
注意: プロパティを直接書き換えず、代わりにメソッドを使ってプロパティを扱ってください。
プロパティ
- Name
- WordPress テーマ オブジェクト
- ThemeURI
- テーマの web ページの URI
- Description
- テーマの説明
- Author
- テーマの作者
- AuthorURI
- テーマ作者の web サイト
- Version
- テーマのバージョン
- Template
- (オプション — 子テーマで使用) 親テーマのフォルダ名
- Status
- テーマが公開されているか
- Tags
- テーマを説明するタグ
- TextDomain
- 翻訳のためにテーマ内で使われるテキストドメイン
- DomainPath
- テーマの翻訳ファイルのパス
メソッド
- errors()
- エラー情報を持つ WP_Error オブジェクトを返します。エラー情報がないとき false を返します。
- exists()
- テーマが存在するとき true を返します。
- parent()
- 親テーマの WP_Theme オブジェクトを返します。親テーマがないとき false を返します。
- cache_delete()
- テーマのキャッシュを消去します。
ヘッダー用メソッド
- get( $header )
- 整形する前のテーマヘッダーを無害化して返します。テンプレートを探すには 'Template' ヘッダーではなく get_template() メソッドを使ってください。成功すると文字列、失敗すると false を返します。
- display ( $header, $markup, $translate )
- テーマヘッダーを取得し整形することにより、表示用に変換します。
パスと URL 用のメソッド
- get_stylesheet()
- テーマのルートにある "stylesheet" ファイルのディレクトリ名を文字列として返します。子テーマのときは子テーマのディレクトリです。
- get_template()
- テーマの "template" ファイルのディレクトリ名を文字列として返します。子テーマのときは親テーマのディレクトリです。
- get_stylesheet_directory()
- テーマのスタイルシートファイルの絶対パスを文字列として返します。子テーマのときは子テーマのファイルのパスです。
- get_template_directory()
- テーマのテンプレートファイルの絶対パスを文字列として返します。子テーマのときは親テーマのファイルのパスです。
- get_stylesheet_directory_uri()
- テーマのスタイルシートファイルの URL を文字列として返します。子テーマのときは子テーマのファイルの URL です。
- get_template_directory_uri()
- テーマのテンプレートファイルの URL を文字列として返します。子テーマのときは親テーマのファイルの URL です。
- get_theme_root()
- テーマルート（すべてのテーマが入る）のディレクトリのパスを文字列として返します。普通は wp-content/themes フォルダの絶対パスです。
- get_theme_root_uri()
- テーマルートのディレクトリの URL を文字列として返します。普通は wp-content/themes フォルダの URL です。
ファイルとイメージ
- get_screenshot( $uri )
- テーマのスクリーンショット画像の URL を返します。パラメータ $uri は返す URL の種類を指定します。'relative' を渡すと相対 URL、他なら絶対 URL です。
- get_files( $type, $depth, $search_parent )
- テーマのディレクトリにあるファイルの配列を返します。
- get_page_templates()
- ページテンプレートの連想配列を返します。キーがファイル名で、値が変換後のヘッダー名です。
権限用のメソッド
- is_allowed()
- テーマがネットワークで許可されているかを示す真偽値。シングルサイトのとき常に true を返します。
- get_allowed( $blog_id )
- サイトまたはネットワークで許可されているテーマ名の配列。$blog_id のデフォルトは現在のブログです。このメソッドは内部で
get_allowed_on_network()とget_allowed_on_site( $blog_id )の両方を呼び出します。 - get_allowed_on_network ()
- ネットワークで許可されているテーマ名の配列を返します。
- get_allowed_on_site( $blog_id )
- サイトで許可されているテーマ名の配列を返します。
並べ替え
- sort_by_name( $themes )
- テーマを名前でソートします。
用例
カスタムページテンプレートを取得
次の小さなコードは現在有効なテーマの使用可能なカスタムページテンプレートの全部を配列として返します。配列の要素はキーがテンプレート名、値がファイル名（テーマのサブディレクトリにあるカスタムページはフォルダ名とファイル名）です。
<?php
$templates = wp_get_theme()->get_page_templates();
foreach ( $templates as $template_name => $template_filename ) {
echo "$template_name ($template_filename)<br />";
}
?>
<?php print_r( wp_get_theme()->get_page_templates() ); ?>
// 出力はこのようになるでしょう:
Array
(
[My Custom Page Template] => my-custom-page.php
[A Second Custom Page] => my-page-templates/my-second-page.php
)
変更履歴
新規導入 : 3.4.0
ソースファイル
WP_Theme は wp-includes/class-wp-theme.php にあります。
