Add `@access` annotations to methods that have no doc block in `wp-admin/includes/*`.

Makes it easier to search for no doc blocks via `}[\n\t\r ]+(protected|private|public)`.

See #32444.

Built from https://develop.svn.wordpress.org/trunk@32656


git-svn-id: http://core.svn.wordpress.org/trunk@32626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-05-29 21:32:24 +00:00
parent b3e0cfd25d
commit 6a08b00632
16 changed files with 191 additions and 9 deletions

View File

@ -151,6 +151,11 @@ class WP_Comments_List_Table extends WP_List_Table {
) );
}
/**
*
* @param string $comment_status
* @return int
*/
public function get_per_page( $comment_status = 'all' ) {
$comments_per_page = $this->get_items_per_page( 'edit_comments_per_page' );
/**
@ -381,6 +386,9 @@ class WP_Comments_List_Table extends WP_List_Table {
return 'comment';
}
/**
* @access public
*/
public function display() {
wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
@ -660,6 +668,9 @@ class WP_Comments_List_Table extends WP_List_Table {
return get_comment_date( __( 'Y/m/d \a\t g:i a' ) );
}
/**
* @access public
*/
public function column_response() {
$post = get_post();

View File

@ -514,6 +514,9 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
return $ret;
}
/**
* @access public
*/
public function __destruct() {
if ( $this->link )
ftp_close($this->link);

View File

@ -171,6 +171,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
return $ret;
}
/**
*
* @return string
*/
public function cwd() {
$cwd = $this->ftp->pwd();
if ( $cwd )
@ -178,6 +182,11 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
return $cwd;
}
/**
*
* @param string $file
* @return bool
*/
public function chdir($file) {
return $this->ftp->chdir($file);
}
@ -448,6 +457,9 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
return $ret;
}
/**
* @access public
*/
public function __destruct() {
$this->ftp->quit();
}

View File

@ -60,6 +60,9 @@ class WP_Links_List_Table extends WP_List_Table {
$this->items = get_bookmarks( $args );
}
/**
* @access public
*/
public function no_items() {
_e( 'No links found.' );
}

View File

@ -184,6 +184,9 @@ class WP_Media_List_Table extends WP_List_Table {
return have_posts();
}
/**
* @access public
*/
public function no_items() {
_e( 'No media attachments found.' );
}

View File

@ -142,6 +142,9 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
) );
}
/**
* @access public
*/
public function no_items() {
_e( 'No sites found.' );
}

View File

@ -212,6 +212,9 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
return ( $a < $b ) ? -1 : 1;
}
/**
* @access public
*/
public function no_items() {
if ( ! $this->has_items )
_e( 'No themes found.' );
@ -324,6 +327,9 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
return $actions;
}
/**
* @access public
*/
public function display_rows() {
foreach ( $this->items as $theme )
$this->single_row( $theme );
@ -334,7 +340,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
* @global int $page
* @global string $s
* @global array $totals
*
*
* @param WP_Theme $theme
*/
public function single_row( $theme ) {

View File

@ -96,6 +96,9 @@ class WP_MS_Users_List_Table extends WP_List_Table {
return $actions;
}
/**
* @access public
*/
public function no_items() {
_e( 'No users found.' );
}

View File

@ -214,6 +214,9 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
}
}
/**
* @access public
*/
public function no_items() {
if ( isset( $this->error ) ) {
$message = $this->error->get_error_message() . '<p class="hide-if-no-js"><a href="#" class="button" onclick="document.location.reload(); return false;">' . __( 'Try again' ) . '</a></p>';
@ -338,7 +341,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
protected function get_table_classes() {
return array( 'widefat', $this->_args['plural'] );
}
/**
* @return array
*/

View File

@ -159,6 +159,9 @@ class WP_Posts_List_Table extends WP_List_Table {
return have_posts();
}
/**
* @access public
*/
public function no_items() {
if ( isset( $_REQUEST['post_status'] ) && 'trash' == $_REQUEST['post_status'] )
echo get_post_type_object( $this->screen->post_type )->labels->not_found_in_trash;

View File

@ -63,6 +63,9 @@ class WP_Terms_List_Table extends WP_List_Table {
return current_user_can( get_taxonomy( $this->screen->taxonomy )->cap->manage_terms );
}
/**
* @access public
*/
public function prepare_items() {
$tags_per_page = $this->get_items_per_page( 'edit_' . $this->screen->taxonomy . '_per_page' );
@ -127,6 +130,9 @@ class WP_Terms_List_Table extends WP_List_Table {
return true;
}
/**
* @access public
*/
public function no_items() {
echo get_taxonomy( $this->screen->taxonomy )->labels->not_found;
}
@ -188,6 +194,9 @@ class WP_Terms_List_Table extends WP_List_Table {
);
}
/**
* @access public
*/
public function display_rows_or_placeholder() {
$taxonomy = $this->screen->taxonomy;

View File

@ -145,6 +145,9 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
) );
}
/**
* @access public
*/
public function no_items() {
_e( 'No themes match your request.' );
}
@ -168,6 +171,9 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
return $display_tabs;
}
/**
* @access public
*/
public function display() {
wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
?>
@ -194,6 +200,9 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
$this->tablenav( 'bottom' );
}
/**
* @access public
*/
public function display_rows() {
$themes = $this->items;
foreach ( $themes as $theme ) {

View File

@ -38,6 +38,9 @@ class WP_Themes_List_Table extends WP_List_Table {
return current_user_can( 'switch_themes' );
}
/**
* @access public
*/
public function prepare_items() {
$themes = wp_get_themes( array( 'allowed' => true ) );
@ -71,6 +74,9 @@ class WP_Themes_List_Table extends WP_List_Table {
) );
}
/**
* @access public
*/
public function no_items() {
if ( $this->search_terms || $this->features ) {
_e( 'No items found.' );
@ -114,6 +120,9 @@ class WP_Themes_List_Table extends WP_List_Table {
<?php
}
/**
* @access public
*/
public function display() {
wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
?>
@ -135,6 +144,9 @@ class WP_Themes_List_Table extends WP_List_Table {
return array();
}
/**
* @access public
*/
public function display_rows_or_placeholder() {
if ( $this->has_items() ) {
$this->display_rows();
@ -145,6 +157,9 @@ class WP_Themes_List_Table extends WP_List_Table {
}
}
/**
* @access public
*/
public function display_rows() {
$themes = $this->items;

View File

@ -40,9 +40,16 @@ class WP_Upgrader_Skin {
$this->add_strings();
}
/**
* @access public
*/
public function add_strings() {
}
/**
*
* @param string|false|WP_Error $result
*/
public function set_result($result) {
$this->result = $result;
}
@ -68,6 +75,9 @@ class WP_Upgrader_Skin {
return request_filesystem_credentials( $url, '', $error, $context, $extra_fields, $allow_relaxed_file_ownership );
}
/**
* @access public
*/
public function header() {
if ( $this->done_header ) {
return;
@ -76,6 +86,10 @@ class WP_Upgrader_Skin {
echo '<div class="wrap">';
echo '<h2>' . $this->options['title'] . '</h2>';
}
/**
* @access public
*/
public function footer() {
if ( $this->done_footer ) {
return;
@ -124,7 +138,15 @@ class WP_Upgrader_Skin {
return;
show_message($string);
}
/**
* @access public
*/
public function before() {}
/**
* @access public
*/
public function after() {}
/**
@ -157,7 +179,14 @@ class WP_Upgrader_Skin {
}
}
/**
* @access public
*/
public function bulk_header() {}
/**
* @access public
*/
public function bulk_footer() {}
}
@ -189,6 +218,9 @@ class Plugin_Upgrader_Skin extends WP_Upgrader_Skin {
parent::__construct($args);
}
/**
* @access public
*/
public function after() {
$this->plugin = $this->upgrader->plugin_info();
if ( !empty($this->plugin) && !is_wp_error($this->result) && $this->plugin_active ){
@ -244,6 +276,9 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin {
parent::__construct($args);
}
/**
* @access public
*/
public function add_strings() {
$this->upgrader->strings['skin_upgrade_start'] = __('The update process is starting. This process may take a while on some hosts, so please be patient.');
$this->upgrader->strings['skin_update_failed_error'] = __('An error occurred while updating %1$s: <strong>%2$s</strong>');
@ -276,10 +311,16 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin {
echo "<p>$string</p>\n";
}
/**
* @access public
*/
public function header() {
// Nothing, This will be displayed within a iframe.
}
/**
* @access public
*/
public function footer() {
// Nothing, This will be displayed within a iframe.
}
@ -305,10 +346,16 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin {
echo '<script type="text/javascript">jQuery(\'.waiting-' . esc_js($this->upgrader->update_current) . '\').hide();</script>';
}
/**
* @access public
*/
public function bulk_header() {
$this->feedback('skin_upgrade_start');
}
/**
* @access public
*/
public function bulk_footer() {
$this->feedback('skin_upgrade_end');
}
@ -349,11 +396,17 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin {
$this->flush_output();
}
/**
* @access public
*/
public function reset() {
$this->in_loop = false;
$this->error = false;
}
/**
* @access public
*/
public function flush_output() {
wp_ob_end_flush_all();
flush();
@ -384,6 +437,10 @@ class Bulk_Plugin_Upgrader_Skin extends Bulk_Upgrader_Skin {
parent::after($this->plugin_info['Title']);
$this->decrement_update_count( 'plugin' );
}
/**
* @access public
*/
public function bulk_footer() {
parent::bulk_footer();
$update_actions = array(
@ -433,6 +490,9 @@ class Bulk_Theme_Upgrader_Skin extends Bulk_Upgrader_Skin {
$this->decrement_update_count( 'theme' );
}
/**
* @access public
*/
public function bulk_footer() {
parent::bulk_footer();
$update_actions = array(
@ -482,13 +542,18 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin {
parent::__construct($args);
}
/**
* @access public
*/
public function before() {
if ( !empty($this->api) )
$this->upgrader->strings['process_success'] = sprintf( __('Successfully installed the plugin <strong>%s %s</strong>.'), $this->api->name, $this->api->version);
}
/**
* @access public
*/
public function after() {
$plugin_file = $this->upgrader->plugin_info();
$install_actions = array();
@ -562,11 +627,17 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin {
parent::__construct($args);
}
/**
* @access public
*/
public function before() {
if ( !empty($this->api) )
$this->upgrader->strings['process_success'] = sprintf( $this->upgrader->strings['process_success_specific'], $this->api->name, $this->api->version);
}
/**
* @access public
*/
public function after() {
if ( empty($this->upgrader->result['destination_name']) )
return;
@ -649,6 +720,9 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin {
parent::__construct($args);
}
/**
* @access public
*/
public function after() {
$this->decrement_update_count( 'theme' );
@ -732,6 +806,9 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin {
parent::__construct( $args );
}
/**
* @access public
*/
public function before() {
$name = $this->upgrader->get_name_for_update( $this->language_update );
@ -750,10 +827,16 @@ class Language_Pack_Upgrader_Skin extends WP_Upgrader_Skin {
echo '</div>';
}
/**
* @access public
*/
public function after() {
echo '</div>';
}
/**
* @access public
*/
public function bulk_footer() {
$this->decrement_update_count( 'translation' );
$update_actions = array();
@ -805,6 +888,11 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
return $result;
}
/**
* @access public
*
* @return array
*/
public function get_upgrade_messages() {
return $this->messages;
}
@ -848,19 +936,20 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
$this->messages[] = $string;
}
/**
* @access public
*/
public function header() {
ob_start();
}
/**
* @access public
*/
public function footer() {
$output = ob_get_contents();
if ( ! empty( $output ) )
$this->feedback( $output );
ob_end_clean();
}
public function bulk_header() {}
public function bulk_footer() {}
public function before() {}
public function after() {}
}

View File

@ -101,6 +101,11 @@ class _WP_List_Table_Compat extends WP_List_Table {
}
}
/**
* @access protected
*
* @return array
*/
protected function get_column_info() {
$columns = get_column_headers( $this->_screen );
$hidden = get_hidden_columns( $this->_screen );
@ -109,6 +114,11 @@ class _WP_List_Table_Compat extends WP_List_Table {
return array( $columns, $hidden, $sortable );
}
/**
* @access public
*
* @return array
*/
public function get_columns() {
return $this->_columns;
}

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.3-alpha-32655';
$wp_version = '4.3-alpha-32656';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.