GitHub Flavored Markdown for WordPress 插件使用教程

32 0 0

GitHub Flavored Markdown for WordPress 插件使用教程

wp-gfmWordPress Plugin for PHP-Markdown and GitHub Flavored Markdown项目地址:https://gitcode.com/gh_mirrors/wp/wp-gfm

1. 项目的目录结构及介绍

wp-gfm/ ├── wp-gfm.php ├── README.md ├── LICENSE ├── assets/ │ ├── css/ │ ├── js/ │ └── images/ ├── includes/ │ ├── class-wp-gfm.php │ ├── class-wp-gfm-admin.php │ └── class-wp-gfm-shortcode.php ├── languages/ │ └── wp-gfm.pot └── vendor/ └── composer/

wp-gfm.php: 插件的主文件，包含插件的基本信息和初始化代码。
README.md: 项目的说明文档。
LICENSE: 项目的许可证文件。
assets/: 包含插件所需的CSS、JS和图片资源。
includes/: 包含插件的核心类文件。
- class-wp-gfm.php: 主类文件，负责插件的主要功能。
- class-wp-gfm-admin.php: 管理后台类文件，负责管理后台的设置和功能。
- class-wp-gfm-shortcode.php: 短代码类文件，负责处理短代码的解析和渲染。
languages/: 包含插件的语言文件。
vendor/: 包含通过Composer管理的第三方依赖库。

2. 项目的启动文件介绍

wp-gfm.php 是插件的启动文件，主要负责插件的初始化和注册。以下是该文件的关键部分代码：


<?php
/**
 * Plugin Name: GitHub Flavored Markdown for WordPress
 * Plugin URI: https://github.com/makotokw/wp-gfm
 * Version: 0.11
 * Description: Converts block in GitHub Flavored Markdown by using shortcode [gfm] and support PHP-Markdown by using shortcode [markdown]
 * Author: makoto_kw
 * Author URI: http://makotokw.com/
 * License: MIT
 */
 
require_once __DIR__ . '/includes/class-wp-gfm.php';
 
function wp_gfm_init() {
    $wp_gfm = WP_GFM::get_instance();
    $wp_gfm->init();
}
add_action('plugins_loaded', 'wp_gfm_init');

require_once __DIR__ . '/includes/class-wp-gfm.php';: 引入主类文件。
function wp_gfm_init(): 初始化插件的主类实例并调用其 init 方法。
add_action('plugins_loaded', 'wp_gfm_init');: 在 WordPress 加载插件时执行初始化函数。

3. 项目的配置文件介绍

插件的配置主要通过管理后台进行设置。以下是配置文件的关键部分代码：


class WP_GFM_Admin {
    private $gfm_options;
 
    public function __construct() {
        add_action('admin_menu', array($this, 'add_plugin_page'));
        add_action('admin_init', array($this, 'page_init'));
    }
 
    public function add_plugin_page() {
        add_options_page(
            'GitHub Flavored Markdown Settings', // 页面标题
            'GitHub Flavored Markdown', // 菜单标题
            'manage_options', // 权限
            'wp-gfm', // 菜单slug
            array($this, 'create_admin_page') // 回调函数
        );
    }
 
    public function page_init() {
        register_setting(
            'gfm_option_group', // 选项组
            'gfm_array', // 选项名称
            array($this, 'sanitize') // 消毒回调
        );
 
        add_settings_section(
            'setting_section_id', // ID
            'General Settings', // 标题
            array($this, 'print_section_info'), // 回调
            'wp-gfm' // 页面
        );
 
        add_settings_field(
            'general_ad', // ID
            'Add a link of wp-gfm plugin to content', // 标题
            array($this