Changeset 34983

Timestamp:

10/09/2015 04:34:29 AM (11 years ago)

Author:

DrewAPicture

Message:

Tests: Add basic DocBlocks for four helper methods in general/template.php used to assist testing the Site Icon feature.

All four helpers were introduced in the feature merge for 4.3.

See #33968.

File:

• trunk/tests/phpunit/tests/general/template.php (modified) (3 diffs)

trunk/tests/phpunit/tests/general/template.php

@@ -107 +107 @@
         }
 
+        /**
+         * Builds and retrieves a custom site icon meta tag.
+         *
+         * @since 4.3.0
+         *
+         * @param $meta_tags
+         * @return array
+         */
         function _custom_site_icon_meta_tag( $meta_tags ) {
                 $meta_tags[] = sprintf( '<link rel="apple-touch-icon" sizes="150x150" href="%s" />', esc_url( get_site_icon_url( 150 ) ) );
@@ -113 +121 @@
         }
 
+        /**
+         * Sets a site icon in options for testing.
+         *
+         * @since 4.3.0
+         */
         function _set_site_icon() {
                 if ( ! $this->site_icon_id ) {
@@ -123 +136 @@
         }
 
+        /**
+         * Removes the site icon from options.
+         *
+         * @since 4.3.0
+         */
         function _remove_site_icon() {
                 delete_option( 'site_icon' );
         }
 
+        /**
+         * Inserts an attachment for testing site icons.
+         *
+         * @since 4.3.0
+         */
         function _insert_attachment() {
                 $filename = DIR_TESTDATA . '/images/test-image.jpg';