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-14 14:25:45 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Plugin: Refactor to use as foundation for planned pledge workflows (#23)

Browse source 
This starts to address several items in the roadmap, but probably doesn't fully address any of them. It takes the plugin code that was written several months ago, before the scope of this project was fully sorted out, and refactors it to be a starting point for the roadmap.

* Adds template files for form inputs that can be used to both create new pledges and manage existing pledges
* Does some validation and sanitization work on form submissions
* Adds a custom post status for deactivated pledges
This commit is contained in:
Corey McKrill 2019-10-04 12:35:02 -07:00 • committed by GitHub
parent 7a355b8314
commit ded645fabc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 613 additions and 323 deletions
Download patch file Download diff file Expand all files Collapse all files

155
plugins/wporg-5ftf/includes/pledge-form.php
View file

@ -12,24 +12,22 @@ use WP_Error;
defined( 'WPINC' ) || die();
add_shortcode( 'five_for_the_future_pledge_form', __NAMESPACE__ . '\render_shortcode' );
// Todo make this into simple optionless blocks instead?
add_shortcode( '5ftf_pledge_form_new', __NAMESPACE__ . '\render_form_new' );
add_shortcode( '5ftf_pledge_form_manage', __NAMESPACE__ . '\render_form_manage' );
/**
*
*
* @param $attributes
* @param $content
* Render the form(s) for creating new pledges.
*
* @return false|string
*/
function render_shortcode( $attributes, $content ) {
function render_form_new() {
$action = filter_input( INPUT_POST, 'action' );
$messages = [];
$complete = false;
$html = '';
if ( 'Submit' === $action ) {
$processed = process_form( $_POST );
if ( 'Submit Pledge' === $action ) {
$processed = process_form_new();
if ( is_wp_error( $processed ) ) {
$messages = array_merge( $messages, $processed->get_error_messages() );
@ -38,34 +36,38 @@ function render_shortcode( $attributes, $content ) {
}
}
if ( $complete ) {
$html = wpautop( __( 'Thank you for your submission.', 'wporg' ) );
} else {
ob_start();
require FiveForTheFuture\PATH . 'views/pledge-form.php';
$html = ob_get_clean();
}
ob_start();
require FiveForTheFuture\PATH . 'views/form-pledge-new.php';
return $html;
return ob_get_clean();
}
/**
*
*
* @param array $form_values
*
* @return string|WP_Error String "success" if the form processed correctly. Otherwise WP_Error.
*/
function process_form( array $form_values ) {
$required_fields = PledgeMeta\has_required_pledge_meta( $form_values );
function process_form_new() {
$submission = filter_input_array( INPUT_POST, get_input_filters() );
if ( is_wp_error( $required_fields ) ) {
return $required_fields;
$has_required = PledgeMeta\has_required_pledge_meta( $submission );
if ( is_wp_error( $has_required ) ) {
return $has_required;
}
$domain = PledgeMeta\get_normalized_domain_from_url( $submission['org-url'] );
if ( has_existing_pledge( $domain ) ) {
return new WP_Error(
'existing_pledge',
__( 'A pledge already exists for this domain.', 'wporg' )
);
}
$name = sanitize_meta(
PledgeMeta\META_PREFIX . 'company-name',
$form_values['company-name'],
PledgeMeta\META_PREFIX . 'org-name',
$submission['org-name'],
'post',
Pledge\CPT_ID
);
@ -76,12 +78,108 @@ function process_form( array $form_values ) {
return $created;
}
PledgeMeta\save_pledge_meta( $created, $form_values );
// save teams contirbuted to as terms
//PledgeMeta\save_pledge_meta( $created, $submission );
return 'success';
}
/**
* Render the form(s) for managing existing pledges.
*
* @return false|string
*/
function render_form_manage() {
$action = filter_input( INPUT_POST, 'action' );
$messages = [];
$updated = false;
if ( 'Update Pledge' === $action ) {
$processed = process_form_manage();
if ( is_wp_error( $processed ) ) {
$messages = array_merge( $messages, $processed->get_error_messages() );
} elseif ( 'success' === $processed ) {
$updated = true;
}
}
ob_start();
require FiveForTheFuture\PATH . 'views/form-pledge-manage.php';
return ob_get_clean();
}
/**
*
*
* @return string|WP_Error String "success" if the form processed correctly. Otherwise WP_Error.
*/
function process_form_manage() {
$submission = filter_input_array( INPUT_POST, get_input_filters() );
$has_required = PledgeMeta\has_required_pledge_meta( $submission );
if ( is_wp_error( $has_required ) ) {
return $has_required;
}
$domain = PledgeMeta\get_normalized_domain_from_url( $submission['org-url'] );
if ( has_existing_pledge( $domain ) ) {
return new WP_Error(
'existing_pledge',
__( 'A pledge already exists for this domain.', 'wporg' )
);
}
}
/**
*
*
* @return array
*/
function get_input_filters() {
return array_merge(
// Inputs that correspond to meta values.
wp_list_pluck( PledgeMeta\get_pledge_meta_config( 'user_input' ), 'php_filter' ),
// Inputs with no corresponding meta value.
array(
'contributor-wporg-usernames' => [
'filter' => FILTER_SANITIZE_STRING,
'flags' => FILTER_REQUIRE_ARRAY,
],
'pledge-agreement' => FILTER_VALIDATE_BOOLEAN,
)
);
}
/**
*
*
* @param string $domain
* @param int $current_pledge_id
*
* @return bool
*/
function has_existing_pledge( $domain, int $current_pledge_id = 0 ) {
$args = array(
'post_type' => Pledge\CPT_ID,
'post_status' => array( 'pending', 'publish' ),
'meta_query' => array(
'key' => PledgeMeta\META_PREFIX . 'org-domain',
'value' => $domain,
),
);
if ( $current_pledge_id ) {
$args['exclude'] = array( $current_pledge_id );
}
$matching_pledge = get_posts( $args );
return ! empty( $matching_pledge );
}
/**
*
*
@ -93,8 +191,7 @@ function create_new_pledge( $name ) {
$args = [
'post_type' => Pledge\CPT_ID,
'post_title' => $name,
'post_status' => 'pending',
'post_author' => get_current_user_id(), // TODO is this how we want to do this?
'post_status' => 'draft',
];
return wp_insert_post( $args, true );