Changeset 57169

Timestamp:

12/07/2023 03:12:25 PM (5 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for Custom_Image_Header and Custom_Background constructors.

Follow-up to [4673], [8656], [12890], [13041].

Props faisalahammad, cadic.
Fixes #58049.

Location:

trunk/src/wp-admin/includes

Files:

• class-custom-background.php (modified) (1 diff)
• class-custom-image-header.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-custom-background.php

@@ -43 +43 @@
      *
      * @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 = '' ) {

trunk/src/wp-admin/includes/class-custom-image-header.php

@@ -48 +48 @@
 
     /**
-     * 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 = '' ) {