WP_Customize_Nav_Menu_Item_Setting

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 8

Every hook that fires from inside WP_Customize_Nav_Menu_Item_Setting, in the order it appears in the class, grouped by the method that fires it.

Properties · 10

$typestringpublic

Setting type.

$defaultarraypublic

Default setting value.

$transportstringpublic

Default transport.

$post_idintpublic

The post ID represented by this setting instance. This is the db_id.

$valuearray|nullprotected

Storage of pre-setup menu item to prevent wasted calls to wp_setup_nav_menu_item().

$previous_post_idintpublic

Previous (placeholder) post ID used before creating a new menu item.

$original_nav_menu_term_idintpublic

When previewing or updating a menu item, this stores the previous nav_menu_term_id which ensures that we can apply the proper filters.

$is_updatedboolprotected

Whether or not update() was called.

$update_statusstringpublic

Status for calling the update method, used in customize_save_response filter.

$update_errorWP_Errorpublic

Any error object returned by wp_update_nav_menu_item() when setting is updated.

Methods · 14

• __construct()Constructor.
• flush_cached_value()Clear the cached value when this nav menu item is updated.
• value()Get the instance data for a given nav_menu_item setting.
• js_value()Prepares the value for editing on the client.
• get_original_title()Get original title.
• get_type_label()Get type label.
• populate_value()Ensure that the value is fully populated with the necessary properties.
• preview()Handle previewing the setting.
• filter_wp_get_nav_menu_items()Filters the wp_get_nav_menu_items() result to supply the previewed menu items.
• sort_wp_get_nav_menu_items()Re-apply the tail logic also applied on $items by wp_get_nav_menu_items().
• value_as_wp_post_nav_menu_item()Get the value emulated into a WP_Post and set up as a nav_menu_item.
• sanitize()Sanitize an input.
• update()Creates/updates the nav_menu_item post for this setting.
• amend_customize_save_response()Export data for the JS client.

Changelog

Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.