Skip to content
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

Use bulk_edit_posts hook for bulk edit handler #7526

Merged
merged 6 commits into from
Mar 11, 2024
Merged

Use bulk_edit_posts hook for bulk edit handler #7526

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
93796db
Use bulk_edit_posts hook for bulk edit handler
merkushin Mar 7, 2024
1b484c7
Fix linter issue
merkushin Mar 7, 2024
caec1bc
Add backward compatible handler
merkushin Mar 7, 2024
58f6525
Add test for bulk_edit_save_post
merkushin Mar 8, 2024
3400b0f
Merge branch 'trunk' into fix/use-proper-hook-for-bulk-action
Imran92 Mar 11, 2024
7ab9b3c
Fix typo
merkushin Mar 11, 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
76 changes: 46 additions & 30 deletions includes/class-sensei-lesson.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,11 @@
add_action( 'manage_lesson_posts_custom_column', array( $this, 'set_quick_edit_admin_defaults' ), 11, 2 );

// save bulk edit fields
add_action( 'save_post', array( $this, 'save_all_lessons_edit_fields' ) );
if ( is_wp_version_compatible( '6.3' ) ) {
add_action( 'bulk_edit_posts', array( $this, 'save_all_lessons_edit_fields' ), 10, 2 );
} else {
add_action( 'save_post_lesson', array( $this, 'bulk_edit_save_post' ), 10, 1 );

Check warning on line 145 in includes/class-sensei-lesson.php

View check run for this annotation

Codecov / codecov/patch

includes/class-sensei-lesson.php#L145 

Added line #L145 was not covered by tests
}

add_action( 'admin_head', array( $this, 'add_custom_link_to_course' ) );

Expand Down Expand Up @@ -4321,38 +4325,59 @@
);
}

/**
* Save bulk edit fields. It is a backword compatible function for the bulk edit pre WP 6.3.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo in the word 'backward'

*
* @internal
*
* @param int $lesson_id Lesson ID.
*/
public function bulk_edit_save_post( $lesson_id ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce verification is done in the called method.
$this->save_all_lessons_edit_fields( array( $lesson_id ), $_REQUEST );
}

/**
* Respond to the ajax call from the bulk edit save function.
* This comes from the admin all lesson screen.
*
* @since 1.8.0
*
* @internal
*
* @param int[] $lesson_ids Lesson IDs.
* @param array $data Data.
*/
public function save_all_lessons_edit_fields() {
public function save_all_lessons_edit_fields( $lesson_ids, $data ) {
$lesson_ids = array_map( 'intval', $lesson_ids );
$lesson_ids = array_filter( $lesson_ids );

// Verify all the data before attempting to save.
if ( ! isset( $_REQUEST['_edit_lessons_nonce'] )
|| ! check_ajax_referer( 'bulk-edit-lessons', '_edit_lessons_nonce' )
|| empty( $_REQUEST['post'] )
|| ! is_array( $_REQUEST['post'] ) ) {
if ( ! isset( $data['_edit_lessons_nonce'] )
|| ! wp_verify_nonce( (string) $data['_edit_lessons_nonce'], 'bulk-edit-lessons' )
|| count( $lesson_ids ) === 0 ) {
return;
}

// Get our variables.
$new_course = isset( $_REQUEST['lesson_course'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['lesson_course'] ) ) : '';
$new_complexity = isset( $_REQUEST['lesson_complexity'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['lesson_complexity'] ) ) : '';
$new_pass_required = isset( $_REQUEST['pass_required'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['pass_required'] ) ) : '';
$new_pass_percentage = isset( $_REQUEST['quiz_passmark'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['quiz_passmark'] ) ) : '';
$new_enable_quiz_reset = isset( $_REQUEST['enable_quiz_reset'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['enable_quiz_reset'] ) ) : '';
$show_questions = isset( $_REQUEST['show_questions'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['show_questions'] ) ) : '';
$random_question_order = isset( $_REQUEST['random_question_order'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['random_question_order'] ) ) : '';
$quiz_grade_type = isset( $_REQUEST['quiz_grade_type'] ) ? sanitize_text_field( (string) wp_unslash( $_REQUEST['quiz_grade_type'] ) ) : '';

// Store the values for all selected posts.
$lesson_ids = $_REQUEST['post'] ?? array(); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- Input is sanitized in the next lines.
$lesson_ids = array_map( 'wp_unslash', $lesson_ids );
$lesson_ids = array_map( 'sanitize_text_field', $lesson_ids );
$lesson_ids = array_map( 'intval', $lesson_ids );
$new_course = isset( $data['lesson_course'] ) ? sanitize_text_field( (string) wp_unslash( $data['lesson_course'] ) ) : '';
$new_complexity = isset( $data['lesson_complexity'] ) ? sanitize_text_field( (string) wp_unslash( $data['lesson_complexity'] ) ) : '';
$new_pass_required = isset( $data['pass_required'] ) ? sanitize_text_field( (string) wp_unslash( $data['pass_required'] ) ) : '';
$new_pass_percentage = isset( $data['quiz_passmark'] ) ? sanitize_text_field( (string) wp_unslash( $data['quiz_passmark'] ) ) : '';
$new_enable_quiz_reset = isset( $data['enable_quiz_reset'] ) ? sanitize_text_field( (string) wp_unslash( $data['enable_quiz_reset'] ) ) : '';
$show_questions = isset( $data['show_questions'] ) ? sanitize_text_field( (string) wp_unslash( $data['show_questions'] ) ) : '';
$random_question_order = isset( $data['random_question_order'] ) ? sanitize_text_field( (string) wp_unslash( $data['random_question_order'] ) ) : '';
$quiz_grade_type = isset( $data['quiz_grade_type'] ) ? sanitize_text_field( (string) wp_unslash( $data['quiz_grade_type'] ) ) : '';

$new_quiz_settings = array(
'pass_required' => $new_pass_required,
'pass_percentage' => $new_pass_percentage,
'enable_quiz_reset' => $new_enable_quiz_reset,
'show_questions' => $show_questions,
'random_question_order' => $random_question_order,
'quiz_grade_type' => $quiz_grade_type,
);

foreach ( $lesson_ids as $lesson_id ) {
// Do not save the items if the value is -1 as this means it was not changed.

Expand All @@ -4366,16 +4391,7 @@
update_post_meta( $lesson_id, '_lesson_complexity', $new_complexity );
}

$new_settings = array(
'pass_required' => $new_pass_required,
'pass_percentage' => $new_pass_percentage,
'enable_quiz_reset' => $new_enable_quiz_reset,
'show_questions' => $show_questions,
'random_question_order' => $random_question_order,
'quiz_grade_type' => $quiz_grade_type,
);

$this->save_quiz_settings( $lesson_id, $new_settings );
$this->save_quiz_settings( $lesson_id, $new_quiz_settings );
}
}

Expand Down
29 changes: 27 additions & 2 deletions tests/unit-tests/test-class-lesson.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1641,19 +1641,44 @@ public function testLessonQuizQuestions_WhenUserAlreadySubmittedTheQuizButQuesti
}

public function testSaveAllLessonsEditFields_WhenCalled_UpdatesPostMeta(): void {
/* Arrange */
$lesson_id = $this->factory->lesson->create();
$course_id = $this->factory->course->create();
$data = array(
'_edit_lessons_nonce' => wp_create_nonce( 'bulk-edit-lessons' ),
'lesson_course' => $course_id,
'lesson_complexity' => 'hard',
);
$lesson = new Sensei_Lesson();

/* Act */
$lesson->save_all_lessons_edit_fields( array( $lesson_id ), $data );

/* Assert */
$expected = array(
'_lesson_course' => $course_id,
'_lesson_complexity' => 'hard',
);
$actual = array(
'_lesson_course' => (int) get_post_meta( $lesson_id, '_lesson_course', true ),
'_lesson_complexity' => get_post_meta( $lesson_id, '_lesson_complexity', true ),
);
self::assertSame( $expected, $actual );
}

public function testBulkEditSavePost_WhenCalled_UpdatesPostMeta(): void {
/* Arrange */
$lesson_id = $this->factory->lesson->create();
$course_id = $this->factory->course->create();
$_REQUEST = array(
'_edit_lessons_nonce' => wp_create_nonce( 'bulk-edit-lessons' ),
'post' => array( $lesson_id ),
'lesson_course' => $course_id,
'lesson_complexity' => 'hard',
);
$lesson = new Sensei_Lesson();

/* Act */
$lesson->save_all_lessons_edit_fields();
$lesson->bulk_edit_save_post( $lesson_id );

/* Assert */
$expected = array(
Expand Down
Loading