Skip to content

Commit

Permalink
Docs: Improve documentation for Custom_Image_Header and `Custom_Bac…
Browse files Browse the repository at this point in the history
…kground` 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
  • Loading branch information
SergeyBiryukov committed Dec 7, 2023
1 parent 52854e2 commit 8035bda
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 5 additions & 2 deletions src/wp-admin/includes/class-custom-background.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
8 changes: 5 additions & 3 deletions src/wp-admin/includes/class-custom-image-header.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 8035bda

Please sign in to comment.