From 40a1e9f9b1376af779020bd6be2a53af829f03ac Mon Sep 17 00:00:00 2001 From: Alec Geatches Date: Thu, 27 Jun 2024 12:36:31 -0600 Subject: [PATCH 1/4] Split custom status configuration views into files --- modules/custom-status/custom-status.php | 376 +++++++----------- .../lib/custom-status-configure.js | 2 +- modules/custom-status/views/configure.php | 60 +++ modules/custom-status/views/edit-status.php | 46 +++ 4 files changed, 255 insertions(+), 229 deletions(-) create mode 100644 modules/custom-status/views/configure.php create mode 100644 modules/custom-status/views/edit-status.php diff --git a/modules/custom-status/custom-status.php b/modules/custom-status/custom-status.php index f8ec5739..da9c56cd 100644 --- a/modules/custom-status/custom-status.php +++ b/modules/custom-status/custom-status.php @@ -28,37 +28,37 @@ public function __construct() { $this->module_url = $this->get_module_url( __FILE__ ); // Register the module with Edit Flow - $args = array( - 'title' => __( 'Custom Statuses', 'edit-flow' ), - 'short_description' => __( 'Create custom post statuses to define the stages of your workflow.', 'edit-flow' ), - 'extended_description' => __( 'Create your own post statuses to add structure your publishing workflow. You can change existing or add new ones anytime, and drag and drop to change their order.', 'edit-flow' ), - 'module_url' => $this->module_url, - 'img_url' => $this->module_url . 'lib/custom_status_s128.png', - 'slug' => 'custom-status', - 'default_options' => array( - 'enabled' => 'on', - 'default_status' => 'pitch', + $args = array( + 'title' => __( 'Custom Statuses', 'edit-flow' ), + 'short_description' => __( 'Create custom post statuses to define the stages of your workflow.', 'edit-flow' ), + 'extended_description' => __( 'Create your own post statuses to add structure your publishing workflow. You can change existing or add new ones anytime, and drag and drop to change their order.', 'edit-flow' ), + 'module_url' => $this->module_url, + 'img_url' => $this->module_url . 'lib/custom_status_s128.png', + 'slug' => 'custom-status', + 'default_options' => array( + 'enabled' => 'on', + 'default_status' => 'pitch', 'always_show_dropdown' => 'off', - 'post_types' => array( + 'post_types' => array( 'post' => 'on', 'page' => 'on', ), ), - 'post_type_support' => 'ef_custom_statuses', // This has been plural in all of our docs - 'configure_page_cb' => 'print_configure_view', - 'configure_link_text' => __( 'Edit Statuses', 'edit-flow' ), - 'messages' => array( - 'status-added' => __( 'Post status created.', 'edit-flow' ), - 'status-missing' => __( "Post status doesn't exist.", 'edit-flow' ), - 'default-status-changed' => __( 'Default post status has been changed.', 'edit-flow' ), - 'term-updated' => __( 'Post status updated.', 'edit-flow' ), - 'status-deleted' => __( 'Post status deleted.', 'edit-flow' ), + 'post_type_support' => 'ef_custom_statuses', // This has been plural in all of our docs + 'configure_page_cb' => 'print_configure_view', + 'configure_link_text' => __( 'Edit Statuses', 'edit-flow' ), + 'messages' => array( + 'status-added' => __( 'Post status created.', 'edit-flow' ), + 'status-missing' => __( "Post status doesn't exist.", 'edit-flow' ), + 'default-status-changed' => __( 'Default post status has been changed.', 'edit-flow' ), + 'term-updated' => __( 'Post status updated.', 'edit-flow' ), + 'status-deleted' => __( 'Post status deleted.', 'edit-flow' ), 'status-position-updated' => __( 'Status order updated.', 'edit-flow' ), ), - 'autoload' => false, - 'settings_help_tab' => array( - 'id' => 'ef-custom-status-overview', - 'title' => __( 'Overview', 'edit-flow' ), + 'autoload' => false, + 'settings_help_tab' => array( + 'id' => 'ef-custom-status-overview', + 'title' => __( 'Overview', 'edit-flow' ), 'content' => __( '

Edit Flow’s custom statuses allow you to define the most important stages of your editorial workflow. Out of the box, WordPress only offers “Draft” and “Pending Review” as post states. With custom statuses, you can create your own post states like “In Progress”, “Pitch”, or “Waiting for Edit” and keep or delete the originals. You can also drag and drop statuses to set the best order for your workflow.

Custom statuses are fully integrated into the rest of Edit Flow and the WordPress admin. On the calendar and story budget, you can filter your view to see only posts of a specific post state. Furthermore, email notifications can be sent to a specific group of users when a post changes state.

', 'edit-flow' ), ), 'settings_help_sidebar' => __( '

For more information:

Custom Status Documentation

Edit Flow Forum

Edit Flow on Github

', 'edit-flow' ), @@ -133,41 +133,41 @@ public function install() { array( 'term' => __( 'Pitch', 'edit-flow' ), 'args' => array( - 'slug' => 'pitch', + 'slug' => 'pitch', 'description' => __( 'Idea proposed; waiting for acceptance.', 'edit-flow' ), - 'position' => 1, + 'position' => 1, ), ), array( 'term' => __( 'Assigned', 'edit-flow' ), 'args' => array( - 'slug' => 'assigned', + 'slug' => 'assigned', 'description' => __( 'Post idea assigned to writer.', 'edit-flow' ), - 'position' => 2, + 'position' => 2, ), ), array( 'term' => __( 'In Progress', 'edit-flow' ), 'args' => array( - 'slug' => 'in-progress', + 'slug' => 'in-progress', 'description' => __( 'Writer is working on the post.', 'edit-flow' ), - 'position' => 3, + 'position' => 3, ), ), array( 'term' => __( 'Draft', 'edit-flow' ), 'args' => array( - 'slug' => 'draft', + 'slug' => 'draft', 'description' => __( 'Post is a draft; not ready for review or publication.', 'edit-flow' ), - 'position' => 4, + 'position' => 4, ), ), array( 'term' => __( 'Pending Review' ), 'args' => array( - 'slug' => 'pending', + 'slug' => 'pending', 'description' => __( 'Post needs to be reviewed by an editor.', 'edit-flow' ), - 'position' => 5, + 'position' => 5, ), ), ); @@ -230,12 +230,12 @@ public function register_custom_statuses() { // Register new taxonomy so that we can store all our fancy new custom statuses (or is it stati?) if ( ! taxonomy_exists( self::taxonomy_key ) ) { $args = array( - 'hierarchical' => false, + 'hierarchical' => false, 'update_count_callback' => '_update_post_term_count', - 'label' => false, - 'query_var' => false, - 'rewrite' => false, - 'show_ui' => false, + 'label' => false, + 'query_var' => false, + 'rewrite' => false, + 'show_ui' => false, ); register_taxonomy( self::taxonomy_key, 'post', $args ); } @@ -301,13 +301,17 @@ public function action_admin_enqueue_scripts() { // Load Javascript we need to use on the configuration views (jQuery Sortable and Quick Edit) if ( $this->is_whitelisted_settings_view( $this->module->name ) ) { wp_enqueue_script( 'jquery-ui-sortable' ); - wp_enqueue_script( 'edit-flow-custom-status-configure', $this->module_url . 'lib/custom-status-configure.js', array( 'jquery', 'jquery-ui-sortable', 'edit-flow-settings-js' ), EDIT_FLOW_VERSION, true ); + wp_enqueue_script( 'edit-flow-custom-status-configure', $this->module_url . 'lib/custom-status-configure.js', [ 'jquery', 'jquery-ui-sortable', 'edit-flow-settings-js' ], EDIT_FLOW_VERSION, true ); + + wp_localize_script( 'edit-flow-custom-status-configure', '__ef_localize_custom_status_configure', [ + 'delete_status_string' => __( 'Are you sure you want to delete the post status? All posts with this status will be assigned to the default status.', 'edit-flow' ), + ] ); } // Custom javascript to modify the post status dropdown where it shows up if ( $this->is_whitelisted_page() ) { - wp_enqueue_script( 'edit_flow-custom_status', $this->module_url . 'lib/custom-status.js', array( 'jquery', 'post' ), EDIT_FLOW_VERSION, true ); - wp_localize_script('edit_flow-custom_status', '__ef_localize_custom_status', array( + wp_enqueue_script( 'edit_flow-custom_status', $this->module_url . 'lib/custom-status.js', [ 'jquery', 'post' ], EDIT_FLOW_VERSION, true ); + wp_localize_script('edit_flow-custom_status', '__ef_localize_custom_status', [ 'no_change' => esc_html__( '— No Change —', 'edit-flow' ), 'published' => esc_html__( 'Published', 'edit-flow' ), 'save_as' => esc_html__( 'Save as', 'edit-flow' ), @@ -315,7 +319,7 @@ public function action_admin_enqueue_scripts() { 'edit' => esc_html__( 'Edit', 'edit-flow' ), 'ok' => esc_html__( 'OK', 'edit-flow' ), 'cancel' => esc_html__( 'Cancel', 'edit-flow' ), - )); + ] ); } } @@ -399,7 +403,7 @@ public function post_admin_header() { $custom_statuses = $this->get_custom_statuses(); // $selected can be empty, but must be set because it's used as a JS variable - $selected = ''; + $selected = ''; $selected_name = ''; if ( ! empty( $post ) ) { @@ -426,26 +430,26 @@ public function post_admin_header() { // The default statuses from WordPress $all_statuses[] = array( - 'name' => __( 'Published', 'edit-flow' ), - 'slug' => 'publish', + 'name' => __( 'Published', 'edit-flow' ), + 'slug' => 'publish', 'description' => '', ); $all_statuses[] = array( - 'name' => __( 'Privately Published', 'edit-flow' ), - 'slug' => 'private', + 'name' => __( 'Privately Published', 'edit-flow' ), + 'slug' => 'private', 'description' => '', ); $all_statuses[] = array( - 'name' => __( 'Scheduled', 'edit-flow' ), - 'slug' => 'future', + 'name' => __( 'Scheduled', 'edit-flow' ), + 'slug' => 'future', 'description' => '', ); // Load the custom statuses foreach ( $custom_statuses as $status ) { $all_statuses[] = array( - 'name' => esc_js( $status->name ), - 'slug' => esc_js( $status->slug ), + 'name' => esc_js( $status->name ), + 'slug' => esc_js( $status->slug ), 'description' => esc_js( $status->description ), ); } @@ -491,8 +495,8 @@ public function add_custom_status( $term, $args = array() ) { $slug = ( ! empty( $args['slug'] ) ) ? $args['slug'] : sanitize_title( $term ); unset( $args['slug'] ); $encoded_description = $this->get_encoded_description( $args ); - $response = wp_insert_term( $term, self::taxonomy_key, array( - 'slug' => $slug, + $response = wp_insert_term( $term, self::taxonomy_key, array( + 'slug' => $slug, 'description' => $encoded_description, ) ); @@ -522,11 +526,11 @@ public function update_custom_status( $status_id, $args = array() ) { // Prevent user from changing draft name or slug if ( 'draft' === $old_status->slug - && ( - ( isset( $args['name'] ) && $args['name'] !== $old_status->name ) - || - ( isset( $args['slug'] ) && $args['slug'] !== $old_status->slug ) - ) ) { + && ( + ( isset( $args['name'] ) && $args['name'] !== $old_status->name ) + || + ( isset( $args['slug'] ) && $args['slug'] !== $old_status->slug ) + ) ) { return new WP_Error( 'invalid', __( 'Changing the name and slug of "Draft" is not allowed', 'edit-flow' ) ); } @@ -546,14 +550,14 @@ public function update_custom_status( $status_id, $args = array() ) { } } // We're encoding metadata that isn't supported by default in the term's description field - $args_to_encode = array(); + $args_to_encode = array(); $args_to_encode['description'] = ( isset( $args['description'] ) ) ? $args['description'] : $old_status->description; - $args_to_encode['position'] = ( isset( $args['position'] ) ) ? $args['position'] : $old_status->position; - $encoded_description = $this->get_encoded_description( $args_to_encode ); - $args['description'] = $encoded_description; + $args_to_encode['position'] = ( isset( $args['position'] ) ) ? $args['position'] : $old_status->position; + $encoded_description = $this->get_encoded_description( $args_to_encode ); + $args['description'] = $encoded_description; $updated_status_array = wp_update_term( $status_id, self::taxonomy_key, $args ); - $updated_status = $this->get_custom_status_by( 'id', $updated_status_array['term_id'] ); + $updated_status = $this->get_custom_status_by( 'id', $updated_status_array['term_id'] ); return $updated_status; } @@ -631,7 +635,7 @@ public function get_custom_statuses( $args = array() ) { // Expand and order the statuses $ordered_statuses = array(); - $hold_to_end = array(); + $hold_to_end = array(); foreach ( $statuses as $key => $status ) { // Unencode and set all of our psuedo term meta because we need the position if it exists $unencoded_description = $this->get_unencoded_description( $status->description ); @@ -681,7 +685,7 @@ public function get_custom_status_by( $field, $value ) { } $custom_statuses = $this->get_custom_statuses(); - $custom_status = wp_filter_object_list( $custom_statuses, array( $field => $value ) ); + $custom_status = wp_filter_object_list( $custom_statuses, array( $field => $value ) ); if ( ! empty( $custom_status ) ) { return array_shift( $custom_status ); @@ -699,7 +703,7 @@ public function get_default_custom_status() { $default_status = $this->get_custom_status_by( 'slug', $this->module->options->default_status ); if ( ! $default_status ) { $custom_statuses = $this->get_custom_statuses(); - $default_status = array_shift( $custom_statuses ); + $default_status = array_shift( $custom_statuses ); } return $default_status; } @@ -799,8 +803,8 @@ public function handle_add_custom_status() { } // Validate and sanitize the form data - $status_name = isset( $_POST['status_name'] ) ? sanitize_text_field( trim( $_POST['status_name'] ) ) : ''; - $status_slug = sanitize_title( $status_name ); + $status_name = isset( $_POST['status_name'] ) ? sanitize_text_field( trim( $_POST['status_name'] ) ) : ''; + $status_slug = sanitize_title( $status_name ); $status_description = isset( $_POST['status_description'] ) ? stripslashes( wp_filter_nohtml_kses( trim( $_POST['status_description'] ) ) ) : ''; /** @@ -840,9 +844,9 @@ public function handle_add_custom_status() { // Try to add the status $status_args = array( 'description' => $status_description, - 'slug' => $status_slug, + 'slug' => $status_slug, ); - $return = $this->add_custom_status( $status_name, $status_args ); + $return = $this->add_custom_status( $status_name, $status_args ); if ( is_wp_error( $return ) ) { /* translators: %s: error message */ wp_die( esc_html( sprintf( __( 'Could not add status: %s', 'edit-flow' ), $return->get_error_message() ) ) ); @@ -877,7 +881,7 @@ public function handle_edit_custom_status() { wp_die( esc_html( $this->module->messages['status-missing'] ) ); } - $name = isset( $_POST['name'] ) ? sanitize_text_field( trim( $_POST['name'] ) ) : ''; + $name = isset( $_POST['name'] ) ? sanitize_text_field( trim( $_POST['name'] ) ) : ''; $description = isset( $_POST['description'] ) ? stripslashes( wp_filter_nohtml_kses( trim( $_POST['description'] ) ) ) : ''; /** @@ -923,9 +927,9 @@ public function handle_edit_custom_status() { } // Try to add the new post status - $args = array( - 'name' => $name, - 'slug' => sanitize_title( $name ), + $args = array( + 'name' => $name, + 'slug' => sanitize_title( $name ), 'description' => $description, ); $return = $this->update_custom_status( $existing_status->term_id, $args ); @@ -963,7 +967,7 @@ public function handle_make_default_custom_status() { } $term_id = (int) $_GET['term-id']; - $term = $this->get_custom_status_by( 'id', $term_id ); + $term = $this->get_custom_status_by( 'id', $term_id ); if ( is_object( $term ) ) { $edit_flow->update_module_option( $this->module->name, 'default_status', $term->slug ); // @todo How do we want to handle users who click the link from "Add New Status" @@ -1000,7 +1004,7 @@ public function handle_delete_custom_status() { // Check to make sure the status isn't already deleted $term_id = (int) $_GET['term-id']; - $term = $this->get_custom_status_by( 'id', $term_id ); + $term = $this->get_custom_status_by( 'id', $term_id ); if ( ! $term ) { wp_die( esc_html__( 'Status does not exist.', 'edit-flow' ) ); } @@ -1070,7 +1074,7 @@ public function handle_ajax_update_status_positions() { foreach ( $_POST['status_positions'] as $position => $term_id ) { // Have to add 1 to the position because the index started with zero - $args = array( + $args = array( 'position' => (int) $position + 1, ); $return = $this->update_custom_status( (int) $term_id, $args ); @@ -1095,9 +1099,9 @@ public function ajax_inline_save_status() { die( esc_html( $this->module->messages['invalid-permissions'] ) ); } - $term_id = isset( $_POST['status_id'] ) ? (int) $_POST['status_id'] : 0; - $status_name = isset( $_POST['name'] ) ? sanitize_text_field( trim( $_POST['name'] ) ) : ''; - $status_slug = isset( $_POST['name'] ) ? sanitize_title( trim( $_POST['name'] ) ) : ''; + $term_id = isset( $_POST['status_id'] ) ? (int) $_POST['status_id'] : 0; + $status_name = isset( $_POST['name'] ) ? sanitize_text_field( trim( $_POST['name'] ) ) : ''; + $status_slug = isset( $_POST['name'] ) ? sanitize_title( trim( $_POST['name'] ) ) : ''; $status_description = isset( $_POST['description'] ) ? stripslashes( wp_filter_nohtml_kses( trim( $_POST['description'] ) ) ) : ''; // Check if name field was filled in @@ -1138,10 +1142,10 @@ public function ajax_inline_save_status() { } // get status_name & status_description - $args = array( - 'name' => $status_name, + $args = array( + 'name' => $status_name, 'description' => $status_description, - 'slug' => $status_slug, + 'slug' => $status_slug, ); $return = $this->update_custom_status( $term_id, $args ); if ( ! is_wp_error( $return ) ) { @@ -1188,7 +1192,7 @@ public function settings_post_types_option() { public function settings_always_show_dropdown_option() { $options = array( 'off' => __( 'Disabled', 'edit-flow' ), - 'on' => __( 'Enabled', 'edit-flow' ), + 'on' => __( 'Enabled', 'edit-flow' ), ); echo ' - - - - - slug ? 'readonly="readonly"' : ''; ?> - - - - - - - - - - -
/> - settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the status. (Max: 20 characters)', 'edit-flow' ) ); ?> -
- - settings->helper_print_error_or_description( 'slug', __( 'The slug is the unique ID for the status and is changed when the name is changed.', 'edit-flow' ) ); ?> -
- - settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the custom status is to be used for.', 'edit-flow' ) ); ?> -
-

- - -

- - - - prepare_items(); - ?> - -
-
- display(); ?> - -

-
-
-
-
-
-

- - - - -

- -
- module->options_group_name ); ?> - module->options_group_name ); ?> - module->name ) . '" />'; ?> - -
- - -
-
- - - settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the status. (Max: 20 characters)', 'edit-flow' ) ); ?> -
-
- - - settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the custom status is to be used for.', 'edit-flow' ) ); ?> -
- - '; ?> -

-
- -
-
-
- inline_edit(); ?> - - prepare_items(); + include __DIR__ . '/views/configure.php'; + } } /** @@ -1366,7 +1286,7 @@ public function check_timestamp_on_publish() { $post_ids = array_map( 'intval', (array) $_REQUEST['post'] ); foreach ( $post_ids as $post_id ) { $wpdb->update( $wpdb->posts, array( 'post_status' => 'pending' ), array( - 'ID' => $post_id, + 'ID' => $post_id, 'post_date_gmt' => '0000-00-00 00:00:00', ) ); clean_post_cache( $post_id ); @@ -1379,8 +1299,8 @@ public function check_timestamp_on_publish() { // Set the post_status as 'pending' only when there's no timestamp set for $post_date_gmt if ( isset( $_POST['post_ID'] ) ) { $post_id = (int) $_POST['post_ID']; - $ret = $wpdb->update( $wpdb->posts, array( 'post_status' => 'pending' ), array( - 'ID' => $post_id, + $ret = $wpdb->update( $wpdb->posts, array( 'post_status' => 'pending' ), array( + 'ID' => $post_id, 'post_date_gmt' => '0000-00-00 00:00:00', ) ); clean_post_cache( $post_id ); @@ -1632,8 +1552,8 @@ public function fix_get_sample_permalink( $permalink, $post_id, $title, $name, $ $new_name = ! is_null( $name ) ? $name : $post->post_name; $new_title = ! is_null( $title ) ? $title : $post->post_title; - $post = get_post( $post_id ); - $status_before = $post->post_status; + $post = get_post( $post_id ); + $status_before = $post->post_status; $post->post_status = 'draft'; $permalink = get_sample_permalink( $post, $title, sanitize_title( $new_name ? $new_name : $new_title, $post->ID ) ); @@ -1673,7 +1593,7 @@ public function fix_get_sample_permalink_html( $permalink, $post_id, $new_title, remove_filter( 'get_sample_permalink_html', array( $this, 'fix_get_sample_permalink_html' ), 10, 5 ); - $post->post_status = 'draft'; + $post->post_status = 'draft'; $sample_permalink_html = get_sample_permalink_html( $post, $new_title, $new_slug ); add_filter( 'get_sample_permalink_html', array( $this, 'fix_get_sample_permalink_html' ), 10, 5 ); @@ -1730,17 +1650,17 @@ private function get_preview_link( $post ) { if ( 'page' == $post->post_type ) { $args = array( - 'page_id' => $post->ID, + 'page_id' => $post->ID, ); - } else if ( 'post' == $post->post_type ) { + } elseif ( 'post' == $post->post_type ) { $args = array( - 'p' => $post->ID, - 'preview' => 'true', + 'p' => $post->ID, + 'preview' => 'true', ); } else { $args = array( - 'p' => $post->ID, - 'post_type' => $post->post_type, + 'p' => $post->ID, + 'post_type' => $post->post_type, ); } @@ -1774,20 +1694,20 @@ public function fix_post_row_actions( $actions, $post ) { if ( 'page' == $post->post_type ) { $args = array( - 'page_id' => $post->ID, + 'page_id' => $post->ID, ); - } else if ( 'post' == $post->post_type ) { + } elseif ( 'post' == $post->post_type ) { $args = array( - 'p' => $post->ID, + 'p' => $post->ID, ); } else { $args = array( - 'p' => $post->ID, - 'post_type' => $post->post_type, + 'p' => $post->ID, + 'post_type' => $post->post_type, ); } $args['preview'] = 'true'; - $preview_link = add_query_arg( $args, home_url( '/' ) ); + $preview_link = add_query_arg( $args, home_url( '/' ) ); /* translators: %s: post title */ $actions['view'] = '' . __( 'Preview' ) . ''; @@ -1816,9 +1736,9 @@ class EF_Custom_Status_List_Table extends WP_List_Table { public function __construct() { parent::__construct( array( - 'plural' => 'custom statuses', + 'plural' => 'custom statuses', 'singular' => 'custom status', - 'ajax' => true, + 'ajax' => true, ) ); } @@ -1830,20 +1750,20 @@ public function __construct() { public function prepare_items() { global $edit_flow; - $columns = $this->get_columns(); - $hidden = array( + $columns = $this->get_columns(); + $hidden = array( 'position', ); - $sortable = array(); + $sortable = array(); $this->_column_headers = array( $columns, $hidden, $sortable ); - $this->items = $edit_flow->custom_status->get_custom_statuses(); - $total_items = count( $this->items ); + $this->items = $edit_flow->custom_status->get_custom_statuses(); + $total_items = count( $this->items ); $this->default_status = $edit_flow->custom_status->get_default_custom_status()->slug; $this->set_pagination_args( array( 'total_items' => $total_items, - 'per_page' => $total_items, + 'per_page' => $total_items, ) ); } @@ -1869,12 +1789,12 @@ public function get_columns() { global $edit_flow; $columns = array( - 'position' => __( 'Position', 'edit-flow' ), - 'name' => __( 'Name', 'edit-flow' ), - 'description' => __( 'Description', 'edit-flow' ), + 'position' => __( 'Position', 'edit-flow' ), + 'name' => __( 'Name', 'edit-flow' ), + 'description' => __( 'Description', 'edit-flow' ), ); - $post_types = get_post_types( '', 'objects' ); + $post_types = get_post_types( '', 'objects' ); $supported_post_types = $edit_flow->helpers->get_post_types_for_module( $edit_flow->custom_status->module ); foreach ( $post_types as $post_type ) { if ( in_array( $post_type->name, $supported_post_types ) ) { @@ -1905,7 +1825,7 @@ public function column_default( $item, $column_name ) { // @todo Cachify this $post_count = wp_cache_get( "ef_custom_status_count_$column_name" ); if ( false === $post_count ) { - $posts = wp_count_posts( $column_name ); + $posts = wp_count_posts( $column_name ); $post_status = $item->slug; // To avoid error notices when changing the name of non-standard statuses if ( isset( $posts->$post_status ) ) { @@ -1944,7 +1864,7 @@ public function column_name( $item ) { global $edit_flow; $item_edit_link = esc_url( $edit_flow->custom_status->get_link( array( - 'action' => 'edit-status', + 'action' => 'edit-status', 'term-id' => $item->term_id, ) ) ); @@ -1959,18 +1879,18 @@ public function column_name( $item ) { return $output; } - $actions = array(); - $actions['edit'] = "" . __( 'Edit', 'edit-flow' ) . ''; + $actions = array(); + $actions['edit'] = "" . __( 'Edit', 'edit-flow' ) . ''; $actions['inline hide-if-no-js'] = '' . __( 'Quick Edit' ) . ''; - $actions['make_default'] = sprintf( '' . __( 'Make Default', 'edit-flow' ) . '', $edit_flow->custom_status->get_link( array( - 'action' => 'make-default', + $actions['make_default'] = sprintf( '' . __( 'Make Default', 'edit-flow' ) . '', $edit_flow->custom_status->get_link( array( + 'action' => 'make-default', 'term-id' => $item->term_id, ) ) ); // Prevent deleting draft status if ( 'draft' !== $item->slug && $item->slug !== $this->default_status ) { $actions['delete delete-status'] = sprintf( '' . __( 'Delete', 'edit-flow' ) . '', $edit_flow->custom_status->get_link( array( - 'action' => 'delete-status', + 'action' => 'delete-status', 'term-id' => $item->term_id, ) ) ); } @@ -2003,8 +1923,8 @@ public function column_description( $item ) { */ public function single_row( $item ) { static $alternate_class = ''; - $alternate_class = ( '' == $alternate_class ? ' alternate' : '' ); - $row_class = ' class="term-static' . $alternate_class . '"'; + $alternate_class = ( '' == $alternate_class ? ' alternate' : '' ); + $row_class = ' class="term-static' . $alternate_class . '"'; echo wp_kses_post( '' ); echo wp_kses_post( $this->single_row_columns( $item ) ); diff --git a/modules/custom-status/lib/custom-status-configure.js b/modules/custom-status/lib/custom-status-configure.js index aa1ff590..7cb17c0f 100644 --- a/modules/custom-status/lib/custom-status-configure.js +++ b/modules/custom-status/lib/custom-status-configure.js @@ -155,7 +155,7 @@ jQuery( document ).ready( function () { jQuery( '.delete-status a' ).on( 'click', function () { - if ( ! confirm( ef_confirm_delete_status_string ) ) { + if ( ! confirm( __ef_localize_custom_status_configure.delete_status_string ) ) { return false; } } ); diff --git a/modules/custom-status/views/configure.php b/modules/custom-status/views/configure.php new file mode 100644 index 00000000..c9ba2253 --- /dev/null +++ b/modules/custom-status/views/configure.php @@ -0,0 +1,60 @@ + + +
+
+ display(); ?> + +

+
+
+ +
+
+
+

+ + + + +

+ + +
+ module->options_group_name ); ?> + module->options_group_name ); ?> + module->name ) . '" />'; ?> + +
+ + +
+
+ + + settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the status. (Max: 20 characters)', 'edit-flow' ) ); ?> +
+ +
+ + + settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the custom status is to be used for.', 'edit-flow' ) ); ?> +
+ + + '; ?> +

+
+ +
+
+
+ +inline_edit(); diff --git a/modules/custom-status/views/edit-status.php b/modules/custom-status/views/edit-status.php new file mode 100644 index 00000000..d7875d27 --- /dev/null +++ b/modules/custom-status/views/edit-status.php @@ -0,0 +1,46 @@ + + +
+
+ + + + + + + + slug ? 'readonly="readonly"' : ''; ?> + + + + + + + + + + +
/> + settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the status. (Max: 20 characters)', 'edit-flow' ) ); ?> +
+ + settings->helper_print_error_or_description( 'slug', __( 'The slug is the unique ID for the status and is changed when the name is changed.', 'edit-flow' ) ); ?> +
+ + settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the custom status is to be used for.', 'edit-flow' ) ); ?> +
+ +

+ + +

+
From 74368615ae865617ec1951406d7970b05c6b7026 Mon Sep 17 00:00:00 2001 From: Alec Geatches Date: Thu, 27 Jun 2024 12:42:47 -0600 Subject: [PATCH 2/4] Change array syntax to short brackets --- modules/custom-status/custom-status.php | 320 ++++++++++++------------ 1 file changed, 160 insertions(+), 160 deletions(-) diff --git a/modules/custom-status/custom-status.php b/modules/custom-status/custom-status.php index da9c56cd..2dcc08ae 100644 --- a/modules/custom-status/custom-status.php +++ b/modules/custom-status/custom-status.php @@ -15,7 +15,7 @@ class EF_Custom_Status extends EF_Module { public $module; - private $custom_statuses_cache = array(); + private $custom_statuses_cache = []; // This is taxonomy name used to store all our custom statuses // phpcs:ignore Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase @@ -28,41 +28,41 @@ public function __construct() { $this->module_url = $this->get_module_url( __FILE__ ); // Register the module with Edit Flow - $args = array( + $args = [ 'title' => __( 'Custom Statuses', 'edit-flow' ), 'short_description' => __( 'Create custom post statuses to define the stages of your workflow.', 'edit-flow' ), 'extended_description' => __( 'Create your own post statuses to add structure your publishing workflow. You can change existing or add new ones anytime, and drag and drop to change their order.', 'edit-flow' ), 'module_url' => $this->module_url, 'img_url' => $this->module_url . 'lib/custom_status_s128.png', 'slug' => 'custom-status', - 'default_options' => array( + 'default_options' => [ 'enabled' => 'on', 'default_status' => 'pitch', 'always_show_dropdown' => 'off', - 'post_types' => array( + 'post_types' => [ 'post' => 'on', 'page' => 'on', - ), - ), + ], + ], 'post_type_support' => 'ef_custom_statuses', // This has been plural in all of our docs 'configure_page_cb' => 'print_configure_view', 'configure_link_text' => __( 'Edit Statuses', 'edit-flow' ), - 'messages' => array( + 'messages' => [ 'status-added' => __( 'Post status created.', 'edit-flow' ), 'status-missing' => __( "Post status doesn't exist.", 'edit-flow' ), 'default-status-changed' => __( 'Default post status has been changed.', 'edit-flow' ), 'term-updated' => __( 'Post status updated.', 'edit-flow' ), 'status-deleted' => __( 'Post status deleted.', 'edit-flow' ), 'status-position-updated' => __( 'Status order updated.', 'edit-flow' ), - ), + ], 'autoload' => false, - 'settings_help_tab' => array( + 'settings_help_tab' => [ 'id' => 'ef-custom-status-overview', 'title' => __( 'Overview', 'edit-flow' ), 'content' => __( '

Edit Flow’s custom statuses allow you to define the most important stages of your editorial workflow. Out of the box, WordPress only offers “Draft” and “Pending Review” as post states. With custom statuses, you can create your own post states like “In Progress”, “Pitch”, or “Waiting for Edit” and keep or delete the originals. You can also drag and drop statuses to set the best order for your workflow.

Custom statuses are fully integrated into the rest of Edit Flow and the WordPress admin. On the calendar and story budget, you can filter your view to see only posts of a specific post state. Furthermore, email notifications can be sent to a specific group of users when a post changes state.

', 'edit-flow' ), - ), + ], 'settings_help_sidebar' => __( '

For more information:

Custom Status Documentation

Edit Flow Forum

Edit Flow on Github

', 'edit-flow' ), - ); + ]; $this->module = EditFlow()->register_module( 'custom_status', $args ); } @@ -76,50 +76,50 @@ public function init() { $this->register_custom_statuses(); // Register our settings - add_action( 'admin_init', array( $this, 'register_settings' ) ); + add_action( 'admin_init', [ $this, 'register_settings' ] ); if ( ! $this->disable_custom_statuses_for_post_type() ) { // Load CSS and JS resources that we probably need in the admin page - add_action( 'admin_enqueue_scripts', array( $this, 'action_admin_enqueue_scripts' ) ); + add_action( 'admin_enqueue_scripts', [ $this, 'action_admin_enqueue_scripts' ] ); // Assets for block editor UI. - add_action( 'enqueue_block_editor_assets', array( $this, 'load_scripts_for_block_editor' ) ); + add_action( 'enqueue_block_editor_assets', [ $this, 'load_scripts_for_block_editor' ] ); // Assets for iframed block editor and editor UI. - add_action( 'enqueue_block_editor_assets', array( $this, 'load_styles_for_block_editor' ) ); + add_action( 'enqueue_block_editor_assets', [ $this, 'load_styles_for_block_editor' ] ); } - add_action( 'admin_notices', array( $this, 'no_js_notice' ) ); - add_action( 'admin_print_scripts', array( $this, 'post_admin_header' ) ); + add_action( 'admin_notices', [ $this, 'no_js_notice' ] ); + add_action( 'admin_print_scripts', [ $this, 'post_admin_header' ] ); // Add custom statuses to the post states. - add_filter( 'display_post_states', array( $this, 'add_status_to_post_states' ), 10, 2 ); + add_filter( 'display_post_states', [ $this, 'add_status_to_post_states' ], 10, 2 ); // Methods for handling the actions of creating, making default, and deleting post stati - add_action( 'admin_init', array( $this, 'handle_add_custom_status' ) ); - add_action( 'admin_init', array( $this, 'handle_edit_custom_status' ) ); - add_action( 'admin_init', array( $this, 'handle_make_default_custom_status' ) ); - add_action( 'admin_init', array( $this, 'handle_delete_custom_status' ) ); - add_action( 'wp_ajax_update_status_positions', array( $this, 'handle_ajax_update_status_positions' ) ); - add_action( 'wp_ajax_inline_save_status', array( $this, 'ajax_inline_save_status' ) ); + add_action( 'admin_init', [ $this, 'handle_add_custom_status' ] ); + add_action( 'admin_init', [ $this, 'handle_edit_custom_status' ] ); + add_action( 'admin_init', [ $this, 'handle_make_default_custom_status' ] ); + add_action( 'admin_init', [ $this, 'handle_delete_custom_status' ] ); + add_action( 'wp_ajax_update_status_positions', [ $this, 'handle_ajax_update_status_positions' ] ); + add_action( 'wp_ajax_inline_save_status', [ $this, 'ajax_inline_save_status' ] ); // These seven-ish methods are hacks for fixing bugs in WordPress core - add_action( 'admin_init', array( $this, 'check_timestamp_on_publish' ) ); - add_filter( 'wp_insert_post_data', array( $this, 'fix_custom_status_timestamp' ), 10, 2 ); - add_filter( 'wp_insert_post_data', array( $this, 'maybe_keep_post_name_empty' ), 10, 2 ); - add_filter( 'pre_wp_unique_post_slug', array( $this, 'fix_unique_post_slug' ), 10, 6 ); - add_filter( 'preview_post_link', array( $this, 'fix_preview_link_part_one' ) ); - add_filter( 'post_link', array( $this, 'fix_preview_link_part_two' ), 10, 3 ); - add_filter( 'page_link', array( $this, 'fix_preview_link_part_two' ), 10, 3 ); - add_filter( 'post_type_link', array( $this, 'fix_preview_link_part_two' ), 10, 3 ); - add_filter( 'preview_post_link', array( $this, 'fix_preview_link_part_three' ), 11, 2 ); - add_filter( 'get_sample_permalink', array( $this, 'fix_get_sample_permalink' ), 10, 5 ); - add_filter( 'get_sample_permalink_html', array( $this, 'fix_get_sample_permalink_html' ), 10, 5 ); - add_filter( 'post_row_actions', array( $this, 'fix_post_row_actions' ), 10, 2 ); - add_filter( 'page_row_actions', array( $this, 'fix_post_row_actions' ), 10, 2 ); + add_action( 'admin_init', [ $this, 'check_timestamp_on_publish' ] ); + add_filter( 'wp_insert_post_data', [ $this, 'fix_custom_status_timestamp' ], 10, 2 ); + add_filter( 'wp_insert_post_data', [ $this, 'maybe_keep_post_name_empty' ], 10, 2 ); + add_filter( 'pre_wp_unique_post_slug', [ $this, 'fix_unique_post_slug' ], 10, 6 ); + add_filter( 'preview_post_link', [ $this, 'fix_preview_link_part_one' ] ); + add_filter( 'post_link', [ $this, 'fix_preview_link_part_two' ], 10, 3 ); + add_filter( 'page_link', [ $this, 'fix_preview_link_part_two' ], 10, 3 ); + add_filter( 'post_type_link', [ $this, 'fix_preview_link_part_two' ], 10, 3 ); + add_filter( 'preview_post_link', [ $this, 'fix_preview_link_part_three' ], 11, 2 ); + add_filter( 'get_sample_permalink', [ $this, 'fix_get_sample_permalink' ], 10, 5 ); + add_filter( 'get_sample_permalink_html', [ $this, 'fix_get_sample_permalink_html' ], 10, 5 ); + add_filter( 'post_row_actions', [ $this, 'fix_post_row_actions' ], 10, 2 ); + add_filter( 'page_row_actions', [ $this, 'fix_post_row_actions' ], 10, 2 ); // Pagination for custom post statuses when previewing posts - add_filter( 'wp_link_pages_link', array( $this, 'modify_preview_link_pagination_url' ), 10, 2 ); + add_filter( 'wp_link_pages_link', [ $this, 'modify_preview_link_pagination_url' ], 10, 2 ); } /** @@ -129,48 +129,48 @@ public function init() { */ public function install() { - $default_terms = array( - array( + $default_terms = [ + [ 'term' => __( 'Pitch', 'edit-flow' ), - 'args' => array( + 'args' => [ 'slug' => 'pitch', 'description' => __( 'Idea proposed; waiting for acceptance.', 'edit-flow' ), 'position' => 1, - ), - ), - array( + ], + ], + [ 'term' => __( 'Assigned', 'edit-flow' ), - 'args' => array( + 'args' => [ 'slug' => 'assigned', 'description' => __( 'Post idea assigned to writer.', 'edit-flow' ), 'position' => 2, - ), - ), - array( + ], + ], + [ 'term' => __( 'In Progress', 'edit-flow' ), - 'args' => array( + 'args' => [ 'slug' => 'in-progress', 'description' => __( 'Writer is working on the post.', 'edit-flow' ), 'position' => 3, - ), - ), - array( + ], + ], + [ 'term' => __( 'Draft', 'edit-flow' ), - 'args' => array( + 'args' => [ 'slug' => 'draft', 'description' => __( 'Post is a draft; not ready for review or publication.', 'edit-flow' ), 'position' => 4, - ), - ), - array( + ], + ], + [ 'term' => __( 'Pending Review' ), - 'args' => array( + 'args' => [ 'slug' => 'pending', 'description' => __( 'Post needs to be reviewed by an editor.', 'edit-flow' ), 'position' => 5, - ), - ), - ); + ], + ], + ]; // Okay, now add the default statuses to the db if they don't already exist foreach ( $default_terms as $term ) { @@ -229,14 +229,14 @@ public function register_custom_statuses() { // Register new taxonomy so that we can store all our fancy new custom statuses (or is it stati?) if ( ! taxonomy_exists( self::taxonomy_key ) ) { - $args = array( + $args = [ 'hierarchical' => false, 'update_count_callback' => '_update_post_term_count', 'label' => false, 'query_var' => false, 'rewrite' => false, 'show_ui' => false, - ); + ]; register_taxonomy( self::taxonomy_key, 'post', $args ); } @@ -254,12 +254,12 @@ public function register_custom_statuses() { // all post statuses for a post type appearing at the top // of manage posts if there is a post with the status foreach ( $custom_statuses as $status ) { - register_post_status( $status->slug, array( + register_post_status( $status->slug, [ 'label' => $status->name, 'protected' => true, '_builtin' => false, 'label_count' => _n_noop( "{$status->name} (%s)", "{$status->name} (%s)" ), - ) ); + ] ); } } } @@ -276,7 +276,7 @@ public function disable_custom_statuses_for_post_type( $post_type = null ) { global $pagenow; // Only allow deregistering on 'edit.php' and 'post.php' - if ( ! in_array( $pagenow, array( 'edit.php', 'post.php', 'post-new.php' ) ) ) { + if ( ! in_array( $pagenow, [ 'edit.php', 'post.php', 'post-new.php' ] ) ) { return false; } @@ -326,7 +326,7 @@ public function action_admin_enqueue_scripts() { public function load_scripts_for_block_editor() { global $post; - wp_enqueue_script( 'edit-flow-block-custom-status-script', EDIT_FLOW_URL . 'dist/custom-status.build.js', array( 'wp-blocks', 'wp-element', 'wp-edit-post', 'wp-plugins', 'wp-components' ), EDIT_FLOW_VERSION ); + wp_enqueue_script( 'edit-flow-block-custom-status-script', EDIT_FLOW_URL . 'dist/custom-status.build.js', [ 'wp-blocks', 'wp-element', 'wp-edit-post', 'wp-plugins', 'wp-components' ], EDIT_FLOW_VERSION ); $custom_statuses = apply_filters( 'ef_custom_status_list', $this->get_custom_statuses(), $post ); @@ -379,7 +379,7 @@ public function is_whitelisted_page() { } // Only add the script to Edit Post and Edit Page pages -- don't want to bog down the rest of the admin with unnecessary javascript - return in_array( $pagenow, array( 'post.php', 'edit.php', 'post-new.php', 'page.php', 'edit-pages.php', 'page-new.php' ) ); + return in_array( $pagenow, [ 'post.php', 'edit.php', 'post-new.php', 'page.php', 'edit-pages.php', 'page-new.php' ] ); } /** @@ -426,32 +426,32 @@ public function post_admin_header() { $custom_statuses = apply_filters( 'ef_custom_status_list', $custom_statuses, $post ); // All right, we want to set up the JS var which contains all custom statuses - $all_statuses = array(); + $all_statuses = []; // The default statuses from WordPress - $all_statuses[] = array( + $all_statuses[] = [ 'name' => __( 'Published', 'edit-flow' ), 'slug' => 'publish', 'description' => '', - ); - $all_statuses[] = array( + ]; + $all_statuses[] = [ 'name' => __( 'Privately Published', 'edit-flow' ), 'slug' => 'private', 'description' => '', - ); - $all_statuses[] = array( + ]; + $all_statuses[] = [ 'name' => __( 'Scheduled', 'edit-flow' ), 'slug' => 'future', 'description' => '', - ); + ]; // Load the custom statuses foreach ( $custom_statuses as $status ) { - $all_statuses[] = array( + $all_statuses[] = [ 'name' => esc_js( $status->name ), 'slug' => esc_js( $status->slug ), 'description' => esc_js( $status->description ), - ); + ]; } $always_show_dropdown = ( 'on' == $this->module->options->always_show_dropdown ) ? 1 : 0; @@ -491,17 +491,17 @@ public function post_admin_header() { * @param array|string $args Change the values of the inserted term * @return array|WP_Error $response The Term ID and Term Taxonomy ID */ - public function add_custom_status( $term, $args = array() ) { + public function add_custom_status( $term, $args = [] ) { $slug = ( ! empty( $args['slug'] ) ) ? $args['slug'] : sanitize_title( $term ); unset( $args['slug'] ); $encoded_description = $this->get_encoded_description( $args ); - $response = wp_insert_term( $term, self::taxonomy_key, array( + $response = wp_insert_term( $term, self::taxonomy_key, [ 'slug' => $slug, 'description' => $encoded_description, - ) ); + ] ); // Reset our internal object cache - $this->custom_statuses_cache = array(); + $this->custom_statuses_cache = []; return $response; } @@ -513,7 +513,7 @@ public function add_custom_status( $term, $args = array() ) { * @param array $args Any arguments to be updated * @return object $updated_status Newly updated status object */ - public function update_custom_status( $status_id, $args = array() ) { + public function update_custom_status( $status_id, $args = [] ) { global $edit_flow; $old_status = $this->get_custom_status_by( 'id', $status_id ); @@ -522,7 +522,7 @@ public function update_custom_status( $status_id, $args = array() ) { } // Reset our internal object cache - $this->custom_statuses_cache = array(); + $this->custom_statuses_cache = []; // Prevent user from changing draft name or slug if ( 'draft' === $old_status->slug @@ -550,7 +550,7 @@ public function update_custom_status( $status_id, $args = array() ) { } } // We're encoding metadata that isn't supported by default in the term's description field - $args_to_encode = array(); + $args_to_encode = []; $args_to_encode['description'] = ( isset( $args['description'] ) ) ? $args['description'] : $old_status->description; $args_to_encode['position'] = ( isset( $args['position'] ) ) ? $args['position'] : $old_status->position; $encoded_description = $this->get_encoded_description( $args_to_encode ); @@ -568,7 +568,7 @@ public function update_custom_status( $status_id, $args = array() ) { * Partly a wrapper for the wp_delete_term function. * BUT, also reassigns posts that currently have the deleted status assigned. */ - public function delete_custom_status( $status_id, $args = array(), $reassign = '' ) { + public function delete_custom_status( $status_id, $args = [], $reassign = '' ) { global $edit_flow; // Reassign posts to alternate status @@ -580,7 +580,7 @@ public function delete_custom_status( $status_id, $args = array(), $reassign = ' } // Reset our internal object cache - $this->custom_statuses_cache = array(); + $this->custom_statuses_cache = []; if ( ! $this->is_restricted_status( $old_status ) && 'draft' !== $old_status ) { $default_status = $this->get_default_custom_status()->slug; @@ -610,7 +610,7 @@ public function delete_custom_status( $status_id, $args = array(), $reassign = ' * @param array $args * @return array $statuses All of the statuses */ - public function get_custom_statuses( $args = array() ) { + public function get_custom_statuses( $args = [] ) { global $wp_post_statuses; if ( $this->disable_custom_statuses_for_post_type() ) { @@ -624,18 +624,18 @@ public function get_custom_statuses( $args = array() ) { } // Handle if the requested taxonomy doesn't exist - $statuses = get_terms( array( + $statuses = get_terms( [ 'taxonomy' => self::taxonomy_key, 'hide_empty' => false, - )); + ]); if ( is_wp_error( $statuses ) || empty( $statuses ) ) { - $statuses = array(); + $statuses = []; } // Expand and order the statuses - $ordered_statuses = array(); - $hold_to_end = array(); + $ordered_statuses = []; + $hold_to_end = []; foreach ( $statuses as $key => $status ) { // Unencode and set all of our psuedo term meta because we need the position if it exists $unencoded_description = $this->get_unencoded_description( $status->description ); @@ -676,7 +676,7 @@ public function get_custom_statuses( $args = array() ) { */ public function get_custom_status_by( $field, $value ) { - if ( ! in_array( $field, array( 'id', 'slug', 'name' ) ) ) { + if ( ! in_array( $field, [ 'id', 'slug', 'name' ] ) ) { return false; } @@ -685,7 +685,7 @@ public function get_custom_status_by( $field, $value ) { } $custom_statuses = $this->get_custom_statuses(); - $custom_status = wp_filter_object_list( $custom_statuses, array( $field => $value ) ); + $custom_status = wp_filter_object_list( $custom_statuses, [ $field => $value ] ); if ( ! empty( $custom_status ) ) { return array_shift( $custom_status ); @@ -722,7 +722,7 @@ public function reassign_post_status( $old_status, $new_status = '' ) { } // Make the database call - $result = $wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'post_status' => $old_status ), array( '%s' ) ); + $result = $wpdb->update( $wpdb->posts, [ 'post_status' => $new_status ], [ 'post_status' => $old_status ], [ '%s' ] ); } /** @@ -747,7 +747,7 @@ public function add_status_to_post_states( $post_states, $post ) { return $post_states; } - $statuses_to_ignore = array( 'future', 'trash', 'publish' ); + $statuses_to_ignore = [ 'future', 'trash', 'publish' ]; if ( in_array( $post_status->name, $statuses_to_ignore, true ) ) { // Let WP core handle these more gracefully. return $post_states; @@ -812,7 +812,7 @@ public function handle_add_custom_status() { * - Name is required and can't conflict with an existing name or slug * - Description is optional */ - $_REQUEST['form-errors'] = array(); + $_REQUEST['form-errors'] = []; // Check if name field was filled in if ( empty( $status_name ) ) { $_REQUEST['form-errors']['name'] = __( 'Please enter a name for the status', 'edit-flow' ); @@ -842,17 +842,17 @@ public function handle_add_custom_status() { } // Try to add the status - $status_args = array( + $status_args = [ 'description' => $status_description, 'slug' => $status_slug, - ); + ]; $return = $this->add_custom_status( $status_name, $status_args ); if ( is_wp_error( $return ) ) { /* translators: %s: error message */ wp_die( esc_html( sprintf( __( 'Could not add status: %s', 'edit-flow' ), $return->get_error_message() ) ) ); } // Redirect if successful - $redirect_url = $this->get_link( array( 'message' => 'status-added' ) ); + $redirect_url = $this->get_link( [ 'message' => 'status-added' ] ); wp_redirect( $redirect_url ); exit; } @@ -891,7 +891,7 @@ public function handle_edit_custom_status() { * - 'name' is a required field and can't conflict with existing name or slug * - 'description' is optional */ - $_REQUEST['form-errors'] = array(); + $_REQUEST['form-errors'] = []; // Check if name field was filled in if ( empty( $name ) ) { $_REQUEST['form-errors']['name'] = __( 'Please enter a name for the status', 'edit-flow' ); @@ -927,17 +927,17 @@ public function handle_edit_custom_status() { } // Try to add the new post status - $args = array( + $args = [ 'name' => $name, 'slug' => sanitize_title( $name ), 'description' => $description, - ); + ]; $return = $this->update_custom_status( $existing_status->term_id, $args ); if ( is_wp_error( $return ) ) { wp_die( esc_html__( 'Error updating post status.', 'edit-flow' ) ); } - $redirect_url = $this->get_link( array( 'message' => 'status-updated' ) ); + $redirect_url = $this->get_link( [ 'message' => 'status-updated' ] ); wp_redirect( $redirect_url ); exit; } @@ -971,7 +971,7 @@ public function handle_make_default_custom_status() { if ( is_object( $term ) ) { $edit_flow->update_module_option( $this->module->name, 'default_status', $term->slug ); // @todo How do we want to handle users who click the link from "Add New Status" - $redirect_url = $this->get_link( array( 'message' => 'default-status-changed' ) ); + $redirect_url = $this->get_link( [ 'message' => 'default-status-changed' ] ); wp_redirect( $redirect_url ); exit; } else { @@ -1019,7 +1019,7 @@ public function handle_delete_custom_status() { wp_die( esc_html( __( 'Could not delete the status: ', 'edit-flow' ) . $return->get_error_message() ) ); } - $redirect_url = $this->get_link( array( 'message' => 'status-deleted' ) ); + $redirect_url = $this->get_link( [ 'message' => 'status-deleted' ] ); wp_redirect( $redirect_url ); exit; } @@ -1032,7 +1032,7 @@ public function handle_delete_custom_status() { * @param array $args (optional) Action and any query args to add to the URL * @return string $link Direct link to complete the action */ - public function get_link( $args = array() ) { + public function get_link( $args = [] ) { if ( ! isset( $args['action'] ) ) { $args['action'] = ''; } @@ -1074,9 +1074,9 @@ public function handle_ajax_update_status_positions() { foreach ( $_POST['status_positions'] as $position => $term_id ) { // Have to add 1 to the position because the index started with zero - $args = array( + $args = [ 'position' => (int) $position + 1, - ); + ]; $return = $this->update_custom_status( (int) $term_id, $args ); // @todo check that this was a valid return } @@ -1142,11 +1142,11 @@ public function ajax_inline_save_status() { } // get status_name & status_description - $args = array( + $args = [ 'name' => $status_name, 'description' => $status_description, 'slug' => $status_slug, - ); + ]; $return = $this->update_custom_status( $term_id, $args ); if ( ! is_wp_error( $return ) ) { set_current_screen( 'edit-custom-status' ); @@ -1170,8 +1170,8 @@ public function ajax_inline_save_status() { public function register_settings() { add_settings_section( $this->module->options_group_name . '_general', false, '__return_false', $this->module->options_group_name ); - add_settings_field( 'post_types', __( 'Use on these post types:', 'edit-flow' ), array( $this, 'settings_post_types_option' ), $this->module->options_group_name, $this->module->options_group_name . '_general' ); - add_settings_field( 'always_show_dropdown', __( 'Always show dropdown:', 'edit-flow' ), array( $this, 'settings_always_show_dropdown_option' ), $this->module->options_group_name, $this->module->options_group_name . '_general' ); + add_settings_field( 'post_types', __( 'Use on these post types:', 'edit-flow' ), [ $this, 'settings_post_types_option' ], $this->module->options_group_name, $this->module->options_group_name . '_general' ); + add_settings_field( 'always_show_dropdown', __( 'Always show dropdown:', 'edit-flow' ), [ $this, 'settings_always_show_dropdown_option' ], $this->module->options_group_name, $this->module->options_group_name . '_general' ); } /** @@ -1190,10 +1190,10 @@ public function settings_post_types_option() { * @since 0.7 */ public function settings_always_show_dropdown_option() { - $options = array( + $options = [ 'off' => __( 'Disabled', 'edit-flow' ), 'on' => __( 'Enabled', 'edit-flow' ), - ); + ]; echo ' From 5d8a159c4727bb9ef42a6cd19cbfc823676e1d94 Mon Sep 17 00:00:00 2001 From: ingeniumed Date: Fri, 28 Jun 2024 14:45:26 +1000 Subject: [PATCH 4/4] Code review feedback being implemented --- .github/workflows/php-tests.yml | 7 +++---- modules/custom-status/custom-status.php | 8 ++++---- modules/custom-status/views/configure.php | 8 ++++++-- modules/editorial-metadata/editorial-metadata.php | 2 +- modules/settings/settings.php | 14 ++------------ modules/user-groups/user-groups.php | 4 ++-- 6 files changed, 18 insertions(+), 25 deletions(-) diff --git a/.github/workflows/php-tests.yml b/.github/workflows/php-tests.yml index dc91c783..ac321ecc 100644 --- a/.github/workflows/php-tests.yml +++ b/.github/workflows/php-tests.yml @@ -44,15 +44,14 @@ jobs: with: composer-options: --prefer-dist --no-progress + - name: Run PHPCS + run: composer run cs + - name: Setup wp-env run: wp-env start env: WP_ENV_CORE: WordPress/WordPress#${{ matrix.wp }} - # Commented out until we finish linting all the files - # - name: Run PHPCS diff tests - # run: bash bin/phpcs-diff.sh - - name: Run PHPUnit tests (single site) run: composer integration diff --git a/modules/custom-status/custom-status.php b/modules/custom-status/custom-status.php index a734dcd1..deaef06f 100644 --- a/modules/custom-status/custom-status.php +++ b/modules/custom-status/custom-status.php @@ -1224,13 +1224,13 @@ public function settings_validate( $new_options ) { return $new_options; } + // phpcs:disable:WordPress.Security.NonceVerification.Missing -- Disabling nonce verification because that is not available here, it's just rendering it. The actual save is done in helper_settings_validate_and_save and that's guarded well. + /** * Primary configuration page for custom status class. * Shows form to add new custom statuses on the left and a * WP_List_Table with the custom status terms on the right * - * Disabling nonce verification because that is not available here, it's just rendering it. The actual save is done in helper_settings_validate_and_save and that's guarded well. - * phpcs:disable:WordPress.Security.NonceVerification.Missing */ public function print_configure_view() { // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- No verification required for unprivileged URL check. @@ -1263,11 +1263,11 @@ public function print_configure_view() { $description = ( isset( $_POST['description'] ) ) ? wp_strip_all_tags( $_POST['description'] ) : $custom_status->description; } - include __DIR__ . '/views/edit-status.php'; + include_once __DIR__ . '/views/edit-status.php'; } else { $custom_status_list_table = new EF_Custom_Status_List_Table(); $custom_status_list_table->prepare_items(); - include __DIR__ . '/views/configure.php'; + include_once __DIR__ . '/views/configure.php'; } } diff --git a/modules/custom-status/views/configure.php b/modules/custom-status/views/configure.php index c9ba2253..00ca33c1 100644 --- a/modules/custom-status/views/configure.php +++ b/modules/custom-status/views/configure.php @@ -2,6 +2,8 @@ defined( 'ABSPATH' ) || exit(); +// phpcs:disable:WordPress.Security.NonceVerification.Missing -- Disabling nonce verification because that is not available here, it's just rendering it. The actual save is done in helper_settings_validate_and_save and that's guarded well. + global $edit_flow; ?> @@ -28,7 +30,7 @@
module->options_group_name ); ?> module->options_group_name ); ?> - module->name ) . '" />'; ?> +
@@ -47,7 +49,7 @@ - '; ?> +

@@ -57,4 +59,6 @@ inline_edit(); diff --git a/modules/editorial-metadata/editorial-metadata.php b/modules/editorial-metadata/editorial-metadata.php index d75a15ae..3e5293e2 100644 --- a/modules/editorial-metadata/editorial-metadata.php +++ b/modules/editorial-metadata/editorial-metadata.php @@ -1606,7 +1606,7 @@ public function print_configure_view() { " method="post"> module->options_group_name ); ?> module->options_group_name ); ?> - module->name ) . '" />'; ?> + diff --git a/modules/settings/settings.php b/modules/settings/settings.php index 784c3e93..2a919633 100644 --- a/modules/settings/settings.php +++ b/modules/settings/settings.php @@ -207,20 +207,10 @@ public function print_default_header( $current_module ) {
name ) : ?> -

: title ); ?> - -

+

: title ); ?>

-

- -

+

diff --git a/modules/user-groups/user-groups.php b/modules/user-groups/user-groups.php index fe4e33c9..4d451756 100644 --- a/modules/user-groups/user-groups.php +++ b/modules/user-groups/user-groups.php @@ -648,7 +648,7 @@ public function print_configure_view() {
module->options_group_name ); ?> module->options_group_name ); ?> - module->name ) . '" />'; ?> +
@@ -665,7 +665,7 @@ public function print_configure_view() { settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the user group is to be used for.', 'edit-flow' ) ); ?>
- '; ?> +