Skip to content

Commit 37f4f61

Browse files
committed
Docs: Various Docblock fixes in wp-includes/class-wp-customize-control.php, as per WP Docs standards;
See #62281. git-svn-id: https://develop.svn.wordpress.org/trunk@59785 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 3f4d358 commit 37f4f61

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

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

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -247,14 +247,14 @@ public function __construct( $manager, $id, $args = array() ) {
247247
}
248248

249249
/**
250-
* Enqueue control related scripts/styles.
250+
* Enqueues control related scripts/styles.
251251
*
252252
* @since 3.4.0
253253
*/
254254
public function enqueue() {}
255255

256256
/**
257-
* Check whether control is active to current Customizer preview.
257+
* Checks whether control is active to current Customizer preview.
258258
*
259259
* @since 4.0.0
260260
*
@@ -292,7 +292,7 @@ public function active_callback() {
292292
}
293293

294294
/**
295-
* Fetch a setting's value.
295+
* Fetches a setting's value.
296296
* Grabs the main setting by default.
297297
*
298298
* @since 3.4.0
@@ -307,7 +307,7 @@ final public function value( $setting_key = 'default' ) {
307307
}
308308

309309
/**
310-
* Refresh the parameters passed to the JavaScript via JSON.
310+
* Refreshes the parameters passed to the JavaScript via JSON.
311311
*
312312
* @since 3.4.0
313313
*/
@@ -332,7 +332,7 @@ public function to_json() {
332332
}
333333

334334
/**
335-
* Get the data to export to the client via JSON.
335+
* Gets the data to export to the client via JSON.
336336
*
337337
* @since 4.1.0
338338
*
@@ -375,7 +375,7 @@ final public function check_capabilities() {
375375
}
376376

377377
/**
378-
* Get the control's content for insertion into the Customizer pane.
378+
* Gets the control's content for insertion into the Customizer pane.
379379
*
380380
* @since 4.1.0
381381
*
@@ -388,7 +388,7 @@ final public function get_content() {
388388
}
389389

390390
/**
391-
* Check capabilities and render the control.
391+
* Checks capabilities and render the control.
392392
*
393393
* @since 3.4.0
394394
* @uses WP_Customize_Control::render()
@@ -437,14 +437,15 @@ protected function render() {
437437
}
438438

439439
/**
440-
* Get the data link attribute for a setting.
440+
* Gets the data link attribute for a setting.
441441
*
442442
* @since 3.4.0
443443
* @since 4.9.0 Return a `data-customize-setting-key-link` attribute if a setting is not registered for the supplied setting key.
444444
*
445445
* @param string $setting_key
446-
* @return string Data link parameter, a `data-customize-setting-link` attribute if the `$setting_key` refers to a pre-registered setting,
447-
* and a `data-customize-setting-key-link` attribute if the setting is not yet registered.
446+
* @return string Data link parameter, a `data-customize-setting-link` attribute if the `$setting_key` refers
447+
* to a pre-registered setting, and a `data-customize-setting-key-link` attribute if the setting
448+
* is not yet registered.
448449
*/
449450
public function get_link( $setting_key = 'default' ) {
450451
if ( isset( $this->settings[ $setting_key ] ) && $this->settings[ $setting_key ] instanceof WP_Customize_Setting ) {
@@ -455,19 +456,19 @@ public function get_link( $setting_key = 'default' ) {
455456
}
456457

457458
/**
458-
* Render the data link attribute for the control's input element.
459+
* Renders the data link attribute for the control's input element.
459460
*
460461
* @since 3.4.0
461462
* @uses WP_Customize_Control::get_link()
462463
*
463-
* @param string $setting_key
464+
* @param string $setting_key Default 'default'.
464465
*/
465466
public function link( $setting_key = 'default' ) {
466467
echo $this->get_link( $setting_key );
467468
}
468469

469470
/**
470-
* Render the custom attributes for the control's input element.
471+
* Renders the custom attributes for the control's input element.
471472
*
472473
* @since 4.0.0
473474
*/
@@ -478,7 +479,7 @@ public function input_attrs() {
478479
}
479480

480481
/**
481-
* Render the control's content.
482+
* Renders the control's content.
482483
*
483484
* Allows the content to be overridden without having to rewrite the wrapper in `$this::render()`.
484485
*
@@ -674,7 +675,7 @@ protected function render_content() {
674675
}
675676

676677
/**
677-
* Render the control's JS template.
678+
* Renders the control's JS template.
678679
*
679680
* This function is only run for control types that have been registered with
680681
* WP_Customize_Manager::register_control_type().

0 commit comments

Comments
 (0)