name = __( 'Social Meta', 'all-in-one-seo-pack' ); // Human-readable name of the plugin.
$this->prefix = 'aiosp_opengraph_'; // option prefix.
$this->file = __FILE__; // the current file.
$this->fb_object_types = array(
'Activities' => array(
'activity' => __( 'Activity', 'all-in-one-seo-pack' ),
'sport' => __( 'Sport', 'all-in-one-seo-pack' ),
),
'Businesses' => array(
'bar' => __( 'Bar', 'all-in-one-seo-pack' ),
'company' => __( 'Company', 'all-in-one-seo-pack' ),
'cafe' => __( 'Cafe', 'all-in-one-seo-pack' ),
'hotel' => __( 'Hotel', 'all-in-one-seo-pack' ),
'restaurant' => __( 'Restaurant', 'all-in-one-seo-pack' ),
),
'Groups' => array(
'cause' => __( 'Cause', 'all-in-one-seo-pack' ),
'sports_league' => __( 'Sports League', 'all-in-one-seo-pack' ),
'sports_team' => __( 'Sports Team', 'all-in-one-seo-pack' ),
),
'Organizations' => array(
'band' => __( 'Band', 'all-in-one-seo-pack' ),
'government' => __( 'Government', 'all-in-one-seo-pack' ),
'non_profit' => __( 'Non Profit', 'all-in-one-seo-pack' ),
'school' => __( 'School', 'all-in-one-seo-pack' ),
'university' => __( 'University', 'all-in-one-seo-pack' ),
),
'People' => array(
'actor' => __( 'Actor', 'all-in-one-seo-pack' ),
'athlete' => __( 'Athlete', 'all-in-one-seo-pack' ),
'author' => __( 'Author', 'all-in-one-seo-pack' ),
'director' => __( 'Director', 'all-in-one-seo-pack' ),
'musician' => __( 'Musician', 'all-in-one-seo-pack' ),
'politician' => __( 'Politician', 'all-in-one-seo-pack' ),
'profile' => __( 'Profile', 'all-in-one-seo-pack' ),
'public_figure' => __( 'Public Figure', 'all-in-one-seo-pack' ),
),
'Places' => array(
'city' => __( 'City', 'all-in-one-seo-pack' ),
'country' => __( 'Country', 'all-in-one-seo-pack' ),
'landmark' => __( 'Landmark', 'all-in-one-seo-pack' ),
'state_province' => __( 'State Province', 'all-in-one-seo-pack' ),
),
'Products and Entertainment' => array(
'album' => __( 'Album', 'all-in-one-seo-pack' ),
'book' => __( 'Book', 'all-in-one-seo-pack' ),
'drink' => __( 'Drink', 'all-in-one-seo-pack' ),
'food' => __( 'Food', 'all-in-one-seo-pack' ),
'game' => __( 'Game', 'all-in-one-seo-pack' ),
'movie' => __( 'Movie', 'all-in-one-seo-pack' ),
'product' => __( 'Product', 'all-in-one-seo-pack' ),
'song' => __( 'Song', 'all-in-one-seo-pack' ),
'tv_show' => __( 'TV Show', 'all-in-one-seo-pack' ),
'episode' => __( 'Episode', 'all-in-one-seo-pack' ),
),
'Websites' => array(
'article' => __( 'Article', 'all-in-one-seo-pack' ),
'website' => __( 'Website', 'all-in-one-seo-pack' ),
),
);
parent::__construct();
if ( is_admin() ) {
add_action( 'admin_init', array( $this, 'admin_init' ), 5 );
} else {
add_action( 'wp', array( $this, 'type_setup' ) );
}
if ( ! is_admin() || wp_doing_ajax() || defined( 'AIOSEOP_UNIT_TESTING' ) ) {
$this->do_opengraph();
}
// Set variables after WordPress load.
add_action( 'init', array( &$this, 'init' ), 999999 );
// Avoid having duplicate meta tags.
add_filter( 'jetpack_enable_open_graph', '__return_false' );
// Force refresh of Facebook cache.
add_action( 'post_updated', array( &$this, 'force_fb_refresh_update' ), 10, 3 );
add_action( 'transition_post_status', array( &$this, 'force_fb_refresh_transition' ), 10, 3 );
add_action( 'edited_term', array( &$this, 'save_tax_data' ), 10, 3 );
// Adds special filters.
add_filter( 'aioseop_opengraph_placeholder', array( &$this, 'filter_placeholder' ) );
add_action( 'aiosp_activate_opengraph', array( $this, 'activate_module' ) );
add_action( 'created_term', array( $this, 'created_term' ), 10, 3 );
// Call to init to generate menus.
$this->init();
}
/**
* Sets the terms defaults after a new term is created.
*
* @param int $term_id Term ID.
* @param int $tt_id Term taxonomy ID.
* @param string $taxonomy Taxonomy slug.
*/
function created_term( $term_id, $tt_id, $taxonomy_name ) {
$k = 'settings';
$prefix = $this->get_prefix( $k );
$tax = get_taxonomy( $taxonomy_name );
$this->set_object_type_for_taxonomy( $prefix, $k, $taxonomy_name, $tax, false, array( $term_id ) );
}
/**
* Sets the defaults for a taxonomy.
*
* @param string $prefix The prefix of this module.
* @param string $k The key against which the options will be determined/set.
* @param string $taxonomy_name The name of the taxonomy.
* @param Object $tax The taxonomy object.
* @param bool $bail_if_no_terms Bail if the taxonomy has no terms.
* @param array $terms The terms in the taxonomy.
*/
private function set_object_type_for_taxonomy( $prefix, $k, $taxonomy_name, $tax, $bail_if_no_terms = false, $terms = null ) {
$object_type = null;
if ( ! $terms ) {
$terms = get_terms(
$taxonomy_name,
array(
'meta_query' => array(
array(
'key' => '_' . $prefix . $k,
'compare' => 'NOT EXISTS',
),
),
'number' => PHP_INT_MAX,
'fields' => 'ids',
'hide_empty' => false,
)
);
}
if ( empty( $terms ) && $bail_if_no_terms ) {
return false;
}
if ( true === $tax->_builtin ) {
$object_type = 'article';
} else {
// custom taxonomy. Let's get a post against this to determine its post type.
$posts = get_posts(
array(
'numberposts' => 1,
'post_type' => 'any',
'tax_query' => array(
array(
'taxonomy' => $taxonomy_name,
'field' => 'term_id',
'terms' => $terms,
),
),
)
);
if ( $posts ) {
global $aioseop_options;
$post_type = $posts[0]->post_type;
if ( isset( $aioseop_options['modules'] ) && isset( $aioseop_options['modules'][ $this->prefix . 'options' ] ) ) {
$og_options = $aioseop_options['modules'][ $this->prefix . 'options' ];
// now let's see what default object type is set for this post type.
$object_type_set = $og_options[ $this->prefix . $post_type . '_fb_object_type' ];
if ( ! empty( $object_type_set ) ) {
$object_type = $object_type_set;
}
}
}
}
if ( $object_type ) {
$opts[ $prefix . $k . '_category' ] = $object_type;
foreach ( $terms as $term_id ) {
update_term_meta( $term_id, '_' . $prefix . $k, $opts );
}
}
return true;
}
/**
* Called when this module is activated.
*/
public function activate_module() {
if ( null !== $this->locations ) {
foreach ( $this->locations as $k => $v ) {
if ( ! isset( $v['type'] ) || 'metabox' !== $v['type'] ) {
continue;
}
$this->set_virgin_tax_terms( $k );
}
}
}
/**
* This iterates over all taxonomies that do not have a opengraph setting defined and sets the defaults.
*
* @param string $k The key against which the options will be determined/set.
*/
private function set_virgin_tax_terms( $k ) {
$prefix = $this->get_prefix( $k );
$opts = $this->default_options( $k );
$taxonomies = get_taxonomies( array( 'public' => true ), 'object' );
if ( ! $taxonomies ) {
return;
}
foreach ( $taxonomies as $name => $tax ) {
$this->set_object_type_for_taxonomy( $prefix, $k, $name, $tax, true, null );
}
}
/**
* Hook called after WordPress has been loaded.
*
* @since 2.4.14
*/
public function init() {
$count_desc = __( ' characters. We recommend a maximum of %1$s chars for the %2$s.', 'all-in-one-seo-pack' );
// Create default options.
$this->default_options = array(
'scan_header' => array(
'name' => __( 'Scan Header', 'all-in-one-seo-pack' ),
'type' => 'custom',
'save' => true,
),
'setmeta' => array(
'name' => __( 'Use AIOSEO Title and Description', 'all-in-one-seo-pack' ),
'type' => 'checkbox',
),
'key' => array(
'name' => __( 'Facebook Admin ID', 'all-in-one-seo-pack' ),
'default' => '',
'type' => 'text',
),
'appid' => array(
'name' => __( 'Facebook App ID', 'all-in-one-seo-pack' ),
'default' => '',
'type' => 'text',
),
'title_shortcodes' => array(
'name' => __( 'Run Shortcodes In Title', 'all-in-one-seo-pack' ),
),
'description_shortcodes' => array(
'name' => __( 'Run Shortcodes In Description', 'all-in-one-seo-pack' ),
),
'sitename' => array(
'name' => __( 'Site Name', 'all-in-one-seo-pack' ),
'default' => get_bloginfo( 'name' ),
'type' => 'text',
),
'hometitle' => array(
'name' => __( 'Home Title', 'all-in-one-seo-pack' ),
'default' => '',
'type' => 'text',
'count' => true,
'count_desc' => $count_desc,
'size' => 95,
'condshow' => array(
'aiosp_opengraph_setmeta' => array(
'lhs' => 'aiosp_opengraph_setmeta',
'op' => '!=',
'rhs' => 'on',
),
),
),
'description' => array(
'name' => __( 'Home Description', 'all-in-one-seo-pack' ),
'default' => '',
'type' => 'textarea',
'count' => true,
'count_desc' => $count_desc,
'size' => 200,
'condshow' => array(
'aiosp_opengraph_setmeta' => array(
'lhs' => 'aiosp_opengraph_setmeta',
'op' => '!=',
'rhs' => 'on',
),
),
),
'homeimage' => array(
'name' => __( 'Home Image', 'all-in-one-seo-pack' ),
'type' => 'image',
),
'generate_descriptions' => array(
'name' => __( 'Use Content For Autogenerated OG Descriptions', 'all-in-one-seo-pack' ),
'default' => 0,
),
'defimg' => array(
'name' => __( 'Select OG:Image Source', 'all-in-one-seo-pack' ),
'type' => 'select',
'initial_options' => array(
'' => __( 'Default Image', 'all-in-one-seo-pack' ),
'featured' => __( 'Featured Image', 'all-in-one-seo-pack' ),
'attach' => __( 'First Attached Image', 'all-in-one-seo-pack' ),
'content' => __( 'First Image In Content', 'all-in-one-seo-pack' ),
'custom' => __( 'Image From Custom Field', 'all-in-one-seo-pack' ),
'author' => __( 'Post Author Image', 'all-in-one-seo-pack' ),
'auto' => __( 'First Available Image', 'all-in-one-seo-pack' ),
),
),
'dimg' => array(
'name' => __( 'Default OG:Image', 'all-in-one-seo-pack' ),
'default' => ( aioseop_get_site_logo_url() ) ? aioseop_get_site_logo_url() : AIOSEOP_PLUGIN_IMAGES_URL . 'default-user-image.png',
'type' => 'image',
),
'dimgwidth' => array(
'name' => __( 'Default Image Width', 'all-in-one-seo-pack' ),
'type' => 'number',
'default' => '',
),
'dimgheight' => array(
'name' => __( 'Default Image Height', 'all-in-one-seo-pack' ),
'type' => 'number',
'default' => '',
),
'meta_key' => array(
'name' => __( 'Use Custom Field For Image', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => '',
),
'image' => array(
'name' => __( 'Image', 'all-in-one-seo-pack' ),
'type' => 'radio',
'initial_options' => array(
0 => '
',
),
),
'customimg' => array(
'name' => __( 'Custom Image', 'all-in-one-seo-pack' ),
'type' => 'image',
),
'imagewidth' => array(
'name' => __( 'Specify Image Width', 'all-in-one-seo-pack' ),
'type' => 'number',
'default' => '',
),
'imageheight' => array(
'name' => __( 'Specify Image Height', 'all-in-one-seo-pack' ),
'type' => 'number',
'default' => '',
),
'video' => array(
'name' => __( 'Custom Video', 'all-in-one-seo-pack' ),
'type' => 'text',
),
'videowidth' => array(
'name' => __( 'Specify Video Width', 'all-in-one-seo-pack' ),
'type' => 'number',
'default' => '',
'condshow' => array(
'aioseop_opengraph_settings_video' => array(
'lhs' => 'aioseop_opengraph_settings_video',
'op' => '!=',
'rhs' => '',
),
),
),
'videoheight' => array(
'name' => __( 'Specify Video Height', 'all-in-one-seo-pack' ),
'type' => 'number',
'default' => '',
'condshow' => array(
'aioseop_opengraph_settings_video' => array(
'lhs' => 'aioseop_opengraph_settings_video',
'op' => '!=',
'rhs' => '',
),
),
),
'defcard' => array(
'name' => __( 'Default Twitter Card', 'all-in-one-seo-pack' ),
'type' => 'select',
'default' => 'summary',
'initial_options' => array(
'summary' => __( 'Summary', 'all-in-one-seo-pack' ),
'summary_large_image' => __( 'Summary Large Image', 'all-in-one-seo-pack' ),
/*
* REMOVING THIS TWITTER CARD TYPE FROM SOCIAL META MODULE
* 'photo' => __( 'Photo', 'all-in-one-seo-pack' )
*/
),
),
'setcard' => array(
'name' => __( 'Twitter Card Type', 'all-in-one-seo-pack' ),
'type' => 'select',
'initial_options' => array(
'summary_large_image' => __( 'Summary Large Image', 'all-in-one-seo-pack' ),
'summary' => __( 'Summary', 'all-in-one-seo-pack' ),
/*
* REMOVING THIS TWITTER CARD TYPE FROM SOCIAL META MODULE
* 'photo' => __( 'Photo', 'all-in-one-seo-pack' )
*/
),
),
'twitter_site' => array(
'name' => __( 'Twitter Site', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => '',
),
'twitter_creator' => array(
'name' => __( 'Show Twitter Author', 'all-in-one-seo-pack' ),
),
'twitter_domain' => array(
'name' => __( 'Twitter Domain', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => '',
),
'customimg_twitter' => array(
'name' => __( 'Custom Twitter Image', 'all-in-one-seo-pack' ),
'type' => 'image',
),
'gen_tags' => array(
'name' => __( 'Automatically Generate Article Tags', 'all-in-one-seo-pack' ),
),
'gen_keywords' => array(
'name' => __( 'Use Keywords In Article Tags', 'all-in-one-seo-pack' ),
'default' => 'on',
'condshow' => array( 'aiosp_opengraph_gen_tags' => 'on' ),
),
'gen_categories' => array(
'name' => __( 'Use Categories In Article Tags', 'all-in-one-seo-pack' ),
'default' => 'on',
'condshow' => array( 'aiosp_opengraph_gen_tags' => 'on' ),
),
'gen_post_tags' => array(
'name' => __( 'Use Post Tags In Article Tags', 'all-in-one-seo-pack' ),
'default' => 'on',
'condshow' => array( 'aiosp_opengraph_gen_tags' => 'on' ),
),
'types' => array(
'name' => __( 'Enable Facebook Meta for Post Types', 'all-in-one-seo-pack' ),
'type' => 'multicheckbox',
'default' => array(
'post' => 'post',
'page' => 'page',
),
'initial_options' => $this->get_post_type_titles( array( '_builtin' => false ) ),
),
'title' => array(
'name' => __( 'Title', 'all-in-one-seo-pack' ),
'default' => '',
'type' => 'text',
'size' => 95,
'count' => 1,
'count_desc' => $count_desc,
),
'desc' => array(
'name' => __( 'Description', 'all-in-one-seo-pack' ),
'default' => '',
'type' => 'textarea',
'cols' => 50,
'rows' => 4,
'count' => 1,
'count_desc' => $count_desc,
),
'category' => array(
'name' => __( 'Facebook Object Type', 'all-in-one-seo-pack' ),
'type' => 'select',
'style' => '',
'default' => '',
'initial_options' => $this->fb_object_types,
),
'facebook_debug' => array(
'name' => __( 'Facebook Debug', 'all-in-one-seo-pack' ),
'type' => 'html',
'save' => false,
'default' => '' . __( 'Debug This Post', 'all-in-one-seo-pack' ) . '',
),
'section' => array(
'name' => __( 'Article Section', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => '',
'condshow' => array( 'aioseop_opengraph_settings_category' => 'article' ),
),
'tag' => array(
'name' => __( 'Article Tags', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => '',
'condshow' => array( 'aioseop_opengraph_settings_category' => 'article' ),
),
'facebook_publisher' => array(
'name' => __( 'Show Facebook Publisher on Articles', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => '',
),
'facebook_author' => array(
'name' => __( 'Show Facebook Author on Articles', 'all-in-one-seo-pack' ),
),
'upgrade' => array(
'type' => 'html',
'label' => 'none',
'default' => sprintf(
'%3$s',
aioseop_get_utm_url( 'metabox-social' ),
sprintf(
/* translators: %s: "All in One SEO Pack Pro". */
__( 'Upgrade to %s', 'all-in-one-seo-pack' ),
AIOSEOP_PLUGIN_NAME . ' Pro'
),
__( 'UPGRADE TO PRO VERSION', 'all-in-one-seo-pack' )
),
),
);
// load initial options / set defaults.
$this->update_options();
$display = array();
if ( isset( $this->options['aiosp_opengraph_types'] ) && ! empty( $this->options['aiosp_opengraph_types'] ) ) {
$display = $this->options['aiosp_opengraph_types'];
}
$this->locations = array(
'opengraph' => array(
'name' => $this->name,
'prefix' => 'aiosp_',
'type' => 'settings',
'options' => array(
'scan_header',
'setmeta',
'key',
'appid',
'sitename',
'title_shortcodes',
'description_shortcodes',
'hometitle',
'description',
'homeimage',
'generate_descriptions',
'defimg',
'dimg',
'dimgwidth',
'dimgheight',
'meta_key',
'defcard',
'twitter_site',
'twitter_creator',
'twitter_domain',
'gen_tags',
'gen_keywords',
'gen_categories',
'gen_post_tags',
'types',
'facebook_publisher',
'facebook_author',
),
),
'settings' => array(
'name' => __( 'Social Settings', 'all-in-one-seo-pack' ),
'type' => 'metabox',
'help_link' => 'https://semperplugins.com/documentation/social-meta-settings-individual-pagepost-settings/',
'options' => array(
'title',
'desc',
'image',
'customimg',
'imagewidth',
'imageheight',
'video',
'videowidth',
'videoheight',
'category',
'facebook_debug',
'section',
'tag',
'setcard',
'customimg_twitter',
),
'display' => apply_filters( 'aioseop_opengraph_display', $display ),
'prefix' => 'aioseop_opengraph_',
),
);
if ( ! AIOSEOPPRO ) {
array_unshift( $this->locations['settings']['options'], 'upgrade' );
}
$this->layout = array(
'home' => array(
'name' => __( 'Home Page Settings', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/social-meta-module/#use-aioseo-title-and-description',
'options' => array( 'setmeta', 'sitename', 'hometitle', 'description', 'homeimage' ),
),
'image' => array(
'name' => __( 'Image Settings', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/social-meta-module/#select-og-image-source',
'options' => array( 'defimg', 'dimg', 'dimgwidth', 'dimgheight', 'meta_key' ),
),
'facebook' => array(
'name' => __( 'Facebook Settings', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/social-meta-module/#facebook-settings',
'options' => array(
'key',
'appid',
'types',
'gen_tags',
'gen_keywords',
'gen_categories',
'gen_post_tags',
'facebook_publisher',
'facebook_author',
),
),
'twitter' => array(
'name' => __( 'Twitter Settings', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/social-meta-module/#default-twitter-card',
'options' => array( 'defcard', 'setcard', 'twitter_site', 'twitter_creator', 'twitter_domain' ),
),
'default' => array(
'name' => __( 'Advanced Settings', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/social-meta-module/',
// this is set below, to the remaining options -- pdb.
'options' => array(),
),
'scan_meta' => array(
'name' => __( 'Scan Social Meta', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/social-meta-module/#scan_meta',
'options' => array( 'scan_header' ),
),
);
$other_options = array();
foreach ( $this->layout as $k => $v ) {
$other_options = array_merge( $other_options, $v['options'] );
}
$this->layout['default']['options'] = array_diff( array_keys( $this->default_options ), $other_options );
}
/**
* Forces FaceBook OpenGraph to refresh its cache when a post is changed to
*
* @param $new_status
* @param $old_status
* @param $post
*
* @todo this and force_fb_refresh_update can probably have the remote POST extracted out.
*
* @see https://developers.facebook.com/docs/sharing/opengraph/using-objects#update
* @since 2.3.11
*/
function force_fb_refresh_transition( $new_status, $old_status, $post ) {
if ( 'publish' !== $new_status ) {
return;
}
if ( 'future' !== $old_status ) {
return;
}
$current_post_type = get_post_type();
// Only ping Facebook if Social SEO is enabled on this post type.
if ( $this->option_isset( 'types' ) && is_array( $this->options['aiosp_opengraph_types'] ) && in_array( $current_post_type, $this->options['aiosp_opengraph_types'] ) ) {
$post_url = aioseop_get_permalink( $post->ID );
$endpoint = sprintf(
'https://graph.facebook.com/?%s',
http_build_query(
array(
'id' => $post_url,
'scrape' => true,
)
)
);
wp_remote_post( $endpoint, array( 'blocking' => false ) );
}
}
/**
* Forces FaceBook OpenGraph refresh on update.
*
* @param $post_id
* @param $post_after
*
* @see https://developers.facebook.com/docs/sharing/opengraph/using-objects#update
* @since 2.3.11
*/
function force_fb_refresh_update( $post_id, $post_after ) {
$current_post_type = get_post_type();
// Only ping Facebook if Social SEO is enabled on this post type.
if ( 'publish' === $post_after->post_status && $this->option_isset( 'types' ) && is_array( $this->options['aiosp_opengraph_types'] ) && in_array( $current_post_type, $this->options['aiosp_opengraph_types'] ) ) {
$post_url = aioseop_get_permalink( $post_id );
$endpoint = sprintf(
'https://graph.facebook.com/?%s',
http_build_query(
array(
'id' => $post_url,
'scrape' => true,
)
)
);
wp_remote_post( $endpoint, array( 'blocking' => false ) );
}
}
function settings_page_init() {
add_filter( 'aiosp_output_option', array( $this, 'display_custom_options' ), 10, 2 );
}
function filter_options( $options, $location ) {
if ( 'settings' == $location ) {
$prefix = $this->get_prefix( $location ) . $location . '_';
list( $legacy, $images ) = $this->get_all_images( $options );
if ( isset( $options ) && isset( $options[ "{$prefix}image" ] ) ) {
$thumbnail = $options[ "{$prefix}image" ];
if ( ctype_digit( (string) $thumbnail ) || ( 'post' == $thumbnail ) ) {
if ( 'post' == $thumbnail ) {
$thumbnail = $images['post1'];
} elseif ( ! empty( $legacy[ $thumbnail ] ) ) {
$thumbnail = $legacy[ $thumbnail ];
}
}
$options[ "{$prefix}image" ] = $thumbnail;
}
if ( empty( $options[ $prefix . 'image' ] ) ) {
$img = array_keys( $images );
if ( ! empty( $img ) && ! empty( $img[1] ) ) {
$options[ $prefix . 'image' ] = $img[1];
}
}
}
return $options;
}
/**
* Applies filter to module settings.
*
* @since 2.3.11
* @since 2.4.14 Added filter for description and title placeholders.
* @since 2.3.15 do_shortcode on description.
*
* @see [plugin]\admin\aioseop_module_class.php > display_options()
*/
function filter_settings( $settings, $location, $current ) {
global $aiosp, $post;
if ( 'opengraph' == $location || 'settings' == $location ) {
$prefix = $this->get_prefix( $location ) . $location . '_';
if ( 'opengraph' == $location ) {
return $settings;
}
if ( 'settings' == $location ) {
list( $legacy, $settings[ $prefix . 'image' ]['initial_options'] ) = $this->get_all_images( $current );
$opts = array( 'title', 'desc' );
$current_post_type = get_post_type();
if ( isset( $this->options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ] ) ) {
$flat_type_list = array();
foreach ( $this->fb_object_types as $k => $v ) {
if ( is_array( $v ) ) {
$flat_type_list = array_merge( $flat_type_list, $v );
} else {
$flat_type_list[ $k ] = $v;
}
}
$default_fb_type = $this->options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ];
// https://github.com/awesomemotive/all-in-one-seo-pack/issues/1013
// if 'blog' is the selected type but because it is no longer a schema type, we use 'website' instead.
if ( 'blog' === $default_fb_type ) {
$default_fb_type = 'website';
}
if ( isset( $flat_type_list[ $default_fb_type ] ) ) {
$default_fb_type = $flat_type_list[ $default_fb_type ];
}
$settings[ $prefix . 'category' ]['initial_options'] = array_merge(
array(
$this->options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ] => __( 'Default ', 'all-in-one-seo-pack' ) . ' - ' . $default_fb_type,
),
$settings[ $prefix . 'category' ]['initial_options']
);
}
if ( isset( $this->options['aiosp_opengraph_defcard'] ) ) {
$settings[ $prefix . 'setcard' ]['default'] = $this->options['aiosp_opengraph_defcard'];
}
$info = $aiosp->get_page_snippet_info();
$title = $info['title'];
$description = $info['description'];
// Description options.
if ( is_object( $post ) ) {
// Always show excerpt.
$description = empty( $this->options['aiosp_opengraph_generate_descriptions'] )
? $aiosp->trim_excerpt_without_filters(
$aiosp->internationalize( preg_replace( '/\s+/', ' ', $post->post_excerpt ) ),
200
)
: $aiosp->trim_excerpt_without_filters(
$aiosp->internationalize( preg_replace( '/\s+/', ' ', $post->post_content ) ),
200
);
}
// #1308 - we want to make sure we are ignoring php version only in the admin area
// while editing the post, so that it does not impact #932.
$screen = get_current_screen();
$ignore_php_version = is_admin() && isset( $screen->id ) && 'post' == $screen->id;
// Add filters.
$description = apply_filters( 'aioseop_description', $description, false, $ignore_php_version );
// Add placholders.
$settings[ "{$prefix}title" ]['placeholder'] = apply_filters( 'aioseop_opengraph_placeholder', $title );
$settings[ "{$prefix}desc" ]['placeholder'] = apply_filters( 'aioseop_opengraph_placeholder', $description );
}
if ( isset( $current[ $prefix . 'setmeta' ] ) && $current[ $prefix . 'setmeta' ] ) {
foreach ( $opts as $opt ) {
if ( isset( $settings[ $prefix . $opt ] ) ) {
$settings[ $prefix . $opt ]['type'] = 'hidden';
$settings[ $prefix . $opt ]['label'] = 'none';
unset( $settings[ $prefix . $opt ]['count'] );
}
}
}
}
return $settings;
}
/**
* Applies filter to module options.
* These will display in the "Social Settings" object tab.
* filter:{prefix}override_options
*
* @since 2.3.11
* @since 2.4.14 Overrides empty og:type values.
*
* @see [plugin]\admin\aioseop_module_class.php > display_options()
*
* @global array $aioseop_options Plugin options.
*
* @param array $options Current options.
* @param string $location Location where filter is called.
* @param array $settings Settings.
*
* @return array
*/
function override_options( $options, $location, $settings ) {
global $aioseop_options;
// Prepare default and prefix.
$prefix = $this->get_prefix( $location ) . $location . '_';
$opts = array();
foreach ( $settings as $k => $v ) {
if ( $v['save'] ) {
$opts[ $k ] = $v['default'];
}
}
foreach ( $options as $k => $v ) {
switch ( $k ) {
case $prefix . 'category':
if ( empty( $v ) ) {
// Get post type.
$type = isset( get_current_screen()->post_type )
? get_current_screen()->post_type
: null;
// Assign default from plugin options.
if ( ! empty( $type )
&& isset( $aioseop_options['modules'] )
&& isset( $aioseop_options['modules']['aiosp_opengraph_options'] )
&& isset( $aioseop_options['modules']['aiosp_opengraph_options'][ 'aiosp_opengraph_' . $type . '_fb_object_type' ] )
) {
$options[ $prefix . 'category' ] =
$aioseop_options['modules']['aiosp_opengraph_options'][ 'aiosp_opengraph_' . $type . '_fb_object_type' ];
}
}
break;
}
if ( null === $v ) {
unset( $options[ $k ] );
}
}
$options = wp_parse_args( $options, $opts );
// @issue #1013 ( https://github.com/awesomemotive/all-in-one-seo-pack/issues/1013 ).
$post_types = $this->get_post_type_titles();
foreach ( $post_types as $slug => $name ) {
$field = 'aiosp_opengraph_' . $slug . '_fb_object_type';
if ( isset( $options[ $field ] ) && 'blog' === $options[ $field ] ) {
$options[ $field ] = 'website';
}
}
return $options;
}
/**
* Applies filter to metabox settings before they are saved.
* Sets custom as default if a custom image is uploaded.
* filter:{prefix}filter_metabox_options
* filter:{prefix}filter_term_metabox_options
*
* @since 2.3.11
* @since 2.4.14 Fixes for aioseop-pro #67 and other bugs found.
*
* @see [plugin]\admin\aioseop_module_class.php > save_post_data()
* @see [this file] > save_tax_data()
*
* @param array $options List of current options.
* @param string $location Location where filter is called.
* @param int $id Either post_id or term_id.
*
* @return array
*/
function filter_metabox_options( $options, $location, $post_id ) {
if ( 'settings' == $location ) {
$prefix = $this->get_prefix( $location ) . $location . '_';
if ( isset( $options[ $prefix . 'customimg_checker' ] )
&& $options[ $prefix . 'customimg_checker' ]
) {
$options[ $prefix . 'image' ] = $options[ $prefix . 'customimg' ];
}
}
return $options;
}
/** Custom settings **/
function display_custom_options( $buf, $args ) {
if ( 'aiosp_opengraph_scan_header' == $args['name'] ) {
$buf .= '';
}
return $buf;
}
function add_attributes( $output ) {
// avoid having duplicate meta tags.
$type = $this->type;
if ( empty( $type ) ) {
$type = 'website';
}
$schema_types = array(
'album' => 'MusicAlbum',
'article' => 'Article',
'bar' => 'BarOrPub',
'blog' => 'Blog',
'book' => 'Book',
'cafe' => 'CafeOrCoffeeShop',
'city' => 'City',
'country' => 'Country',
'episode' => 'Episode',
'food' => 'FoodEvent',
'game' => 'Game',
'hotel' => 'Hotel',
'landmark' => 'LandmarksOrHistoricalBuildings',
'movie' => 'Movie',
'product' => 'Product',
'profile' => 'ProfilePage',
'restaurant' => 'Restaurant',
'school' => 'School',
'sport' => 'SportsEvent',
'website' => 'WebSite',
);
if ( ! empty( $schema_types[ $type ] ) ) {
$type = $schema_types[ $type ];
} else {
$type = 'WebSite';
}
$attributes = apply_filters(
$this->prefix . 'attributes',
array(
'prefix="og: https://ogp.me/ns#"',
)
);
foreach ( $attributes as $attr ) {
if ( strpos( $output, $attr ) === false ) {
$output .= "\n\t$attr ";
}
}
return $output;
}
/**
* Add our social meta.
*
* @since 1.0.0
* @since 2.3.11.5 Support for multiple fb_admins.
* @since 2.3.13 Adds filter:aioseop_description on description.
* @since 2.4.14 Fixes for aioseop-pro #67.
* @since 2.3.15 Always do_shortcode on descriptions, removed for titles.
*
* @global object $post Current WP_Post object.
* @global object $aiosp All in one seo plugin object.
* @global array $aioseop_options All in one seo plugin options.
* @global object $wp_query WP_Query global instance.
*/
function add_meta() {
global $post, $aiosp, $aioseop_options, $wp_query;
$metabox = $this->get_current_options( array(), 'settings' );
$key = $this->options['aiosp_opengraph_key'];
$key = $this->options['aiosp_opengraph_key'];
$dimg = $this->options['aiosp_opengraph_dimg'];
$current_post_type = get_post_type();
$title = '';
$description = '';
$image = '';
$video = '';
$type = $this->type;
$sitename = $this->options['aiosp_opengraph_sitename'];
$tag = '';
// for some reason, options is not populated correctly during unit tests.
if ( defined( 'AIOSEOP_UNIT_TESTING' ) ) {
$this->options = $aioseop_options['modules'][ $this->prefix . 'options' ];
}
$appid = isset( $this->options['aiosp_opengraph_appid'] ) ? $this->options['aiosp_opengraph_appid'] : '';
if ( ! empty( $aioseop_options['aiosp_hide_paginated_descriptions'] ) ) {
$first_page = false;
if ( 2 > aioseop_get_page_number() ) {
$first_page = true;
}
} else {
$first_page = true;
}
$url = $aiosp->aiosp_mrt_get_url( $wp_query );
$url = apply_filters( 'aioseop_canonical_url', $url );
// this will collect the extra values that are required outside the below IF block.
$extra_params = array();
$setmeta = $this->options['aiosp_opengraph_setmeta'];
if ( is_front_page() ) {
$title = $this->options['aiosp_opengraph_hometitle'];
if ( $first_page ) {
$description = $this->options['aiosp_opengraph_description'];
if ( empty( $description ) ) {
$description = get_bloginfo( 'description' );
}
}
if ( ! empty( $this->options['aiosp_opengraph_homeimage'] ) ) {
$image = $this->options['aiosp_opengraph_homeimage'];
} else {
$image = $this->options['aiosp_opengraph_dimg'];
}
/* If Use AIOSEO Title and Desc Selected */
if ( $setmeta ) {
$title = $aiosp->wp_title();
if ( $first_page ) {
$description = $aiosp->get_aioseop_description( $post );
}
}
/* Add some defaults */
if ( empty( $title ) ) {
$title = get_bloginfo( 'name' );
}
if ( empty( $sitename ) ) {
$sitename = get_bloginfo( 'name' );
}
if ( empty( $description ) && $first_page && ! empty( $post ) && ! post_password_required( $post ) ) {
if ( ! empty( $post->post_content ) || ! empty( $post->post_excerpt ) ) {
$description = $aiosp->trim_excerpt_without_filters( $aiosp->internationalize( preg_replace( '/\s+/', ' ', $post->post_excerpt ) ), 200 );
if ( ! empty( $this->options['aiosp_opengraph_generate_descriptions'] ) ) {
$description = $aiosp->trim_excerpt_without_filters( $aiosp->internationalize( preg_replace( '/\s+/', ' ', $post->post_content ) ), 200 );
}
}
}
if ( empty( $description ) && $first_page ) {
$description = get_bloginfo( 'description' );
}
} elseif (
is_singular() && $this->option_isset( 'types' ) &&
is_array( $this->options['aiosp_opengraph_types'] ) &&
in_array( $current_post_type, $this->options['aiosp_opengraph_types'] )
) {
if ( 'article' == $type ) {
if ( ! empty( $metabox['aioseop_opengraph_settings_section'] ) ) {
$section = $metabox['aioseop_opengraph_settings_section'];
}
if ( ! empty( $metabox['aioseop_opengraph_settings_tag'] ) ) {
$tag = $metabox['aioseop_opengraph_settings_tag'];
}
if ( ! empty( $this->options['aiosp_opengraph_facebook_publisher'] ) ) {
$publisher = $this->options['aiosp_opengraph_facebook_publisher'];
}
}
if ( ! empty( $this->options['aiosp_opengraph_twitter_domain'] ) ) {
$domain = $this->options['aiosp_opengraph_twitter_domain'];
}
if ( 'article' == $type && ! empty( $post ) ) {
if ( isset( $post->post_author ) && ! empty( $this->options['aiosp_opengraph_facebook_author'] ) ) {
$author = get_the_author_meta( 'facebook', $post->post_author );
}
if ( isset( $post->post_date_gmt ) ) {
$published_time = date( 'Y-m-d\TH:i:s\Z', mysql2date( 'U', $post->post_date_gmt ) );
}
if ( isset( $post->post_modified_gmt ) ) {
$modified_time = date( 'Y-m-d\TH:i:s\Z', mysql2date( 'U', $post->post_modified_gmt ) );
}
}
$image = $metabox['aioseop_opengraph_settings_image'];
$video = $metabox['aioseop_opengraph_settings_video'];
$title = $metabox['aioseop_opengraph_settings_title'];
$description = $metabox['aioseop_opengraph_settings_desc'];
// Let's make a note of manually provided descriptions/titles as they might need special handling.
// @issue #808 ( https://github.com/awesomemotive/all-in-one-seo-pack/issues/808 ).
// @issue #2296 ( https://github.com/awesomemotive/all-in-one-seo-pack/issues/2296 ).
$title_from_main_settings = trim( strip_tags( get_post_meta( $post->ID, '_aioseop_title', true ) ) );
$desc_from_main_settings = trim( strip_tags( get_post_meta( $post->ID, '_aioseop_description', true ) ) );
if ( empty( $title ) && empty( $title_from_main_settings ) ) {
$extra_params['auto_generate_title'] = true;
}
if ( empty( $description ) && empty( $desc_from_main_settings ) ) {
$extra_params['auto_generate_desc'] = true;
}
/* Add AIOSEO variables if Site Title and Desc from AIOSEOP not selected */
global $aiosp;
if ( empty( $title ) ) {
$title = $aiosp->wp_title();
}
if ( empty( $description ) ) {
$description = trim( strip_tags( get_post_meta( $post->ID, '_aioseop_description', true ) ) );
}
/* Add default title */
if ( empty( $title ) ) {
$title = get_the_title();
}
// Add default description.
if ( empty( $description ) && ! post_password_required( $post ) ) {
$description = $post->post_excerpt;
if ( $this->options['aiosp_opengraph_generate_descriptions'] || empty( $description ) ) {
if ( ! AIOSEOPPRO || ( AIOSEOPPRO && apply_filters( $this->prefix . 'generate_descriptions_from_content', true, $post ) ) ) {
$description = $post->post_content;
} else {
$description = $post->post_excerpt;
}
}
}
if ( empty( $type ) ) {
$type = 'article';
}
} elseif ( AIOSEOPPRO && ( is_category() || is_tag() || is_tax() ) ) {
if ( isset( $this->options['aioseop_opengraph_settings_category'] ) ) {
$type = $this->options['aioseop_opengraph_settings_category'];
}
if ( isset( $metabox['aioseop_opengraph_settings_category'] ) ) {
$type = $metabox['aioseop_opengraph_settings_category'];
}
if ( 'article' == $type ) {
if ( ! empty( $metabox['aioseop_opengraph_settings_section'] ) ) {
$section = $metabox['aioseop_opengraph_settings_section'];
}
if ( ! empty( $metabox['aioseop_opengraph_settings_tag'] ) ) {
$tag = $metabox['aioseop_opengraph_settings_tag'];
}
if ( ! empty( $this->options['aiosp_opengraph_facebook_publisher'] ) ) {
$publisher = $this->options['aiosp_opengraph_facebook_publisher'];
}
}
if ( ! empty( $this->options['aiosp_opengraph_twitter_domain'] ) ) {
$domain = $this->options['aiosp_opengraph_twitter_domain'];
}
if ( 'article' == $type && ! empty( $post ) ) {
if ( isset( $post->post_author ) && ! empty( $this->options['aiosp_opengraph_facebook_author'] ) ) {
$author = get_the_author_meta( 'facebook', $post->post_author );
}
if ( isset( $post->post_date_gmt ) ) {
$published_time = date( 'Y-m-d\TH:i:s\Z', mysql2date( 'U', $post->post_date_gmt ) );
}
if ( isset( $post->post_modified_gmt ) ) {
$modified_time = date( 'Y-m-d\TH:i:s\Z', mysql2date( 'U', $post->post_modified_gmt ) );
}
}
$image = $metabox['aioseop_opengraph_settings_image'];
$video = $metabox['aioseop_opengraph_settings_video'];
$title = $metabox['aioseop_opengraph_settings_title'];
$description = $metabox['aioseop_opengraph_settings_desc'];
/* Add AIOSEO variables if Site Title and Desc from AIOSEOP not selected */
global $aiosp;
if ( empty( $title ) ) {
$title = $aiosp->wp_title();
}
if ( empty( $description ) ) {
$term_id = isset( $_GET['tag_ID'] ) ? (int) $_GET['tag_ID'] : 0;
$term_id = $term_id ? $term_id : get_queried_object()->term_id;
$description = trim( strip_tags( get_term_meta( $term_id, '_aioseop_description', true ) ) );
}
// Add default title.
if ( empty( $title ) ) {
$title = get_the_title();
}
// Add default description.
if ( empty( $description ) && ! post_password_required( $post ) ) {
$description = get_queried_object()->description;
}
if ( empty( $type ) ) {
// Pro Issue #321 ( https://github.com/awesomemotive/aioseop-pro/issues/321 ).
if ( AIOSEOPPRO && ( is_category() || is_tag() || is_tax() ) ) {
$og_options = $aioseop_options['modules'][ $this->prefix . 'options' ];
$current_post_type = get_post_type();
// check if the post type's object type is set.
if ( isset( $og_options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ] ) ) {
$type = $og_options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ];
} elseif ( in_array( $current_post_type, array( 'post', 'page' ) ) ) {
$type = 'article';
}
} else {
$type = 'website';
}
}
} elseif ( is_home() && ! is_front_page() ) {
// This is the blog page but not the homepage.
global $aiosp;
$image = $metabox['aioseop_opengraph_settings_image'];
$video = $metabox['aioseop_opengraph_settings_video'];
$title = $metabox['aioseop_opengraph_settings_title'];
$description = $metabox['aioseop_opengraph_settings_desc'];
if ( empty( $description ) ) {
// If there's not social description, fall back to the SEO description.
$description = trim( strip_tags( get_post_meta( get_option( 'page_for_posts' ), '_aioseop_description', true ) ) );
}
if ( empty( $title ) ) {
$title = $aiosp->wp_title();
}
} else {
return;
}
if ( 'article' === $type && ! empty( $post ) && is_singular() ) {
if ( ! empty( $this->options['aiosp_opengraph_gen_tags'] ) ) {
if ( ! empty( $this->options['aiosp_opengraph_gen_keywords'] ) ) {
$keywords = $aiosp->get_main_keywords();
$keywords = $this->apply_cf_fields( $keywords );
$keywords = apply_filters( 'aioseop_keywords', $keywords );
if ( ! empty( $keywords ) && ! empty( $tag ) ) {
$tag .= ',' . $keywords;
} elseif ( empty( $tag ) ) {
$tag = $keywords;
}
}
$tag = $aiosp->keyword_string_to_list( $tag );
if ( ! empty( $this->options['aiosp_opengraph_gen_categories'] ) ) {
$tag = array_merge( $tag, $aiosp->get_all_categories( $post->ID ) );
}
if ( ! empty( $this->options['aiosp_opengraph_gen_post_tags'] ) ) {
$tag = array_merge( $tag, $aiosp->get_all_tags( $post->ID ) );
}
}
if ( ! empty( $tag ) ) {
$tag = $aiosp->clean_keyword_list( $tag );
}
}
if ( ! empty( $this->options['aiosp_opengraph_title_shortcodes'] ) ) {
$title = aioseop_do_shortcodes( $title );
}
if ( ! empty( $description ) ) {
$description = $aiosp->internationalize( preg_replace( '/\s+/', ' ', $description ) );
if ( ! empty( $this->options['aiosp_opengraph_description_shortcodes'] ) ) {
$description = aioseop_do_shortcodes( $description );
}
if ( ! empty( $this->options['aiosp_opengraph_generate_descriptions'] ) && $this->options['aiosp_opengraph_generate_descriptions'] ) {
$description = $aiosp->trim_excerpt_without_filters( $description, 200 );
} else {
// User input still needs to be run through this function to strip tags.
$description = $aiosp->trim_excerpt_without_filters( $description, 99999 );
}
}
$title = $this->apply_cf_fields( $title );
$description = $this->apply_cf_fields( $description );
/* Data Validation */
$title = strip_tags( esc_attr( $title ) );
$sitename = strip_tags( esc_attr( $sitename ) );
$description = strip_tags( esc_attr( $description ) );
// Apply last filters.
$description = apply_filters( 'aioseop_description', $description );
/* *** HANDLE IMAGES *** */
$thumbnail = $image;
// Add user supplied default image.
if ( empty( $thumbnail ) ) {
if ( empty( $this->options['aiosp_opengraph_defimg'] ) ) {
$thumbnail = $this->options['aiosp_opengraph_dimg'];
if ( aioseop_get_site_logo_url() &&
( AIOSEOP_PLUGIN_IMAGES_URL . 'default-user-image.png' === $thumbnail ) || empty( $thumbnail ) ) {
$thumbnail = aioseop_get_site_logo_url();
}
} else {
$img_type = $this->options['aiosp_opengraph_defimg'];
if ( ! empty( $post ) ) {
/**
* Customize the type of image per post/post_type.
*
* @param string $img_type Type of image source.
* @param WP_Post $post The global post.
* @param string $type The OG Type.
*/
$img_type = apply_filters( 'aiosp_opengraph_default_image_type', $img_type, $post, $type );
}
switch ( $img_type ) {
case 'featured':
$thumbnail = $this->get_the_image_by_post_thumbnail();
break;
case 'attach':
$thumbnail = $this->get_the_image_by_attachment();
break;
case 'content':
$thumbnail = $this->get_the_image_by_scan();
break;
case 'custom':
$meta_key = $this->options['aiosp_opengraph_meta_key'];
if ( ! empty( $meta_key ) && ! empty( $post ) ) {
$meta_key = explode( ',', $meta_key );
$thumbnail = $this->get_the_image_by_meta_key(
array(
'post_id' => $post->ID,
'meta_key' => $meta_key,
)
);
}
break;
case 'auto':
$thumbnail = $this->get_the_image();
break;
case 'author':
$thumbnail = $this->get_the_image_by_author();
break;
default:
$thumbnail = $this->options['aiosp_opengraph_dimg'];
}
}
}
if ( empty( $thumbnail ) ) {
$thumbnail = $this->options['aiosp_opengraph_dimg'];
if ( aioseop_get_site_logo_url() &&
( AIOSEOP_PLUGIN_IMAGES_URL . 'default-user-image.png' === $thumbnail ) || empty( $thumbnail ) ) {
$thumbnail = aioseop_get_site_logo_url();
}
if ( ! empty( $post ) ) {
/**
* Customize the default image per post/post_type.
*
* @param string $thumbnail The image URL.
* @param WP_Post $post The global post.
* @param string $type The OG Type.
*/
$thumbnail = apply_filters( 'aiosp_opengraph_default_image', $thumbnail, $post, $type );
}
}
if ( ! empty( $thumbnail ) ) {
$thumbnail = esc_url( $thumbnail );
$thumbnail = set_url_scheme( $thumbnail );
}
/* *** HANDLE IMAGE DIMENSIONS *** */
// TODO When Image ID is available, use meta data for image dimensions.
$width = '';
$height = '';
if ( ! empty( $thumbnail ) ) {
if ( ! empty( $metabox['aioseop_opengraph_settings_imagewidth'] ) ) {
$width = $metabox['aioseop_opengraph_settings_imagewidth'];
}
if ( ! empty( $metabox['aioseop_opengraph_settings_imageheight'] ) ) {
$height = $metabox['aioseop_opengraph_settings_imageheight'];
}
if ( empty( $width ) && ! empty( $this->options['aiosp_opengraph_dimgwidth'] ) ) {
$width = $this->options['aiosp_opengraph_dimgwidth'];
}
if ( empty( $height ) && ! empty( $this->options['aiosp_opengraph_dimgheight'] ) ) {
$height = $this->options['aiosp_opengraph_dimgheight'];
}
}
/* *** HANDLE VIDEO *** */
if ( ! empty( $video ) ) {
if ( ! empty( $metabox['aioseop_opengraph_settings_videowidth'] ) ) {
$videowidth = $metabox['aioseop_opengraph_settings_videowidth'];
}
if ( ! empty( $metabox['aioseop_opengraph_settings_videoheight'] ) ) {
$videoheight = $metabox['aioseop_opengraph_settings_videoheight'];
}
}
/* *** HANDLE TWITTER CARD *** */
$card = 'summary';
$site = '';
$domain = '';
$creator = '';
$twitter_thumbnail = '';
if ( ! empty( $this->options['aiosp_opengraph_defcard'] ) ) {
$card = $this->options['aiosp_opengraph_defcard'];
}
if ( ! empty( $metabox['aioseop_opengraph_settings_setcard'] ) ) {
$card = $metabox['aioseop_opengraph_settings_setcard'];
}
// support for changing legacy twitter cardtype-photo to summary large image.
if ( 'photo' == $card ) {
$card = 'summary_large_image';
}
if ( ! empty( $this->options['aiosp_opengraph_twitter_site'] ) ) {
$site = $this->options['aiosp_opengraph_twitter_site'];
$site = AIOSEOP_Opengraph_Public::prepare_twitter_username( $site );
}
if ( ! empty( $this->options['aiosp_opengraph_twitter_domain'] ) ) {
$domain = $this->options['aiosp_opengraph_twitter_domain'];
}
if ( ! empty( $post ) && isset( $post->post_author ) && ! empty( $this->options['aiosp_opengraph_twitter_creator'] ) ) {
$creator = get_the_author_meta( 'twitter', $post->post_author );
$creator = AIOSEOP_Opengraph_Public::prepare_twitter_username( $creator );
}
if ( isset( $metabox['aioseop_opengraph_settings_customimg_twitter'] ) && ! empty( $metabox['aioseop_opengraph_settings_customimg_twitter'] ) ) {
// Set Twitter image from custom.
$twitter_thumbnail = set_url_scheme( $metabox['aioseop_opengraph_settings_customimg_twitter'] );
} elseif ( ! empty( $thumbnail ) ) {
$twitter_thumbnail = $thumbnail; // Default Twitter image if custom isn't set.
}
/* *** COLLECT DATA *** */
$meta = array(
'facebook' => array(
'og:type' => $type,
'og:title' => $title,
'og:description' => $description,
'og:url' => $url,
'og:site_name' => $sitename,
'og:image' => $thumbnail,
'og:image:width' => $width,
'og:image:height' => $height,
'og:video' => isset( $video ) ? $video : '',
'og:video:width' => isset( $videowidth ) ? $videowidth : '',
'og:video:height' => isset( $videoheight ) ? $videoheight : '',
'fb:admins' => $key,
'fb:app_id' => $appid,
'article:section' => isset( $section ) ? $section : '',
'article:tag' => $tag,
'article:published_time' => isset( $published_time ) ? $published_time : '',
'article:modified_time' => isset( $modified_time ) ? $modified_time : '',
'article:publisher' => isset( $publisher ) ? $publisher : '',
'article:author' => isset( $author ) ? $author : '',
),
'twitter' => array(
'twitter:card' => $card,
'twitter:site' => $site,
'twitter:creator' => $creator,
'twitter:domain' => $domain,
'twitter:title' => $title,
'twitter:description' => $description,
'twitter:image' => $twitter_thumbnail,
),
);
// Issue #1848 ( https://github.com/awesomemotive/all-in-one-seo-pack/issues/1848 ).
// Issue #2867 ( https://github.com/awesomemotive/all-in-one-seo-pack/issues/2867 ).
if ( is_ssl() ) {
$meta['facebook'] += array( 'og:image:secure_url' => $thumbnail );
$meta['facebook'] += array( 'og:video:secure_url' => $video );
}
/* *** RENDER DATA *** */
$tags = array(
'facebook' => array(
'name' => 'property',
'value' => 'content',
),
'twitter' => array(
'name' => 'name',
'value' => 'content',
),
);
// TODO Remove when `$tmp_meta_slug` is removed from 'aiosp_opengraph_meta' filter.
$meta_keys = $this->get_reference_meta_keys();
foreach ( $meta as $k1_social_network => $v1_data ) {
foreach ( $v1_data as $k2_meta_tag => $v2_meta_value ) {
$filtered_value = $this->handle_meta_tag( $v2_meta_value, $k1_social_network, $k2_meta_tag, $extra_params );
$tmp_meta_slug = $meta_keys[ $k1_social_network ][ $k2_meta_tag ];
/**
* Process meta tags for their idiosyncracies.
*
* @todo Remove `$tmp_meta_slug` and remove `$meta_keys`.
*
* @since 3.0
* @since 3.3 Change variable names for readability.
*
* @param string $filtered_value The value that is proposed to be shown in the tag.
* @param string $k1_social_network The social network.
* @param string $tmp_meta_slug The meta tag without the network name prefixed.
* @param string $k2_meta_tag The meta tag with the network name prefixed. This is not always $network:$meta_tag.
* @param array $extra_params Extra parameters that might be required to process the meta tag.
*/
$filtered_value = apply_filters( 'aiosp_opengraph_meta', $filtered_value, $k1_social_network, $tmp_meta_slug, $k2_meta_tag, $extra_params );
if ( ! empty( $filtered_value ) ) {
if ( ! is_array( $filtered_value ) ) {
$filtered_value = array( $filtered_value );
}
/**
* This is to accommodate multiple fb:admins on separate lines.
*
* @TODO Eventually we'll want to put this in its own function so things like images work too.
*/
if ( 'fb:admins' === $k2_meta_tag ) {
$fbadmins = explode( ',', str_replace( ' ', '', $filtered_value[0] ) ); // Trim spaces then turn comma-separated values into an array.
foreach ( $fbadmins as $fbadmin ) {
echo '' . "\n";
}
} else {
// For everything else.
foreach ( $filtered_value as $f ) {
// #1363: use esc_attr( $f ) instead of htmlspecialchars_decode( $f, ENT_QUOTES )
echo '' . "\n";
}
}
}
}
}
}
/**
* Process meta tags for specific idiosyncrasies.
*
* @since 3.0
*
* @param string $value The value that is proposed to be shown in the tag.
* @param string $network The social network.
* @param string $meta_tag The meta tag without the network name prefixed.
* @param array $extra_params Extra parameters that might be required to process the meta tag.
* @return string The final value that will be shown.
*/
function handle_meta_tag( $value, $network, $meta_tag, $extra_params ) {
switch ( $meta_tag ) {
case 'type':
// @issue 1013 ( https://github.com/awesomemotive/all-in-one-seo-pack/issues/1013 ).
if ( 'blog' === $value ) {
$value = 'website';
}
break;
default:
break;
}
// TODO Remove when `$tmp_meta_slug` is removed from 'aiosp_opengraph_disable_meta_tag_truncation' filter.
$meta_keys = $this->get_reference_meta_keys();
$tmp_meta_slug = $meta_keys[ $network ][ $meta_tag ];
/**
* Disables truncation of meta tags. Return true to shortcircuit and disable truncation.
*
* @todo Remove `$tmp_meta_slug` and remove `$meta_keys`.
*
* @since 3.0
*
* @issue https://github.com/awesomemotive/all-in-one-seo-pack/issues/808
* @issue https://github.com/awesomemotive/all-in-one-seo-pack/issues/2296
* @link https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup.html
*
* @param bool The value that is proposed to be shown in the tag.
* @param string $network The social network.
* @param string $tmp_meta_slug The meta tag without the network name prefixed.
* @param string $meta_tag The meta tag with the network name prefixed. This is not always $network:$meta_tag.
*/
if ( true === apply_filters( $this->prefix . 'disable_meta_tag_truncation', false, $network, $tmp_meta_slug, $meta_tag ) ) {
return $value;
}
if ( isset( $extra_params['auto_generate_desc'] ) && $extra_params['auto_generate_desc'] ) {
switch ( $meta_tag ) {
case 'twitter:title':
$value = trim( AIOSEOP_PHP_Functions::substr( $value, 0, 70 ) );
break;
case 'og:description':
case 'twitter:description':
$value = trim( AIOSEOP_PHP_Functions::substr( $value, 0, 200 ) );
break;
default:
break;
}
}
return $value;
}
/**
* Get Reference Meta Keys Array.
*
* TODO Remove when `$tmp_meta_slug` is removed from 'aiosp_opengraph_disable_meta_tag_truncation' & 'aiosp_opengraph_meta' filter.
*
* @since 3.3
*
* @return array
*/
private function get_reference_meta_keys() {
$meta_keys = array(
'facebook' => array(
'og:type' => 'type',
'og:title' => 'title',
'og:description' => 'description',
'og:url' => 'url',
'og:site_name' => 'sitename',
'og:image' => 'thumbnail',
'og:image:width' => 'width',
'og:image:height' => 'height',
'og:video' => 'video',
'og:video:width' => 'videowidth',
'og:video:height' => 'videoheight',
'fb:admins' => 'key',
'fb:app_id' => 'appid',
'article:section' => 'section',
'article:tag' => 'tag',
'article:published_time' => 'published_time',
'article:modified_time' => 'modified_time',
'article:publisher' => 'publisher',
'article:author' => 'author',
),
'twitter' => array(
'twitter:card' => 'card',
'twitter:site' => 'site',
'twitter:creator' => 'creator',
'twitter:domain' => 'domain',
'twitter:title' => 'title',
'twitter:description' => 'description',
'twitter:image' => 'twitter_thumbnail',
),
);
if ( is_ssl() ) {
$meta_keys['facebook'] += array( 'og:image:secure_url' => 'thumbnail_1' );
$meta_keys['facebook'] += array( 'og:video:secure_url' => 'video_1' );
}
return $meta_keys;
}
/**
* Do / adds opengraph properties to meta.
*
* @since 2.3.11
*
* @global array $aioseop_options AIOSEOP plugin options.
*/
public function do_opengraph() {
global $aioseop_options;
if ( ! empty( $aioseop_options )
&& ! empty( $aioseop_options['aiosp_schema_markup'] )
) {
add_filter( 'language_attributes', array( &$this, 'add_attributes' ) );
}
if ( ! wp_doing_ajax() ) {
add_action( 'aioseop_modules_wp_head', array( &$this, 'add_meta' ), 5 );
// Add social meta to AMP plugin.
if ( apply_filters( 'aioseop_enable_amp_social_meta', true ) === true ) {
add_action( 'amp_post_template_head', array( &$this, 'add_meta' ), 12 );
}
}
}
/**
* Set up types.
*
* @since ?
* @since 2.3.15 Change to website for homepage and blog post index page, default to object.
*/
function type_setup() {
$this->type = 'object'; // Default to type object if we don't have some other rule.
if ( is_home() || is_front_page() ) {
$this->type = 'website'; // Home page and blog page should be website.
} elseif ( is_singular() && $this->option_isset( 'types' ) ) {
$metabox = $this->get_current_options( array(), 'settings' );
$current_post_type = get_post_type();
if ( ! empty( $metabox['aioseop_opengraph_settings_category'] ) ) {
$this->type = $metabox['aioseop_opengraph_settings_category'];
} elseif ( isset( $this->options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ] ) ) {
$this->type = $this->options[ "aiosp_opengraph_{$current_post_type}_fb_object_type" ];
}
}
}
/**
* Inits hooks and others for admin init.
* action:admin_init.
*
* @since 2.3.11
* @since 2.4.14 Refactored function name, and new filter added for defaults and missing term metabox.
*/
function admin_init() {
add_filter( $this->prefix . 'display_settings', array( &$this, 'filter_settings' ), 10, 3 );
add_filter( $this->prefix . 'override_options', array( &$this, 'override_options' ), 10, 3 );
add_filter(
$this->get_prefix( 'settings' ) . 'default_options',
array(
&$this,
'filter_default_options',
),
10,
2
);
add_filter(
$this->get_prefix( 'settings' ) . 'filter_metabox_options',
array(
&$this,
'filter_metabox_options',
),
10,
3
);
add_filter(
$this->get_prefix( 'settings' ) . 'filter_term_metabox_options',
array(
&$this,
'filter_metabox_options',
),
10,
3
);
$post_types = $this->get_post_type_titles();
$rempost = array(
'revision' => 1,
'nav_menu_item' => 1,
'custom_css' => 1,
'customize_changeset' => 1,
);
$post_types = array_diff_key( $post_types, $rempost );
$this->default_options['types']['initial_options'] = $post_types;
foreach ( $post_types as $slug => $name ) {
$field = $slug . '_fb_object_type';
$this->default_options[ $field ] = array(
'name' => "$name " . __( 'Object Type', 'all-in-one-seo-pack' ) . "
($slug)",
'type' => 'select',
'style' => '',
'initial_options' => $this->fb_object_types,
'default' => 'article',
'condshow' => array( 'aiosp_opengraph_types\[\]' => $slug ),
);
$this->locations['opengraph']['options'][] = $field;
$this->layout['facebook']['options'][] = $field;
}
$this->setting_options();
}
function get_all_images( $options = null, $p = null ) {
static $img = array();
if ( ! is_array( $options ) ) {
$options = array();
}
if ( ! empty( $this->options['aiosp_opengraph_meta_key'] ) ) {
$options['meta_key'] = $this->options['aiosp_opengraph_meta_key'];
}
if ( empty( $img ) ) {
$size = apply_filters( 'post_thumbnail_size', 'large' );
$default = $this->get_the_image_by_default();
if ( ! empty( $default ) ) {
$default = set_url_scheme( $default );
$img[ $default ] = 0;
}
$img = array_merge( $img, parent::get_all_images( $options, null ) );
}
if ( ! empty( $options ) && ! empty( $options['aioseop_opengraph_settings_customimg'] ) ) {
$img[ $options['aioseop_opengraph_settings_customimg'] ] = 'customimg';
}
if ( ! empty( $options ) && ! empty( $options['aioseop_opengraph_settings_customimg'] ) ) {
$img[ $options['aioseop_opengraph_settings_customimg'] ] = 'customimg';
$img[ $options['aioseop_opengraph_settings_customimg_twitter'] ] = 'customimg_twitter';
}
$author_img = $this->get_the_image_by_author( $p );
if ( $author_img ) {
$image['author'] = $author_img;
}
$image = array_flip( $img );
$images = array();
if ( ! empty( $image ) ) {
foreach ( $image as $k => $v ) {
$images[ $v ] = '
';
}
}
return array( $image, $images );
}
function get_the_image_by_author( $options = null, $p = null ) {
if ( null === $p ) {
global $post;
} else {
$post = $p;
}
if ( ! empty( $post ) && ! empty( $post->post_author ) ) {
$matches = array();
$get_avatar = get_avatar( $post->post_author, 300 );
if ( preg_match( "/src='(.*?)'/i", $get_avatar, $matches ) ) {
return $matches[1];
}
}
return false;
}
function get_the_image( $options = null, $p = null ) {
$meta_key = $this->options['aiosp_opengraph_meta_key'];
return parent::get_the_image( array( 'meta_key' => $meta_key ), $p );
}
function get_the_image_by_default( $args = array() ) {
return $this->options['aiosp_opengraph_dimg'];
}
function settings_update() {
}
/**
* Admin Enqueue Scripts
*
* Add hook in \All_in_One_SEO_Pack_Module::enqueue_metabox_scripts - Bails adding hook if not on target valid screen.
* Add hook in \All_in_One_SEO_Pack_Module::add_page_hooks - Function itself is hooked based on the screen_id/page.
*
* @since 2.9.2
*
* @see 'admin_enqueue_scripts' hook
* @link https://developer.wordpress.org/reference/hooks/admin_enqueue_scripts/
*
* @param string $hook_suffix
*/
public function admin_enqueue_scripts( $hook_suffix ) {
switch ( $hook_suffix ) {
case 'term.php':
// Legacy code for taxonomy terms until we refactor all title format related code.
$count_chars_data['aiosp_title_extra'] = 0;
wp_enqueue_script(
'aioseop-count-chars-old',
AIOSEOP_PLUGIN_URL . 'js/admin/aioseop-count-chars-old.js',
array(),
AIOSEOP_VERSION,
true
);
wp_enqueue_script(
'aioseop-opengraph-script',
AIOSEOP_PLUGIN_URL . 'js/modules/aioseop_opengraph.js',
array(),
AIOSEOP_VERSION
);
break;
default:
wp_enqueue_script(
'aioseop-opengraph-script',
AIOSEOP_PLUGIN_URL . 'js/modules/aioseop_opengraph.js',
array(),
AIOSEOP_VERSION
);
wp_enqueue_script(
'aioseop-count-chars',
AIOSEOP_PLUGIN_URL . 'js/admin/aioseop-count-chars.js',
array(),
AIOSEOP_VERSION
);
wp_enqueue_script(
'aioseop-admin-functions',
AIOSEOP_PLUGIN_URL . 'js/admin/aioseop-admin-functions.js',
array(),
AIOSEOP_VERSION
);
$count_chars_data = array(
'pluginDirName' => AIOSEOP_PLUGIN_DIRNAME,
'currentPage' => $hook_suffix,
);
wp_localize_script( 'aioseop-count-chars', 'aioseopOGCharacterCounter', $count_chars_data );
break;
}
// Dev note: If certain JS files need to be restricted to select screens, then follow concept
// used in `All_in_One_SEO_Pack::admin_enqueue_scripts()` (v2.9.1); which uses the `$hook_suffix`
// and a switch-case. This also helps prevent unnessecarily processing localized data when it isn't needed.
parent::admin_enqueue_scripts( $hook_suffix );
}
/**
* Enqueue our file upload scripts and styles.
*
* @param $hook
*/
function og_admin_enqueue_scripts( $hook ) {
if ( 'all-in-one-seo_page_aiosp_opengraph' != $hook && 'term.php' != $hook ) {
// Only enqueue if we're on the social module settings page.
return;
}
wp_enqueue_script( 'media-upload' );
wp_enqueue_script( 'thickbox' );
wp_enqueue_style( 'thickbox' );
wp_enqueue_media();
}
function save_tax_data( $term_id, $tt_id, $taxonomy ) {
static $update = false;
if ( $update ) {
return;
}
if ( null !== $this->locations ) {
foreach ( $this->locations as $k => $v ) {
if ( isset( $v['type'] ) && ( 'metabox' === $v['type'] ) ) {
$opts = $this->default_options( $k );
$options = array();
$update = false;
foreach ( $opts as $l => $o ) {
if ( isset( $_POST[ $l ] ) ) {
$options[ $l ] = stripslashes_deep( $_POST[ $l ] );
$options[ $l ] = esc_attr( $options[ $l ] );
$update = true;
}
}
if ( $update ) {
$prefix = $this->get_prefix( $k );
$options = apply_filters( $prefix . 'filter_term_metabox_options', $options, $k, $term_id );
foreach ( $options as $option ) {
$option = aioseop_sanitize( $option );
}
update_term_meta( $term_id, '_' . $prefix . $k, $options );
}
}
}
}
}
/**
* Returns the placeholder filtered and ready for DOM display.
* filter:aioseop_opengraph_placeholder
*
* @since 2.4.14
*
* @param mixed $placeholder Placeholder to be filtered.
* @param string $type Type of the value to be filtered.
*
* @return string
*/
public function filter_placeholder( $placeholder, $type = 'text' ) {
return strip_tags( trim( $placeholder ) );
}
/**
* Returns filtered default options.
* filter:{prefix}default_options
*
* @since 2.4.13
*
* @param array $options Default options.
* @param string $location Location.
*
* @return array
*/
public function filter_default_options( $options, $location ) {
if ( 'settings' === $location ) {
$prefix = $this->get_prefix( $location ) . $location . '_';
// Add image checker as default.
$options[ $prefix . 'customimg_checker' ] = 0;
}
return $options;
}
}
}