Skip to content

Hooks/filters parity for preview & update functionality #11493

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

Open
vishalsingh098 wants to merge 2 commits into
base: trunk
Choose a base branch
from
+160 −1
Open

Hooks/filters parity for preview & update functionality #11493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e4c2c8
Hooks/filters parity for preview & update functionality
vishal-xecurify Apr 9, 2026
6b0afe7
Re-run CI
vishal-xecurify Apr 9, 2026
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
36 changes: 35 additions & 1 deletion src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,29 @@ public function preview() {
add_filter( 'wp_get_nav_menu_items', array( __CLASS__, 'sort_wp_get_nav_menu_items' ), 1000, 3 );
}

// @todo Add get_post_metadata filters for plugins to add their data.
/**
* Fires when the WP_Customize_Nav_Menu_Item_Setting::preview() method is called
* for a specific nav menu item setting.
*
* The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
*
* @since 7.1.0
*
* @param WP_Customize_Nav_Menu_Item_Setting $setting WP_Customize_Nav_Menu_Item_Setting instance.
*/
do_action( "customize_preview_{$this->id}", $this );

/**
* Fires when the WP_Customize_Nav_Menu_Item_Setting::preview() method is called
* for nav menu item settings.
*
* The dynamic portion of the hook name, `$this->type`, refers to the setting type.
*
* @since 7.1.0
*
* @param WP_Customize_Nav_Menu_Item_Setting $setting WP_Customize_Nav_Menu_Item_Setting instance.
*/
do_action( "customize_preview_{$this->type}", $this );

return true;
}
Expand Down Expand Up @@ -888,6 +910,18 @@ protected function update( $value ) {
}
}

/**
* Fires when the WP_Customize_Nav_Menu_Item_Setting::update() method is called.
*
* The dynamic portion of the hook name, `$this->type`, refers to the setting type.
*
* @since 7.1.0
*
* @param array|false $value Value of the setting. False if the menu item is to be deleted.
* @param WP_Customize_Nav_Menu_Item_Setting $setting WP_Customize_Nav_Menu_Item_Setting instance.
*/
do_action( "customize_update_{$this->type}", $value, $this );

return ( 'error' !== $this->update_status );
}

Expand Down
125 changes: 125 additions & 0 deletions tests/phpunit/tests/customize/nav-menu-item-setting.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,6 +843,131 @@ public function test_save_deleted() {
$this->assertSame( 'deleted', $update_result['status'] );
}

/**
* Tests that preview() fires the customize_preview_{$id} and customize_preview_{$type} action hooks.
*
* @ticket 55051
*
* @covers WP_Customize_Nav_Menu_Item_Setting::preview
*/
public function test_preview_fires_action_hooks() {
do_action( 'customize_register', $this->wp_customize );

$menu_id = wp_create_nav_menu( 'Primary' );
$post_id = self::factory()->post->create( array( 'post_title' => 'Hello World' ) );
$item_id = wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-type' => 'post_type',
'menu-item-object' => 'post',
'menu-item-object-id' => $post_id,
'menu-item-title' => 'Hello World',
'menu-item-status' => 'publish',
)
);

$setting_id = "nav_menu_item[$item_id]";
$setting = new WP_Customize_Nav_Menu_Item_Setting( $this->wp_customize, $setting_id );
$this->wp_customize->set_post_value(
$setting_id,
array(
'type' => 'post_type',
'object' => 'post',
'object_id' => $post_id,
'title' => 'Updated Title',
'status' => 'publish',
'nav_menu_term_id' => $menu_id,
)
);

$preview_id_action_count = 0;
$preview_type_action_count = 0;
$preview_id_setting = null;
$preview_type_setting = null;

add_action(
"customize_preview_{$setting_id}",
function ( $s ) use ( &$preview_id_action_count, &$preview_id_setting ) {
++$preview_id_action_count;
$preview_id_setting = $s;
}
);

add_action(
'customize_preview_nav_menu_item',
function ( $s ) use ( &$preview_type_action_count, &$preview_type_setting ) {
++$preview_type_action_count;
$preview_type_setting = $s;
}
);

$setting->preview();

$this->assertSame( 1, $preview_id_action_count, 'customize_preview_{$id} action was not fired exactly once.' );
$this->assertSame( $setting, $preview_id_setting, 'customize_preview_{$id} action did not receive the setting instance.' );
$this->assertSame( 1, $preview_type_action_count, 'customize_preview_{$type} action was not fired exactly once.' );
$this->assertSame( $setting, $preview_type_setting, 'customize_preview_{$type} action did not receive the setting instance.' );
}

/**
* Tests that update() fires the customize_update_{$type} action hook.
*
* @ticket 55051
*
* @covers WP_Customize_Nav_Menu_Item_Setting::update
*/
public function test_update_fires_action_hook() {
do_action( 'customize_register', $this->wp_customize );

$menu_id = wp_create_nav_menu( 'Primary' );
$post_id = self::factory()->post->create( array( 'post_title' => 'Hello World' ) );
$item_id = wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-type' => 'post_type',
'menu-item-object' => 'post',
'menu-item-object-id' => $post_id,
'menu-item-title' => 'Hello World',
'menu-item-status' => 'publish',
)
);

$post_value = array(
'type' => 'post_type',
'object' => 'post',
'object_id' => $post_id,
'title' => 'Updated Title',
'status' => 'publish',
'nav_menu_term_id' => $menu_id,
);
$setting_id = "nav_menu_item[$item_id]";
$setting = new WP_Customize_Nav_Menu_Item_Setting( $this->wp_customize, $setting_id );
$this->wp_customize->set_post_value( $setting_id, $post_value );

$update_action_count = 0;
$update_action_value = null;
$update_action_setting = null;

add_action(
'customize_update_nav_menu_item',
function ( $value, $s ) use ( &$update_action_count, &$update_action_value, &$update_action_setting ) {
++$update_action_count;
$update_action_value = $value;
$update_action_setting = $s;
},
10,
2
);

$setting->save();

$this->assertSame( 1, $update_action_count, 'customize_update_{$type} action was not fired exactly once.' );
$this->assertSame( $setting, $update_action_setting, 'customize_update_{$type} action did not receive the setting instance.' );
$this->assertIsArray( $update_action_value, 'customize_update_{$type} action did not receive the value as an array.' );
}

/**
* @ticket 33665
*/
Expand Down
Loading