<!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][9078] trunk/src/bp-activity/bp-activity-admin.php: Add hook documentation to bp-activity-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/9078">9078</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/9078","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-11 01:08:07 +0000 (Sat, 11 Oct 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 to bp-activity-admin.php.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5938">#5938</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityadminphp">trunk/src/bp-activity/bp-activity-admin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityadminphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-admin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-admin.php 2014-10-10 20:17:54 UTC (rev 9077)
+++ trunk/src/bp-activity/bp-activity-admin.php 2014-10-11 01:08:07 UTC (rev 9078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -171,6 +171,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Hide the primary link meta box by default
</span><span class="cx" style="display: block; padding: 0 10px"> $hidden = array_merge( (array) $hidden, array( 'bp_activity_itemids', 'bp_activity_link', 'bp_activity_type', 'bp_activity_userid', ) );
</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 default hidden metaboxes so plugins can alter list.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array $hidden Default metaboxes to hide.
+ * @param WP_Screen $screen Screen identifier.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_hide_meta_boxes', array_unique( $hidden ), $screen );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'default_hidden_meta_boxes', 'bp_activity_admin_edit_hidden_metaboxes', 10, 2 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,7 +206,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</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 top of Activity admin page.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param string $doaction Current $_GET action being performed in admin screen.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_admin_load', $doaction );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Edit screen
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -300,7 +314,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Get activity IDs
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_ids = array_map( 'absint', (array) $_REQUEST['aid'] );
</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 a filter for plugins to modify the requested activities to load
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters list of IDs being spammed/un-spammed/deleted.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array $activity_ids Activity IDs to spam/un-spam/delete.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $activity_ids = apply_filters( 'bp_activity_admin_action_activity_ids', $activity_ids );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Is this a bulk request?
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -384,7 +404,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $activity );
</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 actions for plugins to do something before we redirect
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before redirect for plugins to do something with activity.
+ *
+ * Passes an activity array counts how many were spam, not spam, deleted, and IDs that were errors.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array Array holding spam, not spam, deleted counts, error IDs.
+ * @param string $redirect_to URL to redirect to.
+ * @param array $activity_ids Original array of activity IDs.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_admin_action_after', array( $spammed, $unspammed, $deleted, $errors ), $redirect_to, $activity_ids );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add arguments to the redirect URL so that on page reload, we can easily display what we've just done.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -401,7 +431,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $errors ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = add_query_arg( 'error', implode ( ',', array_map( 'absint', $errors ) ), $redirect_to );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Redirect
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters redirect URL after activty spamming/un-spamming/deletion occurs.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param string $redirect_to URL to redirect to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_redirect( apply_filters( 'bp_activity_admin_action_redirect', $redirect_to ) );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -512,7 +548,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $result )
</span><span class="cx" style="display: block; padding: 0 10px"> $error = $activity->id;
</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 actions for plugins to do something before we redirect
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before redirect so plugins can do something first on save action.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array Array holding activity object and ID that holds error.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_activity_admin_edit_after', array( &$activity, $error ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If an error occurred, pass back the activity ID that failed
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -521,7 +563,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = add_query_arg( 'updated', (int) $activity->id, $redirect_to );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Redirect
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters URL to redirect to after saving.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param string $redirect_to URL to redirect to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_redirect( apply_filters( 'bp_activity_admin_edit_redirect', $redirect_to ) );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -586,7 +634,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $form_url = remove_query_arg( array( 'action', 'deleted', 'error', 'spammed', 'unspammed', ), $_SERVER['REQUEST_URI'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $form_url = add_query_arg( 'action', 'save', $form_url );
</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 modify the activity before we display the edit form
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before activity edit form is displays so plugins can modify the activity.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array Array holding single activity object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_activity_admin_edit', array( &$activity ) ); ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -900,7 +954,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Prepare the activity items for display
</span><span class="cx" style="display: block; padding: 0 10px"> $bp_activity_list_table->prepare_items();
</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 modify the activity before we display the edit form
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before edit form is displayed so plugins can modify the activity messages.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array $messages Array of messages to display at top of page.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_admin_index', $messages ); ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1211,7 +1271,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <li class="all"><a href="<?php echo esc_attr( esc_url( $url_base ) ); ?>" class="<?php if ( 'spam' != $this->view ) echo 'current'; ?>"><?php _e( 'All', 'buddypress' ); ?></a> |</li>
</span><span class="cx" style="display: block; padding: 0 10px"> <li class="spam"><a href="<?php echo esc_attr( esc_url( add_query_arg( 'activity_status', 'spam', $url_base ) ) ); ?>" class="<?php if ( 'spam' == $this->view ) echo 'current'; ?>"><?php printf( __( 'Spam <span class="count">(%s)</span>', 'buddypress' ), number_format_i18n( $this->spam_count ) ); ?></a></li>
</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_activity_list_table_get_views', $url_base, $this->view ); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php
+
+ /**
+ * Fires inside listing of views so plugins can add their own.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param string $url_base Current URL base for view.
+ * @param string $view Current view being displayed.
+ */
+ do_action( 'bp_activity_list_table_get_views', $url_base, $this->view ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </ul>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1229,6 +1299,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $actions['bulk_ham'] = __( 'Not Spam', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> $actions['bulk_delete'] = __( 'Delete Permanently', 'buddypress' );
</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 default bulk actions so plugins can add custom actions.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array $actions Default available actions for bulk operations.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_activity_list_table_get_bulk_actions', $actions );
</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">@@ -1429,7 +1506,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Start timestamp
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<div class="submitted-on">';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Other plugins can filter which actions are shown
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters available actions for plugins to alter.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array $actions Array of available actions user could use.
+ * @param array $item Current item being added to page.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $actions = apply_filters( 'bp_activity_admin_comment_row_actions', array_filter( $actions ), $item );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: 2: activity admin ui date/time */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1440,8 +1524,23 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get activity content - if not set, use the action
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $item['content'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters current activity item content.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param array $item Array index holding current activity item content.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = apply_filters_ref_array( 'bp_get_activity_content_body', array( $item['content'] ) );
</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">+ /**
+ * Filters current activity item action.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @var array $item Array index holding current activity item action.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = apply_filters_ref_array( 'bp_get_activity_action', array( $item['action'] ) );
</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">@@ -1459,6 +1558,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function column_response( $item ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Is $item is a root activity?
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters default list of default root activity types.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param array Array of default activity types.
+ * @param array $item Current item being displayed.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $item['item_id'] ) || ! in_array( $item['type'], apply_filters( 'bp_activity_admin_root_activity_types', array( 'activity_comment' ), $item ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_count = !empty( $item['children'] ) ? bp_activity_recurse_comment_count( (object) $item ) : 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $root_activity_url = bp_get_admin_url( 'admin.php?page=bp-activity&aid=' . $item['id'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1573,6 +1681,13 @@
</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">+ /**
+ * Filters if an activity item can be commented on or not.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param bool $can_comment Whether an activity item can be commented on or not.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_activity_list_table_can_comment', $can_comment );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>