tec3/five-for-the-future
tec3/five-for-the-future
1
0
Fork 0
mirror of https://github.com/WordPress/five-for-the-future.git synced 2025-07-04 10:05:43 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Plugin: Add a system for logging events related to pledges and contributors (#54)

Browse source 
Uses action hooks to capture relevant events as log entries on a per-pledge basis. This provides a running history of a pledge and can be used as an audit log if questions arise about changes to a pledge or there are weird bugs.

Fixes #39
This commit is contained in:
Corey McKrill 2019-10-29 12:46:13 -07:00 • committed by GitHub
parent 6209060eb2
commit 5c5ae83287
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 424 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

58
plugins/wporg-5ftf/includes/contributor.php
View file

@ -123,22 +123,40 @@ function populate_list_table_columns( $column, $post_id ) {
}
/**
* Create a contributor post as a child of a pledge post.
* Add one or more contributors to a pledge.
*
* @param string $wporg_username
* @param int $pledge_id
* Note that this does not validate whether a contributor's wporg username exists in the system.
*
* @return int|WP_Error Post ID on success. Otherwise WP_Error.
* @param int $pledge_id The post ID of the pledge.
* @param array $contributors Array of contributor wporg usernames.
*
* @return void
*/
function create_new_contributor( $wporg_username, $pledge_id ) {
$args = array(
'post_type' => CPT_ID,
'post_title' => sanitize_user( $wporg_username ),
'post_parent' => $pledge_id,
'post_status' => 'pending',
);
function add_pledge_contributors( $pledge_id, $contributors ) {
$results = array();
return wp_insert_post( $args, true );
foreach ( $contributors as $wporg_username ) {
$args = array(
'post_type' => CPT_ID,
'post_title' => sanitize_user( $wporg_username ),
'post_parent' => $pledge_id,
'post_status' => 'pending',
);
$result = wp_insert_post( $args, true );
$results[ $wporg_username ] = ( is_wp_error( $result ) ) ? $result->get_error_code() : $result;
}
/**
* Action: Fires when one or more contributors are added to a pledge.
*
* @param int $pledge_id The post ID of the pledge.
* @param array $contributors Array of contributor wporg usernames.
* @param array $results Associative array, key is wporg username, value is post ID on success,
* or an error code on failure.
*/
do_action( FiveForTheFuture\PREFIX . '_add_pledge_contributors', $pledge_id, $contributors, $results );
}
/**
@ -152,7 +170,19 @@ function create_new_contributor( $wporg_username, $pledge_id ) {
* @return false|WP_Post|null
*/
function remove_contributor( $contributor_post_id ) {
return wp_trash_post( $contributor_post_id );
$pledge_id = get_post( $contributor_post_id )->post_parent;
$result = wp_trash_post( $contributor_post_id );
/**
* Action: Fires when a contributor is removed from a pledge.
*
* @param int $pledge_id
* @param int $contributor_post_id
* @param WP_Post|false|null $result
*/
do_action( FiveForTheFuture\PREFIX . '_remove_contributor', $pledge_id, $contributor_post_id, $result );
return $result;
}
/**
@ -271,7 +301,7 @@ function process_my_pledges_form() {
'post_status' => $status,
) );
} elseif ( 'trash' === $status ) {
wp_delete_post( $contributor_post_id );
remove_contributor( $contributor_post_id );
}
return $message;