Skip to content

Add a taxonomy for hiding lessons #2830

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
adamwoodnz merged 8 commits into from
Aug 8, 2024
Merged

Add a taxonomy for hiding lessons #2830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
791b76e
Add a taxonomy for hiding lessons
adamwoodnz Aug 7, 2024
90b956e
Add deprecation label to post meta setting
adamwoodnz Aug 7, 2024
dc10ae5
Add taxonomy based visibility settings panel
adamwoodnz Aug 7, 2024
b7a288d
Adjust tax capabilities
adamwoodnz Aug 7, 2024
0ae6444
Add a new taxonomy based lesson visibility panel
adamwoodnz Aug 7, 2024
cfcf2fe
Filter the lessons by taxonomy on the frontend
adamwoodnz Aug 7, 2024
1806125
Use a pre-existing Jetpack Search tax
adamwoodnz Aug 7, 2024
1dd65f1
Use standard taxonomy UI
adamwoodnz Aug 8, 2024
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
52 changes: 52 additions & 0 deletions wp-content/plugins/wporg-learn/inc/taxonomy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ function register() {
register_lesson_instruction_type();
register_lesson_level();
register_lesson_plan_series();
register_lesson_visibility();
register_workshop_series();
register_workshop_type();
register_wp_version();
Expand Down Expand Up @@ -260,6 +261,57 @@ function register_lesson_level() {
register_taxonomy( 'level', array( 'lesson-plan', 'lesson', 'course' ), $args );
}

/**
* Register the Lesson visibility taxonomy, used to hide lessons from the archive and search views.
*/
function register_lesson_visibility() {
$labels = array(
'name' => _x( 'Visibility', 'Taxonomy General Name', 'wporg-learn' ),
'singular_name' => _x( 'Visibility', 'Taxonomy Singular Name', 'wporg-learn' ),
'menu_name' => __( 'Visibility', 'wporg-learn' ),
'all_items' => __( 'All Visibilities', 'wporg-learn' ),
'parent_item' => __( 'Parent Visibility', 'wporg-learn' ),
'parent_item_colon' => __( 'Parent Visibility:', 'wporg-learn' ),
'new_item_name' => __( 'New Visibility Name', 'wporg-learn' ),
'add_new_item' => __( 'Add New Visibility', 'wporg-learn' ),
'edit_item' => __( 'Edit Visibility', 'wporg-learn' ),
'update_item' => __( 'Update Visibility', 'wporg-learn' ),
'view_item' => __( 'View Visibility', 'wporg-learn' ),
'separate_items_with_commas' => __( 'Separate visibilities with commas', 'wporg-learn' ),
'add_or_remove_items' => __( 'Add or remove visibilities', 'wporg-learn' ),
'choose_from_most_used' => __( 'Choose from the most used', 'wporg-learn' ),
'popular_items' => __( 'Popular Visibilities', 'wporg-learn' ),
'search_items' => __( 'Search Visibilities', 'wporg-learn' ),
'not_found' => __( 'No Visibilities Found', 'wporg-learn' ),
'no_terms' => __( 'No visibilities', 'wporg-learn' ),
'items_list' => __( 'Visibilities list', 'wporg-learn' ),
'items_list_navigation' => __( 'Visibilities list navigation', 'wporg-learn' ),
);

$args = array(
'labels' => $labels,
'hierarchical' => true,
'public' => true,
'query_var' => 'wporg_lesson_visibility', // Prevent collisions with query params in the archive filter.
'show_ui' => true,
'show_admin_column' => true,
'show_in_nav_menus' => true,
'show_tagcloud' => false,
'show_in_rest' => true,
'rewrite' => false,
'capabilities' => array(
'manage_terms' => 'manage_categories',
'edit_terms' => 'manage_categories',
'delete_terms' => 'manage_categories',
'assign_terms' => 'edit_lessons',
),
);

// Use an existing taxonomy registered with Jetpack Search
// See https://github.com/Automattic/jetpack/blob/36b2d5232e2ec3a1ad14034ab673fddce3acab97/projects/packages/sync/src/modules/class-search.php#L1479
register_taxonomy( 'show', array( 'lesson' ), $args );
}

/**
* Register the Lesson Plan Series taxonomy.
*/
Expand Down
2 changes: 1 addition & 1 deletion wp-content/plugins/wporg-learn/js/lesson-archive-excluded-meta/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const LessonArchiveExcludedMeta = () => {
const [ lessonExcluded, setLessonFeatured ] = useState( postMetaData?._lesson_archive_excluded === EXCLUDED );

return (
<PluginDocumentSettingPanel title={ __( 'Hidden Lesson', 'wporg-learn' ) }>
<PluginDocumentSettingPanel title={ __( 'Hidden Lesson (deprecated)', 'wporg-learn' ) }>
Copy link
Copy Markdown
Contributor Author

@adamwoodnz adamwoodnz Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this setting panel block once data migration is complete

<PanelRow>
<CheckboxControl
label={ __( 'Exclude this lesson from the archive', 'wporg-learn' ) }
Expand Down
23 changes: 20 additions & 3 deletions wp-content/themes/pub/wporg-learn-2024/inc/query.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ function add_excluded_to_lesson_archive_query( $query ) {
// Ensure this code runs only for the main query on lesson archive pages and search results.
if ( ! is_admin() && $query->is_main_query() && ( $query->is_archive( 'lesson' ) || $query->is_search() ) ) {
$meta_query = $query->get( 'meta_query', array() );
$tax_query = $query->get( 'tax_query', array() );

$exclude_lesson_query = array(
$exclude_lessons_by_post_meta = array(
Copy link
Copy Markdown
Contributor Author

@adamwoodnz adamwoodnz Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Meta query can be removed once data migration is complete

'relation' => 'OR',
array(
'key' => '_lesson_archive_excluded',
Expand All @@ -71,13 +72,29 @@ function add_excluded_to_lesson_archive_query( $query ) {
$meta_query = array(
'relation' => 'AND',
$meta_query,
$exclude_lesson_query,
$exclude_lessons_by_post_meta,
);
} else {
$meta_query = $exclude_lesson_query;
$meta_query = $exclude_lessons_by_post_meta;
}

$exclude_lessons_by_taxonomy = array(
'taxonomy' => 'show',
'field' => 'slug',
'terms' => 'hidden',
'operator' => 'NOT IN',
);

// If there's an existing tax query, add the new condition
if ( ! empty( $tax_query ) ) {
$tax_query['relation'] = 'AND';
$tax_query[] = $exclude_lessons_by_taxonomy;
} else {
$tax_query = array( $exclude_lessons_by_taxonomy );
}

$query->set( 'meta_query', $meta_query );
$query->set( 'tax_query', $tax_query );
}
}

Expand Down