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

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

関数リファレンス/wp prepare attachment for js

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

JSONでエンコードされた事が予想される場合、JSためのアタッチメント投稿オブジェクトを準備します。アタッチメントのモデルに適合します。

使い方

<?php wp_prepare_attachment_for_js( $attachment ) ?>

パラメータ

$attachment
mixed) (必須) Attachmentの ID またはオブジェクト。
初期値: なし

返り値

(array) 
アタッチメントの配列の詳細。

戻されるフィールドは次の通り:

  • id
  • title
  • filename
  • url
  • link
  • alt
  • author
  • description
  • caption
  • name
  • status
  • uploadedTo
  • date
  • modified
  • menuOrder
  • mime
  • type
  • subtype
  • icon
  • dateFormatted
  • nonces
  • editLink
  • sizes
  • width
  • height
  • fileLength
  • compat

用例

JSギャラリーに画像データを渡します。

<?php
add_action( 'wp_head', 'my_js_gallery_add_gallery_images', 1 );
function my_js_gallery_add_gallery_images(){
	global $post;

	$gallery_images = array();
	$attachments = get_posts( array(
		'post_type' => 'attachment',
		'post_status' => 'inherit',
		'post_parent' => $post->ID,
		'post_mime_type' => 'image',
	) );

	foreach( $attachments as $attachment )
		$gallery_images[] = wp_prepare_attachment_for_js( $attachment->ID );

	wp_localize_script( 'my-js-gallery', 'my_js_gallery', array(
		'images' => $gallery_images,
	) );
}

デフォルトの使い方

更新履歴

ソースファイル

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

関連

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


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