• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「クラスリファレンス/WP Theme」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Class Reference/WP Theme 18:07, 9 November 2017 Tazotodua 版を流し込み。)
 
 
(同じ利用者による、間の6版が非表示)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
== Role of WP_Theme ==
+
== WP_Theme の役割<span id="Role_of_WP_Theme"></span> ==
WP_Theme is a class defined in {{Trac|wp-includes/class-wp-theme.php}} that helps developers interact with a theme.
+
  
== Methods and Properties ==
+
WP_Theme は {{Trac|wp-includes/class-wp-theme.php}} にて定義されているクラスで、開発者がテーマを扱うインターフェイスを提供します。
This is the formal documentation of <tt>WP_Theme</tt>. You shouldn't alter the properties directly, but instead use the methods to interact with them.
+
  
=== Properties ===
+
== メソッドとプロパティ<span id="Methods_and_Properties"></span> ==
; Name : WordPress Theme object.
+
; ThemeURI : The URI of the theme's webpage.
+
; Description : The description of the theme
+
; Author : The theme's author
+
; AuthorURI : The website of the theme author
+
; Version : The version of the theme
+
; Template : (Optional — used in a child theme) The folder name of the parent theme
+
; Status : If the theme is published
+
; Tags : Tags used to describe the theme
+
; TextDomain : The text domain used in the theme for translation purposes
+
; DomainPath : Path to the theme translation files
+
  
=== Methods ===
+
これは <tt>WP_Theme</tt> の正式なドキュメントです。
; errors() : Returns [[Class_Reference/WP_Error|WP_Error]] object with error information. If there isn't any error information then it returns false
+
; exists() : Boolean for if the theme exists
+
; parent() : Returns parent WP_Theme object or false if there is no parent theme
+
; cache_delete() : Clears the cache for the theme
+
  
==== Header Methods ====
+
'''注意:''' プロパティを直接書き換えず、代わりにメソッドを使ってプロパティを扱ってください。
; get( $header ) : Used to get a sanitized but unformatted theme header. Use the [[Function Reference/get_template|get_template()]] method to find the template, not the 'Template' header. Returns string on success and false on failure
+
; display ( $header, $markup, $translate ) : Gets the theme header then formats and translates it for display.
+
  
==== Path and URL Methods ====
+
=== プロパティ<span id="Properties"></span> ===
; get_stylesheet() : Returns a string with the directory name of the theme's "stylesheet" files, inside the theme root. If this is a child theme it is the directory from the child theme.
+
; get_template() : Returns a string with the directory name of the theme's "template" file. If this is a child theme it is the directory from the parent theme.
+
; get_stylesheet_directory() : Returns a string with the absolute path to a theme's stylesheet files. If the theme is a child theme, the path will be to the child theme files.
+
; get_template_directory() : Returns a string with the absolute path to a theme's template files. If the theme is a child theme, the path will be to the parent theme files.
+
; get_stylesheet_directory_uri() : Returns a string with the URL to the theme's stylesheet files. If the theme is a child theme, the URL will be to the child theme files.
+
; get_template_directory_uri() : Returns a string with the URL to the theme's template files. If the theme is a child theme, the URL will be to the parent theme files.
+
; get_theme_root() : Returns a string with the path to the directory of the theme root. This is typically the absolute path to the wp-content/themes folder.
+
; get_theme_root_uri() : Returns a string with the URL to the directory of the theme root. This is typically the absolute URL to the wp-content/themes folder.
+
  
==== Files and Images ====
+
; Name : WordPress テーマ オブジェクト
; get_screenshot( $uri ) : Returns the URL to the screenshot image for the theme.  The $uri parameter determines the type of url to return. Passing 'relative' returns a relative URL otherwise it defaults to an absolute URL.
+
; ThemeURI : テーマの web ページの URI
; get_files( $type, $depth, $search_parent ) : Returns an array of files in the theme's directory.
+
; Description : テーマの説明
; get_page_templates() : Returns an array of page templates, keyed by the filename, with the value of the translated header name.
+
; Author : テーマの作者
 +
; AuthorURI : テーマ作者の web サイト
 +
; Version : テーマのバージョン
 +
; Template : (オプション — 子テーマで使用) 親テーマのフォルダ名
 +
; Status : テーマが公開されているか
 +
; Tags : テーマを説明するタグ
 +
; TextDomain : 翻訳のためにテーマ内で使われるテキストドメイン
 +
; DomainPath : テーマの翻訳ファイルのパス
  
==== Permission Methods ====
+
=== メソッド<span id="Methods"></span> ===
; is_allowed() : Boolean value for if a theme is allowed for the network. Always returns true if called on a single site.
+
; get_allowed( $blog_id ) : Returns an array of theme names that are allowed on the site or network. The $blog_id defaults to current blog. This method calls both get_allowed_on_network() and get_allowed_on_site( $blog_id ).
+
; get_allowed_on_network () : Returns an array of theme names that are allowed on the network.
+
; get_allowed_on_site( $blog_id ) : Returns an array of theme names that are allowed on the site.
+
  
==== Sorting ====
+
; errors() : エラー情報を持つ [[クラスリファレンス/WP_Error|WP_Error]] オブジェクトを返します。エラー情報がないとき false を返します。
; sort_by_name( $themes ) : Sorts themes by name
+
; exists() : テーマが存在するとき true を返します。
 +
; parent() : 親テーマの WP_Theme オブジェクトを返します。親テーマがないとき false を返します。
 +
; cache_delete() : テーマのキャッシュを消去します。
 +
 
 +
==== ヘッダー用メソッド<span id="Header_Methods"></span> ====
 +
 
 +
; get( $header ) : 整形する前のテーマヘッダーを無害化して返します。テンプレートを探すには <tt>'Template'</tt> ヘッダーではなく [[関数リファレンス/get_template|get_template()]] メソッドを使ってください。成功すると文字列、失敗すると false を返します。
 +
; display ( $header, $markup, $translate ) : テーマヘッダーを取得し整形することにより、表示用に変換します。
 +
 
 +
==== パスと URL 用のメソッド<span id="Path_and_URL_Methods"></span> ====
 +
 
 +
; get_stylesheet() : テーマのルートにある <tt>"stylesheet"</tt> ファイルのディレクトリ名を文字列として返します。子テーマのときは子テーマのディレクトリです。
 +
; get_template() : テーマの <tt>"template"</tt> ファイルのディレクトリ名を文字列として返します。子テーマのときは''親テーマ''のディレクトリです。
 +
; get_stylesheet_directory() : テーマのスタイルシートファイルの絶対パスを文字列として返します。子テーマのときは子テーマのファイルのパスです。
 +
; get_template_directory() : テーマのテンプレートファイルの絶対パスを文字列として返します。子テーマのときは''親テーマ''のファイルのパスです。
 +
; get_stylesheet_directory_uri() : テーマのスタイルシートファイルの URL を文字列として返します。子テーマのときは子テーマのファイルの URL です。
 +
; get_template_directory_uri() : テーマのテンプレートファイルの URL を文字列として返します。子テーマのときは''親テーマ''のファイルの URL です。
 +
; get_theme_root() : テーマルート(すべてのテーマが入る)のディレクトリのパスを文字列として返します。普通は <tt>wp-content/themes</tt> フォルダの絶対パスです。
 +
; get_theme_root_uri() : テーマルートのディレクトリの URL を文字列として返します。普通は <tt>wp-content/themes</tt> フォルダの URL です。
 +
 
 +
==== ファイルとイメージ<span id="Files_and_Images"></span> ====
 +
 
 +
; get_screenshot( $uri ) : テーマのスクリーンショット画像の URL を返します。パラメータ <tt>$uri</tt> は返す URL の種類を指定します。<tt>'relative'</tt> を渡すと相対 URL、他なら絶対 URL です。
 +
; get_files( $type, $depth, $search_parent ) : テーマのディレクトリにあるファイルの配列を返します。
 +
; get_page_templates() : ページテンプレートの連想配列を返します。キーがファイル名で、値が変換後のヘッダー名です。
 +
 
 +
==== 権限用のメソッド<span id="Permission_Methods"></span> ====
 +
 
 +
; is_allowed() : テーマがネットワークで許可されているかを示す真偽値。シングルサイトのとき常に true を返します。
 +
; 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_site( $blog_id ) : サイトで許可されているテーマ名の配列を返します。
 +
 
 +
==== 並べ替え<span id="Sorting"></span> ====
 +
 
 +
; sort_by_name( $themes ) : テーマを名前でソートします。
  
 
== 用例<span id="Examples"></span> ==
 
== 用例<span id="Examples"></span> ==
  
=== Get Custom Page Templates ===
+
=== カスタムページテンプレートを取得<span id="Get_Custom_Page_Templates"></span> ===
The following code snippets return all the custom [[Page_Templates|Page Templates]] available to the currently activated theme as an array. Each array item has a key of the Template Name and value of the filename (or folder-name and filename for custom page templates stored in a theme's subdirectory).
+
 
 +
次の小さなコードは現在有効なテーマの使用可能なカスタム[[ページテンプレート]]の全部を、1行にひとつ表示します。行の前半がテンプレート名、後半がファイル名(テーマのサブディレクトリにあるカスタムページはフォルダ名とファイル名)です。
  
 
<pre>
 
<pre>
71行目: 83行目:
 
<?php print_r( wp_get_theme()->get_page_templates() ); ?>
 
<?php print_r( wp_get_theme()->get_page_templates() ); ?>
  
// Outputs:
+
// 出力はこのようになるでしょう:
 
Array
 
Array
 
(
 
(
80行目: 92行目:
 
== 変更履歴<span id="Change_Log"></span> ==
 
== 変更履歴<span id="Change_Log"></span> ==
  
Since : [[Version 3.4|3.4.0]]
+
新規導入 : [[Version 3.4|3.4.0]]
  
 
== ソースファイル<span id="Source_File"></span> ==
 
== ソースファイル<span id="Source_File"></span> ==
  
<tt>WP_Theme</tt> is located in {{Trac|wp-includes/class-wp-theme.php}}.
+
<tt>WP_Theme</tt> {{Trac|wp-includes/class-wp-theme.php}} にあります。
  
 
== 関連項目<span id="Related"></span> ==
 
== 関連項目<span id="Related"></span> ==

2018年6月9日 (土) 10:35時点における最新版

この項目「クラスリファレンス/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 ) 
テーマを名前でソートします。

用例

カスタムページテンプレートを取得

次の小さなコードは現在有効なテーマの使用可能なカスタムページテンプレートの全部を、1行にひとつ表示します。行の前半がテンプレート名、後半がファイル名(テーマのサブディレクトリにあるカスタムページはフォルダ名とファイル名)です。

 <?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_Themewp-includes/class-wp-theme.php にあります。

関連項目

クラスリファレンス関数リファレンスの各インデックスも参照してください。

最新英語版: Reference / Classes / WP_Theme

最新英語版: WordPress Codex » Class Reference/WP Theme最新版との差分