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

「関数リファレンス/apply filters」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
({{原文|Function Reference/apply_filters|85216}}<!-- 15:17, 2 April 2010 Ramiy 版 -->)
 
(翻訳済み、div は付けていない)
1行目: 1行目:
{{NeedTrans}}
+
== 説明 ==
== Description ==
+
  
Call the functions added to a filter hook. See the [[Plugin API]] for a list of filter hooks.
+
フィルターフックに追加された関数を呼び出します。フィルターフックの一覧は [[プラグイン_API]] をごらんください。
  
The callback functions attached to filter hook <tt>$tag</tt> are invoked by calling this function. This function can be used to create a new filter hook by simply calling this function with the name of the new hook specified using the <tt>$tag</tt> parameter.
+
この関数により、フィルターフック <tt>$tag</tt> に付加されたコールバック関数が呼び出されます。この関数を、<tt>$tag</tt> パラメータを使用して新しく指定したフックの名前と一緒に呼び出すことで、フィルターフックを新規作成することができます。
  
== Usage ==
+
== 使い方 ==
  
%%% <?php apply_filters( $tag, $value ); ?> %%%
+
<?php apply_filters( $tag, $value ); ?>  
  
== Parameters ==
+
== パラメータ ==
  
{{Parameter|$tag|string|The name of the filter hook.}}
+
{{Parameter|$tag|文字列|フィルターフック名。}}
{{Parameter|$value|mixed|The value which the filters hooked to <tt>$tag</tt> may modify.}}
+
{{Parameter|$value|mixed|フィルターがフックされている <tt>$tag</tt> が変更できる値。}}
  
== Return ==
+
== 戻り値 ==
  
; (''mixed'') : The result of <tt>$value</tt> after all hooked functions are applied to it.
+
; (''mixed'') : 全てのフックされた関数が適用された後の <tt>$value</tt> の結果。
  
'''Note:''' The type of return should be the same as the type of $value: a string or an array, for example.
+
''':''' 戻り値の型は、$value の型(文字列や配列等)と同じでなければなりません。
  
== Examples ==
+
== 用例 ==
  
=== Echo after Filtering ===
+
=== フィルター後にエコーする ===
 
   
 
   
 
  echo apply_filters( $tag, $value );
 
  echo apply_filters( $tag, $value );
  
=== Get Filtered ===
+
=== フィルターされる ===
  
 
  $myvar = apply_filters( $tag, $value );
 
  $myvar = apply_filters( $tag, $value );
  
== Notes ==
+
== ==
  
== Change Log ==
+
== 更新履歴 ==
  
* Since: 0.71
+
* 0.71 以降
  
== Source File ==
+
== ソースファイル ==
  
<tt>apply_filters()</tt> is located in {{Trac|wp-includes/plugin.php}}.
+
<tt>apply_filters()</tt> {{Trac|wp-includes/plugin.php}} にあります。
  
== Related ==
+
== 関連資料 ==
  
 
{{Filter Tags}}
 
{{Filter Tags}}

2010年4月16日 (金) 08:56時点における版

説明

フィルターフックに追加された関数を呼び出します。フィルターフックの一覧は プラグイン_API をごらんください。

この関数により、フィルターフック $tag に付加されたコールバック関数が呼び出されます。この関数を、$tag パラメータを使用して新しく指定したフックの名前と一緒に呼び出すことで、フィルターフックを新規作成することができます。

使い方

<?php apply_filters( $tag, $value ); ?> 

パラメータ

$tag
文字列) (必須) フィルターフック名。
初期値: なし
$value
mixed) (必須) フィルターがフックされている $tag が変更できる値。
初期値: なし

戻り値

(mixed
全てのフックされた関数が適用された後の $value の結果。

注: 戻り値の型は、$value の型(文字列や配列等)と同じでなければなりません。

用例

フィルター後にエコーする

echo apply_filters( $tag, $value );

フィルターされる

$myvar = apply_filters( $tag, $value );

更新履歴

  • 0.71 以降

ソースファイル

apply_filters()wp-includes/plugin.php にあります。

関連資料

フィルター: has_filter(), add_filter(), apply_filters(), current_filter(), remove_filter(), remove_all_filters()



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

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