Clarify return values for pf_de_https() and related methods.

See #1167.
PressForward · Sep 14, 2023 · 4de8eac · 4de8eac
1 parent 5798c18
commit 4de8eac
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 12 deletions.
diff --git a/Controllers/HTTPTools.php b/Controllers/HTTPTools.php
@@ -171,7 +171,7 @@ public function url_is_aggregation_service( $url ) {
 	 *
 	 * @param string $url        URL.
 	 * @param string $deprecated No longer used.
-	 * @return mixed
+	 * @return array
 	 */
 	public function get_url_content( $url, $deprecated = '' ) {
 		$url = str_replace( '&amp;', '&', $url );

diff --git a/Controllers/PF_Readability.php b/Controllers/PF_Readability.php
@@ -234,10 +234,6 @@ public function readability_object( $url ) {
 
 		$request = pf_de_https( $url, 'wp_remote_get' );
 
-		if ( is_wp_error( $request ) ) {
-			$content = 'error-secured';
-			return $content;
-		}
 		if ( ! empty( $request['body'] ) ) {
 			$html = $request['body'];
 		} elseif ( ! empty( $request ) && ( ! is_array( $request ) ) ) {

diff --git a/Libraries/PFOpenGraph.php b/Libraries/PFOpenGraph.php
@@ -45,7 +45,7 @@ class PFOpenGraph implements Iterator {
 	 * false on error.
 	 *
 	 * @param $URI URI to page to parse for Open Graph data
-	 * @return PFOpenGraph|bool
+	 * @return PFOpenGraph|false
 	 */
 	public static function fetch( $URI ) {
 		$cache_key = 'wp_remote_get_' . $URI;
@@ -55,10 +55,10 @@ public static function fetch( $URI ) {
 			$response_body = $cached;
 		} else {
 			$response = pf_de_https( $URI, 'wp_remote_get' );
-			if ( $response && ! is_wp_error( $response ) ) {
-				$response_body = wp_remote_retrieve_body( $response );
+			if ( $response ) {
+				$response_body = $response['body'];
+				wp_cache_set( $cache_key, $response_body, 'pressforward_external_pages' );
 			}
-			wp_cache_set( $cache_key, $response_body, 'pressforward_external_pages' );
 		}
 
 		if ( ! $response_body ) {

diff --git a/includes/functions.php b/includes/functions.php
@@ -446,9 +446,9 @@ function pf_prep_item_for_submit( $item ) {
  *
  * @param string        $url      URL.
  * @param bool|callable $callback Function to call first to try and get the URL.
- * @return string|object $r Returns the string URL, converted, when no function is passed.
- *                          Otherwise returns the result of the function after being
- *                          checked for accessibility.
+ * @return string|array $r Returns the string URL, converted, when no function is passed.
+ *                         Otherwise returns the result of the function after being
+ *                         checked for accessibility.
  */
 function pf_de_https( $url, $callback = false ) {
 	$url_orig = $url;