Changeset 59785

Timestamp:

02/08/2025 11:58:35 AM (9 months ago)

Author:

audrasjb

Message:

Docs: Various Docblock fixes in wp-includes/class-wp-customize-control.php, as per WP Docs standards;

See #62281.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (13 diffs)

trunk/src/wp-includes/class-wp-customize-control.php

@@ -248 +248 @@
 
     /**
-     * Enqueue control related scripts/styles.
+     * Enqueues control related scripts/styles.
      *
      * @since 3.4.0
@@ -255 +255 @@
 
     /**
-     * Check whether control is active to current Customizer preview.
+     * Checks whether control is active to current Customizer preview.
      *
      * @since 4.0.0
@@ -293 +293 @@
 
     /**
-     * Fetch a setting's value.
+     * Fetches a setting's value.
      * Grabs the main setting by default.
      *
@@ -308 +308 @@
 
     /**
-     * Refresh the parameters passed to the JavaScript via JSON.
+     * Refreshes the parameters passed to the JavaScript via JSON.
      *
      * @since 3.4.0
@@ -333 +333 @@
 
     /**
-     * Get the data to export to the client via JSON.
+     * Gets the data to export to the client via JSON.
      *
      * @since 4.1.0
@@ -376 +376 @@
 
     /**
-     * Get the control's content for insertion into the Customizer pane.
+     * Gets the control's content for insertion into the Customizer pane.
      *
      * @since 4.1.0
@@ -389 +389 @@
 
     /**
-     * Check capabilities and render the control.
+     * Checks capabilities and render the control.
      *
      * @since 3.4.0
@@ -438 +438 @@
 
     /**
-     * Get the data link attribute for a setting.
+     * Gets the data link attribute for a setting.
      *
      * @since 3.4.0
@@ -444 +444 @@
      *
      * @param string $setting_key
-     * @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.
+     * @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.
      */
     public function get_link( $setting_key = 'default' ) {
@@ -456 +457 @@
 
     /**
-     * Render the data link attribute for the control's input element.
+     * Renders the data link attribute for the control's input element.
      *
      * @since 3.4.0
      * @uses WP_Customize_Control::get_link()
      *
-     * @param string $setting_key
+     * @param string $setting_key Default 'default'.
      */
     public function link( $setting_key = 'default' ) {
@@ -468 +469 @@
 
     /**
-     * Render the custom attributes for the control's input element.
+     * Renders the custom attributes for the control's input element.
      *
      * @since 4.0.0
@@ -479 +480 @@
 
     /**
-     * Render the control's content.
+     * Renders the control's content.
      *
      * Allows the content to be overridden without having to rewrite the wrapper in `$this::render()`.
@@ -675 +676 @@
 
     /**
-     * Render the control's JS template.
+     * Renders the control's JS template.
      *
      * This function is only run for control types that have been registered with