Coding Standards: Fix/ignore the WordPress.NamingConventions.ValidFunctionName violations.

pento · pento · commit ef5a9dfda608 · 2019-07-01T08:00:12.000Z
See #47632 git-svn-id: https://develop.svn.wordpress.org/trunk@45580 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/includes/file.php b/src/wp-admin/includes/file.php
@@ -1720,7 +1720,7 @@ function copy_dir( $from, $to, $skip_list = array() ) {
  * @param bool         $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
  * @return bool|null True on success, false on failure, null if the filesystem method class file does not exist.
  */
-function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) {
+function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	global $wp_filesystem;
 
 	require_once( ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php' );
diff --git a/src/wp-admin/includes/misc.php b/src/wp-admin/includes/misc.php
@@ -831,7 +831,7 @@ function iis7_add_rewrite_rule( $filename, $rewrite_rule ) {
  * @param DOMDocument $doc
  * @param string $filename
  */
-function saveDomDocument( $doc, $filename ) {
+function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$config = $doc->saveXML();
 	$config = preg_replace( "/([^\r])\n/", "$1\r\n", $config );
 	$fp     = fopen( $filename, 'w' );
diff --git a/src/wp-admin/includes/upgrade.php b/src/wp-admin/includes/upgrade.php
@@ -2453,7 +2453,7 @@ function get_alloptions_110() {
  * @param string $setting Option name.
  * @return mixed
  */
-function __get_option( $setting ) {
+function __get_option( $setting ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	global $wpdb;
 
 	if ( $setting == 'home' && defined( 'WP_HOME' ) ) {
@@ -2522,7 +2522,7 @@ function deslash( $content ) {
  *                                 Default true.
  * @return array Strings containing the results of the various update queries.
  */
-function dbDelta( $queries = '', $execute = true ) {
+function dbDelta( $queries = '', $execute = true ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	global $wpdb;
 
 	if ( in_array( $queries, array( '', 'all', 'blog', 'global', 'ms_global' ), true ) ) {
diff --git a/src/wp-admin/link-parse-opml.php b/src/wp-admin/link-parse-opml.php
@@ -31,7 +31,7 @@
  * @param string $tagName XML element name.
  * @param array $attrs XML element attributes.
  */
-function startElement( $parser, $tagName, $attrs ) {
+function startElement( $parser, $tagName, $attrs ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	global $names, $urls, $targets, $descriptions, $feeds;
 
 	if ( 'OUTLINE' === $tagName ) {
@@ -68,7 +68,7 @@ function startElement( $parser, $tagName, $attrs ) {
  * @param mixed $parser XML Parser resource.
  * @param string $tagName XML tag name.
  */
-function endElement( $parser, $tagName ) {
+function endElement( $parser, $tagName ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	// Nothing to do.
 }
 
diff --git a/src/wp-includes/author-template.php b/src/wp-includes/author-template.php
@@ -563,6 +563,6 @@ function is_multi_author() {
  * @since 3.2.0
  * @access private
  */
-function __clear_multi_author_cache() {
+function __clear_multi_author_cache() { //phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	delete_transient( 'is_multi_author' );
 }
diff --git a/src/wp-includes/category-template.php b/src/wp-includes/category-template.php
@@ -105,7 +105,7 @@ function get_the_category( $id = false ) {
  * @param int $cat_ID Category ID.
  * @return string|WP_Error Category name on success, WP_Error on failure.
  */
-function get_the_category_by_ID( $cat_ID ) {
+function get_the_category_by_ID( $cat_ID ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$cat_ID   = (int) $cat_ID;
 	$category = get_term( $cat_ID );
 
diff --git a/src/wp-includes/category.php b/src/wp-includes/category.php
@@ -197,7 +197,7 @@ function get_category_by_slug( $slug ) {
  * @param string $cat_name Category name.
  * @return int 0, if failure and ID of category on success.
  */
-function get_cat_ID( $cat_name ) {
+function get_cat_ID( $cat_name ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$cat = get_term_by( 'name', $cat_name, 'category' );
 	if ( $cat ) {
 		return $cat->term_id;
diff --git a/src/wp-includes/class-http.php b/src/wp-includes/class-http.php
@@ -647,7 +647,7 @@ public function head( $url, $args = array() ) {
 	 * @param string $strResponse The full response string
 	 * @return array Array with 'headers' and 'body' keys.
 	 */
-	public static function processResponse( $strResponse ) {
+	public static function processResponse( $strResponse ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		$res = explode( "\r\n\r\n", $strResponse, 2 );
 
 		return array(
@@ -669,7 +669,7 @@ public static function processResponse( $strResponse ) {
 	 * @return array Processed string headers. If duplicate headers are encountered,
 	 *                  Then a numbered array is returned as the value of that header-key.
 	 */
-	public static function processHeaders( $headers, $url = '' ) {
+	public static function processHeaders( $headers, $url = '' ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		// Split headers, one per array element.
 		if ( is_string( $headers ) ) {
 			// Tolerate line terminator: CRLF = LF (RFC 2616 19.3).
@@ -752,7 +752,7 @@ public static function processHeaders( $headers, $url = '' ) {
 	 *
 	 * @param array $r Full array of args passed into ::request()
 	 */
-	public static function buildCookieHeader( &$r ) {
+	public static function buildCookieHeader( &$r ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		if ( ! empty( $r['cookies'] ) ) {
 			// Upgrade any name => value cookie pairs to WP_HTTP_Cookie instances.
 			foreach ( $r['cookies'] as $name => $value ) {
@@ -788,7 +788,7 @@ public static function buildCookieHeader( &$r ) {
 	 * @param string $body Body content
 	 * @return string Chunked decoded body on success or raw body on failure.
 	 */
-	public static function chunkTransferDecode( $body ) {
+	public static function chunkTransferDecode( $body ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		// The body is not chunked encoded or is malformed.
 		if ( ! preg_match( '/^([0-9a-f]+)[^\r\n]*\r\n/i', trim( $body ) ) ) {
 			return $body;
diff --git a/src/wp-includes/class-wp-http-cookie.php b/src/wp-includes/class-wp-http-cookie.php
@@ -211,7 +211,7 @@ public function test( $url ) {
 	 *
 	 * @return string Header encoded cookie name and value.
 	 */
-	public function getHeaderValue() {
+	public function getHeaderValue() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		if ( ! isset( $this->name ) || ! isset( $this->value ) ) {
 			return '';
 		}
@@ -234,7 +234,7 @@ public function getHeaderValue() {
 	 *
 	 * @return string
 	 */
-	public function getFullHeader() {
+	public function getFullHeader() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		return 'Cookie: ' . $this->getHeaderValue();
 	}
 
diff --git a/src/wp-includes/class-wp-http-response.php b/src/wp-includes/class-wp-http-response.php
@@ -147,7 +147,7 @@ public function set_data( $data ) {
 	 *
 	 * @return mixed Any JSON-serializable value.
 	 */
-	public function jsonSerialize() {
+	public function jsonSerialize() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		return $this->get_data();
 	}
 }
diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php
@@ -262,7 +262,7 @@ function comment_author_link( $comment_ID = 0 ) {
  *                                   Default current comment.
  * @return string Comment author's IP address.
  */
-function get_comment_author_IP( $comment_ID = 0 ) {
+function get_comment_author_IP( $comment_ID = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$comment = get_comment( $comment_ID );
 
 	/**
@@ -287,7 +287,7 @@ function get_comment_author_IP( $comment_ID = 0 ) {
  * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
  *                                   Default current comment.
  */
-function comment_author_IP( $comment_ID = 0 ) {
+function comment_author_IP( $comment_ID = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	echo esc_html( get_comment_author_IP( $comment_ID ) );
 }
 
@@ -651,7 +651,7 @@ function comment_excerpt( $comment_ID = 0 ) {
  *
  * @return int The comment ID.
  */
-function get_comment_ID() {
+function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$comment = get_comment();
 
 	/**
@@ -671,7 +671,7 @@ function get_comment_ID() {
  *
  * @since 0.71
  */
-function comment_ID() {
+function comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	echo get_comment_ID();
 }
 
diff --git a/src/wp-includes/compat.php b/src/wp-includes/compat.php
@@ -434,6 +434,7 @@ function json_last_error_msg() {
 	 * @since 4.4.0
 	 */
 	interface JsonSerializable {
+		// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		public function jsonSerialize();
 	}
 }
diff --git a/src/wp-includes/formatting.php b/src/wp-includes/formatting.php
@@ -2427,7 +2427,7 @@ function convert_invalid_entities( $content ) {
  * @param bool   $force If true, forces balancing, ignoring the value of the option. Default false.
  * @return string Balanced text
  */
-function balanceTags( $text, $force = false ) {
+function balanceTags( $text, $force = false ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	if ( $force || get_option( 'use_balanceTags' ) == 1 ) {
 		return force_balance_tags( $text );
 	} else {
diff --git a/src/wp-includes/functions.php b/src/wp-includes/functions.php
@@ -5631,7 +5631,7 @@ function get_file_data( $file, $default_headers, $context = '' ) {
  *
  * @return true True.
  */
-function __return_true() {
+function __return_true() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	return true;
 }
 
@@ -5646,7 +5646,7 @@ function __return_true() {
  *
  * @return false False.
  */
-function __return_false() {
+function __return_false() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	return false;
 }
 
@@ -5659,7 +5659,7 @@ function __return_false() {
  *
  * @return int 0.
  */
-function __return_zero() {
+function __return_zero() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	return 0;
 }
 
@@ -5672,7 +5672,7 @@ function __return_zero() {
  *
  * @return array Empty array.
  */
-function __return_empty_array() {
+function __return_empty_array() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	return array();
 }
 
@@ -5685,7 +5685,7 @@ function __return_empty_array() {
  *
  * @return null Null value.
  */
-function __return_null() {
+function __return_null() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	return null;
 }
 
@@ -5700,7 +5700,7 @@ function __return_null() {
  *
  * @return string Empty string.
  */
-function __return_empty_string() {
+function __return_empty_string() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	return '';
 }
 
diff --git a/src/wp-includes/general-template.php b/src/wp-includes/general-template.php
@@ -4548,7 +4548,7 @@ function readonly( $readonly, $current = true, $echo = true ) {
  * @param string $type    The type of checked|selected|disabled|readonly we are doing
  * @return string html attribute or empty string
  */
-function __checked_selected_helper( $helper, $current, $echo, $type ) {
+function __checked_selected_helper( $helper, $current, $echo, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore
 	if ( (string) $helper === (string) $current ) {
 		$result = " $type='$type'";
 	} else {
diff --git a/src/wp-includes/load.php b/src/wp-includes/load.php
@@ -26,7 +26,7 @@ function wp_get_server_protocol() {
  * @since 2.1.0
  * @access private
  */
-function wp_unregister_GLOBALS() {
+function wp_unregister_GLOBALS() {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	if ( ! ini_get( 'register_globals' ) ) {
 		return;
 	}
diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php
@@ -2252,7 +2252,7 @@ function force_ssl_content( $force = '' ) {
  * @param string $url URL
  * @return string URL with https as the scheme
  */
-function filter_SSL( $url ) {
+function filter_SSL( $url ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	if ( ! is_string( $url ) ) {
 		return get_bloginfo( 'url' ); // Return home blog url with proper scheme
 	}
diff --git a/src/wp-includes/pomo/streams.php b/src/wp-includes/pomo/streams.php
@@ -34,7 +34,7 @@ public function POMO_Reader() {
 		 *
 		 * @param string $endian Set the endianness of the file. Accepts 'big', or 'little'.
 		 */
-		function setEndian( $endian ) {
+		function setEndian( $endian ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 			$this->endian = $endian;
 		}
 
diff --git a/src/wp-includes/post-template.php b/src/wp-includes/post-template.php
@@ -13,7 +13,7 @@
  *
  * @since 0.71
  */
-function the_ID() {
+function the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	echo get_the_ID();
 }
 
@@ -24,7 +24,7 @@ function the_ID() {
  *
  * @return int|false The ID of the current item in the WordPress Loop. False if $post is not set.
  */
-function get_the_ID() {
+function get_the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$post = get_post();
 	return ! empty( $post ) ? $post->ID : false;
 }
diff --git a/src/xmlrpc.php b/src/xmlrpc.php
@@ -96,7 +96,7 @@
  * @param string $io Whether input or output
  * @param string $msg Information describing logging reason.
  */
-function logIO( $io, $msg ) {
+function logIO( $io, $msg ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	_deprecated_function( __FUNCTION__, '3.4.0', 'error_log()' );
 	if ( ! empty( $GLOBALS['xmlrpc_logging'] ) ) {
 		error_log( $io . ' - ' . $msg );
diff --git a/tests/phpunit/includes/class-basic-object.php b/tests/phpunit/includes/class-basic-object.php
@@ -37,6 +37,7 @@ public function __call( $name, $arguments ) {
 		return call_user_func_array( array( $this, $name ), $arguments );
 	}
 
+	// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 	private function callMe() {
 		return 'maybe';
 	}
diff --git a/tests/phpunit/includes/functions.php b/tests/phpunit/includes/functions.php
@@ -21,7 +21,7 @@ function tests_get_phpunit_version() {
 /**
  * Resets various `$_SERVER` variables that can get altered during tests.
  */
-function tests_reset__SERVER() {
+function tests_reset__SERVER() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$_SERVER['HTTP_HOST']       = WP_TESTS_DOMAIN;
 	$_SERVER['REMOTE_ADDR']     = '127.0.0.1';
 	$_SERVER['REQUEST_METHOD']  = 'GET';
diff --git a/tests/phpunit/includes/object-cache.php b/tests/phpunit/includes/object-cache.php
@@ -761,6 +761,7 @@ function wp_cache_add_non_persistent_groups( $groups ) {
 	$wp_object_cache->add_non_persistent_groups( $groups );
 }
 
+// phpcs:disable WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 class WP_Object_Cache {
 
 	/**
@@ -2160,3 +2161,4 @@ public function switch_to_blog( $blog_id ) {
 		$this->blog_prefix = ( is_multisite() ? $blog_id : $table_prefix ) . ':';
 	}
 }
+// phpcs:enable
diff --git a/tests/phpunit/includes/phpunit6/compat.php b/tests/phpunit/includes/phpunit6/compat.php
@@ -17,6 +17,7 @@ class_alias( 'PHPUnit\Util\Getopt', 'PHPUnit_Util_Getopt' );
 
 	class PHPUnit_Util_Test {
 
+		// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		public static function getTickets( $className, $methodName ) {
 			$annotations = PHPUnit\Util\Test::parseTestMethodAnnotations( $className, $methodName );
 
diff --git a/tests/phpunit/includes/trac.php b/tests/phpunit/includes/trac.php
@@ -13,7 +13,7 @@ class TracTickets {
 	 *
 	 * @return bool|null true if the ticket is resolved, false if not resolved, null on error
 	 */
-	public static function isTracTicketClosed( $trac_url, $ticket_id ) {
+	public static function isTracTicketClosed( $trac_url, $ticket_id ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 		if ( ! extension_loaded( 'openssl' ) ) {
 			$trac_url = preg_replace( '/^https:/', 'http:', $trac_url );
 		}
@@ -44,12 +44,14 @@ public static function isTracTicketClosed( $trac_url, $ticket_id ) {
 		return ! in_array( $ticket_id, self::$trac_ticket_cache[ $trac_url ] );
 	}
 
+	// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 	public static function usingLocalCache() {
 		echo PHP_EOL . "\x1b[0m\x1b[30;43m\x1b[2K";
 		echo 'INFO: Trac was inaccessible, so a local ticket status cache was used.' . PHP_EOL;
 		echo "\x1b[0m\x1b[2K";
 	}
 
+	// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
 	public static function forcingKnownBugs() {
 		echo PHP_EOL . "\x1b[0m\x1b[37;41m\x1b[2K";
 		echo "ERROR: Trac was inaccessible, so known bugs weren't able to be skipped." . PHP_EOL;
diff --git a/tests/phpunit/includes/utils.php b/tests/phpunit/includes/utils.php

Original file line number	Diff line number	Diff line change
`@@ -563,6 +563,6 @@ function is_multi_author() {`
`563`	`563`	`* @since 3.2.0`
`564`	`564`	`* @access private`
`565`	`565`	`*/`
`566`		`-function __clear_multi_author_cache() {`
	`566`	`+function __clear_multi_author_cache() { //phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore`
`567`	`567`	`delete_transient( 'is_multi_author' );`
`568`	`568`	`}`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ public function test( $url ) {`
`211`	`211`	`*`
`212`	`212`	`* @return string Header encoded cookie name and value.`
`213`	`213`	`*/`
`214`		`- public function getHeaderValue() {`
	`214`	`+ public function getHeaderValue() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid`
`215`	`215`	`if ( ! isset( $this->name ) \|\| ! isset( $this->value ) ) {`
`216`	`216`	`return '';`
`217`	`217`	`}`
`@@ -234,7 +234,7 @@ public function getHeaderValue() {`
`234`	`234`	`*`
`235`	`235`	`* @return string`
`236`	`236`	`*/`
`237`		`- public function getFullHeader() {`
	`237`	`+ public function getFullHeader() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid`
`238`	`238`	`return 'Cookie: ' . $this->getHeaderValue();`
`239`	`239`	`}`
`240`	`240`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ public function set_data( $data ) {`
`147`	`147`	`*`
`148`	`148`	`* @return mixed Any JSON-serializable value.`
`149`	`149`	`*/`
`150`		`- public function jsonSerialize() {`
	`150`	`+ public function jsonSerialize() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid`
`151`	`151`	`return $this->get_data();`
`152`	`152`	`}`
`153`	`153`	`}`