<?php
if ( ! class_exists( 'Facebook_Social_Plugin_Button_Settings' ) )
require_once( dirname(__FILE__) . '/settings-social-plugin-button.php' );
/**
* Site settings for the Facebook Like Button social plugin
*
* @since 1.1
*/
class Facebook_Like_Button_Settings extends Facebook_Social_Plugin_Button_Settings {
/**
* Setting page identifier.
*
* @since 1.1
*
* @var string
*/
const PAGE_SLUG = 'facebook-like-button';
/**
* Define our option array value.
*
* @since 1.1
*
* @var string
*/
const OPTION_NAME = 'facebook_like_button';
/**
* The hook suffix assigned by add_submenu_page()
*
* @since 1.1
*
* @var string
*/
protected $hook_suffix = '';
/**
* Initialize with an options array.
*
* @since 1.1
*
* @param array $options existing options
*/
public function __construct( $options = array() ) {
if ( is_array( $options ) && ! empty( $options ) )
$this->existing_options = $options;
else
$this->existing_options = array();
}
/**
* Evaluate the Facebook_Like_Button class file if it is not already loaded
*
* @since 1.1
*
* @return void
*/
public static function require_like_button_builder() {
if ( ! class_exists( 'Facebook_Like_Button' ) )
require_once( dirname( dirname(__FILE__) ) . '/social-plugins/class-facebook-like-button.php' );
}
/**
* Reference the social plugin by name.
*
* @since 1.1
* @return string social plugin name
*/
public static function social_plugin_name() {
return __( 'Like Button', 'facebook' );
}
/**
* Navigate to the settings page through the Facebook top-level menu item.
*
* @since 1.1
*
* @uses add_submenu_page()
* @param string $parent_slug Facebook top-level menu item slug
* @return string submenu hook suffix
*/
public static function add_submenu_item( $parent_slug ) {
$like_button_settings = new Facebook_Like_Button_Settings();
$hook_suffix = add_submenu_page(
$parent_slug,
self::social_plugin_name(),
self::social_plugin_name(),
'manage_options',
self::PAGE_SLUG,
array( &$like_button_settings, 'settings_page' )
);
if ( $hook_suffix ) {
$like_button_settings->hook_suffix = $hook_suffix;
register_setting( $hook_suffix, self::OPTION_NAME, array( 'Facebook_Like_Button_Settings', 'sanitize_options' ) );
add_action( 'load-' . $hook_suffix, array( &$like_button_settings, 'onload' ) );
}
return $hook_suffix;
}
/**
* Load stored options and scripts on settings page view.
*
* @since 1.1
*
* @return void
*/
public function onload() {
$options = get_option( self::OPTION_NAME );
if ( ! is_array( $options ) )
$options = array();
$this->existing_options = $options;
$this->settings_api_init();
}
/**
* Load the page.
*
* @since 1.1
*
* @return void
*/
public function settings_page() {
if ( ! isset( $this->hook_suffix ) )
return;
Facebook_Settings::settings_page_template( $this->hook_suffix, sprintf( __( '%s Settings', 'facebook' ), self::social_plugin_name() ) );
}
/**
* Hook into the settings API.
*
* @since 1.1
*
* @uses add_settings_section()
* @uses add_settings_field()
* @return void
*/
private function settings_api_init() {
if ( ! isset( $this->hook_suffix ) )
return;
$section = 'facebook-like-button';
add_settings_section(
$section,
'', // no title for main section
array( &$this, 'section_header' ),
$this->hook_suffix
);
/* when, where */
add_settings_field(
'facebook-like-show-on',
_x( 'Show on', 'Display the social plugin in specific areas of a website', 'facebook' ),
array( &$this, 'display_show_on' ),
$this->hook_suffix,
$section
);
add_settings_field(
'facebook-like-position',
_x( 'Position', 'Desired position of a Facebook social plugin relative to main post content.', 'facebook' ),
array( &$this, 'display_position' ),
$this->hook_suffix,
$section,
array( 'label_for' => 'facebook-like-position' )
);
/* like button options */
add_settings_field(
'facebook-like-share',
__( 'Share Button', 'facebook' ),
array( &$this, 'display_share' ),
$this->hook_suffix,
$section,
array( 'label_for' => 'facebook-like-share' )
);
add_settings_field(
'facebook-like-layout',
_x( 'Layout', 'Positioning of components of a Facebook social plugin relative to each other. Example layouts include button before interaction count or interaction count above button.', 'facebook' ),
array( &$this, 'display_layout' ),
$this->hook_suffix,
$section
);
add_settings_field(
'facebook-like-show-faces',
_x( 'Show faces', 'Show the faces of Facebook friends who have interacted with this object.', 'facebook' ),
array( &$this, 'display_show_faces' ),
$this->hook_suffix,
$section,
array( 'label_for' => 'facebook-like-show-faces' )
);
add_settings_field(
'facebook-like-width',
__( 'Width', 'facebook' ),
array( &$this, 'display_width' ),
$this->hook_suffix,
$section,
array( 'label_for' => 'facebook-like-width' )
);
add_settings_field(
'facebook-like-action',
__( 'Action', 'facebook' ),
array( &$this, 'display_action' ),
$this->hook_suffix,
$section
);
add_settings_field(
'facebook-like-font',
__( 'Font', 'facebook' ),
array( &$this, 'display_font' ),
$this->hook_suffix,
$section,
array( 'label_for' => 'facebook-like-font' )
);
add_settings_field(
'facebook-like-colorscheme',
__( 'Color scheme', 'facebook' ),
array( &$this, 'display_colorscheme' ),
$this->hook_suffix,
$section
);
}
/**
* Introduce publishers to the Like Button social plugin
*
* @since 1.1
*
* @return void
*/
public function section_header() {
echo '<p>' . esc_html( __( 'Help your visitors share your pages on their Facebook profile with one click.', 'facebook' ) ) . ' <a href="https://developers.facebook.com/docs/plugins/like-button/" title="' . esc_attr( sprintf( __( '%s social plugin documentation', 'facebook' ), 'Facebook ' . self::social_plugin_name() ) ) . '">' . esc_html( __( 'Read more...', 'facebook' ) ) . '</a></p>';
}
/**
* Where should the button appear?
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_show_on( $extra_attributes = array() ) {
$key = 'show_on';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-show-on',
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<fieldset id="' . $id . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo '>' . self::show_on_choices( $name, self::get_display_conditionals_by_feature( 'like', 'all' ), 'all' ) . '</fieldset>';
echo '<p class="description">' . esc_html( self::show_on_description( self::social_plugin_name() ) ) . '</p>';
}
/**
* Where would you like it?
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_position( $extra_attributes = array() ) {
$key = 'position';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<select name="' . esc_attr( $name ) . '" id="' . $id . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo '>' . self::position_choices( isset( $this->existing_options[$key] ) ? $this->existing_options[$key] : '' ) . '</select>';
}
/**
* Display the share button option checkbox.
*
* @since 1.5.4
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_share( $extra_attributes = array() ) {
$key = 'share';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<label><input type="checkbox" name="' . esc_attr( $name ) . '" id="' . $id . '" value="1"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
checked( isset( $this->existing_options[$key] ) );
echo ' /> ';
echo esc_html( sprintf( _x( 'Include a %1$s alongside the %2$s.', 'Include another social plugin alongside the current social plugin. Example: Share alongside Like', 'facebook' ), __( 'Share Button', 'facebook' ), self::social_plugin_name() ) ) . '</label>';
echo '<p class="description">' . esc_html( __( 'Allows a Facebook user to easily share your URL on a Facebook Timeline, Page, group, or in a Facebook Message.', 'facebook' ) ) . '</p>';
}
/**
* Describe layout choices.
*
* @since 1.1
*
* @return array layout descriptions keyed by layout choice
*/
public static function layout_descriptions() {
$like_plural = _x( 'likes', 'plural of the noun: Facebook Likes', 'facebook' );
return array(
'standard' => __( 'Display social text next to the button.', 'facebook' ),
'button_count' => sprintf( __( 'Display total number of %s next to the button.', 'facebook' ), $like_plural ),
'box_count' => sprintf( __( 'Display total number of %s above the button.', 'facebook' ), $like_plural )
);
}
/**
* Choose a Like Button layout option.
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_layout( $extra_attributes = array() ) {
$key = 'layout';
self::require_like_button_builder();
if ( isset( $this->existing_options[$key] ) && isset( Facebook_Like_Button::$layout_choices[ $this->existing_options[$key] ] ) )
$existing_value = $this->existing_options[$key];
else
$existing_value = 'standard';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
$name = esc_attr( $name );
$descriptions = self::layout_descriptions();
$layout_choices = array_keys( Facebook_Like_Button::$layout_choices );
$choices = array();
foreach( $layout_choices as $layout ) {
$choice = '<label><input type="radio" name="' . $name . '" value="' . $layout . '"';
$choice .= checked( $layout, $existing_value, false );
$choice .= ' /> ';
$choice .= $layout;
if ( isset( $descriptions[$layout] ) )
$choice .= esc_html( ' — ' . $descriptions[$layout] );
$choice .= '</label>';
$choices[] = $choice;
unset( $choice );
}
if ( ! empty( $choices ) ) {
echo '<fieldset id="' . $id . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo '><div>';
echo implode( '</div><div>', $choices );
echo '</div></fieldset>';
}
}
/**
* Option to display faces of friends below the Like Button
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_show_faces( $extra_attributes = array() ) {
$key = 'show_faces';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-show-faces',
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<label><input type="checkbox" name="' . esc_attr( $name ) . '" id="' . $id . '" value="1"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
checked( isset( $this->existing_options[$key] ) );
echo ' /> ' . esc_html( __( "Show profile photos of the viewer's friends who have already liked the URL.", 'facebook' ) ) . '</label>';
}
/**
* Allow the publisher to customize the width of the Like Button
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_width( $extra_attributes = array() ) {
global $content_width;
$key = 'width';
if ( isset( $this->existing_options[$key] ) )
$existing_value = absint( $this->existing_options[$key] );
else if ( isset( $content_width ) )
$existing_value = absint( $content_width );
if ( ! isset( $existing_value ) || $existing_value < 55 )
$existing_value = 450; // match social plugin config page default
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<input type="number" name="' . esc_attr( $name ) . '" id="' . $id . '" size="5" min="55" step="1" value="' . $existing_value . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo ' />';
if ( isset( $content_width ) && $name === self::OPTION_NAME . '[' . $key . ']' )
echo ' ' . esc_html( sprintf( __( 'Content width: %u', 'facebook' ), absint( $content_width ) ) );
echo '<p class="description">' . esc_html( sprintf( __( 'The width of the %s display area in whole pixels.', 'facebook' ), self::social_plugin_name() ) ) . '</p>';
}
/**
* Choose action text.
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_action( $extra_attributes = array() ) {
$key = 'action';
self::require_like_button_builder();
if ( isset( $this->existing_options[$key] ) && isset( Facebook_Like_Button::$action_choices[ $this->existing_options[$key] ] ) )
$existing_value = $this->existing_options[$key];
else
$existing_value = 'like';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
$name = esc_attr( $name );
$action_choices = array_keys( Facebook_Like_Button::$action_choices );
$fields = array();
foreach( $action_choices as $action ) {
$fields[] = '<label><input type="radio" name="' . $name . '" value="' . $action . '"' . checked( $action, $existing_value, false ) . ' /> ' . esc_html( __( $action, 'facebook' ) ) . '</label>';
}
echo '<fieldset id="' . $id . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo '>' . implode( ' ', $fields ) . '</fieldset>';
echo '<p class="description">' . esc_html( __( 'Action verb displayed in button.', 'facebook' ) ) . '</p>';
}
/**
* Choose a custom font.
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_font( $extra_attributes = array() ) {
$key = 'font';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<select name="' . esc_attr( $name ) . '" id="' . $id . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo '>' . self::font_choices( isset( $this->existing_options[$key] ) ? $this->existing_options[$key] : '' ) . '</select>';
}
/**
* Customize the color scheme.
*
* @since 1.1
*
* @param array $extra_attributes custom form attributes
* @return void
*/
public function display_colorscheme( $extra_attributes = array() ) {
$key = 'colorscheme';
extract( self::parse_form_field_attributes(
$extra_attributes,
array(
'id' => 'facebook-like-' . $key,
'class' => '',
'name' => self::OPTION_NAME . '[' . $key . ']'
)
) );
echo '<fieldset id="' . $id . '"';
if ( isset( $class ) && $class )
echo ' class="' . $class . '"';
echo '>' . self::color_scheme_choices( $name, isset( $this->existing_options[$key] ) ? $this->existing_options[$key] : '' ) . '</fieldset>';
}
/**
* Translate HTML data response returned from Facebook social plugin builder into underscored keys and PHP values before saving.
*
* @since 1.1
*
* @param array $options data-* options returned from Facebook social plugin builder
* @return array $options options to store in WordPress
*/
public static function html_data_to_options( $options ) {
if ( ! is_array( $options ) )
return array();
if ( isset( $options['share'] ) ) {
if ( $options['share'] === 'true' )
$options['share'] = true;
else if ( $options['share'] === 'false' )
$options['share'] = false;
}
if ( isset( $options['show-faces'] ) ) {
if ( $options['show-faces'] === 'true' )
$options['show_faces'] = true;
else if ( $options['show-faces'] === 'false' )
$options['show_faces'] = false;
unset( $options['show-faces'] );
}
if ( isset( $options['width'] ) )
$options['width'] = absint( $options['width'] );
return $options;
}
/**
* Sanitize Like Button settings before they are saved to the database.
*
* @since 1.1
*
* @param array $options Like Button options
* @return array clean option sets. note: we remove Like Button social plugin default options, storing only custom settings (e.g. dark color scheme stored, light is default and therefore not stored)
*/
public static function sanitize_options( $options ) {
if ( ! is_array( $options ) || empty( $options ) )
return array();
self::require_like_button_builder();
// Handle like button display preferences first
$clean_options = parent::sanitize_options( $options );
if ( isset( $clean_options['show_on'] ) ) {
self::update_display_conditionals( 'like', $clean_options['show_on'], self::get_show_on_choices( 'all' ) );
unset( $clean_options['show_on'] );
}
unset( $options['show_on'] );
foreach( array( 'share', 'show_faces' ) as $bool_option ) {
if ( isset( $options[ $bool_option ] ) )
$options[ $bool_option ] = true;
else
$options[ $bool_option ] = false;
}
if ( isset( $options['width'] ) )
$options['width'] = absint( $options['width'] );
$like_button = Facebook_Like_Button::fromArray( $options );
if ( $like_button ) {
$like_button->validate();
return array_merge( $clean_options, self::html_data_to_options( $like_button->toHTMLDataArray() ) );
}
return $clean_options;
}
}
?>