Skip to content

Docs: Fix return_value() inline documentation #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: Fix return_value() inline documentation #205

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6b2d29
Docs: Fix return_value() inline documentation
rollybueno Oct 19, 2025
1c622e4
Fix: Accurate return and data type
rollybueno Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Config_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,9 +1035,9 @@
*
* @param string $name
* @param string $type
* @param string $type
* @param array $values
Copy link
Member

@swissspidy swissspidy Oct 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make the type more precise? I think this one is correct

Suggested change
* @param array $values
* @param array<array{name: string, value: string, type: string}> $values

Copy link
Contributor Author

@rollybueno rollybueno Oct 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

value: mixed is more precise since it can be integer, string or boleean. e.g. define( 'WP_DEBUG', true ), define( 'SITE_ID_CURRENT_SITE', 1 ), define( 'DB_NAME', 'wp_cli_test' )

* @param string $wp_config_file_name Config file name
* @return string The value of the requested constant or variable as defined in the wp-config.php file; if the
* @return mixed The value of the requested constant or variable as defined in the wp-config.php file; if the
* requested constant or variable is not defined then the function will print an error and exit.
*/
private function return_value( $name, $type, $values, $wp_config_file_name ) {
Expand Down Expand Up @@ -1196,7 +1196,7 @@
$wp_config_file_name
);

return $value;

Check failure on line 1199 in src/Config_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Method Config_Command::get_value() should return string but returns mixed.
}

/**
Expand Down
Loading