Changeset 32013

Timestamp:

04/04/2015 06:22:30 PM (10 years ago)

Author:

DrewAPicture

Message:

Add missing DocBlocks for the _limit_array(), _limit_string(), _limit_url(), _limit_img(), _limit_embed(), and _process_meta_entry() utility methods in WP_Press_This.

See [31609]. See #31888.

File:

• trunk/src/wp-admin/includes/class-wp-press-this.php (modified) (10 diffs)

trunk/src/wp-admin/includes/class-wp-press-this.php

@@ -9 +9 @@
 
 /**
- * Press This class
+ * Press This class.
  *
  * @since 4.2.0
@@ -39 +39 @@
     public function site_settings() {
         return array(
-            // Used to trigger the bookmarklet update notice.
-            // Needs to be set here and in get_shortcut_link() in wp-includes/link-template.php.
+            /*
+             * Used to trigger the bookmarklet update notice. Needs to be set here and in
+             * get_shortcut_link() in wp-includes/link-template.php.
+             */
             'version' => '8',
 
@@ -252 +254 @@
 
         if ( ! is_wp_error( $source_tmp_file ) && file_exists( $source_tmp_file ) ) {
+
             // Get the content of the source page from the tmp file..
-
             $source_content = wp_kses(
                 @file_get_contents( $source_tmp_file ),
@@ -290 +292 @@
     }
 
+    /**
+     * Utility method to limit an array to 50 values.
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @param array $value Array to limit.
+     * @return array Original array if fewer than 50 values, limited array, empty array otherwise.
+     */
     private function _limit_array( $value ) {
         if ( is_array( $value ) ) {
@@ -302 +313 @@
     }
 
+    /**
+     * Utility method to limit the length of a given string to 5,000 characters.
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @param string $value String to limit.
+     * @return bool|int|string If boolean or integer, that value. If a string, the original value
+     *                         if fewer than 5,000 characters, a truncated version, otherwise an
+     *                         empty string.
+     */
     private function _limit_string( $value ) {
         $return = '';
@@ -321 +343 @@
     }
 
+    /**
+     * Utility method to limit a given URL to 2,048 characters.
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @param string $url URL to check for length and validity.
+     * @return string Escaped URL if of valid length (< 2048) and makeup. Empty string otherwise.
+     */
     private function _limit_url( $url ) {
         if ( ! is_string( $url ) ) {
@@ -349 +380 @@
     }
 
+    /**
+     * Utility method to limit image source URLs.
+     *
+     * Excluded URLs include share-this type buttons, loaders, spinners, spacers, WP interface images,
+     * tiny buttons or thumbs, mathtag.com or quantserve.com images, or the WP stats gif.
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @param string $src Image source URL.
+     * @return string If not matched an excluded URL type, the original URL, empty string otherwise.
+     */
     private function _limit_img( $src ) {
         $src = $this->_limit_url( $src );
@@ -384 +427 @@
     }
 
+    /**
+     * Limit embed source URLs to specific providers.
+     *
+     * Not all core oEmbed providers are supported. Supported providers include YouTube, Vimeo,
+     * Vine, Daily Motion, SoundCloud, and Twitter.
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @param string $src Embed source URL.
+     * @return string If not from a supported provider, an empty string. Otherwise, a reformattd embed URL.
+     */
     private function _limit_embed( $src ) {
         $src = $this->_limit_url( $src );
@@ -415 +470 @@
     }
 
+    /**
+     * Process a meta data entry from the source.
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @param string $meta_name  Meta key name.
+     * @param mixed  $meta_value Meta value.
+     * @param array  $data       Associative array of source data.
+     * @return array Processed data array.
+     */
     private function _process_meta_entry( $meta_name, $meta_value, $data ) {
         if ( preg_match( '/:?(title|description|keywords|site_name)$/', $meta_name ) ) {
@@ -544 +610 @@
         }
 
-        // Fetch and gather <link> data
+        // Fetch and gather <link> data.
         if ( empty( $data['_links'] ) ) {
             $data['_links'] = array();