sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

4.1 Docs Audit: Improve inline documentation for various wpdb methods.

Browse Source 
#30469.


git-svn-id: https://develop.svn.wordpress.org/trunk@30624 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-28 12:33:16 +00:00
parent a1af1437c3
commit 57f295484d
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/wp-includes/wp-db.php
View File

@ -1964,13 +1964,13 @@ class wpdb {
}
/**
* Adds field charsets to field/value/format arrays
* generated by the process_field_formats() method.
* Adds field charsets to field/value/format arrays generated by
* the {@see wpdb::process_field_formats()} method.
*
* @since 4.1.0
* @access protected
*
* @param array $data As it comes from the process_field_formats() method.
* @param array $data As it comes from the {@see wpdb::process_field_formats()} method.
* @param string $table Table name.
* @return The same array as $data with additional 'charset' keys.
*/
@ -2161,7 +2161,7 @@ class wpdb {
* @access protected
*
* @param string $table Table name.
* @return string|WP_Error Table character set, `WP_Error` object if it couldn't be found.
* @return string|WP_Error Table character set, {@see WP_Error} object if it couldn't be found.
*/
protected function get_table_charset( $table ) {
$table = strtolower( $table );
@ -2254,9 +2254,8 @@ class wpdb {
*
* @param string $table Table name.
* @param string $column Column name.
* @return mixed Column character set as a string.
* False if the column has no character set.
* `WP_Error` object if there was an error.
* @return mixed Column character set as a string. False if the column has no
* character set. {@see WP_Error} object if there was an error.
*/
protected function get_col_charset( $table, $column ) {
$table = strtolower( $table );
@ -2347,7 +2346,7 @@ class wpdb {
* @return array|WP_Error The $data parameter, with invalid characters removed from
* each value. This works as a passthrough: any additional keys
* such as 'field' are retained in each value array. If we cannot
* remove invalid characters, a `WP_Error` object is returned.
* remove invalid characters, a {@see WP_Error} object is returned.
*/
protected function strip_invalid_text( $data ) {
// Some multibyte character sets that we can check in PHP.
@ -2469,7 +2468,7 @@ class wpdb {
* @access protected
*
* @param string $query Query to convert.
* @return string|WP_Error The converted query, or a `WP_Error` object if the conversion fails.
* @return string|WP_Error The converted query, or a {@see WP_Error} object if the conversion fails.
*/
protected function strip_invalid_text_from_query( $query ) {
$table = $this->get_table_from_query( $query );