Changeset 9119 for trunk/wp-admin/includes/plugin-install.php

Timestamp:

10/10/2008 06:21:16 PM (17 years ago)

Author:

ryan

Message:

phpdoc for wp-admin. Props jacobsantos. see #7527

File:

• trunk/wp-admin/includes/plugin-install.php (modified) (16 diffs)

trunk/wp-admin/includes/plugin-install.php

@@ -20 +20 @@
  *
  * The second filter, 'plugins_api', is the result that would be returned.
+ *
+ * @since 2.7.0
  *
  * @param string $action
@@ -45 +47 @@
 
 /**
- * 
- *
- * @param unknown_type $args
- * @return unknown
+ * Retrieve popular WordPress plugin tags.
+ *
+ * @since 2.7.0
+ *
+ * @param array $args
+ * @return array
  */
 function install_popular_tags( $args = array() ) {
@@ -68 +72 @@
 
 add_action('install_plugins_search', 'install_search', 10, 1);
+
+/**
+ * Display search results and display as tag cloud.
+ *
+ * @since 2.7.0
+ *
+ * @param string $page
+ */
 function install_search($page) {
     $type = isset($_REQUEST['type']) ? $_REQUEST['type'] : '';
@@ -112 +124 @@
     <?php
 
-        $api_tags = install_popular_tags();
-
-        //Set up the tags in a way which can be interprated by wp_generate_tag_cloud()
-        $tags = array();
-        foreach ( (array)$api_tags as $tag )
-            $tags[ $tag['name'] ] = (object) array(
-                                    'link' => clean_url( admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
-                                    'name' => $tag['name'],
-                                    'count' => $tag['count'] );
-        echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%d plugin'), 'multiple_text' => __('%d plugins') ) );
-}
-
+    $api_tags = install_popular_tags();
+
+    //Set up the tags in a way which can be interprated by wp_generate_tag_cloud()
+    $tags = array();
+    foreach ( (array)$api_tags as $tag )
+        $tags[ $tag['name'] ] = (object) array(
+                                'link' => clean_url( admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
+                                'name' => $tag['name'],
+                                'count' => $tag['count'] );
+    echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%d plugin'), 'multiple_text' => __('%d plugins') ) );
+}
+
+/**
+ * Display search form for searching plugins.
+ *
+ * @since 2.7.0
+ */
 function install_search_form(){
     $type = isset($_REQUEST['type']) ? $_REQUEST['type'] : '';
@@ -140 +157 @@
 
 add_action('install_plugins_featured', 'install_featured', 10, 1);
+
+/**
+ * Display featured plugins.
+ *
+ * @since 2.7.0
+ *
+ * @param string $page
+ */
 function install_featured($page){
     $args = array('browse' => 'featured', 'page' => $page);
@@ -146 +171 @@
 }
 add_action('install_plugins_popular', 'install_popular', 10, 1);
+
+/**
+ * Display popular plugins.
+ *
+ * @since 2.7.0
+ *
+ * @param string $page
+ */
 function install_popular($page){
     $args = array('browse' => 'popular', 'page' => $page);
@@ -152 +185 @@
 }
 add_action('install_plugins_new', 'install_new', 10, 1);
+
+/**
+ * Display new plugins.
+ *
+ * @since 2.7.0
+ *
+ * @param string $page
+ */
 function install_new($page){
     $args = array('browse' => 'new', 'page' => $page);
@@ -158 +199 @@
 }
 add_action('install_plugins_updated', 'install_updated', 10, 1);
+
+/**
+ * Display recently updated plugins.
+ *
+ * @since 2.7.0
+ *
+ * @param string $page
+ */
 function install_updated($page){
     $args = array('browse' => 'updated', 'page' => $page);
@@ -164 +213 @@
 }
 add_action('install_plugins_upload', 'install_upload_custom', 10, 1);
+
+/**
+ * Display upload plugin form for adding plugins by uploading them manually.
+ *
+ * @since 2.7.0
+ *
+ * @param string $page
+ */
 function install_upload_custom($page){
     //$args = array('browse' => 'updated', 'page' => $page);
@@ -171 +228 @@
 }
 
+/**
+ * Display plugin content based on plugin list.
+ *
+ * @since 2.7.0
+ *
+ * @param array $plugins List of plugins.
+ * @param string $page
+ * @param int $totalpages Number of pages.
+ */
 function display_plugins_table($plugins, $page = 1, $totalpages = 1){
     global $tab;
@@ -286 +352 @@
 }
 
+/**
+ * Display iframe header.
+ *
+ * @since 2.7.0
+ *
+ * @param string $title Title for iframe.
+ */
 function install_iframe_header($title = '') {
 if( empty($title) )
@@ -318 +391 @@
 }
 
+/**
+ * Display iframe footer.
+ *
+ * @since 2.7.0
+ */
 function install_iframe_footer() {
 echo '
@@ -325 +403 @@
 
 add_action('install_plugins_pre_plugin-information', 'install_plugin_information');
+
+/**
+ * Display plugin information in dialog box form.
+ *
+ * @since 2.7.0
+ */
 function install_plugin_information() {
     global $tab;
@@ -448 +532 @@
 
 add_action('install_plugins_pre_install', 'install_plugin');
+
+/**
+ * Display plugin link and execute install.
+ *
+ * @since 2.7.0
+ */
 function install_plugin() {
 
@@ -466 +556 @@
     exit;
 }
-function do_plugin_install($download_url = '', $plugin_information = NULL) {
+
+/**
+ * Retrieve plugin and install.
+ *
+ * @since 2.7.0
+ *
+ * @param string $download_url Optional. Download URL.
+ * @param object $plugin_information Optional. Plugin information
+ */
+function do_plugin_install($download_url = '', $plugin_information = null) {
     global $wp_filesystem;
 
@@ -513 +612 @@
 }
 
+/**
+ * Install plugin.
+ *
+ * @since 2.7.0
+ *
+ * @param string $package
+ * @param string $feedback Optional.
+ * @return mixed.
+ */
 function wp_install_plugin($package, $feedback = '') {
     global $wp_filesystem;