Changeset 26284

Timestamp:

11/20/2013 03:35:38 AM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/my-sites.php.

Props megane9988, kpdesign.
Fixes #25586.

File:

• trunk/src/wp-admin/my-sites.php (modified) (3 diffs)

trunk/src/wp-admin/my-sites.php

@@ -69 +69 @@
         <?php
         choose_primary_blog();
+        /**
+         * Fires before the sites table on the My Sites screen.
+         *
+         * @since 3.0.0
+         */
         do_action( 'myblogs_allblogs_options' );
         ?>
@@ -74 +79 @@
         <table class="widefat fixed">
         <?php
+        /**
+         * Enable the Global Settings section on the My Sites screen.
+         *
+         * By default, the Global Settings section is hidden. Passing a non-empty
+         * string to this filter will enable the section, and allow new settings
+         * to be added, either globally or for specific sites.
+         *
+         * @since MU
+         *
+         * @param string $settings_html The settings HTML markup. Default empty.
+         * @param object $context       Context of the setting (global or site-specific). Default 'global'.
+         */
         $settings_html = apply_filters( 'myblogs_options', '', 'global' );
         if ( $settings_html != '' ) {
@@ -103 +120 @@
                         echo "<td valign='top' style='$s'>";
                         echo "<h3>{$user_blog->blogname}</h3>";
+                        /**
+                         * Filter the row links displayed for each site on the My Sites screen.
+                         *
+                         * @since MU
+                         *
+                         * @param string $string    The HTML site link markup.
+                         * @param object $user_blog An object containing the site data.
+                         */
                         echo "<p>" . apply_filters( 'myblogs_blog_actions', "<a href='" . esc_url( get_home_url( $user_blog->userblog_id ) ). "'>" . __( 'Visit' ) . "</a> | <a href='" . esc_url( get_admin_url( $user_blog->userblog_id ) ) . "'>" . __( 'Dashboard' ) . "</a>", $user_blog ) . "</p>";
+                        /** This filter is documented in wp-admin/my-sites.php */
                         echo apply_filters( 'myblogs_options', '', $user_blog );
                         echo "</td>";