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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ。)
 
(和訳完了。)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
新しい画像サイズを登録する関数です。これは新しい画像がアップロードされる際に、WordPressがアイキャッチ画像 (以前はサムネイルと呼ばれていたもの) を指定した大きさで生成する時に使われます。
  
Registers a new image size. This means that WordPress will create a copy of the Featured Image (formerly known as post thumbnail) with the specified dimensions when you upload a new image.
+
'''Note:''' アイキャッチ画像を有効化する、またはサムネイルを投稿するためには、使用しているテーマの <tt>[[Theme_Development#Functions_File|functions.php]]</tt> に <code>[[Function Reference/add theme support|add_theme_support]]( 'post-thumbnails' );</code> が含まれていなければなりません。詳しくは「[[Post Thumbnails|投稿サムネイル]]」のページも参照してください。
  
'''Note:''' To enable featured images, or post thumbnails, the current theme must include <code>[[Function Reference/add theme support|add_theme_support]]( 'post-thumbnails' );</code> in its <tt>[[Theme_Development#Functions_File|functions.php]]</tt> file. See also [[Post Thumbnails]].
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
 +
<?php add_image_size( $name, $width, $height, $crop ); ?>
  
== Usage ==
+
<div id="Parameters">
 
+
== パラメータ ==
%%%<?php add_image_size( $name, $width, $height, $crop ); ?>%%%
+
</div>
 
+
{{Parameter|$name|string|新しい画像サイズの名前}}
== Parameters ==
+
{{Parameter|$width|int|投稿サムネイルの幅をピクセル数で表すもの|optional|0}}
 
+
{{Parameter|$height|int|投稿サムネイルの高さをピクセル数で表すもの|optional|0}}
{{Parameter|$name|string|The new image size name.}}
+
{{Parameter|$crop|boolean|画像の切り抜きを行うか否かを指定。<tt>False</tt> - 指定した縦または横の大きさでのリサイズ(ソフトプロポーショナル)。<tt>True</tt> - 指定した大きさでの切り抜き(ハードクロップ)。|optional|false}}
{{Parameter|$width|int|The post thumbnail width in pixels.|optional|0}}
+
{{Parameter|$height|int|The post thumbnail height in pixels.|optional|0}}
+
{{Parameter|$crop|boolean|Crop the image or not. False - Soft proportional crop mode ; True - Hard crop mode.|optional|false}}
+
 
+
== Reserved Image Size Names ==
+
  
 +
<div id="Reserved Image Size Names">
 +
== 予約語 ==
 +
</div>
 
<code>thumb</code>, <code>thumbnail</code>, <code>medium</code>, <code>large</code>, <code>post-thumbnail</code>
 
<code>thumb</code>, <code>thumbnail</code>, <code>medium</code>, <code>large</code>, <code>post-thumbnail</code>
  
''The names "<code>thumb</code>" & "<code>thumbnail</code>" are just alias, so exactly the same.''
+
''"<code>thumb</code>" "<code>thumbnail</code>" はエイリアスなので、全く同一です。''
  
For a detailed explanation and "why", read further inside the [[Function_Reference/image_downsize#Description|image_downsize()]] article.
+
詳しい説明と「なぜなのか」という背景については、 <tt>[[Function_Reference/image_downsize#Description|image_downsize()]]</tt> に詳しい記載があります。
 
+
However, if needed, you can always set the options yourself:
+
  
 +
しかし、必要ならば自らオプションを設定することができます。
 
  update_option('thumbnail_size_w', 160);
 
  update_option('thumbnail_size_w', 160);
 
  update_option('thumbnail_size_h', 160);
 
  update_option('thumbnail_size_h', 160);
 
  update_option('thumbnail_crop', 1);
 
  update_option('thumbnail_crop', 1);
  
== Examples ==
+
<div id="Examples">
 
+
== 用例 ==
A theme's functions.php file.
+
</div>
 +
テーマの <code>functions.php</code> ファイルの用例です。
  
 
  if ( function_exists( 'add_theme_support' ) ) {
 
  if ( function_exists( 'add_theme_support' ) ) {
 
  add_theme_support( 'post-thumbnails' );
 
  add_theme_support( 'post-thumbnails' );
         set_post_thumbnail_size( 150, 150 ); // default Post Thumbnail dimensions 
+
         set_post_thumbnail_size( 150, 150 ); // 初期設定の投稿サムネイル値
 
  }
 
  }
 
   
 
   
 
  if ( function_exists( 'add_image_size' ) ) {  
 
  if ( function_exists( 'add_image_size' ) ) {  
  add_image_size( 'category-thumb', 300, 9999 ); //300 pixels wide (and unlimited height)
+
  add_image_size( 'category-thumb', 300, 9999 ); //300ピクセルの幅 (高さは無制限)
  add_image_size( 'homepage-thumb', 220, 180, true ); //(cropped)
+
  add_image_size( 'homepage-thumb', 220, 180, true ); //(切り抜かれた大きさ)
 
  }
 
  }
===  Crop Mode ===
 
  
Set the image size by resizing the image proportionally (that is, without distorting it):
+
<div id="Crop Mode">
<pre>add_image_size( 'homepage-thumb', 220, 180 ); // 220 pixels wide by 180 pixels tall, soft proportional crop mode</pre>
+
===  切り抜きモード ===
 +
</div>
 +
プロポーショナルに画像のサイズ変更をする場合 (歪ませない場合)
 +
<pre>add_image_size( 'homepage-thumb', 220, 180 ); // 幅220ピクセル、高さ180ピクセルのソフトプロポーショナル</pre>
  
Set the image size by cropping the image (either from the sides, or from the top and bottom):
+
画像サイズを切り抜きに依って変更する場合 (横からまたは上下から)
<pre>add_image_size( 'homepage-thumb', 220, 180, true ); // 220 pixels wide by 180 pixels tall, hard crop mode</pre>
+
<pre>add_image_size( 'homepage-thumb', 220, 180, true ); // 幅220ピクセル、高さ180ピクセルのハードクロップ</pre>
  
=== Using the New Image Sizes ===
+
<div id="Using the New Image Sizes">
 
+
=== 新しい画像サイズを使う ===
Within a theme's template files.
+
</div>
 +
テーマのテンプレートファイル内での用例。
  
 
  <?php if ( has_post_thumbnail() ) { the_post_thumbnail( 'category-thumb' ); } ?>
 
  <?php if ( has_post_thumbnail() ) { the_post_thumbnail( 'category-thumb' ); } ?>
  
== Notes ==
+
<div id="Notes">
 +
== 注釈 ==
 +
</div>
 +
<tt>'false'</tt> の設定を行った時、もしアップロードされた画像の縦または横の大きさが新しい画像サイズと同一であった場合、アップロードディレクトリ内に新しい画像を作成することに失敗します。
  
Using the 'false' setting will fail to produce a new image in the upload directory if one of the image dimensions of the uploaded image are equal to the new image size.
+
<div id="Change_log">
 +
== 変更履歴 ==
 +
</div>
 +
* [[Version 2.9|2.9]]にて導入されました。
  
== Change Log ==
+
<div id="Source_file">
 +
== ソースファイル ==
 +
</div>
 +
<tt>add_image_size()</tt> は {{Trac|wp-includes/media.php}} にあります。
  
* Since [[Version 2.9|2.9]]
+
<div id="Resources">
 +
== リソース ==
 +
</div>
 +
[http://wordpress.org/extend/plugins/regenerate-thumbnails/ Regenerate Thumbnails] - このプラグインは画像のサムネイルを再生成します。「設定→メディア」でサムネイルの設定を変えた後、それまでにアップロードされた画像のサムネイルを変更したい時や、異なった大きさのアイキャッチ画像を一斉に変更したい時、非常に使い勝手のよいプラグインです。
  
== Source File ==
+
[http://wordpress.org/extend/plugins/ajax-thumbnail-rebuild/ AJAX thumbnail rebuild] - このプラグインはサムネイルを再生成します。アップロード済みサムネイルに対して <tt>add_image_size()</tt> を用いたい時に使えるプラグインです。(動作は遅いものの、メモリー不足エラーとなることがありません)
  
<tt>add_image_size()</tt> is located in {{Trac|wp-includes/media.php}}.
+
[http://wordpress.org/extend/plugins/simple-image-sizes/ Simple Image Sizes] - このプラグインは「メディア」パネルから直接、新しいサイズのサムネイルを生成するものです。このプラグインはまた、サムネイルの再生成も行います。このプラグインは投稿する画像サイズにサムネイルを追加し、それらを直接投稿へ追加させることができます。再生成したい大きさや投稿タイプを選ぶこともできます。
  
== Resources ==
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
{{Post Thumbnail Tags}}
  
[http://wordpress.org/extend/plugins/regenerate-thumbnails/ Regenerate Thumbnails] - This plugin regenerate the thumbnails for your image attachments. This is very handy if you've changed any of your thumbnail dimensions (via Settings -> Media) after previously uploading images or have changed to a theme with different featured post image dimensions.
 
  
[http://wordpress.org/extend/plugins/ajax-thumbnail-rebuild/ AJAX thumbnail rebuild] - This plugin allows you to re-build the post thumbnails. Useful if you use add_image_size() after already having uploaded post thumbnails. (This plugin is slow, but never has out of memory errors).
+
{{原文|Function Reference/add image size|133124}}<!-- 08:46, 14 July 2013 Djkaz -->
  
[http://wordpress.org/extend/plugins/simple-image-sizes/ Simple Image Sizes] - This plugin allows you create new sizes of thumbnails directly from the  "Media" panel. It allows you to regenerate the thumbnails too. The plugin adds the thumbnails to your post sizes and you can add them directly on your posts. You can choose the sizes you wanted to regenerate and the posts types too.
 
 
== Related ==
 
 
{{Post Thumbnail Tags}}
 
  
 
{{Tag Footer}}
 
{{Tag Footer}}
  
 
[[Category:Functions]]
 
[[Category:Functions]]

2013年7月14日 (日) 19:07時点における版

新しい画像サイズを登録する関数です。これは新しい画像がアップロードされる際に、WordPressがアイキャッチ画像 (以前はサムネイルと呼ばれていたもの) を指定した大きさで生成する時に使われます。

Note: アイキャッチ画像を有効化する、またはサムネイルを投稿するためには、使用しているテーマの functions.phpadd_theme_support( 'post-thumbnails' ); が含まれていなければなりません。詳しくは「投稿サムネイル」のページも参照してください。

使い方

<?php add_image_size( $name, $width, $height, $crop ); ?>

パラメータ

$name
string) (必須) 新しい画像サイズの名前
初期値: なし
$width
int) (optional) 投稿サムネイルの幅をピクセル数で表すもの
初期値: 0
$height
int) (optional) 投稿サムネイルの高さをピクセル数で表すもの
初期値: 0
$crop
boolean) (optional) 画像の切り抜きを行うか否かを指定。False - 指定した縦または横の大きさでのリサイズ(ソフトプロポーショナル)。True - 指定した大きさでの切り抜き(ハードクロップ)。
初期値: false

予約語

thumb, thumbnail, medium, large, post-thumbnail

"thumb" と "thumbnail" はエイリアスなので、全く同一です。

詳しい説明と「なぜなのか」という背景については、 image_downsize() に詳しい記載があります。

しかし、必要ならば自らオプションを設定することができます。

update_option('thumbnail_size_w', 160);
update_option('thumbnail_size_h', 160);
update_option('thumbnail_crop', 1);

用例

テーマの functions.php ファイルの用例です。

if ( function_exists( 'add_theme_support' ) ) {
	add_theme_support( 'post-thumbnails' );
        set_post_thumbnail_size( 150, 150 ); // 初期設定の投稿サムネイル値
}

if ( function_exists( 'add_image_size' ) ) { 
	add_image_size( 'category-thumb', 300, 9999 ); //300ピクセルの幅 (高さは無制限)
	add_image_size( 'homepage-thumb', 220, 180, true ); //(切り抜かれた大きさ)
}

切り抜きモード

プロポーショナルに画像のサイズ変更をする場合 (歪ませない場合)

add_image_size( 'homepage-thumb', 220, 180 ); // 幅220ピクセル、高さ180ピクセルのソフトプロポーショナル

画像サイズを切り抜きに依って変更する場合 (横からまたは上下から)

add_image_size( 'homepage-thumb', 220, 180, true ); // 幅220ピクセル、高さ180ピクセルのハードクロップ

新しい画像サイズを使う

テーマのテンプレートファイル内での用例。

<?php if ( has_post_thumbnail() ) { the_post_thumbnail( 'category-thumb' ); } ?>

注釈

'false' の設定を行った時、もしアップロードされた画像の縦または横の大きさが新しい画像サイズと同一であった場合、アップロードディレクトリ内に新しい画像を作成することに失敗します。

変更履歴

  • 2.9にて導入されました。

ソースファイル

add_image_size()wp-includes/media.php にあります。

リソース

Regenerate Thumbnails - このプラグインは画像のサムネイルを再生成します。「設定→メディア」でサムネイルの設定を変えた後、それまでにアップロードされた画像のサムネイルを変更したい時や、異なった大きさのアイキャッチ画像を一斉に変更したい時、非常に使い勝手のよいプラグインです。

AJAX thumbnail rebuild - このプラグインはサムネイルを再生成します。アップロード済みサムネイルに対して add_image_size() を用いたい時に使えるプラグインです。(動作は遅いものの、メモリー不足エラーとなることがありません)

Simple Image Sizes - このプラグインは「メディア」パネルから直接、新しいサイズのサムネイルを生成するものです。このプラグインはまた、サムネイルの再生成も行います。このプラグインは投稿する画像サイズにサムネイルを追加し、それらを直接投稿へ追加させることができます。再生成したい大きさや投稿タイプを選ぶこともできます。

投稿サムネイル: has_post_thumbnail, the_post_thumbnail, get_post_thumbnail_id, get_the_post_thumbnail, add_image_size(), set_post_thumbnail_size()


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


関数リファレンステンプレートタグ目次もご覧ください。