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

See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30676 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor 2014-11-30 23:32:31 +00:00
parent 45f4403dd0
commit 5817aa262d
4 changed files with 11 additions and 6 deletions

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' ),

View File

@ -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 ) {

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 ) {

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;