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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
({{原文|Function Reference/do_action|76444}}<!-- 21:07, 29 July 2009 Brentes 版 -->)
 
(翻訳済み、div は付けていない)
1行目: 1行目:
== Description ==
+
== 説明 ==
  
Hooks a function on to a specific [[プラグイン_API#Actions|action]].
+
特定の[[プラグイン_API#Actions|アクション]]に関数をフックします。
  
See [[プラグイン_API/Action_Reference|Plugin API/Action Reference]] for a list of hooks for action. Actions are (usually) triggered when the Wordpress core calls [[関数リファレンス/do_action|do_action()]].
+
アクションフックの一覧は [[プラグイン_API/アクションフック一覧|アクションフック一覧]] をごらんください。アクションは(通常は) WordPress コアが [[関数リファレンス/do_action|do_action()]] を呼び出すときにトリガーされます。
  
== Usage ==
+
== 使い方 ==
  
%%% <?php add_action( $tag, $function_to_add, $priority, $accepted_args ); ?> %%%
+
<?php add_action( $tag, $function_to_add, $priority, $accepted_args ); ?>  
  
== Parameters ==
+
== パラメータ ==
  
{{Parameter|$tag|string|The name of the action you wish to hook onto. (See [[Plugin_API/Action_Reference|Plugin API/Action Reference]] for a list of action hooks)}}
+
{{Parameter|$tag|文字列|フックするアクション名 (アクションの一覧は [[プラグイン_API/アクションフック一覧|アクションフック一覧]] を参照)}}
{{Parameter|$function_to_add|callback|The name of the function you wish to be called. Note: any of the syntaxes explained in [http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback the PHP documentation for the 'callback' type] are valid.}}
+
{{Parameter|$function_to_add|コールバック|呼び出す関数名。注: any of the syntaxes explained in [http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback' タイプについてのドキュメント] で説明される構文は全て有効です。}}
{{Parameter|$priority|int|How important your function is. Alter this to make your function be called before or after other functions. The default is 10, so (for example) setting it to 5 would make it run earlier and setting it to 12 would make it run later.|optional|10}}
+
{{Parameter|$priority|整数|関数の重要度です。呼び出す関数と他の関数との順序を変更します。デフォルト値は 10 で、例えば 5 に設定すると早く実行され、12 に設定すると遅く実行されます。|オプション|10}}
{{Parameter|$accepted_args|int|How many arguments your function takes. In WordPress 1.5.1+, hooked functions can take extra arguments that are set when the matching [[Function_Reference/do_action|do_action()]] or apply_filters() call is run. For example, the action <tt>comment_id_not_found</tt> will pass any functions that hook onto it the ID of the requested comment.|optional|1}}
+
{{Parameter|$accepted_args|整数|関数の引数の数です。WordPress 1.5.1+ では、フックした関数は、対応する [[関数リファレンス/do_action|do_action()]] あるいは apply_filters() が実行される時に、余分に引数を取ることができます。例えば、アクション <tt>comment_id_not_found</tt> は、これにフックする関数に、リクエストされたコメントの ID を渡すことができます。|オプション|1}}
  
== Examples ==
+
== 用例 ==
  
=== Simple Hook ===
+
=== 単純なフック ===
To email some friends whenever an entry is posted on your blog:
+
ブログに投稿したときに、メールで友人に知らせます。
  
 
<pre>
 
<pre>
31行目: 31行目:
 
</pre>
 
</pre>
  
=== Take Arguments ===
+
=== 引数を取る ===
The hooked function takes one argument from the action. Specifically, the 'echo_comment_id' function, takes the argument $comment_ID. It then echos the value of the received argument.
+
フックした関数は、アクションから引数を 1 つ取ります。特に 'echo_comment_id' 関数は、$comment_ID を取ります。この例は、受け取った引数の値を画面に表示します。
  
 
<pre>
 
<pre>
41行目: 41行目:
 
</pre>
 
</pre>
  
== Notes ==
+
== ==
  
== Change Log ==
+
== 更新履歴 ==
  
Since: 1.2.0
+
1.2.0 以降
  
== Source File ==
+
== ソースファイル ==
  
 
<tt>add_action()</tt> is located in {{Trac|wp-includes/plugin.php}}.
 
<tt>add_action()</tt> is located in {{Trac|wp-includes/plugin.php}}.

2010年4月15日 (木) 17:33時点における版

説明

特定のアクションに関数をフックします。

アクションフックの一覧は アクションフック一覧 をごらんください。アクションは(通常は) WordPress コアが do_action() を呼び出すときにトリガーされます。

使い方

<?php add_action( $tag, $function_to_add, $priority, $accepted_args ); ?> 

パラメータ

$tag
文字列) (必須) フックするアクション名 (アクションの一覧は アクションフック一覧 を参照)
初期値: なし
$function_to_add
コールバック) (必須) 呼び出す関数名。注: any of the syntaxes explained in 'callback' タイプについてのドキュメント で説明される構文は全て有効です。
初期値: なし
$priority
整数) (オプション) 関数の重要度です。呼び出す関数と他の関数との順序を変更します。デフォルト値は 10 で、例えば 5 に設定すると早く実行され、12 に設定すると遅く実行されます。
初期値: 10
$accepted_args
整数) (オプション) 関数の引数の数です。WordPress 1.5.1+ では、フックした関数は、対応する do_action() あるいは apply_filters() が実行される時に、余分に引数を取ることができます。例えば、アクション comment_id_not_found は、これにフックする関数に、リクエストされたコメントの ID を渡すことができます。
初期値: 1

用例

単純なフック

ブログに投稿したときに、メールで友人に知らせます。

function email_friends($post_ID)  {
   $friends = 'bob@example.org, susie@example.org';
   mail($friends, "sally's blog updated" , 'I just put something on my blog: http://blog.example.com');
   return $post_ID;
}

add_action('publish_post', 'email_friends');

引数を取る

フックした関数は、アクションから引数を 1 つ取ります。特に 'echo_comment_id' 関数は、$comment_ID を取ります。この例は、受け取った引数の値を画面に表示します。

function echo_comment_id($comment_ID) {
   echo "I just received $comment_ID";
}
add_action('comment_id_not_found','echo_comment_id', 10, 1);

更新履歴

1.2.0 以降

ソースファイル

add_action() is located in wp-includes/plugin.php.

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

関連資料

アクション: has_action(), add_action(), do_action(), do_action_ref_array(), did_action(), remove_action(), remove_all_actions()



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