WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Customize_Control::get_link()

WP_Customize_Control::get_link( string $setting_key = 'default' ): string

In this article

Back to top

Gets the data link attribute for a setting.

Parameters

$setting_keystringoptional

Default:'default'

Return

string Data link parameter, a data-customize-setting-link attribute if the $setting_key refers to a pre-registered setting, and a data-customize-setting-key-link attribute if the setting is not yet registered.

Source

public function get_link( $setting_key = 'default' ) {
	if ( isset( $this->settings[ $setting_key ] ) && $this->settings[ $setting_key ] instanceof WP_Customize_Setting ) {
		return 'data-customize-setting-link="' . esc_attr( $this->settings[ $setting_key ]->id ) . '"';
	} else {
		return 'data-customize-setting-key-link="' . esc_attr( $setting_key ) . '"';
	}
}

View all references View on Trac View on GitHub

UsesDescription
esc_attr()wp-includes/formatting.php

Escaping for HTML attributes.

Used byDescription
WP_Customize_Control::link()wp-includes/class-wp-customize-control.php

Renders the data link attribute for the control’s input element.

WP_Customize_Control::render_content()wp-includes/class-wp-customize-control.php

Renders the control’s content.

Changelog

VersionDescription
4.9.0Return a data-customize-setting-key-link attribute if a setting is not registered for the supplied setting key.
3.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.