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

「関数リファレンス/update attached file」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(ページの作成:「== 説明 == 添付ファイルIDに基づいて添付ファイルのパスを更新する。 添付ファイルのパスを更新するために使用され、添付...」)
 
(和訳をクリーンアップ。)
 
1行目: 1行目:
== 説明 ==
+
== 説明<span id="Description"></span> ==
  
添付ファイルIDに基づいて添付ファイルのパスを更新する。
+
添付ファイルの ID を指定して、実際のファイルのパスを更新します。
  
 +
添付ファイルのパスは投稿メタ情報 <tt>'_wp_attached_file'</tt> に保存されており、この関数はそれを更新します。
  
添付ファイルのパスを更新するために使用され、添付ファイルのパスを保存するために投稿メタ情報 '_wp_attached_file' を使用する。
+
'''注意:''' この関数はファイルを移動しません。何らかの理由で移動した後、<tt>'_wp_attached_file'</tt> 投稿メタ情報を更新するためにこの関数を使います。
  
注意:これはファイルを移動しません。これは、移動後に '_wp_attached_file'投稿メタ情報を更新します。
+
== 使い方<span id="Usage"></span> ==
 
+
 
+
== 使い方 ==
+
  
 
  <?php update_attached_file( $attachment_id, $file ) ?>
 
  <?php update_attached_file( $attachment_id, $file ) ?>
  
== パラメータ ==
+
== パラメータ<span id="Parameters"></span> ==
  
{{Parameter|$attachment_id|integer|添付ファイルの ID|required}}
+
{{Parameter|$attachment_id|整数|添付ファイルの ID|必須}}
  
 +
{{Parameter|$file|文字列|実際のファイルのパス|必須}}
  
{{Parameter|$file|文字列|添付ファイルのパス|required}}
+
== 戻り値<span id="Return Values"></span> ==
  
 +
{{Return||真偽値|成功時は true、失敗時は false。}}
  
 +
== 用例<span id="Examples"></span> ==
  
== 戻り値 ==
+
== 参考<span id="Notes"></span> ==
  
{{Return||bool|成功時はtrue、失敗時は false。}}
+
* [[関数リファレンス/apply_filters|<tt>apply_filters()</tt>]] を使って <tt>$file</tt> にフィルター [https://developer.wordpress.org/reference/hooks/update_attached_file/ <tt>'update_attached_file'</tt>] を適用します。引数は <tt>$file</tt> と <tt>$attachment_id</tt> です。
  
== ==
+
== 変更履歴<span id="Changelog"></span> ==
  
用途:apply_filters()を使用して、$fileと$attachment_idにupdate_attached_file()を追加します。
+
* 新規導入: [[Version 2.1.0|2.1.0]]
  
 +
== ソースファイル<span id="Source_File"></span> ==
  
 +
<tt>update_attached_file()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
== 更新履歴 ==
+
== 関連項目<span id="Related"></span> ==
  
* [[Version 2.1.0]] 以降。
+
{{Tag Footer}}
  
== ソースファイル ==
+
{{原文|Function Reference/update_attached_file|146634}} <!-- 2014-09-15T10:09 Jesin 版 -->
  
<tt>update_attached_file() </tt> は {{Trac|wp-includes/post.php}} にあります。
+
{{DEFAULTSORT:Update_attached_file}}
 +
[[Category:関数]]
  
 
+
[[en:Function Reference/update_attached_file]]
{{Tag Footer}}
+
 
+
{{原文|Function Reference/update_attached_file|146634}}<!-- 2014-09-15T10:09 Jesin 版 -->
+
{{DEFAULTSORT:Set_post_thumbnail}}
+
[[Category:関数]]
+

2017年6月29日 (木) 00:34時点における最新版

説明

添付ファイルの ID を指定して、実際のファイルのパスを更新します。

添付ファイルのパスは投稿メタ情報 '_wp_attached_file' に保存されており、この関数はそれを更新します。

注意: この関数はファイルを移動しません。何らかの理由で移動した後、'_wp_attached_file' 投稿メタ情報を更新するためにこの関数を使います。

使い方

<?php update_attached_file( $attachment_id, $file ) ?>

パラメータ

$attachment_id
整数) (必須) 添付ファイルの ID
初期値: なし
$file
文字列) (必須) 実際のファイルのパス
初期値: なし

戻り値

(真偽値) 
成功時は true、失敗時は false。

用例

参考

変更履歴

ソースファイル

update_attached_file()wp-includes/post.php にあります。

関連項目

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


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