_x( 'Pledges', 'Pledges General Name', 'wporg' ),
'singular_name' => _x( 'Pledge', 'Pledge Singular Name', 'wporg' ),
'menu_name' => __( 'Five for the Future', 'wporg' ),
'archives' => __( 'Pledge Archives', 'wporg' ),
'attributes' => __( 'Pledge Attributes', 'wporg' ),
'parent_item_colon' => __( 'Parent Pledge:', 'wporg' ),
'all_items' => __( 'Pledges', 'wporg' ),
'add_new_item' => __( 'Add New Pledge', 'wporg' ),
'add_new' => __( 'Add New', 'wporg' ),
'new_item' => __( 'New Pledge', 'wporg' ),
'edit_item' => __( 'Edit Pledge', 'wporg' ),
'update_item' => __( 'Update Pledge', 'wporg' ),
'view_item' => __( 'View Pledge', 'wporg' ),
'view_items' => __( 'View Pledges', 'wporg' ),
'search_items' => __( 'Search Pledges', 'wporg' ),
'not_found' => __( 'Not found', 'wporg' ),
'not_found_in_trash' => __( 'Not found in Trash', 'wporg' ),
'insert_into_item' => __( 'Insert into pledge', 'wporg' ),
'uploaded_to_this_item' => __( 'Uploaded to this pledge', 'wporg' ),
'items_list' => __( 'Pledges list', 'wporg' ),
'items_list_navigation' => __( 'Pledges list navigation', 'wporg' ),
'filter_items_list' => __( 'Filter pledges list', 'wporg' ),
);
$args = array(
'labels' => $labels,
'supports' => array( 'title', 'thumbnail' ),
'hierarchical' => false,
'public' => true,
'show_ui' => true,
'show_in_menu' => true,
'menu_position' => 25,
'show_in_admin_bar' => false,
'show_in_nav_menus' => false,
'can_export' => false,
'taxonomies' => array(),
'has_archive' => SLUG_PL,
'rewrite' => array(
'slug' => SLUG,
),
'exclude_from_search' => true,
'publicly_queryable' => true,
'capability_type' => 'page',
'show_in_rest' => false, // todo Maybe turn this on later.
);
register_post_type( CPT_ID, $args );
}
/**
* Register the post status(es).
*
* @return void
*/
function register_custom_post_status() {
register_post_status(
FiveForTheFuture\PREFIX . '-deactivated',
array(
'label' => __( 'Deactivated', 'wporg' ),
'label_count' => _n_noop( 'Deactivated (%s)', 'Deactivated (%s)', 'wporg' ),
'public' => false,
'internal' => false,
'protected' => true,
CPT_ID => true, // Custom parameter to streamline its use with the Pledge CPT.
)
);
}
/**
* Add columns to the Pledges list table.
*
* @param array $columns
*
* @return array
*/
function add_list_table_columns( $columns ) {
$first = array_slice( $columns, 0, 2, true );
$last = array_slice( $columns, 2, null, true );
$new_columns = array(
'contributor_counts' => __( 'Contributors', 'wporg' ),
'domain' => __( 'Domain', 'wporg' ),
);
return array_merge( $first, $new_columns, $last );
}
/**
* Render content in the custom columns added to the Pledges list table.
*
* @param string $column
* @param int $post_id
*
* @return void
*/
function populate_list_table_columns( $column, $post_id ) {
switch ( $column ) {
case 'contributor_counts':
$contribs = Contributor\get_pledge_contributors( $post_id, 'all' );
printf(
wpautop( '%1$d confirmed' . "\n" . '%2$d unconfirmed' ),
count( $contribs['publish'] ),
count( $contribs['pending'] )
);
break;
case 'domain':
$domain = get_post_meta( $post_id, META_PREFIX . 'org-domain', true );
echo esc_html( $domain );
break;
}
}
/**
* Create a new pledge post.
*
* @param string $name The name of the company to use as the post title.
*
* @return int|WP_Error Post ID on success. Otherwise WP_Error.
*/
function create_new_pledge( $name ) {
$args = array(
'post_type' => CPT_ID,
'post_title' => $name,
'post_status' => 'draft',
);
$pledge_id = wp_insert_post( $args, true );
// The pledge's meta data is saved at this point via `save_pledge_meta()`, which is a `save_post` callback.
if ( ! is_wp_error( $pledge_id ) ) {
send_pledge_confirmation_email( $pledge_id, get_post()->ID );
}
return $pledge_id;
}
/**
* Email pledge manager to confirm their email address.
*
* @param int $pledge_id The ID of the pledge.
* @param int $action_page_id The ID of the page that the user will be taken back to, in order to process their
* confirmation request.
*
* @return bool
*/
function send_pledge_confirmation_email( $pledge_id, $action_page_id ) {
$pledge = get_post( $pledge_id );
$message =
"Thanks for pledging your organization's time to contribute to the WordPress open source project! Please confirm this email address in order to publish your pledge:" . "\n\n" .
Email\get_authentication_url( $pledge_id, 'confirm_pledge_email', $action_page_id )
;
return Email\send_email(
$pledge->{'5ftf_org-pledge-email'},
'Please confirm your email address',
$message,
$pledge_id
);
}
/**
* Filter query for archive & search pages to ensure we're only showing the expected data.
*
* @param WP_Query $query The WP_Query instance (passed by reference).
* @return void
*/
function filter_query( $query ) {
if ( is_admin() || ! $query->is_main_query() ) {
return;
}
$contributor_count_key = META_PREFIX . 'pledge-confirmed-contributors';
$hours_count_key = META_PREFIX . 'pledge-total-hours';
// Set up meta queries to include the "valid pledge" check, added to both search and pledge archive requests.
$meta_queries = (array) $query->get( 'meta_query' );
$meta_queries[] = array(
'key' => $contributor_count_key,
'value' => 0,
'compare' => '>',
'type' => 'NUMERIC',
);
// Searching is restricted to pledges with contributors only.
if ( $query->is_search ) {
$query->set( 'post_type', CPT_ID );
$query->set( 'meta_query', $meta_queries );
}
// Use the custom order param to sort the archive page.
if ( $query->is_archive && CPT_ID === $query->get( 'post_type' ) ) {
// Archives should only show pledges with contributors.
$query->set( 'meta_query', $meta_queries );
$order = isset( $_GET['order'] ) ? $_GET['order'] : '';
switch ( $order ) {
case 'alphabetical':
$query->set( 'orderby', 'name' );
$query->set( 'order', 'ASC' );
break;
case 'hours':
$query->set( 'meta_key', $hours_count_key );
$query->set( 'orderby', 'meta_value_num' );
$query->set( 'order', 'DESC' );
break;
}
}
}