<!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][9271] trunk/src/bp-members/bp-members-screens.php: Add hook documentation in bp-members-screens.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/9271">9271</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/9271","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:31:20 +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-screens.php.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5944">#5944</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersscreensphp">trunk/src/bp-members/bp-members-screens.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersscreensphp"></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-screens.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-screens.php 2014-12-24 02:30:41 UTC (rev 9270)
+++ trunk/src/bp-members/bp-members-screens.php 2014-12-24 02:31:20 UTC (rev 9271)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,7 +16,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Handle the display of the profile page by loading the correct template file.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_members_screen_display_profile() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires right before the loading of the Member profile screen template file.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_screen_display_profile' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the template to load for the Member profile page screen.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $template Path to the Member template to load.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_load_template( apply_filters( 'bp_members_screen_display_profile', 'members/single/home' ) );
</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">@@ -27,8 +41,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_members_directory() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_update_is_directory( true, 'members' );
</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 right before the loading of the Member directory index screen template file.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_screen_index' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the template to load for the Member directory page screen.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value Path to the member directory template to load.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_load_template( apply_filters( 'bp_members_screen_index', 'members/index' ) );
</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">@@ -53,6 +79,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = bp_get_root_domain();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the URL to redirect logged in users to when visiting registration page.
+ *
+ * @since BuddyPress (1.5.1)
+ *
+ * @param string $redirect_to URL to redirect user to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_redirect( apply_filters( 'bp_loggedin_register_page_redirect_to', $redirect_to ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,6 +99,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // If the signup page is submitted, validate and save
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $_POST['signup_submit'] ) && bp_verify_nonce_request( 'bp_new_signup' ) ) {
</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 the validation of a new signup.
+ *
+ * @since BuddyPress (2.0.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_signup_pre_validate' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check the base account details for problems
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -132,6 +170,11 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the validation of a new signup.
+ *
+ * @since BuddyPress (1.1.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_signup_validate' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add any errors to the action for the field in the template for display.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,6 +182,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $bp->signup->errors as $fieldname => $error_message ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // addslashes() and stripslashes() to avoid create_function()
</span><span class="cx" style="display: block; padding: 0 10px"> // syntax errors when the $error_message contains quotes
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the error message in the loop.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value Error message wrapped in html.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_' . $fieldname . '_errors', create_function( '', 'echo apply_filters(\'bp_members_signup_error_message\', "<div class=\"error\">" . stripslashes( \'' . addslashes( $error_message ) . '\' ) . "</div>" );' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -185,6 +236,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'blog' == $active_signup || 'all' == $active_signup )
</span><span class="cx" style="display: block; padding: 0 10px"> $usermeta['public'] = ( isset( $_POST['signup_blog_privacy'] ) && 'public' == $_POST['signup_blog_privacy'] ) ? true : false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the user meta used for signup.
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @param array $usermeta Array of user meta to add to signup.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $usermeta = apply_filters( 'bp_signup_usermeta', $usermeta );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Finally, sign up the user and/or blog
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -201,12 +259,30 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the completion of a new signup.
+ *
+ * @since BuddyPress (1.1.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_complete_signup' );
</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><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires right before the loading of the Member registration screen template file.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_core_screen_signup' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the template to load for the Member registration page screen.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value Path to the Member registration template to load.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_load_template( apply_filters( 'bp_core_template_register', array( 'register', 'registration/register' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_screens', 'bp_core_screen_signup' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -228,6 +304,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = trailingslashit( bp_get_root_domain() );
</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">+ /**
+ * Filters the URL to redirect logged in users to when visiting activation page.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param string $redirect_to URL to redirect user to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_redirect( apply_filters( 'bp_loggedin_activate_page_redirect_to', $redirect_to ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -243,7 +326,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // we've got a key; let's attempt to activate the signup
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $key ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Activate the signup
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the activation signup.
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @param bool|int $value Value returned by activation.
+ * Integer on success, boolean on failure.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $user = apply_filters( 'bp_core_activate_account', bp_core_activate_signup( $key ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If there were errors, add a message and redirect
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,6 +355,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp->activation_complete = true;
</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">+ /**
+ * Filters the template to load for the Member activation page screen.
+ *
+ * @since BuddyPress (1.1.1)
+ *
+ * @param string $value Path to the Member activation template to load.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_load_template( apply_filters( 'bp_core_template_activate', array( 'activate', 'registration/activate' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_screens', 'bp_core_screen_activation' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,6 +402,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! bp_current_action() && ! bp_current_item() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_update_is_directory( true, 'members' );
</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 if looking at Members directory when needing theme compat.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_screen_index' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_buddypress_template', array( $this, 'directory_template_hierarchy' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,6 +420,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_active( 'activity' ) && bp_is_single_activity() )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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 if looking at Members user page when needing theme compat.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_members_screen_display_profile' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_buddypress_template', array( $this, 'single_template_hierarchy' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -336,12 +444,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.8.0)
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $templates The templates from bp_get_theme_compat_templates().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $templates The templates from bp_get_theme_compat_templates().
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array $templates Array of custom templates to look for.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function directory_template_hierarchy( $templates = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Setup our templates based on priority
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the template hierarchy for theme compat and members directory page.
+ *
+ * @since BuddyPress (1.8.0)
+ *
+ * @param array $value Array of template paths to add to hierarchy.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_templates = apply_filters( 'bp_template_hierarchy_members_directory', array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'members/index-directory.php'
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -399,7 +514,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Setup some variables we're going to reference in our custom templates
</span><span class="cx" style="display: block; padding: 0 10px"> $user_nicename = buddypress()->displayed_user->userdata->user_nicename;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Setup our templates based on priority
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the template hierarchy for theme compat and member pages.
+ *
+ * @since BuddyPress (1.8.0)
+ *
+ * @param array $value Array of template paths to add to hierarchy.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_templates = apply_filters( 'bp_template_hierarchy_members_single_item', array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'members/single/index-id-' . sanitize_file_name( bp_displayed_user_id() ) . '.php',
</span><span class="cx" style="display: block; padding: 0 10px"> 'members/single/index-nicename-' . sanitize_file_name( $user_nicename ) . '.php',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -501,7 +622,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function template_hierarchy( $templates ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $component = sanitize_file_name( bp_current_component() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Setup our templates based on priority
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the template hierarchy for theme compat and registration/activation pages.
+ *
+ * This filter is a variable filter that depends on the current component
+ * being used.
+ *
+ * @since BuddyPress (1.8.0)
+ *
+ * @param array $value Array of template paths to add to hierarchy.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_templates = apply_filters( "bp_template_hierarchy_{$component}", array(
</span><span class="cx" style="display: block; padding: 0 10px"> "members/index-{$component}.php"
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span></span></pre>
</div>
</div>
</body>
</html>