<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[32013] trunk/src/wp-admin/includes/class-wp-press-this.php: 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`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/32013">32013</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/32013","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-04-04 18:22:30 +0000 (Sat, 04 Apr 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/31609">[31609]</a>. See <a href="https://core.trac.wordpress.org/ticket/31888">#31888</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswppressthisphp">trunk/src/wp-admin/includes/class-wp-press-this.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswppressthisphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-press-this.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-press-this.php 2015-04-04 16:33:24 UTC (rev 32012)
+++ trunk/src/wp-admin/includes/class-wp-press-this.php 2015-04-04 18:22:30 UTC (rev 32013)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,7 +8,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Press This class
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Press This class.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,8 +38,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function site_settings() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Used to trigger the bookmarklet update notice.
- // Needs to be set here and in get_shortcut_link() in wp-includes/link-template.php.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Used to trigger the bookmarklet update notice. Needs to be set here and in
+ * get_shortcut_link() in wp-includes/link-template.php.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> 'version' => '8',
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -251,8 +253,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $source_content = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_wp_error( $source_tmp_file ) && file_exists( $source_tmp_file ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Get the content of the source page from the tmp file..
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $source_content = wp_kses(
</span><span class="cx" style="display: block; padding: 0 10px"> @file_get_contents( $source_tmp_file ),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -289,6 +291,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $source_content;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> private function _limit_array( $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( count( $value ) > 50 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -301,6 +312,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> private function _limit_string( $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $return = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -320,6 +342,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> private function _limit_url( $url ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_string( $url ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -348,6 +379,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return esc_url_raw( $url, array( 'http', 'https' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> private function _limit_img( $src ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $src = $this->_limit_url( $src );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -383,6 +426,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $src;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> private function _limit_embed( $src ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $src = $this->_limit_url( $src );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -414,6 +469,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $src;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> private function _process_meta_entry( $meta_name, $meta_value, $data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( preg_match( '/:?(title|description|keywords|site_name)$/', $meta_name ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data['_meta'][ $meta_name ] = $meta_value;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -543,7 +609,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Fetch and gather <link> data
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Fetch and gather <link> data.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $data['_links'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data['_links'] = array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>