<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][9267] trunk/src/bp-members/bp-members-admin.php: Add hook documentation in bp-members-admin.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9267">9267</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9267","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-12-24 02:28:15 +0000 (Wed, 24 Dec 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add hook documentation in bp-members-admin.php.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5944">#5944</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersadminphp">trunk/src/bp-members/bp-members-admin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersadminphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-admin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-admin.php 2014-12-24 02:27:31 UTC (rev 9266)
+++ trunk/src/bp-members/bp-members-admin.php 2014-12-24 02:28:15 UTC (rev 9267)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -552,6 +552,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
</span><span class="cx" style="display: block; padding: 0 10px"> $css = $this->css_url . "admin{$min}.css";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the CSS URL to enqueue in the Members admin area.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $css URL to the CSS admin file to load.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $css = apply_filters( 'bp_members_admin_css', $css );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_style( 'bp-members-css', $css, array(), bp_get_version() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -561,14 +569,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_style_add_data( 'bp-members-css', 'suffix', $min );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Only load javascript for BuddyPress profile
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Only load JavaScript for BuddyPress profile
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( get_current_screen()->id == $this->user_page ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $js = $this->js_url . "admin{$min}.js";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the JS URL to enqueue in the Members admin area.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $js URL to the JavaScript admin file to load.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $js = apply_filters( 'bp_members_admin_js', $js );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'bp-members-js', $js, array( 'jquery' ), bp_get_version(), true );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Plugins may want to hook here to load some css/js
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after all of the members JavaScript and CSS is enqueued.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $id ID of the current screen.
+ * @param array $screen_id Array of allowed screens to add scripts and styles to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_admin_enqueue_scripts', get_current_screen()->id, $this->screen_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -659,10 +682,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Call an action for plugins to hook in early
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires at the start of the signups admin load.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $doaction Current bulk action being processed.
+ * @param array $_REQUEST Current $_REQUEST global.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_members_admin_load', array( $doaction, $_REQUEST ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allowed actions
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the allowed actions for use in the user admin page.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $value Array of allowed actions to use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $allowed_actions = apply_filters( 'bp_members_admin_allowed_actions', array( 'update', 'delete_avatar', 'spam', 'ham' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Prepare the display of the Community Profile screen
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -700,8 +736,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->stats_metabox->priority = 'core';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * xProfile Hooks to load the profile fields if component is active
- * Plugins should not use this hook, please use 'bp_members_admin_user_metaboxes' instead
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fires before loading the profile fields if component is active.
+ *
+ * Plugins should not use this hook, please use 'bp_members_admin_user_metaboxes' instead.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param int $user_id Current user ID for the screen.
+ * @param string $id Current screen ID.
+ * @param object $stats_metabox Object holding position data for use with the stats metabox.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_members_admin_xprofile_metabox', array( $user_id, get_current_screen()->id, $this->stats_metabox ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -736,11 +779,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Custom metabox ?
- * Plugins can restrict metabox to "bp_moderate" admins checking
- * the first argument ($this->is_self_profile) is false in their hook
- * They can also restruct their metabox to self profile editing
- * by cheking it set to true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fires at the end of the Community Profile screen.
+ *
+ * Plugins can restrict metabox to "bp_moderate" admins by checking if
+ * the first argument ($this->is_self_profile) is false in their callback.
+ * They can also restrict their metabox to self profile editing
+ * by setting it to true.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param bool $is_self_profile Whether or not it is the current user's profile.
+ * @param int $user_id Current user ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_admin_user_metaboxes', $this->is_self_profile, $user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -765,6 +814,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->redirect = $redirect_to;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires at end of user profile admin load if doaction does not match any available actions.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $doaction Current bulk action being processed.
+ * @param int $user_id Current user ID.
+ * @param array $_REQUEST Current $_REQUEST global.
+ * @param string $redirect Determined redirect url to send user to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_members_admin_update_user', array( $doaction, $user_id, $_REQUEST, $this->redirect ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_redirect( $this->redirect );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1005,6 +1064,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> // Loading other stats only if user has activated their account
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $user->user_status ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires in the user stats metabox if the user has activated their account.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $value Array holding the user ID.
+ * @param object $user Current displayed user object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_admin_user_stats', array( 'user_id' => $user->ID ), $user );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1312,10 +1380,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = remove_query_arg( array( 'action', 'error', 'updated', 'activated', 'notactivated', 'deleted', 'notdeleted', 'resent', 'notresent', 'do_delete', 'do_resend', 'do_activate', '_wpnonce', 'signup_ids' ), $_SERVER['REQUEST_URI'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $doaction = bp_admin_list_table_current_bulk_action();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Call an action for plugins to hook in early
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires at the start of the signups admin load.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $doaction Current bulk action being processed.
+ * @param array $_REQUEST Current $_REQUEST global.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_signups_admin_load', $doaction, $_REQUEST );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allowed actions
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the allowed actions for use in the user signups admin page.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $value Array of allowed actions to use.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $allowed_actions = apply_filters( 'bp_signups_admin_allowed_actions', array( 'do_delete', 'do_activate', 'do_resend' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Prepare the display of the Community Profile screen
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1446,6 +1527,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->redirect = $redirect_to;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires at end of signups admin load if doaction does not match any actions.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $doaction Current bulk action being processed.
+ * @param array $_REQUEST Current $_REQUEST global.
+ * @param string $redirect Determined redirect url to send user to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_admin_update_signups', $doaction, $_REQUEST, $this->redirect );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_redirect( $this->redirect );
</span></span></pre>
</div>
</div>
</body>
</html>