Current File : /var/www/pn/beta/64801_wp-content/plugins/autodescription/inc/classes/post-data.class.php
<?php
/**
* @package The_SEO_Framework\Classes
*/
namespace The_SEO_Framework;
defined( 'ABSPATH' ) or die;
/**
* The SEO Framework plugin
* Copyright (C) 2015 - 2018 Sybre Waaijer, CyberWire (https://cyberwire.nl/)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as published
* by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Class The_SEO_Framework\Post_Data
*
* Holds Post data.
*
* @since 2.1.6
*/
class Post_Data extends Detect {
/**
* Constructor, load parent constructor
*/
protected function __construct() {
parent::__construct();
}
/**
* Return custom field post meta data.
*
* Return only the first value of custom field. Return false if field is
* blank or not set.
*
* @since 2.0.0
* @staticvar array $field_cache
*
* @param string $field Custom field key.
* @param int $post_id The post ID
* @return string|boolean Return value or false on failure.
*/
public function get_custom_field( $field, $post_id = null ) {
//* If field is falsy, get_post_meta() will return an array.
if ( ! $field )
return false;
static $field_cache = array();
if ( isset( $field_cache[ $field ][ $post_id ] ) )
return $field_cache[ $field ][ $post_id ];
if ( empty( $post_id ) )
$post_id = $this->get_the_real_ID();
$custom_field = \get_post_meta( $post_id, $field, true );
//* If custom field is empty, empty cache..
if ( empty( $custom_field ) )
$field_cache[ $field ][ $post_id ] = '';
//* Render custom field, slashes stripped, sanitized if string
$field_cache[ $field ][ $post_id ] = is_array( $custom_field ) ? \stripslashes_deep( $custom_field ) : stripslashes( $custom_field );
return $field_cache[ $field ][ $post_id ];
}
/**
* Saves the SEO settings when we save an attachment.
*
* This is a passthrough method for `inpost_seo_save()`.
* Sanity check is handled at `save_custom_fields()`, which `inpost_seo_save()` uses.
*
* @since 3.0.6
* @uses $this->inpost_seo_save()
*
* @param integer $post_id Post ID.
* @return void
*/
public function inattachment_seo_save( $post_id ) {
$this->inpost_seo_save( $post_id, \get_post( $post_id ) );
}
/**
* Saves the SEO settings when we save a post or page.
* Some values get sanitized, the rest are pulled from identically named subkeys in the $_POST['autodescription'] array.
*
* @since 2.0.0
* @since 2.9.3 : Added 'exclude_from_archive'.
* @securitycheck 3.0.0 OK. NOTE: Check is done at save_custom_fields().
* @uses $this->save_custom_fields() : Perform security checks and saves post meta / custom field data to a post or page.
*
* @param integer $post_id Post ID.
* @param \WP_Post $post Post object.
* @return void
*/
public function inpost_seo_save( $post_id, $post ) {
//* Nonce is done at the end of this function.
if ( empty( $_POST['autodescription'] ) )
return;
$defaults = array(
'_genesis_title' => '',
'_genesis_description' => '',
'_genesis_canonical_uri' => '',
'redirect' => '', // Will be displayed in custom fields when set...
'_social_image_url' => '',
'_social_image_id' => 0,
'_genesis_noindex' => 0,
'_genesis_nofollow' => 0,
'_genesis_noarchive' => 0,
'exclude_local_search' => 0, // Will be displayed in custom fields when set...
'exclude_from_archive' => 0, // Will be displayed in custom fields when set...
'_open_graph_title' => '',
'_open_graph_description' => '',
'_twitter_title' => '',
'_twitter_description' => '',
);
/**
* Merge user submitted options with fallback defaults
* Passes through nonce at the end of the function.
*/
$data = \wp_parse_args( $_POST['autodescription'], $defaults );
foreach ( (array) $data as $key => $value ) :
switch ( $key ) :
case '_genesis_title' :
case '_open_graph_title' :
case '_twitter_title' :
$data[ $key ] = $this->s_title_raw( $value );
continue 2;
case '_genesis_description' :
case '_open_graph_description' :
case '_twitter_description' :
$data[ $key ] = $this->s_description_raw( $value );
continue 2;
case '_genesis_canonical_uri' :
case '_social_image_url' :
/**
* Remove unwanted query parameters. They're allowed by Google, but very much rather not.
* Also, they will only cause bugs.
* Query parameters are also only used when no pretty permalinks are used. Which is bad.
*/
$data[ $key ] = $this->s_url_query( $value );
continue 2;
case '_social_image_id' :
//* Bound to _social_image_url.
$data[ $key ] = $data['_social_image_url'] ? $this->s_absint( $value ) : 0;
continue 2;
case 'redirect' :
//* Let's keep this as the output really is.
$data[ $key ] = $this->s_redirect_url( $value );
continue 2;
case '_genesis_noindex' :
case '_genesis_nofollow' :
case '_genesis_noarchive' :
case 'exclude_local_search' :
case 'exclude_from_archive' :
$data[ $key ] = $this->s_one_zero( $value );
continue 2;
default :
break;
endswitch;
endforeach;
//* Perform nonce and save fields.
$this->save_custom_fields( $data, $this->inpost_nonce_field, $this->inpost_nonce_name, $post );
}
/**
* Save post meta / custom field data for a post or page.
*
* It verifies the nonce, then checks we're not doing autosave, ajax or a future post request. It then checks the
* current user's permissions, before finally* either updating the post meta, or deleting the field if the value was not
* truthy.
*
* By passing an array of fields => values from the same metabox (and therefore same nonce) into the $data argument,
* repeated checks against the nonce, request and permissions are avoided.
*
* @since 2.0.0
* @securitycheck 3.0.0 OK.
*
* @thanks StudioPress (http://www.studiopress.com/) for some code.
*
* @param array $data Key/Value pairs of data to save in '_field_name' => 'value' format.
* @param string $nonce_action Nonce action for use with wp_verify_nonce().
* @param string $nonce_name Name of the nonce to check for permissions.
* @param \WP_Post|integer $post Post object or ID.
* @return mixed Return null if permissions incorrect, doing autosave, ajax or future post, false if update or delete
* failed, and true on success.
*/
public function save_custom_fields( array $data, $nonce_action, $nonce_name, $post ) {
//* Verify the nonce
if ( ! isset( $_POST[ $nonce_name ] ) || ! \wp_verify_nonce( $_POST[ $nonce_name ], $nonce_action ) )
return;
/**
* Don't try to save the data under autosave, ajax, or future post.
* @TODO find a way to maintain revisions:
* @link https://github.com/sybrew/the-seo-framework/issues/48
* @link https://johnblackbourn.com/post-meta-revisions-wordpress
*/
if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
return;
if ( $this->doing_ajax() )
return;
if ( defined( 'DOING_CRON' ) && DOING_CRON )
return;
//* Grab the post object
$post = \get_post( $post );
/**
* Don't save if WP is creating a revision (same as DOING_AUTOSAVE?)
* @todo @see wp_is_post_revision(), which also returns the post revision ID...
*/
if ( 'revision' === \get_post_type( $post ) )
return;
//* Check that the user is allowed to edit the post
if ( ! \current_user_can( 'edit_post', $post->ID ) )
return;
//* Cycle through $data, insert value or delete field
foreach ( (array) $data as $field => $value ) {
//* Save $value, or delete if the $value is empty
if ( $value ) {
\update_post_meta( $post->ID, $field, $value );
} else {
\delete_post_meta( $post->ID, $field );
}
}
}
/**
* Saves primary term data for posts.
*
* @since 3.0.0
* @securitycheck 3.0.0 OK.
*
* @param integer $post_id Post ID.
* @param \WP_Post $post Post object.
* @return void
*/
public function _save_inpost_primary_term( $post_id, $post ) {
//* Nonce is done at the end of this function.
if ( empty( $_POST['autodescription'] ) )
return;
$post_type = \get_post_type( $post_id ) ?: false;
if ( ! $post_type )
return;
/**
* Don't save if WP is creating a revision (same as DOING_AUTOSAVE?)
* @todo @see wp_is_post_revision(), which also returns the post revision ID...
*/
if ( 'revision' === $post_type )
return;
//* Check that the user is allowed to edit the post
if ( ! \current_user_can( 'edit_post', $post_id ) )
return;
$_taxonomies = $this->get_hierarchical_taxonomies_as( 'names', $post_type );
$values = array();
foreach ( $_taxonomies as $_taxonomy ) {
$_post_key = '_primary_term_' . $_taxonomy;
$values[ $_taxonomy ] = array(
'action' => $this->inpost_nonce_field . '_pt',
'name' => $this->inpost_nonce_name . '_pt_' . $_taxonomy,
'value' => isset( $_POST['autodescription'][ $_post_key ] ) ? \absint( $_POST['autodescription'][ $_post_key ] ) : false,
);
}
foreach ( $values as $t => $v ) {
if ( \wp_verify_nonce( $v['name'], $v['action'] ) ) {
$this->update_primary_term_id( $post_id, $t, $v['value'] );
}
}
}
/**
* Fetches or parses the excerpt of the post.
*
* @since 1.0.0
* @since 2.8.2 : Added 4th parameter for escaping.
*
* @param string $excerpt the Excerpt.
* @param int $the_id The Post ID.
* @param int $tt_id The Taxonomy Term ID.
* @param int $tt_id The Taxonomy Term ID.
* @return string The escaped Excerpt.
*/
public function get_excerpt_by_id( $excerpt = '', $the_id = '', $tt_id = '', $escape = true ) {
if ( empty( $excerpt ) )
$excerpt = $this->fetch_excerpt( $the_id, $tt_id );
//* No need to parse an empty excerpt.
if ( '' === $excerpt )
return '';
if ( $escape )
return $this->s_excerpt( $excerpt );
return $this->s_excerpt_raw( $excerpt );
}
/**
* Fetches excerpt from post excerpt or fetches the full post content.
* Determines if a page builder is used to return an empty string.
* Does not sanitize output.
*
* @since 2.5.2
* @since 2.6.6 Detects Page builders.
*
* @param int $the_id The Post ID.
* @param int $tt_id The Taxonomy Term ID.
* @return string The excerpt.
*/
public function fetch_excerpt( $the_id = '', $tt_id = '' ) {
$post = $this->fetch_post_by_id( $the_id, $tt_id, OBJECT );
if ( empty( $post ) )
return '';
/**
* Fetch custom excerpt, if not empty, from the post_excerpt field.
* @since 2.5.2
*/
if ( ! empty( $post->post_excerpt ) ) {
$excerpt = $post->post_excerpt;
} elseif ( isset( $post->post_content ) ) {
$excerpt = $this->uses_page_builder( $post->ID ) ? '' : $post->post_content;
} else {
$excerpt = '';
}
return $excerpt;
}
/**
* Returns Post Array from ID.
* Also returns latest post from blog or archive if applicable.
*
* @since 2.6.0
* @since 2.6.6 Added $output parameter.
*
* @param int $the_id The Post ID.
* @param int $tt_id The Taxonomy Term ID
* @param mixed $output The value type to return. Accepts OBJECT, ARRAY_A, or ARRAY_N
* @return string|array The Post Array.
*/
protected function fetch_post_by_id( $the_id = '', $tt_id = '', $output = ARRAY_A ) {
if ( '' === $the_id && '' === $tt_id ) {
$the_id = $this->get_the_real_ID();
if ( false === $the_id )
return '';
}
/**
* @since 2.2.8 Use the 2nd parameter.
* @since 2.3.3 Now casts to array
*/
if ( '' !== $the_id ) {
if ( $this->is_blog_page( $the_id ) ) {
$args = array(
'posts_per_page' => 1,
'offset' => 0,
'category' => '',
'category_name' => '',
'orderby' => 'date',
'order' => 'DESC',
'post_type' => 'post',
'post_status' => 'publish',
'cache_results' => false,
);
$post = \get_posts( $args );
} else {
$post = \get_post( $the_id );
}
} elseif ( '' !== $tt_id ) {
/**
* @since 2.3.3 Match the descriptions in admin as on the front end.
*/
$args = array(
'posts_per_page' => 1,
'offset' => 0,
'category' => $tt_id,
'category_name' => '',
'post_type' => 'post',
'post_status' => 'publish',
'cache_results' => false,
);
$post = \get_posts( $args );
} else {
$post = \get_post( $the_id );
}
/**
* @since 2.6.5 Transform post array to object (on Archives).
*/
if ( is_array( $post ) && isset( $post[0] ) && is_object( $post[0] ) )
$post = $post[0];
//* Something went wrong, nothing to be found. Return empty.
if ( empty( $post ) )
return '';
//* Stop getting something that doesn't exists. E.g. 404
if ( isset( $post->ID ) && 0 === $post->ID )
return '';
/**
* @since 2.6.6
*/
if ( ARRAY_A === $output || ARRAY_N === $output ) {
$_post = \WP_Post::get_instance( $post );
$post = $_post->to_array();
if ( ARRAY_N === $output )
$post = array_values( $post );
}
return $post;
}
/**
* Fetch latest public post ID.
*
* @since 2.4.3
* @since 2.9.3 : 1. Removed object caching.
* : 2. It now uses WP_Query, instead of wpdb.
* @staticvar int $post_id
*
* @return int Latest Post ID.
*/
public function get_latest_post_id() {
static $post_id = null;
if ( null !== $post_id )
return $post_id;
$query = new \WP_Query( array(
'posts_per_page' => 1,
'post_type' => array( 'post', 'page' ),
'orderby' => 'date',
'order' => 'DESC',
'post_status' => array( 'publish', 'future', 'pending' ),
'fields' => 'ids',
'cache_results' => false,
'suppress_filters' => true,
'no_found_rows' => true,
) );
return $post_id = reset( $query->posts );
}
/**
* Fetches Post content.
*
* @since 2.6.0
*
* @param int $id The post ID.
* @return string The post content.
*/
public function get_post_content( $id = 0 ) {
$id = $id ?: $this->get_the_real_ID();
$content = \get_post_field( 'post_content', $id );
if ( is_string( $content ) )
return $content;
return '';
}
/**
* Determines whether the post has a page builder attached to it.
* Doesn't use plugin detection features as some builders might be incorporated within themes.
*
* Detects the following builders:
* - Divi Builder by Elegant Themes
* - Visual Composer by WPBakery
* - Page Builder by SiteOrigin
* - Beaver Builder by Fastline Media
*
* @since 2.6.6
*
* @param int $post_id
* @return boolean
*/
public function uses_page_builder( $post_id ) {
$meta = \get_post_meta( $post_id );
/**
* Applies filters 'the_seo_framework_detect_page_builder' : boolean
* Determines whether a page builder has been detected.
* @since 2.6.6
*
* @param boolean The current state.
* @param int $post_id The current Post ID.
* @param array $meta The current post meta.
*/
$detected = (bool) \apply_filters( 'the_seo_framework_detect_page_builder', false, $post_id, $meta );
if ( $detected )
return true;
if ( empty( $meta ) )
return false;
if ( isset( $meta['_et_pb_use_builder'][0] ) && 'on' === $meta['_et_pb_use_builder'][0] && defined( 'ET_BUILDER_VERSION' ) ) :
//* Divi Builder by Elegant Themes
return true;
elseif ( isset( $meta['_wpb_vc_js_status'][0] ) && 'true' === $meta['_wpb_vc_js_status'][0] && defined( 'WPB_VC_VERSION' ) ) :
//* Visual Composer by WPBakery
return true;
elseif ( isset( $meta['panels_data'][0] ) && '' !== $meta['panels_data'][0] && defined( 'SITEORIGIN_PANELS_VERSION' ) ) :
//* Page Builder by SiteOrigin
return true;
elseif ( isset( $meta['_fl_builder_enabled'][0] ) && '1' === $meta['_fl_builder_enabled'][0] && defined( 'FL_BUILDER_VERSION' ) ) :
//* Beaver Builder by Fastline Media
return true;
endif;
return false;
}
/**
* Determines if the current post is protected or private.
* Only works on singular pages.
*
* @since 2.8.0
* @since 3.0.0 1. No longer checks for current query.
* 2. Input parameter now default to null.
* This currently doesn't affect how it works.
*
* @param int|null|\WP_Post The post ID or WP Post object.
* @return bool True if protected, false otherwise.
*/
public function is_protected( $id = null ) {
$post = \get_post( $id, OBJECT );
$ret = false;
if ( isset( $post->post_password ) && '' !== $post->post_password ) {
$ret = true;
} elseif ( isset( $post->post_status ) && 'private' === $post->post_status ) {
$ret = true;
}
return $ret;
}
/**
* Determines if the current post has a password.
*
* @since 3.0.0
*
* @param int|null|\WP_Post The post ID or WP Post object.
* @return bool True if private, false otherwise.
*/
public function is_password_protected( $id = null ) {
$post = \get_post( $id, OBJECT );
$ret = false;
if ( isset( $post->post_password ) && '' !== $post->post_password )
$ret = true;
return $ret;
}
/**
* Determines if the current post is private.
*
* @since 3.0.0
*
* @param int|null|\WP_Post The post ID or WP Post object.
* @return bool True if private, false otherwise.
*/
public function is_private( $id = null ) {
$post = \get_post( $id, OBJECT );
$ret = false;
if ( isset( $post->post_status ) && 'private' === $post->post_status )
$ret = true;
return $ret;
}
/**
* Returns list of post IDs that are excluded from search.
*
* @since 3.0.0
*
* @return array The excluded post IDs.
*/
public function get_ids_excluded_from_search() {
$cache = $this->get_excluded_ids_from_cache();
$ids = array();
if ( ! empty( $cache['search'] ) ) {
$ids = $cache['search'];
}
return $ids;
}
/**
* Returns list of post IDs that are excluded from archive.
*
* @since 3.0.0
*
* @return array The excluded post IDs.
*/
public function get_ids_excluded_from_archive() {
$cache = $this->get_excluded_ids_from_cache();
$ids = array();
if ( ! empty( $cache['archive'] ) ) {
$ids = $cache['archive'];
}
return $ids;
}
/**
* Returns the primary term for post.
*
* @since 3.0.0
*
* @param int|null $post_id The post ID.
* @param string $taxonomy The taxonomy name.
* @return \WP_Term|false The primary term. False if not set.
*/
public function get_primary_term( $post_id = null, $taxonomy = '' ) {
$primary_id = $this->get_primary_term_id( $post_id, $taxonomy );
if ( ! $primary_id )
return false;
$terms = \get_the_terms( $post_id, $taxonomy );
$primary_term = false;
foreach ( $terms as $term ) {
if ( $primary_id === (int) $term->term_id ) {
$primary_term = $term;
break;
}
}
return $primary_term;
}
/**
* Returns the primary term ID for post.
*
* @since 3.0.0
*
* @param int|null $post_id The post ID.
* @param string $taxonomy The taxonomy name.
* @return int The primary term ID. 0 if not set.
*/
public function get_primary_term_id( $post_id = null, $taxonomy = '' ) {
return (int) $this->get_custom_field( '_primary_term_' . $taxonomy, $post_id ) ?: 0;
}
/**
* Updates the primary term ID for post.
*
* @since 3.0.0
*
* @param int|null $post_id The post ID.
* @param string $taxonomy The taxonomy name.
* @param int $value The new value. If empty, it will delete the entry.
* @return bool True on success, false on failure.
*/
public function update_primary_term_id( $post_id = null, $taxonomy = '', $value = 0 ) {
if ( empty( $value ) ) {
$success = \delete_post_meta( $post_id, '_primary_term_' . $taxonomy );
} else {
$success = \update_post_meta( $post_id, '_primary_term_' . $taxonomy, $value );
}
return $success;
}
}
Mini Shell