当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/add custom image header」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
({{原文|Function Reference/add_custom_image_header|83618}}<!-- 23:17, 3 March 2010 Esmi 版 -->)
 
 
(3人の利用者による、間の4版が非表示)
1行目: 1行目:
{{NeedTrans}}
+
{{Deprecated|new_function()=add_theme_support}}
== Description ==
+
== 説明 ==
Add callbacks for image header display.
+
イメージヘッダー表示にコールバックを追加します。
  
The parameter <tt>$header_callback</tt> callback will be required to display the content for the '<tt>wp_head</tt>' action. The parameter <tt>$admin_header_callback</tt> callback will be added to <tt>Custom_Image_Header</tt> class and that will be added to the '<tt>admin_menu</tt>' action.
+
パラメータ <tt>$header_callback</tt> コールバックは、'<tt>wp_head</tt>' アクションの中身を表示するのに必要です。パラメータ <tt>$admin_header_callback</tt> コールバックは、<tt>Custom_Image_Header</tt> クラスに追加され、'<tt>admin_menu</tt>' アクションに追加されます。
  
== Usage ==
+
== 使い方 ==
%%%<?php add_custom_image_header( $header_callback, $admin_header_callback ) ?>%%%
+
<code><?php add_custom_image_header( $header_callback, $admin_header_callback ) ?></code>
  
== Parameters ==
+
== パラメータ ==
{{Parameter|$header_callback|callback|Call on '<tt>wp_head</tt>' action.}}
+
{{Parameter|$header_callback|callback|'<tt>wp_head</tt>' アクションで呼び出す}}
{{Parameter|$admin_header_callback|callback|Call on [[Administration_Panels|administration panels]].}}
+
{{Parameter|$admin_header_callback|callback|[[管理パネル]]で呼び出す}}
  
== Return Values ==
+
== 戻り値 ==
; (void) : This function does not return a value.
+
; (void) : この関数には、戻り値はありません。
  
== Examples ==
+
== 用例 ==
Edit the file <tt>functions.php</tt> inside your theme and add the following code.
+
テーマの <tt>functions.php</tt> ファイルを編集して、以下のコードを追加してください。
  
Four constants must be defined in order for the custom image header to work:
+
カスタムイメージヘッダーが動作するには、4つの定数を定義しなければなりません。
 
<pre>define('HEADER_TEXTCOLOR', 'ffffff');
 
<pre>define('HEADER_TEXTCOLOR', 'ffffff');
 
define('HEADER_IMAGE', '%s/images/default_header.jpg'); // %s is the template dir uri
 
define('HEADER_IMAGE', '%s/images/default_header.jpg'); // %s is the template dir uri
24行目: 24行目:
 
define('HEADER_IMAGE_HEIGHT', 200);</pre>
 
define('HEADER_IMAGE_HEIGHT', 200);</pre>
  
If you don't want to allow changing the header text color, add:
+
ヘッダーのテキストの色を変化させたくない場合は、以下を追加してください。
 
<pre>define('NO_HEADER_TEXT', true );</pre>
 
<pre>define('NO_HEADER_TEXT', true );</pre>
  
Then change the first definition to:
+
それから、最初の定義を以下に変更してください。
 
<pre>define('HEADER_TEXTCOLOR', '');</pre>
 
<pre>define('HEADER_TEXTCOLOR', '');</pre>
  
If you intend to create child themes use:
+
子テーマを作りたい場合は、以下を使用してください。
  
 
<pre>define('HEADER_IMAGE', get_bloginfo('stylesheet_directory') . '/images/banner.jpg');</pre>
 
<pre>define('HEADER_IMAGE', get_bloginfo('stylesheet_directory') . '/images/banner.jpg');</pre>
  
Otherwise, you'll pick up the header image for the parent theme rather than the child.
+
これをしない場合は、子テーマではなく、親テーマのヘッダー画像を取得します。
  
Next you need to write two functions. One will be included in the site header. The second will be included in the admin header. Both of these functions are required. The smallest possible amount of code would be something like this, although you can do anything you need.
+
さらに、2つの関数を書く必要があります。1つは site header に含まれます。2つ目は admin header に含まれます。これらの関数は必須です。(必要なものを追加することもできますが、)最も少ない場合で以下のようになります。
  
 
<pre>// gets included in the site header
 
<pre>// gets included in the site header
57行目: 57行目:
 
}</pre>
 
}</pre>
  
Finish with calling the add_custom_image_header function with the two earlier function names as parameters:
+
これら2つの関数名をパラメータとすることで、add_custom_image_header 関数の呼び出しが完了します。
  
 
<pre>add_custom_image_header('header_style', 'admin_header_style');</pre>
 
<pre>add_custom_image_header('header_style', 'admin_header_style');</pre>
  
Taking this last step will make the Custom Header item appear in the Appearance menu. WordPress takes care of everything else.
+
この手順で、カスタムヘッダーアイテムが、外観メニューに表示されます。後は、WordPress が面倒を見ます。
  
== Notes ==
+
== ==
* Uses: <tt>Custom_Image_Header</tt>. Sets up for <tt>$admin_header_callback</tt> for [[Administration_Panels|administration panel]] display.
+
* 使用: <tt>Custom_Image_Header</tt>。[[管理パネル]] に表示する <tt>$admin_header_callback</tt> のセットアップ。
  
== Change Log ==
+
== 更新履歴 ==
Since: 2.1.0
+
* 廃止: [[Version 3.4|3.4.0]]
 +
* 導入: [[Version 2.1|2.1.0]]
  
== Source File ==
+
== ソース ==
<tt>add_custom_image_header()</tt> is located in <tt>wp-includes/theme.php</tt>.
+
<tt>add_custom_image_header()</tt> は、<tt>wp-includes/theme.php</tt> にあります。
  
== Related ==
+
== 関連 ==
 
<!--
 
<!--
 
     To Do:
 
     To Do:
79行目: 80行目:
 
     Some functions may be related to many groups of functions.
 
     Some functions may be related to many groups of functions.
 
-->
 
-->
 
+
[[:en:Function Reference/get_header_image|get_header_image]], [[:en:Function Reference/header_image|header_image]]
  
 
{{原文|Function Reference/add_custom_image_header|83618}}<!-- 23:17, 3 March 2010 Esmi 版 -->
 
{{原文|Function Reference/add_custom_image_header|83618}}<!-- 23:17, 3 March 2010 Esmi 版 -->
  
[[Category:Functions]]
+
[[Category:非推奨]]
[[Category:New_page_created]]
+
[[Category:関数]]

2015年5月15日 (金) 12:41時点における最新版


この関数は 非推奨となりました。これは新しい関数に置き換えられた、またはサポート外になった、あるいは将来バージョンにて削除されるためです。この関数を用いる全てのコードは、置き換えとなる関数が存在する場合、書き換えられる必要があります。wp-includes/deprecated.phpもご参照ください。 これらの関数から適切なものを代わりに用いてください。

説明

イメージヘッダー表示にコールバックを追加します。

パラメータ $header_callback コールバックは、'wp_head' アクションの中身を表示するのに必要です。パラメータ $admin_header_callback コールバックは、Custom_Image_Header クラスに追加され、'admin_menu' アクションに追加されます。

使い方

<?php add_custom_image_header( $header_callback, $admin_header_callback ) ?>

パラメータ

$header_callback
callback) (必須) 'wp_head' アクションで呼び出す
初期値: なし
$admin_header_callback
callback) (必須管理パネルで呼び出す
初期値: なし

戻り値

(void) 
この関数には、戻り値はありません。

用例

テーマの functions.php ファイルを編集して、以下のコードを追加してください。

カスタムイメージヘッダーが動作するには、4つの定数を定義しなければなりません。

define('HEADER_TEXTCOLOR', 'ffffff');
define('HEADER_IMAGE', '%s/images/default_header.jpg'); // %s is the template dir uri
define('HEADER_IMAGE_WIDTH', 775); // use width and height appropriate for your theme
define('HEADER_IMAGE_HEIGHT', 200);

ヘッダーのテキストの色を変化させたくない場合は、以下を追加してください。

define('NO_HEADER_TEXT', true );

それから、最初の定義を以下に変更してください。

define('HEADER_TEXTCOLOR', '');

子テーマを作りたい場合は、以下を使用してください。

define('HEADER_IMAGE', get_bloginfo('stylesheet_directory') . '/images/banner.jpg');

これをしない場合は、子テーマではなく、親テーマのヘッダー画像を取得します。

さらに、2つの関数を書く必要があります。1つは site header に含まれます。2つ目は admin header に含まれます。これらの関数は必須です。(必要なものを追加することもできますが、)最も少ない場合で以下のようになります。

// gets included in the site header
function header_style() {
    ?><style type="text/css">
        #header {
            background: url(<?php header_image(); ?>);
        }
    </style><?php
}
// gets included in the admin header
function admin_header_style() {
    ?><style type="text/css">
        #headimg {
            width: <?php echo HEADER_IMAGE_WIDTH; ?>px;
            height: <?php echo HEADER_IMAGE_HEIGHT; ?>px;
        }
    </style><?php
}

これら2つの関数名をパラメータとすることで、add_custom_image_header 関数の呼び出しが完了します。

add_custom_image_header('header_style', 'admin_header_style');

この手順で、カスタムヘッダーアイテムが、外観メニューに表示されます。後は、WordPress が面倒を見ます。

  • 使用: Custom_Image_Header管理パネル に表示する $admin_header_callback のセットアップ。

更新履歴

ソース

add_custom_image_header() は、wp-includes/theme.php にあります。

関連

get_header_image, header_image

最新英語版: WordPress Codex » Function Reference/add_custom_image_header最新版との差分