vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-04-04 20:54:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Remove unnecessary variables names from @return tags.

Browse Source 
See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48100 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2020-06-19 22:53:54 +00:00
parent b34efdd38a
commit 1db25e3d38
35 changed files with 61 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
tests/phpunit/tests/admin/wpPrivacyRequestsTable.php
View File

@@ -21,7 +21,7 @@ class Tests_Admin_WpPrivacyRequestsTable extends WP_UnitTestCase {
*
* @since 5.1.0
*
* @return PHPUnit_Framework_MockObject_MockObject|WP_Privacy_Requests_Table $instance Mocked class instance.
* @return PHPUnit_Framework_MockObject_MockObject|WP_Privacy_Requests_Table Mocked class instance.
*/
public function get_mocked_class_instance() {
$args = array(
@@ -91,7 +91,7 @@ class Tests_Admin_WpPrivacyRequestsTable extends WP_UnitTestCase {
* @since 5.1.0
*
* @param string $request The complete SQL query.
* @return string $request The complete SQL query.
* @return string The complete SQL query.
*/
public function filter_posts_request( $request ) {
$this->sql = $request;

2
tests/phpunit/tests/ajax/PrivacyErasePersonalData.php
View File

@@ -784,7 +784,7 @@ class Tests_Ajax_PrivacyErasePersonalData extends WP_Ajax_UnitTestCase {
* @param string $email_address The comment author email address.
* @param int $page Page number.
*
* @return array $return Erase data.
* @return array Erase data.
*/
public function callback_personal_data_eraser( $email_address, $page = 1 ) {
if ( 1 === $page ) {

2
tests/phpunit/tests/customize/selective-refresh.php
View File

@@ -204,7 +204,7 @@ class Test_WP_Customize_Selective_Refresh extends WP_UnitTestCase {
*
* @param false|array $partial_args The arguments to the WP_Customize_Partial constructor.
* @param string $partial_id ID for dynamic partial.
* @return false|array $args Dynamic partial args.
* @return false|array Dynamic partial args.
*/
function filter_customize_dynamic_partial_args( $partial_args, $partial_id ) {
$this->assertTrue( false === $partial_args || is_array( $partial_args ) );

2
tests/phpunit/tests/functions/anonymization.php
View File

@@ -266,7 +266,7 @@ class Tests_Functions_Anonymization extends WP_UnitTestCase {
* @param string $anonymous Anonymized data.
* @param string $type Type of the data.
* @param string $data Original data.
* @return string $anonymous Anonymized data.
* @return string Anonymized data.
*/
public function filter_wp_privacy_anonymize_data( $anonymous, $type, $data ) {
if ( 'url' === $type && 'example.com' === parse_url( $data, PHP_URL_HOST ) ) {

8
tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php
View File

@@ -198,7 +198,7 @@ class Tests_Privacy_WpPrivacySendErasureFulfillmentNotification extends WP_UnitT
* @since 5.1.0
*
* @param string $user_email The email address of the notification recipient.
* @return string $user_email The email address of the notification recipient.
* @return string The email address of the notification recipient.
*/
public function filter_email_address( $user_email ) {
return 'modified-' . $user_email;
@@ -224,7 +224,7 @@ class Tests_Privacy_WpPrivacySendErasureFulfillmentNotification extends WP_UnitT
* @since 5.1.0
*
* @param string $subject The email subject.
* @return string $subject The email subject.
* @return string The email subject.
*/
public function filter_email_subject( $subject ) {
return 'Modified subject';
@@ -250,7 +250,7 @@ class Tests_Privacy_WpPrivacySendErasureFulfillmentNotification extends WP_UnitT
* @since 5.1.0
*
* @param string $email_text Text in the email.
* @return string $email_text Text in the email.
* @return string Text in the email.
*/
public function filter_email_body_text( $email_text ) {
return 'Modified text';
@@ -278,7 +278,7 @@ class Tests_Privacy_WpPrivacySendErasureFulfillmentNotification extends WP_UnitT
* @since 5.4.0
*
* @param string|array $headers The email headers.
* @return array $headers The new email headers.
* @return array The new email headers.
*/
public function modify_email_headers( $headers ) {
$headers = array(

12
tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php
View File

@@ -167,7 +167,7 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase
* @since 4.9.6
*
* @param int $expiration The expiration age of the export, in seconds.
* @return int $expiration The expiration age of the export, in seconds.
* @return int The expiration age of the export, in seconds.
*/
public function modify_export_expiration( $expiration ) {
// Set date to always be "Mon, 18 Dec 2017 21:30:00 GMT", so can assert a fixed date.
@@ -194,7 +194,7 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase
* @since 5.3.0
*
* @param string $user_email The email address of the notification recipient.
* @return string $user_email The modified email address of the notification recipient.
* @return string The modified email address of the notification recipient.
*/
public function filter_email_address( $user_email ) {
return 'modified-' . $user_email;
@@ -220,7 +220,7 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase
* @since 5.3.0
*
* @param string $subject The email subject.
* @return string $subject The email subject.
* @return string The email subject.
*/
public function filter_email_subject( $subject ) {
return 'Modified subject';
@@ -246,7 +246,7 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase
*
* @param string $email_text Text in the email.
* @param int $request_id The request ID for this personal data export.
* @return string $email_text Text in the email.
* @return string Text in the email.
*/
public function modify_email_content( $email_text, $request_id ) {
return 'Custom content for request ID: ' . $request_id;
@@ -274,7 +274,7 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase
* @since 5.4.0
*
* @param string|array $headers The email headers.
* @return array $headers The new email headers.
* @return array The new email headers.
*/
public function modify_email_headers( $headers ) {
$headers = array(
@@ -319,7 +319,7 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase
* @type string $siteurl The site URL sending the mail.
* }
*
* @return string $email_text Text in the email.
* @return string Text in the email.
*/
public function modify_email_content_with_email_data( $email_text, $request_id, $email_data ) {
return 'Custom content using the $site_url of $email_data: ' . $email_data['siteurl'];

2
tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php
View File

@@ -235,7 +235,7 @@ class Tests_User_WpPrivacySendRequestConfirmationNotification extends WP_UnitTes
* @since 5.4.0
*
* @param string|array $headers The email headers.
* @return array $headers The new email headers.
* @return array The new email headers.
*/
public function modify_email_headers( $headers ) {
$headers = array(

4
tests/phpunit/tests/user.php
View File

@@ -1907,7 +1907,7 @@ class Tests_User extends WP_UnitTestCase {
*
* @ticket 47509
*
* @return array $additional_profile_data The additional user data.
* @return array The additional user data.
*/
public function export_additional_user_profile_data() {
$additional_profile_data = array(
@@ -1930,7 +1930,7 @@ class Tests_User extends WP_UnitTestCase {
*
* @ticket 47509
*
* @return array $additional_profile_data The additional user data.
* @return array The additional user data.
*/
public function export_additional_user_profile_data_with_dup_name() {
$additional_profile_data = array(

4
tests/phpunit/tests/user/wpSendUserRequest.php
View File

@@ -222,7 +222,7 @@ class Tests_User_WpSendUserRequest extends WP_UnitTestCase {
* @since 4.9.9
*
* @param string $email_text Confirmation email text.
* @return string $email_text Filtered email text.
* @return string Filtered email text.
*/
public function modify_email_content( $email_text ) {
return 'Custom Email Content.';
@@ -252,7 +252,7 @@ class Tests_User_WpSendUserRequest extends WP_UnitTestCase {
* @since 5.4.0
*
* @param string|array $headers The email headers.
* @return array $headers The new email headers.
* @return array The new email headers.
*/
public function modify_email_headers( $headers ) {
$headers = array(