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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(関連資料)
(最新版のマージ)
1行目: 1行目:
 
== 説明 ==
 
== 説明 ==
  
フックを作成します。 [[関数リファレンス/add_action|add_action]] でアクションが付加可能になります。
+
フックを作成します。  
 +
 
 +
This function invokes all functions attached to action hook <tt>$tag</tt>. It is possible to create new action hooks by simply calling this function, specifying the name of the new hook using the <tt>$tag</tt> parameter. You can pass extra arguments to the hooks, much like you can with <tt>[[Function_Reference/apply_filters | apply_filters()]]</tt>. This function works similar to <tt>apply_filters()</tt> with the exception that nothing is returned and only the functions or methods are called.
 +
 
 +
[[関数リファレンス/add_action|add_action]] でアクションが付加可能になります。
  
 
== 使い方 ==
 
== 使い方 ==
  
 
  <?php do_action( $tag, $arg ); ?>  
 
  <?php do_action( $tag, $arg ); ?>  
 +
 +
Multiple Arguments:
 +
<?php do_action( $tag, $arg_a, $arg_b, $etc ); ?>
  
 
== パラメータ ==
 
== パラメータ ==
  
 
{{Parameter|$tag|文字列|作成したいフック名}}
 
{{Parameter|$tag|文字列|作成したいフック名}}
{{Parameter|$arg|文字列|このフックが受け入れる引数|オプション|<nowiki>''</nowiki>}}
+
<!--{{Parameter|$arg|文字列|このフックが受け入れる引数|オプション|<nowiki>''</nowiki>}} -->
 +
{{Parameter|$arg|mixed|引数のリストは、このフックに送信します。|オプション|空の文字列}}
 +
 
 +
== 返り値 ==
 +
 
 +
なし
  
 
== 用例 ==
 
== 用例 ==
 +
 +
<pre>
 +
<?php
 +
# ======= (mu-)プラグイン、テーマ、コアのどこか ======= #
 +
 +
/**
 +
* You can have as many arguments as you want,
 +
* but your callback function and the add_action call need to agree in number of arguments.
 +
* Note: `add_action` above has 2 and 'i_am_hook' accepts 2.
 +
* You will find action hooks like these in a lot of themes & plugins and in many place @core
 +
* @see: http://codex.wordpress.org/Plugin_API/Action_Reference
 +
*/
 +
 +
# ======= 例えば functions.phpファイル内 ======= #
 +
 +
/**
 +
* Define callback function
 +
* Inside this function you can do whatever you can imagine
 +
* with the variables that are loaded in the do_action() call above.
 +
*/
 +
function who_is_hook( $a, $b )
 +
{
 +
echo '<code>';
 +
print_r( $a ); // `print_r` the array data inside the 1st argument
 +
echo '</code>';
 +
 +
echo '<br />'.$b; // echo linebreak and value of 2nd argument
 +
}
 +
 +
// then add it to the action hook, matching the defined number (2) of arguments in do_action
 +
// see [http://codex.wordpress.org/Function_Reference/add_action] in the Codex
 +
 +
// add_action( $tag, $function_to_add, $priority, $accepted_args );
 +
add_action( 'i_am_hook', 'who_is_hook', 10, 2 );
 +
 +
// Define the arguments for the action hook
 +
$a = array(
 +
'eye patch' => 'yes'
 +
,'parrot' => true
 +
,'wooden leg' => (int) 1
 +
);
 +
$b = 'And Hook said: "I ate ice cream with Peter Pan."';
 +
 +
// Executes the action hook named 'i_am_hook'
 +
do_action( 'i_am_hook', $a, $b );
 +
 +
 +
# ======= ブラウザで出力を参照 ======= #
 +
 +
Array (
 +
['eye patch'] => 'yes'
 +
['parrot'] => true
 +
['wooden leg'] => 1
 +
)
 +
And hook said: "I ate ice cream with Peter Pan."
 +
</pre>
  
 
== 注 ==
 
== 注 ==
 +
 +
* Uses: [[Global_Variables |グローバル変数]] /[[:en:Global_Variables |en]] <tt>$wp_filter</tt> - Stores all of the filters and actions.
 +
* Uses: [[グローバル変数]] /[[:en:Global_Variables |en]] <tt>$wp_actions</tt> - Increments the amount of times the action was triggered.
  
 
== 変更履歴 ==
 
== 変更履歴 ==
24行目: 95行目:
 
<tt>do_action()</tt> は {{Trac|wp-includes/plugin.php}} にあります。
 
<tt>do_action()</tt> は {{Trac|wp-includes/plugin.php}} にあります。
  
{{原文|Function Reference/do_action|73168}}<!-- 14:30, 31 May 2009 Ramiy 版 -->
+
{{原文|Function Reference/do_action|73168}}<!-- 23:59, 17 May 2014‎ Hissy 版 -->
  
 
== 関連資料 ==
 
== 関連資料 ==
  
 
{{Action Tags}}
 
{{Action Tags}}
 +
 +
{{NeedTrans}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}
  
 
{{DEFAULTSORT:Do_action}}
 
{{DEFAULTSORT:Do_action}}

2015年6月3日 (水) 08:04時点における版

説明

フックを作成します。

This function invokes all functions attached to action hook $tag. It is possible to create new action hooks by simply calling this function, specifying the name of the new hook using the $tag parameter. You can pass extra arguments to the hooks, much like you can with apply_filters(). This function works similar to apply_filters() with the exception that nothing is returned and only the functions or methods are called.

add_action でアクションが付加可能になります。

使い方

<?php do_action( $tag, $arg ); ?> 

Multiple Arguments:

<?php do_action( $tag, $arg_a, $arg_b, $etc ); ?>

パラメータ

$tag
文字列) (必須) 作成したいフック名
初期値: なし
$arg
mixed) (オプション) 引数のリストは、このフックに送信します。
初期値: 空の文字列

返り値

なし

用例

<?php 
# ======= (mu-)プラグイン、テーマ、コアのどこか ======= #

/**
 * You can have as many arguments as you want,
 * but your callback function and the add_action call need to agree in number of arguments.
 * Note: `add_action` above has 2 and 'i_am_hook' accepts 2. 
 * You will find action hooks like these in a lot of themes & plugins and in many place @core
 * @see: http://codex.wordpress.org/Plugin_API/Action_Reference
 */

# ======= 例えば functions.phpファイル内 ======= #

/**
 * Define callback function
 * Inside this function you can do whatever you can imagine
 * with the variables that are loaded in the do_action() call above.
 */
function who_is_hook( $a, $b )
{
	echo '<code>';
		print_r( $a ); // `print_r` the array data inside the 1st argument
	echo '</code>';

	echo '<br />'.$b; // echo linebreak and value of 2nd argument
}

// then add it to the action hook, matching the defined number (2) of arguments in do_action
// see [http://codex.wordpress.org/Function_Reference/add_action] in the Codex 

// add_action( $tag, $function_to_add, $priority, $accepted_args );
add_action( 'i_am_hook', 'who_is_hook', 10, 2 );

// Define the arguments for the action hook
$a = array(
	 'eye patch' => 'yes'
	,'parrot' => true
	,'wooden leg' => (int) 1
);
$b = 'And Hook said: "I ate ice cream with Peter Pan."'; 

// Executes the action hook named 'i_am_hook'
do_action( 'i_am_hook', $a, $b );


# ======= ブラウザで出力を参照 ======= #

Array ( 
	['eye patch'] => 'yes'
	['parrot'] => true
	['wooden leg'] => 1
) 
And hook said: "I ate ice cream with Peter Pan."

変更履歴

1.2.0 以降

ソースファイル

do_action()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()


このページ「関数リファレンス/do action」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています


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