<!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][9298] trunk/src/bp-xprofile/bp-xprofile-admin.php: Adds hooks documentation for bp-xprofile-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/9298">9298</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/9298","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>2015-01-06 02:57:43 +0000 (Tue, 06 Jan 2015)</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'>Adds hooks documentation for bp-xprofile-admin.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5949">#5949</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofileadminphp">trunk/src/bp-xprofile/bp-xprofile-admin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofileadminphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-admin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-admin.php 2015-01-05 21:33:44 UTC (rev 9297)
+++ trunk/src/bp-xprofile/bp-xprofile-admin.php 2015-01-06 02:57:43 UTC (rev 9298)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,8 +119,18 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php do_action( 'xprofile_admin_group_action', $group ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php
</ins><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 action buttons in xprofile management admin.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param BP_XProfile_Group $group BP_XProfile_Group object
+ * for the current group.
+ */
+ do_action( 'xprofile_admin_group_action', $group ); ?>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -197,6 +207,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 1 == $group_id )
</span><span class="cx" style="display: block; padding: 0 10px"> bp_update_option( 'bp-xprofile-base-group-name', $group->name );
</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 the end of the group adding/saving process, if successful.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param BP_XProfile_Group $group Current BP_XProfile_Group object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_groups_saved_group', $group );
</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">@@ -226,6 +243,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $message = __( 'The group was deleted successfully.', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> $type = 'success';
</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 the end of group deletion process, if successful.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param BP_XProfile_Group $group Current BP_XProfile_Group object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_groups_deleted_group', $group );
</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">@@ -287,6 +311,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $_GET['mode'] );
</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 the end of the process to save a field for a user, if successful.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param BP_XProfile_Field $field Current BP_XProfile_Field object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_fields_saved_field', $field );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $groups = bp_xprofile_get_groups();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -303,7 +334,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Handles the deletion of a profile field (or field option)
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.0)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.0.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global string $message The feedback message to show
</span><span class="cx" style="display: block; padding: 0 10px"> * @global $type The type of feedback message to show
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $field_id The field to delete
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,6 +356,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $message = sprintf( __( 'The %s was deleted successfully!', 'buddypress' ), $field_type );
</span><span class="cx" style="display: block; padding: 0 10px"> $type = 'success';
</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 the end of the field deletion process, if successful.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param BP_XProfile_Field $field Current BP_XProfile_Field object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_fields_deleted_field', $field );
</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">@@ -386,7 +424,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php bp_the_profile_field_name(); ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if ( ! $field->can_delete ) : ?> <?php _e( '(Primary)', 'buddypress' ); endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if ( bp_get_the_profile_field_is_required() ) : ?><?php _e( '(Required)', 'buddypress' ) ?><?php endif; ?>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php do_action( 'xprofile_admin_field_name_legend', $field ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php
+
+ /**
+ * Fires at end of legend above the name field in base xprofile group.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param BP_XProfile_Field $field Current BP_XProfile_Field
+ * object being rendered.
+ */
+ do_action( 'xprofile_admin_field_name_legend', $field ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </span>
</span><span class="cx" style="display: block; padding: 0 10px"> </legend>
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="field-wrapper">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -395,8 +443,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $field->type, array_keys( bp_xprofile_get_field_types() ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $field_type = bp_xprofile_create_field_type( $field->type );
</span><span class="cx" style="display: block; padding: 0 10px"> $field_type->admin_field_html();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the input if the current field is not in default field types.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param BP_XProfile_Field $field Current BP_XProfile_Field
+ * object being rendered.
+ * @param int $value Integer 1.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_admin_field', $field, 1 );
</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">@@ -418,8 +475,18 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php do_action( 'xprofile_admin_field_action', $field ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php
</ins><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 field management links in xprofile management admin.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param BP_XProfile_Group $group BP_XProfile_Group object
+ * for the current group.
+ */
+ do_action( 'xprofile_admin_field_action', $field ); ?>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> </fieldset>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -694,6 +761,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! xprofile_set_field_data( $field_id, $user_id, $value, $is_required[ $field_id ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $errors = true;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires after the saving of each profile field, if successful.
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @param int $field_id ID of the field being updated.
+ * @param string $value Value that was saved to the field.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_profile_field_data_updated', $field_id, $value );
</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">@@ -702,6 +778,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> xprofile_set_field_visibility_level( $field_id, $user_id, $visibility_level );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 after all of the profile fields have been saved.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $user_id ID of the user whose data is being saved.
+ * @param array $posted_field_ids IDs of the fields that were submitted.
+ * @param bool $errors Whether or not errors occurred during saving.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'xprofile_updated_profile', $user_id, $posted_field_ids, $errors );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Set the feedback messages
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -771,6 +856,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif;
</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 before display of visibility form elements for profile metaboxes.
+ *
+ * @since BuddyPress (1.7.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_custom_profile_edit_fields_pre_visibility' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $can_change_visibility = bp_current_user_can( 'bp_xprofile_change_field_visibility' ); ?>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -800,8 +890,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php do_action( 'bp_custom_profile_edit_fields' ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php
</ins><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 custom profile field items on your xprofile screen tab.
+ *
+ * @since BuddyPress (1.1.0)
+ */
+ do_action( 'bp_custom_profile_edit_fields' ); ?>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endwhile; // bp_profile_fields() ?>
</span></span></pre>
</div>
</div>
</body>
</html>