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

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

プラグイン API/フィルターフック一覧/attachment fields to edit

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

説明

"attachment_fields_to_edit" フィルターは、添付ファイルを編集するときに表示される添付ファイルフィールドの配列をフィルタリングするために使用されます。

使い方

'attachment_fields_to_edit' フィルターが呼び出されると、2つの引数が渡されます。第1引数は、表示されるフィールドを説明する連想配列です。2番目の引数は、編集中の添付ファイルを記述する $post オブジェクトです。フィルターに接続された関数は、配列にフィールドを追加または削除し、変更された配列を返すことができます。

function filter_function_name( $form_fields, $post ) {
  // ...
}
add_filter( 'attachment_fields_to_edit', 'filter_function_name', 10, 2 );

filter_function_name は、$form_fields 配列の取得時に WordPress が呼び出す関数です。フィルター関数は、処理が終了した後にフィールドの配列を返さなければならないこと、もしくは添付ファイルを編集するときにフィールドが表示されないこと、そして $form_fields 配列をフィルタリングする他のプラグインがエラーを生成する可能性があることに注意してください。

filter_function_name は一意の関数名でなければなりません。既に宣言されている他の関数名と一致することはできません。

用例

場所フィールドを追加する

次の例は、すべての添付ファイルに「場所」フィールド(スラッグ: location)を追加します。さらにアクション "edit_attachment" を使用して、送信された値を添付ファイルの投稿メタ(スラッグ: location)に保存します。

function my_add_attachment_location_field( $form_fields, $post ) {
    $field_value = get_post_meta( $post->ID, 'location', true );
    $form_fields['location'] = array(
        'value' => $field_value ? $field_value : '',
        'label' => __( 'Location' ),
        'helps' => __( 'Set a location for this attachment' )
    );
    return $form_fields;
}
add_filter( 'attachment_fields_to_edit', 'my_add_attachment_location_field', 10, 2 );

function my_save_attachment_location( $attachment_id ) {
    if ( isset( $_REQUEST['attachments'][$attachment_id]['location'] ) ) {
        $location = $_REQUEST['attachments'][$attachment_id]['location'];
        update_post_meta( $attachment_id, 'location', $location );
    }
}
add_action( 'edit_attachment', 'my_save_attachment_location' );

関連項目

外部リソース

参考

最新英語版: WordPress Codex » Plugin_API/Filter_Reference/attachment_fields_to_edit