Skip to content

fix(story-budget): respect ef_story_budget_taxonomy_used filter in dropdown #861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GaryJones merged 1 commit into from
Dec 23, 2025
Merged

fix(story-budget): respect ef_story_budget_taxonomy_used filter in dropdown #861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),

### Fixed

* fix(story-budget): respect `ef_story_budget_taxonomy_used` filter in dropdown by @GaryJones in [#861](https://github.com/Automattic/Edit-Flow/pull/861)
* fix: prevent spurious "Leave site?" warning on new posts with custom statuses by @GaryJones in [#860](https://github.com/Automattic/Edit-Flow/pull/860)
* fix: scope module asset loading to relevant pages only by @GaryJones in [#858](https://github.com/Automattic/Edit-Flow/pull/858)
* fix: allow text selection in calendar overlay without triggering drag by @GaryJones in [#857](https://github.com/Automattic/Edit-Flow/pull/857)
Expand Down
130 changes: 66 additions & 64 deletions modules/story-budget/story-budget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,19 @@ public function __construct() {

$this->module_url = $this->get_module_url( __FILE__ );
// Register the module with Edit Flow
$args = array(
'title' => __( 'Story Budget', 'edit-flow' ),
$args = array(
'title' => __( 'Story Budget', 'edit-flow' ),
// translators: %s is a link to the story budget page
'short_description' => sprintf( __( 'View the status of all your content <a href="%s">at a glance</a>.', 'edit-flow' ), admin_url( 'index.php?page=story-budget' ) ),
'short_description' => sprintf( __( 'View the status of all your content <a href="%s">at a glance</a>.', 'edit-flow' ), admin_url( 'index.php?page=story-budget' ) ),
'extended_description' => __( 'Use the story budget to see how content on your site is progressing. Filter by specific categories or date ranges to see details about each post in progress.', 'edit-flow' ),
'module_url' => $this->module_url,
'img_url' => $this->module_url . 'lib/story_budget_s128.png',
'slug' => 'story-budget',
'default_options' => array(
'module_url' => $this->module_url,
'img_url' => $this->module_url . 'lib/story_budget_s128.png',
'slug' => 'story-budget',
'default_options' => array(
'enabled' => 'on',
),
'configure_page_cb' => false,
'autoload' => false,
'configure_page_cb' => false,
'autoload' => false,
);
$this->module = EditFlow()->register_module( 'story_budget', $args );
}
Expand All @@ -70,10 +70,10 @@ public function init() {
return;
}

$this->num_columns = $this->get_num_columns();
$this->show_excerpts = $this->get_show_excerpts();
$this->hide_empty_terms = $this->get_hide_empty_terms();
$this->max_num_columns = apply_filters( 'ef_story_budget_max_num_columns', 3 );
$this->num_columns = $this->get_num_columns();
$this->show_excerpts = $this->get_show_excerpts();
$this->hide_empty_terms = $this->get_hide_empty_terms();
$this->max_num_columns = apply_filters( 'ef_story_budget_max_num_columns', 3 );

// Filter to allow users to pick a taxonomy other than 'category' for sorting their posts
$this->taxonomy_used = apply_filters( 'ef_story_budget_taxonomy_used', $this->taxonomy_used );
Expand All @@ -100,9 +100,9 @@ public function install() {

$story_budget_roles = array(
'administrator' => array( 'ef_view_story_budget' ),
'editor' => array( 'ef_view_story_budget' ),
'author' => array( 'ef_view_story_budget' ),
'contributor' => array( 'ef_view_story_budget' ),
'editor' => array( 'ef_view_story_budget' ),
'author' => array( 'ef_view_story_budget' ),
'contributor' => array( 'ef_view_story_budget' ),
);
foreach ( $story_budget_roles as $role => $caps ) {
$this->add_caps_to_role( $role, $caps );
Expand Down Expand Up @@ -184,14 +184,14 @@ public function action_enqueue_admin_styles() {
public function register_term_columns() {

$term_columns = array(
'title' => __( 'Title', 'edit-flow' ),
'status' => __( 'Status', 'edit-flow' ),
'author' => __( 'Author', 'edit-flow' ),
'post_date' => __( 'Post Date', 'edit-flow' ),
'title' => __( 'Title', 'edit-flow' ),
'status' => __( 'Status', 'edit-flow' ),
'author' => __( 'Author', 'edit-flow' ),
'post_date' => __( 'Post Date', 'edit-flow' ),
'post_modified' => __( 'Last Modified', 'edit-flow' ),
);

$term_columns = apply_filters( 'ef_story_budget_term_columns', $term_columns );
$term_columns = apply_filters( 'ef_story_budget_term_columns', $term_columns );
$this->term_columns = $term_columns;
}

Expand Down Expand Up @@ -394,16 +394,16 @@ public function story_budget() {
$this->user_filters = $this->update_user_filters();

if ( ! empty( $this->user_filters[ $this->taxonomy_used ] ) ) {
$terms = array();
$terms = array();
$terms[] = get_term( $this->user_filters[ $this->taxonomy_used ], $this->taxonomy_used );
} else {
// Get all of the terms from the taxonomy, regardless whether there are published posts
$terms = get_terms( array(
'taxonomy' => $this->taxonomy_used,
'orderby' => 'name',
'order' => 'asc',
'orderby' => 'name',
'order' => 'asc',
'hide_empty' => 0,
'parent' => 0,
'parent' => 0,
));
}
$this->terms = apply_filters( 'ef_story_budget_filter_terms', $terms ); // allow for reordering or any other filtering of terms
Expand Down Expand Up @@ -486,30 +486,30 @@ public function story_budget_time_range() {
public function get_posts_for_term( $term, $args = null ) {

$defaults = array(
'post_status' => null,
'author' => null,
'post_status' => null,
'author' => null,
'posts_per_page' => apply_filters( 'ef_story_budget_max_query', 200 ),
);
$args = array_merge( $defaults, $args );
$args = array_merge( $defaults, $args );

// Filter to the term and any children if it's hierarchical
$arg_terms = array(
$arg_terms = array(
$term->term_id,
);
$arg_terms = array_merge( $arg_terms, get_term_children( $term->term_id, $this->taxonomy_used ) );
$arg_terms = array_merge( $arg_terms, get_term_children( $term->term_id, $this->taxonomy_used ) );
$args['tax_query'] = array(
array(
'taxonomy' => $this->taxonomy_used,
'field' => 'id',
'terms' => $arg_terms,
'field' => 'id',
'terms' => $arg_terms,
'operator' => 'IN',
),
);

// Unpublished as a status is just an array of everything but 'publish'.
if ( 'unpublish' == $args['post_status'] ) {
$args['post_status'] = '';
$post_stati = wp_filter_object_list( $this->get_budget_post_stati(), array( 'name' => 'publish' ), 'not' );
$post_stati = wp_filter_object_list( $this->get_budget_post_stati(), array( 'name' => 'publish' ), 'not' );

if ( ! apply_filters( 'ef_show_scheduled_as_unpublished', false ) ) {
$post_stati = wp_filter_object_list( $post_stati, array( 'name' => 'future' ), 'not' );
Expand All @@ -524,8 +524,8 @@ public function get_posts_for_term( $term, $args = null ) {
}

$beginning_date = strtotime( $this->user_filters['start_date'] );
$days_to_show = $this->user_filters['number_days'];
$ending_date = $beginning_date + ( $days_to_show * DAY_IN_SECONDS );
$days_to_show = $this->user_filters['number_days'];
$ending_date = $beginning_date + ( $days_to_show * DAY_IN_SECONDS );

$args['date_query'] = array(
'after' => date( 'Y-m-d', $beginning_date ),
Expand Down Expand Up @@ -684,7 +684,7 @@ public function term_column_title( $post, $parent_term ) {
$post_title = _draft_or_post_title( $post->ID );

$post_type_object = get_post_type_object( $post->post_type );
$can_edit_post = current_user_can( $post_type_object->cap->edit_post, $post->ID );
$can_edit_post = current_user_can( $post_type_object->cap->edit_post, $post->ID );
if ( $can_edit_post ) {
$output = '<strong><a href="' . get_edit_post_link( $post->ID ) . '">' . esc_html( $post_title ) . '</a></strong>';
} else {
Expand All @@ -707,7 +707,7 @@ public function term_column_title( $post, $parent_term ) {
$output .= '</div>';

// Edit or Trash or View
$output .= '<div class="row-actions">';
$output .= '<div class="row-actions">';
$item_actions = array();
if ( $can_edit_post ) {
$item_actions['edit'] = '<a title="' . __( 'Edit this post', 'edit-flow' ) . '" href="' . get_edit_post_link( $post->ID ) . '">' . __( 'Edit', 'edit-flow' ) . '</a>';
Expand All @@ -720,15 +720,15 @@ public function term_column_title( $post, $parent_term ) {
if ( in_array( $post->post_status, array( 'publish' ) ) ) {
// translators: %s is the post title
$item_actions['view'] = '<a href="' . get_permalink( $post->ID ) . '" title="' . esc_attr( sprintf( __( 'View &#8220;%s&#8221;', 'edit-flow' ), $post_title ) ) . '" rel="permalink">' . __( 'View', 'edit-flow' ) . '</a>';
} else if ( $can_edit_post ) {
} elseif ( $can_edit_post ) {
// translators: %s is the post title
$item_actions['previewpost'] = '<a href="' . esc_url( apply_filters( 'preview_post_link', add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ), $post ) ) . '" title="' . esc_attr( sprintf( __( 'Preview &#8220;%s&#8221;', 'edit-flow' ), $post_title ) ) . '" rel="permalink">' . __( 'Preview', 'edit-flow' ) . '</a>';
}

$item_actions = apply_filters( 'ef_story_budget_item_actions', $item_actions, $post->ID );
if ( count( $item_actions ) ) {
$output .= '<div class="row-actions">';
$html = '';
$html = '';
foreach ( $item_actions as $class => $item_action ) {
$html .= '<span class="' . esc_attr( $class ) . '">' . $item_action . '</span> | ';
}
Expand All @@ -747,7 +747,6 @@ public function print_messages() {

<?php
if ( isset( $_GET['trashed'] ) || isset( $_GET['untrashed'] ) ) {

echo '<div id="trashed-message" class="updated"><p>';

// Following mostly stolen from edit.php
Expand Down Expand Up @@ -810,11 +809,11 @@ public function update_user_filters() {
$current_user = wp_get_current_user();

$user_filters = array(
'post_status' => $this->filter_get_param( 'post_status' ),
'cat' => $this->filter_get_param( 'cat' ),
'author' => $this->filter_get_param( 'author' ),
'start_date' => $this->filter_get_param( 'start_date' ),
'number_days' => $this->filter_get_param( 'number_days' ),
'post_status' => $this->filter_get_param( 'post_status' ),
'cat' => $this->filter_get_param( 'cat' ),
'author' => $this->filter_get_param( 'author' ),
'start_date' => $this->filter_get_param( 'start_date' ),
'number_days' => $this->filter_get_param( 'number_days' ),
);

$current_user_filters = array();
Expand Down Expand Up @@ -870,7 +869,7 @@ public function filter_get_param( $param ) {
// Sure, this could be done in one line. But we're cooler than that: let's make it more readable!
if ( ! isset( $_GET[ $param ] ) ) {
return null;
} else if ( empty( $_GET[ $param ] ) ) {
} elseif ( empty( $_GET[ $param ] ) ) {
return '';
}

Expand All @@ -881,8 +880,8 @@ public function story_budget_filters() {
$select_filter_names = array();

$select_filter_names['post_status'] = 'post_status';
$select_filter_names['cat'] = 'cat';
$select_filter_names['author'] = 'author';
$select_filter_names['cat'] = 'cat';
$select_filter_names['author'] = 'author';

return apply_filters( 'ef_story_budget_filter_names', $select_filter_names );
}
Expand All @@ -907,19 +906,22 @@ public function story_budget_filter_options( $select_id, $select_name, $filters
<?php
break;
case 'cat':
// Borrowed from wp-admin/edit.php
if ( taxonomy_exists( 'category' ) ) {
if ( taxonomy_exists( $this->taxonomy_used ) ) {
$taxonomy_obj = get_taxonomy( $this->taxonomy_used );
echo '<label for="cat">';
echo '<span class="screen-reader-text">' . esc_html__( 'Filter by category', 'edit-flow' ) . '</span>';
$category_dropdown_args = array(
'show_option_all' => __( 'View all categories', 'edit-flow' ),
'hide_empty' => 0,
'hierarchical' => 1,
'show_count' => 0,
'orderby' => 'name',
'selected' => $this->user_filters['cat'],
// translators: %s is the taxonomy name (e.g., "category", "tag")
echo '<span class="screen-reader-text">' . esc_html( sprintf( __( 'Filter by %s', 'edit-flow' ), $taxonomy_obj->labels->singular_name ) ) . '</span>';
$dropdown_args = array(
// translators: %s is the taxonomy name (e.g., "categories", "tags")
'show_option_all' => sprintf( __( 'View all %s', 'edit-flow' ), strtolower( $taxonomy_obj->labels->name ) ),
'hide_empty' => 0,
'hierarchical' => $taxonomy_obj->hierarchical,
'show_count' => 0,
'orderby' => 'name',
'selected' => $this->user_filters['cat'],
'taxonomy' => $this->taxonomy_used,
);
wp_dropdown_categories( $category_dropdown_args );
wp_dropdown_categories( $dropdown_args );
echo '</label>';
}
break;
Expand All @@ -928,9 +930,9 @@ public function story_budget_filter_options( $select_id, $select_name, $filters
echo '<span class="screen-reader-text">' . esc_html__( 'Filter by author', 'edit-flow' ) . '</span>';
$users_dropdown_args = array(
'show_option_all' => __( 'View all users', 'edit-flow' ),
'name' => 'author',
'selected' => $this->user_filters['author'],
'who' => 'authors',
'name' => 'author',
'selected' => $this->user_filters['author'],
'who' => 'authors',
);
$users_dropdown_args = apply_filters( 'ef_story_budget_users_dropdown_args', $users_dropdown_args );
wp_dropdown_users( $users_dropdown_args );
Expand All @@ -948,8 +950,8 @@ public function story_budget_filter_options( $select_id, $select_name, $filters
* @return array An array of StdClass objects representing statuses
*/
public function get_budget_post_stati() {
$post_stati = get_post_stati( array(), 'object' );
$custom_status_slugs = wp_list_pluck( $this->get_post_statuses(), 'slug' );
$post_stati = get_post_stati( array(), 'object' );
$custom_status_slugs = wp_list_pluck( $this->get_post_statuses(), 'slug' );
$custom_status_slugs[] = 'future';
$custom_status_slugs[] = 'publish';

Expand Down
Loading