From 8035bdaec0eb7a4957da26933a88c8e8fb7fe479 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Thu, 7 Dec 2023 15:12:25 +0000 Subject: [PATCH] Docs: Improve documentation for `Custom_Image_Header` and `Custom_Background` constructors. Follow-up to [4673], [8656], [12890], [13041]. Props faisalahammad, cadic. Fixes #58049. git-svn-id: https://develop.svn.wordpress.org/trunk@57169 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-custom-background.php | 7 +++++-- src/wp-admin/includes/class-custom-image-header.php | 8 +++++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/src/wp-admin/includes/class-custom-background.php b/src/wp-admin/includes/class-custom-background.php index 2eb3ccfd64..1d1cce73b8 100644 --- a/src/wp-admin/includes/class-custom-background.php +++ b/src/wp-admin/includes/class-custom-background.php @@ -42,8 +42,11 @@ class Custom_Background { * Constructor - Registers administration header callback. * * @since 3.0.0 - * @param callable $admin_header_callback - * @param callable $admin_image_div_callback Optional custom image div output callback. + * + * @param callable $admin_header_callback Optional. Administration header callback. + * Default empty string. + * @param callable $admin_image_div_callback Optional. Custom image div output callback. + * Default empty string. */ public function __construct( $admin_header_callback = '', $admin_image_div_callback = '' ) { $this->admin_header_callback = $admin_header_callback; diff --git a/src/wp-admin/includes/class-custom-image-header.php b/src/wp-admin/includes/class-custom-image-header.php index ee3bcb12ec..a4b04bf3fc 100644 --- a/src/wp-admin/includes/class-custom-image-header.php +++ b/src/wp-admin/includes/class-custom-image-header.php @@ -47,11 +47,13 @@ class Custom_Image_Header { private $updated; /** - * Constructor - Register administration header callback. + * Constructor - Registers administration header callback. * * @since 2.1.0 - * @param callable $admin_header_callback - * @param callable $admin_image_div_callback Optional custom image div output callback. + * + * @param callable $admin_header_callback Administration header callback. + * @param callable $admin_image_div_callback Optional. Custom image div output callback. + * Default empty string. */ public function __construct( $admin_header_callback, $admin_image_div_callback = '' ) { $this->admin_header_callback = $admin_header_callback;