- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「関数リファレンス/add new user to blog」の版間の差分
提供: WordPress Codex 日本語版
< 関数リファレンス
(英文をコピペ。) |
|||
1行目: | 1行目: | ||
− | + | {{Stub}} | |
− | + | ||
− | == Usage == | + | |
+ | <div id="Description"> | ||
+ | == 説明 == | ||
+ | </div> | ||
+ | 新規ユーザーを適切なブログに追加する関数です。 | ||
+ | |||
+ | <div id="Usage"> | ||
+ | == 使用法 == | ||
+ | </div> | ||
<?php add_new_user_to_blog( $user_id, $email, $meta ) ?> | <?php add_new_user_to_blog( $user_id, $email, $meta ) ?> | ||
− | |||
− | |||
− | |||
− | |||
− | == | + | <div id="Parameters"> |
− | + | == パラメータ == | |
+ | </div> | ||
+ | {{Parameter|$user_id|integer|新規ユーザーID|required}} | ||
+ | {{Parameter|$email|string|新規ユーザーのメールアドレス|required}} | ||
+ | {{Parameter|$meta|array|メタにサインアップする。<tt>'add_to_blog'</tt> と <tt>'new_role'</tt> のフィールドが使われる。|required}} | ||
− | == | + | <div id="Return_Value"> |
− | + | == 戻り値 == | |
+ | </div> | ||
+ | なし。この関数は数値を戻しません。 | ||
− | == | + | <div id="Examples"> |
− | + | == 使用例 == | |
− | + | </div> | |
− | + | ||
− | == | + | <div id="Notes"> |
− | + | == 注意点 == | |
+ | </div> | ||
+ | * ユーザーをメインのブログから削除するためには、 <tt>[[Function_Reference/remove_user_from_blog | remove_user_from_blog()]]</tt> を用います。 | ||
+ | * <tt>$meta['add_to_blog']</tt> で与えられたIDのブログにユーザーを追加するためには、 <tt>[[Function_Reference/add_user_to_blog | add_user_to_blog()]]</tt> を用います。 | ||
+ | * <tt>'primary_blog'</tt> のメタキーをアップデートするためには、 <tt>[[Function_Reference/update_user_meta | update_user_meta()]]</tt> を用います。 | ||
− | == | + | <div id="Change Log"> |
− | + | == 改訂履歴 == | |
+ | </div> | ||
+ | [[Version MU|MU]] ([[Version 3.0|3.0.0]]) にて導入されました。 | ||
− | == | + | <div id="Source File"> |
+ | == ソースファイル == | ||
+ | </div> | ||
+ | <tt>add_new_user_to_blog()</tt> は {{Trac|wp-includes/ms-functions.php}} にあります。 | ||
+ | <div id="Related"> | ||
+ | == 関連項目 == | ||
+ | </div> | ||
{{User Blog Tags}} | {{User Blog Tags}} | ||
2013年8月9日 (金) 22:43時点における版
新規ユーザーを適切なブログに追加する関数です。
使用法
<?php add_new_user_to_blog( $user_id, $email, $meta ) ?>
パラメータ
- $user_id
- (integer) (required) 新規ユーザーID
- 初期値: なし
- (string) (required) 新規ユーザーのメールアドレス
- 初期値: なし
- $meta
- (array) (required) メタにサインアップする。'add_to_blog' と 'new_role' のフィールドが使われる。
- 初期値: なし
戻り値
なし。この関数は数値を戻しません。
使用例
注意点
- ユーザーをメインのブログから削除するためには、 remove_user_from_blog() を用います。
- $meta['add_to_blog'] で与えられたIDのブログにユーザーを追加するためには、 add_user_to_blog() を用います。
- 'primary_blog' のメタキーをアップデートするためには、 update_user_meta() を用います。
改訂履歴
ソースファイル
add_new_user_to_blog() は wp-includes/ms-functions.php
にあります。
関連項目
ブログユーザー関数: add_user_to_blog(), add_new_user_to_blog(), remove_user_from_blog(), get_users_of_blog(), is_user_member_of_blog()
最新英語版: WordPress Codex » add new user to blog (最新版との差分)
関数リファレンス、テンプレートタグ目次もご覧ください。