WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve various `@param` docs for `src/wp-includes/class-wp-customize*.php`. 

See #30224.

Built from https://develop.svn.wordpress.org/trunk@30676


git-svn-id: http://core.svn.wordpress.org/trunk@30666 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2014-11-30 23:33:23 +00:00
parent 3ad5115eaf
commit a215b8801d
5 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
wp-includes/class-wp-customize-control.php
View File

@ -822,6 +822,8 @@ class WP_Customize_Image_Control extends WP_Customize_Upload_Control {
* @uses WP_Customize_Upload_Control::__construct() * @uses WP_Customize_Upload_Control::__construct()
* *
* @param WP_Customize_Manager $manager * @param WP_Customize_Manager $manager
* @param string $id
* @param array $args
*/ */
public function __construct( $manager, $id, $args = array() ) { public function __construct( $manager, $id, $args = array() ) {
parent::__construct( $manager, $id, $args ); parent::__construct( $manager, $id, $args );
@ -901,6 +903,9 @@ class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control {
public $uploaded_headers; public $uploaded_headers;
public $default_headers; public $default_headers;
/**
* @param WP_Customize_Manager $manager
*/
public function __construct( $manager ) { public function __construct( $manager ) {
parent::__construct( $manager, 'header_image', array( parent::__construct( $manager, 'header_image', array(
'label' => __( 'Header Image' ), 'label' => __( 'Header Image' ),

4
wp-includes/class-wp-customize-manager.php
View File

@ -62,7 +62,7 @@ final class WP_Customize_Manager {
*/ */
protected $registered_control_types = array(); protected $registered_control_types = array();
/** /**
* $_POST values for Customize Settings. * $_POST values for Customize Settings.
* *
* @var array * @var array
@ -403,7 +403,7 @@ final class WP_Customize_Manager {
* *
* @since 3.4.0 * @since 3.4.0
* *
* @param mixed $setting A WP_Customize_Setting derived object * @param WP_Customize_Setting $setting A WP_Customize_Setting derived object
* @return string $post_value Sanitized value * @return string $post_value Sanitized value
*/ */
public function post_value( $setting ) { public function post_value( $setting ) {

6
wp-includes/class-wp-customize-setting.php
View File

@ -168,7 +168,7 @@ class WP_Customize_Setting {
* *
* @since 3.4.0 * @since 3.4.0
* *
* @return bool False if cap check fails or value isn't set. * @return false|null False if cap check fails or value isn't set.
*/ */
public final function save() { public final function save() {
$value = $this->post_value(); $value = $this->post_value();
@ -294,7 +294,7 @@ class WP_Customize_Setting {
* @since 3.4.0 * @since 3.4.0
* *
* @param mixed $value The value to update. * @param mixed $value The value to update.
* @return mixed The result of saving the value. * @return bool|null The result of saving the value.
*/ */
protected function _update_option( $value ) { protected function _update_option( $value ) {
// Handle non-array option. // Handle non-array option.
@ -469,7 +469,7 @@ class WP_Customize_Setting {
* *
* @param $root * @param $root
* @param $keys * @param $keys
* @param $default A default value which is used as a fallback. Default is null. * @param mixed $default A default value which is used as a fallback. Default is null.
* @return mixed The requested value or the default value. * @return mixed The requested value or the default value.
*/ */
final protected function multidimensional_get( $root, $keys, $default = null ) { final protected function multidimensional_get( $root, $keys, $default = null ) {

2
wp-includes/class-wp-customize-widgets.php
View File

@ -325,7 +325,7 @@ final class WP_Customize_Widgets {
* @since 3.9.0 * @since 3.9.0
* @access public * @access public
* *
* @param array $sidebars_widgets * @param array $old_sidebars_widgets
*/ */
public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) { public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) {
return $this->old_sidebars_widgets; return $this->old_sidebars_widgets;

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30675'; $wp_version = '4.1-beta2-30676';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.