README

从 Twitter API 获取推文的辅助库。

安装

该库作为 Composer 包提供。您可以使用以下命令将其包含到您的项目中：

composer require htmlburger/carbon-twitter

使用方法

use Carbon_Twitter\Carbon_Twitter;

Carbon_Twitter::config( array(
  'api' => array(
    'access_token'        => '',
    'access_token_secret' => '',
    'consumer_key'        => '',
    'consumer_secret'     => '',
  ),
  'cache_lifetime'   => 300,
  'verbose'          => false,
  'cache_candidates' => [ 'WordPress', 'File' ],
) );

$tweets = Carbon_Twitter::get_tweets( 'wordpress', 5 );

foreach ( $tweets as $tweet ) {
  echo $tweet->text;
}

或使用辅助函数

carbon_twitter_set_config( array(
  'api' => array(
    'access_token'        => '',
    'access_token_secret' => '',
    'consumer_key'        => '',
    'consumer_secret'     => '',
  ),
  'cache_lifetime'   => 300,
  'verbose'          => false,
  'cache_drivers'    => [ 'WordPress', 'File' ],
) );

$tweets = carbon_twitter_get_tweets( 'wordpress', 5 );

foreach ( $tweets as $tweet ) {
  echo $tweet->text;
}

配置参数

api (数组) - 必需

api 参数包含 4 个元素的数组

• access_token
• access_token_secret
• consumer_key
• consumer_secret

cache_lifetime (整数) - 可选

以秒为单位定义的缓存持续时间。默认为 300 秒（5 分钟）

verbose (布尔值) - 可选

是否启用详细模式。默认为 false。

cache_drivers (数组) - 可选

要使用的缓存驱动程序数组。使用项目中支持的第一个驱动程序。默认为 array( 'WordPress', 'File' )

在 WordPress 环境中

一旦库安装到您的 WordPress 项目中，即可获得以下功能：

• 注册了 Carbon_Twitter_Feed 小部件
• 注册了新的 Carbon 容器 - Twitter 设置

有多个钩子可以使用，以自定义功能

Carbon_Twitter_Feed_Widget

carbon_twitter_widget_id

允许您修改小部件 ID。

apply_filters( 'carbon_twitter_widget_id', 'carbon_twitter_feed_widget' );

carbon_twitter_widget_title

允许您修改默认小部件标题。

apply_filters( 'carbon_twitter_widget_title', __( 'Carbon Twitter Feed', 'carbon-twitter' ) )

carbon_twitter_widget_description

允许您修改默认小部件描述。

apply_filters( 'carbon_twitter_widget_description', __( 'Displays a Twitter Feed.', 'carbon-twitter' ) )

carbon_twitter_widget_fields

允许您修改默认小部件字段数组。

apply_filters( 'carbon_twitter_widget_fields', array(
  Field::make( 'text', 'title', __( 'Title', 'carbon-twitter' ) ),
  Field::make( 'text', 'twitter_username', __( 'Twitter Username', 'carbon-twitter' ) ),
  Field::make( 'text', 'count_tweets', __( 'Number of Tweets to Display', 'carbon-twitter' ) )
    ->set_default_value( 5 ),
) )

carbon_twitter_widget_classes

允许您修改添加到小部件中的 CSS 类。

apply_filters( 'carbon_twitter_widget_classes', 'carbon-twitter-feed' )

Twitter 设置 Carbon 容器

carbon_twitter_settings_title

允许您更改 Twitter 设置 Carbon 容器的标题。

apply_filters( 'carbon_twitter_settings_title', __( 'Twitter Settings', 'carbon-twitter' ) )

carbon_twitter_settings_page_parent

允许您更改 Twitter 设置 Carbon 容器的页面父级。

apply_filters( 'carbon_twitter_settings_page_parent', 'crbn-theme-options.php' )

carbon_twitter_settings_custom_help_text

允许您修改 Twitter 设置 Carbon 容器的帮助文本。

carbon_twitter_settings_fields

允许您修改 Twitter 设置 Carbon 容器中的默认字段。

apply_filters( 'carbon_twitter_settings_fields', array(
    Field::make( 'html', 'carbon_twitter_settings_html' )
      ->set_html( carbon_twitter_get_options_help_text() ),
    Field::make( 'text', 'carbon_twitter_consumer_key', __( 'Consumer Key', 'carbon-twitter' ) ),
    Field::make( 'text', 'carbon_twitter_consumer_secret', __( 'Consumer Secret', 'carbon-twitter' ) ),
    Field::make( 'text', 'carbon_twitter_access_token', __( 'Access Token', 'carbon-twitter' ) ),
    Field::make( 'text', 'carbon_twitter_access_token_secret', __( 'Access Token Secret', 'carbon-twitter' ) ),
  ) )