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

「関数リファレンス/wp generate attachment metadata」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/wp_generate_attachment_metadata 03:12, 30 September 2017‎ Karzin 版を流し込み。)
 
(和訳完了。)
 
1行目: 1行目:
== Description ==
+
== 説明<span id="Description"></span> ==
This function generates metadata for an image attachment.  It also creates a thumbnail and other intermediate sizes of the image attachment based on the sizes defined on the [[Settings_Media_Screen]].
+
 
 +
この関数は画像である添付ファイルのメタデータを生成します。またサムネイルと中間サイズの画像も生成します。中間サイズは管理画面の [[管理画面/メディア設定|設定 &gt; メディア]] で定義します。
 +
 
 +
== 使い方<span id="Usage"></span> ==
  
== Usage ==
 
 
  <?php wp_generate_attachment_metadata( $attachment_id, $file ); ?>
 
  <?php wp_generate_attachment_metadata( $attachment_id, $file ); ?>
  
== Parameters ==
+
== パラメータ<span id="Parameters"></span> ==
{{Parameter|$attachment_id|int|Attachment Id to process.}}
+
{{Parameter|$file|string|Location of the file on the server. Use absolute path and not the URI of the file. The file MUST be in the uploads directory. See [[Function_Reference/wp_upload_dir|wp_upload_dir()]]}}
+
  
== Return Values ==
+
{{Parameter|$attachment_id|整数|処理する添付ファイルの ID}}
; <tt>(array)</tt> : attachment metadata in the format required by [[Function_Reference/wp_update_attachment_metadata|wp_update_attachment_metadata()]]
+
{{Parameter|$file|文字列|サーバー上のファイルの位置。URI ではなく絶対パスを使ってください。ファイルは''必ず'' uploads ディレクトリー内とします。[[関数リファレンス/wp_upload_dir|<tt>wp_upload_dir()</tt>]] を見てください。}}
  
The elements returned in the array are:
+
== 戻り値<span id="Return_Values"></span> ==
  
; <tt>["width"]</tt> : (''string'') Horizontal size of image attachment, in pixels.
+
; <tt>(配列)</tt> : [[関数リファレンス/wp_update_attachment_metadata|<tt>wp_update_attachment_metadata()</tt>]] が必要とする形式の添付ファイルのメタデータ。
; <tt>["height"]</tt> : (''string'') Vertical size of image attachment, in pixels.
+
 
; <tt>["file"]</tt> : (''string'') Path to image attachment, relative to the currently configured uploads directory.
+
返される配列の要素は以下のとおりです:
; <tt>["hwstring_small"]</tt> : (''string'') Height/width string for HTML img tag used to display the Small size of this image.<br />For example: <tt>height='96' width='126'</tt>
+
 
; <tt>["sizes"]["thumbnail"]["file"]</tt> : (''string'') File name of Thumbnail-sized copy of image attachment.
+
; <tt>["width"]</tt> : (''文字列'') 画像の横サイズ。単位はピクセル。
; <tt>["sizes"]["thumbnail"]["width"]</tt> : (''string'') Horizontal size of Thumbnail-sized copy of image attachment, in pixels.
+
; <tt>["height"]</tt> : (''文字列'') 画像の縦サイズ。単位はピクセル。
; <tt>["sizes"]["thumbnail"]["height"]</tt> : (''string'') Vertical size of Thumbnail-sized copy of image attachment, in pixels.
+
; <tt>["file"]</tt> : (''文字列'') 現在定義されている uploads ディレクトリーからの画像(添付ファイル)の相対パス。
; <tt>["sizes"]["medium"]</tt> : (''array'') Same three elements as <tt>["sizes"]["thumbnail"]</tt> but for Medium-sized copy of image attachment.
+
; <tt>["hwstring_small"]</tt> : (''文字列'') HTML の <code>img</code> タグに入れて小サイズの画像を表示するための高さ/幅の文字列。<br />: <code>height='96' width='126'</code>
; <tt>["sizes"]["large"]</tt> : (''array'') Same three elements as <tt>["sizes"]["thumbnail"]</tt> but for Large-sized copy of image attachment.
+
; <tt>["sizes"]["thumbnail"]["file"]</tt> : (''文字列'') サムネイルの大きさでコピーされた画像のファイル名。
; <tt>["sizes"]["post-thumbnail"]</tt> : (''array'') Same three elements as <tt>["sizes"]["thumbnail"]</tt> but for Post Thumbnail-sized copy of image attachment.
+
; <tt>["sizes"]["thumbnail"]["width"]</tt> : (''文字列'') サムネイルの大きさでコピーされた画像の横サイズ。単位はピクセル。
; <tt>["sizes"]["large-feature"]</tt> : (''array'') Same three elements as <tt>["sizes"]["thumbnail"]</tt> but for Large Feature-sized copy of image attachment.
+
; <tt>["sizes"]["thumbnail"]["height"]</tt> : (''文字列'') サムネイルの大きさでコピーされた画像の縦サイズ。単位はピクセル。
; <tt>["sizes"]["small-feature"]</tt> : (''array'') Same three elements as <tt>["sizes"]["thumbnail"]</tt> but for Small Feature-sized copy of image attachment.
+
; <tt>["sizes"]["medium"]</tt> : (''配列'') 中サイズでコピーされた画像の、<tt>["sizes"]["thumbnail"]</tt> と同じ3要素の配列。
; <tt>["image_meta"]</tt> : (''array'') Image attachment Metadata returned by [[Function_Reference/wp_read_image_metadata#Return_Values|wp_read_image_metadata()]]
+
; <tt>["sizes"]["large"]</tt> : (''配列'') 大サイズでコピーされた画像の、<tt>["sizes"]["thumbnail"]</tt> と同じ3要素の配列。
 +
; <tt>["sizes"]["post-thumbnail"]</tt> : (''配列'') 投稿のアイキャッチ画像サイズでコピーされた画像の、<tt>["sizes"]["thumbnail"]</tt> と同じ3要素の配列。
 +
; <tt>["sizes"]["large-feature"]</tt> : (''配列'') 投稿の大きなアイキャッチ画像サイズでコピーされた画像の、<tt>["sizes"]["thumbnail"]</tt> と同じ3要素の配列。
 +
; <tt>["sizes"]["small-feature"]</tt> : (''配列'') 投稿の小さなアイキャッチ画像サイズでコピーされた画像の、<tt>["sizes"]["thumbnail"]</tt> と同じ3要素の配列。
 +
; <tt>["image_meta"]</tt> : (''配列'') [[関数リファレンス/wp_read_image_metadata#Return_Values|wp_read_image_metadata()]] が返す画像(添付ファイル)のメタデータ。
 +
 
 +
== 用例<span id="Examples"></span> ==
 +
 
 +
添付ファイルの親投稿の ID を37にした上でメタデータを生成します:
  
== Example ==
 
To generate attachment metadata for attachment with parent post ID 37:
 
 
<pre>
 
<pre>
 
<?php
 
<?php
 +
  // $filename が添付ファイルの絶対パス
 
   $attach_id = wp_insert_attachment( $attachment, $filename, 37 );
 
   $attach_id = wp_insert_attachment( $attachment, $filename, 37 );
 
   $attach_data = wp_generate_attachment_metadata( $attach_id, $filename );
 
   $attach_data = wp_generate_attachment_metadata( $attach_id, $filename );
   wp_update_attachment_metadata( $attach_id, $attach_data );
+
   wp_update_attachment_metadata( $attach_id, $attach_data );
 
?>
 
?>
 
</pre>
 
</pre>
  
== Notes ==
+
== 参考<span id="Notes"></span> ==
This function can be used to regenerate thumbnail and intermediate sizes of the image after changes have been made on the [[Settings_Media_Screen]] but it does not check or delete intermediate sizes it previously created for the same image.
+
  
Thumbnail and intermediate sizes of the image, and ["sizes"] elements in the array returned by this function, are only generated when the intermediate size is smaller than the size of the image.
+
* この関数は [[管理画面/メディア設定|設定 &gt; メディア]] で変更を行った後に画像のサムネイルと中間サイズを再生成するのに利用できます。ただし同じ画像について以前に生成済みの中間サイズの有無を確かめたり削除したりしません。
  
The function should be used in conjunction with [[Function_Reference/wp_update_attachment_metadata|wp_update_attachment_metadata()]].
+
* 画像のサムネイルと中間サイズ、およびこの関数が返す配列の <code>["sizes"]</code> 要素は、中間サイズがオリジナルの画像サイズより小さい場合のみ生成されます。
  
If this function is undefined in the environment where it is to be used, such as within a Shortcode, use the include function:  
+
* この関数は [[関数リファレンス/wp_update_attachment_metadata|wp_update_attachment_metadata()]] と併用すべきです。
 +
 
 +
* この関数が未定義の環境、例えばショートコードを定義する場面で使いたい場合は、inlcude 関数を使ってください:
 
<pre>
 
<pre>
 
<?php  
 
<?php  
54行目: 62行目:
 
</pre>
 
</pre>
  
== Source File ==
+
== 変更履歴<span id="Change_Log"></span> ==
<tt>wp_generate_attachment_metadata()</tt> is located in
+
 
{{Trac|wp-admin/includes/image.php}}.
+
新規導入 : [[Version 2.1|2.1]]
 +
 
 +
== ソースファイル<span id="Source_File"></span> ==
 +
 
 +
<tt>wp_generate_attachment_metadata()</tt> {{Trac|wp-admin/includes/image.php}} にあります。
  
 
== Related ==
 
== Related ==
[[Function Reference/wp_update_attachment_metadata|wp_update_attachment_metadata()]],
+
[[関数リファレンス/wp_update_attachment_metadata|wp_update_attachment_metadata()]],
[[Function Reference/wp_get_attachment_metadata|wp_get_attachment_metadata()]],
+
[[関数リファレンス/wp_get_attachment_metadata|wp_get_attachment_metadata()]],
[[Function Reference/wp_read_image_metadata|wp_read_image_metadata()]],
+
[[関数リファレンス/wp_read_image_metadata|wp_read_image_metadata()]],
[[Function Reference/wp_get_attachment_image|wp_get_attachment_image()]],
+
[[関数リファレンス/wp_get_attachment_image|wp_get_attachment_image()]],
[[Function Reference/wp_get_attachment_image_src|wp_get_attachment_image_src()]],
+
[[関数リファレンス/wp_get_attachment_image_src|wp_get_attachment_image_src()]],
[[Function Reference/wp_get_attachment_thumb_file|wp_get_attachment_thumb_file()]],
+
[[関数リファレンス/wp_get_attachment_thumb_file|wp_get_attachment_thumb_file()]],
[[Function Reference/wp_get_attachment_thumb_url|wp_get_attachment_thumb_url()]],
+
[[関数リファレンス/wp_get_attachment_thumb_url|wp_get_attachment_thumb_url()]],
[[Function Reference/wp_attachment_is_image|wp_attachment_is_image()]],
+
[[関数リファレンス/wp_attachment_is_image|wp_attachment_is_image()]],
[[Function Reference/wp_insert_attachment|wp_insert_attachment()]],
+
[[関数リファレンス/wp_insert_attachment|wp_insert_attachment()]],
[[Function Reference/wp_delete_attachment|wp_delete_attachment()]],
+
[[関数リファレンス/wp_delete_attachment|wp_delete_attachment()]],
[[Function Reference/wp_get_attachment_link|wp_get_attachment_link()]],
+
[[関数リファレンス/wp_get_attachment_link|wp_get_attachment_link()]],
[[Function Reference/wp_get_attachment_url|wp_get_attachment_url()]],
+
[[関数リファレンス/wp_get_attachment_url|wp_get_attachment_url()]],
[[Function Reference/is_attachment|is_attachment()]],
+
[[関数リファレンス/is_attachment|is_attachment()]],
[[Function Reference/wp_insert_post|wp_insert_post()]]
+
[[関数リファレンス/wp_insert_post|wp_insert_post()]]
  
 
{{原文|Function Reference/wp_generate_attachment_metadata|161535}} <!-- 03:12, 30 September 2017‎ Karzin 版 -->
 
{{原文|Function Reference/wp_generate_attachment_metadata|161535}} <!-- 03:12, 30 September 2017‎ Karzin 版 -->
  
[[Category:Functions]]
+
[[Category:関数]]
[[Category:Attachments]]
+
[[Category:添付ファイル]]
  
 
[[en:Function Reference/wp_generate_attachment_metadata]]
 
[[en:Function Reference/wp_generate_attachment_metadata]]

2018年5月4日 (金) 17:21時点における最新版

説明

この関数は画像である添付ファイルのメタデータを生成します。またサムネイルと中間サイズの画像も生成します。中間サイズは管理画面の 設定 > メディア で定義します。

使い方

<?php wp_generate_attachment_metadata( $attachment_id, $file ); ?>

パラメータ

$attachment_id
整数) (必須) 処理する添付ファイルの ID
初期値: なし
$file
文字列) (必須) サーバー上のファイルの位置。URI ではなく絶対パスを使ってください。ファイルは必ず uploads ディレクトリー内とします。wp_upload_dir() を見てください。
初期値: なし

戻り値

(配列) 
wp_update_attachment_metadata() が必要とする形式の添付ファイルのメタデータ。

返される配列の要素は以下のとおりです:

["width"] 
(文字列) 画像の横サイズ。単位はピクセル。
["height"] 
(文字列) 画像の縦サイズ。単位はピクセル。
["file"] 
(文字列) 現在定義されている uploads ディレクトリーからの画像(添付ファイル)の相対パス。
["hwstring_small"] 
(文字列) HTML の img タグに入れて小サイズの画像を表示するための高さ/幅の文字列。
例: height='96' width='126'
["sizes"]["thumbnail"]["file"] 
(文字列) サムネイルの大きさでコピーされた画像のファイル名。
["sizes"]["thumbnail"]["width"] 
(文字列) サムネイルの大きさでコピーされた画像の横サイズ。単位はピクセル。
["sizes"]["thumbnail"]["height"] 
(文字列) サムネイルの大きさでコピーされた画像の縦サイズ。単位はピクセル。
["sizes"]["medium"] 
(配列) 中サイズでコピーされた画像の、["sizes"]["thumbnail"] と同じ3要素の配列。
["sizes"]["large"] 
(配列) 大サイズでコピーされた画像の、["sizes"]["thumbnail"] と同じ3要素の配列。
["sizes"]["post-thumbnail"] 
(配列) 投稿のアイキャッチ画像サイズでコピーされた画像の、["sizes"]["thumbnail"] と同じ3要素の配列。
["sizes"]["large-feature"] 
(配列) 投稿の大きなアイキャッチ画像サイズでコピーされた画像の、["sizes"]["thumbnail"] と同じ3要素の配列。
["sizes"]["small-feature"] 
(配列) 投稿の小さなアイキャッチ画像サイズでコピーされた画像の、["sizes"]["thumbnail"] と同じ3要素の配列。
["image_meta"] 
(配列) wp_read_image_metadata() が返す画像(添付ファイル)のメタデータ。

用例

添付ファイルの親投稿の ID を37にした上でメタデータを生成します:

<?php
  // $filename が添付ファイルの絶対パス
  $attach_id = wp_insert_attachment( $attachment, $filename, 37 );
  $attach_data = wp_generate_attachment_metadata( $attach_id, $filename );
  wp_update_attachment_metadata( $attach_id, $attach_data );
?>

参考

  • この関数は 設定 > メディア で変更を行った後に画像のサムネイルと中間サイズを再生成するのに利用できます。ただし同じ画像について以前に生成済みの中間サイズの有無を確かめたり削除したりしません。
  • 画像のサムネイルと中間サイズ、およびこの関数が返す配列の ["sizes"] 要素は、中間サイズがオリジナルの画像サイズより小さい場合のみ生成されます。
  • この関数が未定義の環境、例えばショートコードを定義する場面で使いたい場合は、inlcude 関数を使ってください:
<?php 
if ( ! function_exists( 'wp_crop_image' ) ) {
	include( ABSPATH . 'wp-admin/includes/image.php' );
}
?>

変更履歴

新規導入 : 2.1

ソースファイル

wp_generate_attachment_metadata()wp-admin/includes/image.php にあります。

Related

wp_update_attachment_metadata(), wp_get_attachment_metadata(), wp_read_image_metadata(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), wp_attachment_is_image(), wp_insert_attachment(), wp_delete_attachment(), wp_get_attachment_link(), wp_get_attachment_url(), is_attachment(), wp_insert_post()

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