WordPress 플러그인 개발 환경 설정하기
WordPress 플러그인 개발을 시작하려면 먼저 전문적인 로컬 개발 환경을 설정해야 합니다. 이는 온라인 웹사이트에 영향을 미치지 않으면서 테스트를 실시할 수 있게 해주고, 개발 효율성을 대폭 향상시킵니다. 일반적인 개발 환경에는 XAMPP, MAMP 또는 Local by Flywheel 같은 로컬 서버 소프트웨어, VS Code 또는 PHPStorm 같은 코드 편집기, 그리고 깨끗한 WordPress 설치가 포함됩니다.
핵심 개발 파일은 특정 규칙에 따라 이름이 지정된 플러그인 주 파일입니다. 플러그인 주 파일은 일반적으로 PHP 파일입니다. 예를 들면, my-first-plugin.php이 파일에는 특정 플러그인 헤더 주석이 포함되어야 하며, WordPress는 이 정보를 읽어서 당신의 플러그인을 인식합니다. 가장 기본적인 플러그인 헤더 예시는 다음과 같습니다:
<?php
/**
* Plugin Name: 我的第一个插件
* Plugin URI: https://example.com/my-first-plugin
* Description: 这是一个简短的插件描述，用于在后台插件列表中显示。
* Version: 1.0.0
* Author: 你的名字
* Author URI: https://example.com
* License: GPL v2 or later
* Text Domain: my-first-plugin
*/위의 코드가 포함된 파일을 WordPress 설치 디렉토리 내의 /wp-content/plugins/ 폴더 내에서 워드프레스 관리 페이지의 “플러그인” 페이지로 이동하면, 당신의 플러그인을 볼 수 있고, 활성화할 수 있습니다. 비록 지금은 아무런 기능이 없지만, 이것은 개발 환경이 성공적으로 설정되었다는 표시입니다.
추천 읽기 WordPress 플러그인 개발을 마스터하세요: 제로에서 시작하여 첫 번째 커스텀 플러그인을 만들어 보세요.。
플러그인 디렉토리 구조를 이해하세요.
플러그인 기능이 복잡해질수록 모든 코드를 하나의 주 파일에 포함하는 것은 유지 보수가 어렵게 됩니다. 따라서, 분명한 파일 및 디렉토리 구조를 설정하는 것이 매우 중요합니다. 잘 구조화된 플러그인 디렉토리는 팀 간의 협동뿐만 아니라 향후 기능 확장에도 도움이 됩니다.
권장되는 중간 규모의 플러그인 디렉토리 구조는 다음과 같습니다:
- my-plugin/ (플러그인 루트 디렉터리)
- my-plugin.php (플러그인의 주 파일로, 가이드와 핵심 정의를 담당합니다)
- uninstall.php (플러그인을 제거할 때 실행되는 청소 스크립트)
- includes/ (핵심 기능 클래스나 함수 파일을 저장하는 곳)
- admin/ (백엔드 관리 인터페이스 관련 코드가 저장되어 있습니다.)
- public/ (사용자가 보는 코드를 저장하기 전에)
- assets/ (CSS, JavaScript, 이미지와 같은 정적 리소스를 저장하는 장소)
- languages/ (국제화된 번역 파일 .pot/.mo 저장)
메인 파일에서 my-plugin.php 일반적으로 당신은 플러그인 상수(예: 플러그인 경로와 URL)를 정의한 후 이를 사용합니다. require_once 필요에 따라 다른 디렉토리의 기능 파일을 포함시킵니다. 이러한 모듈화된 방식은 코드 관리를 간단하게 할 수 있게 해 줍니다.
플러그인의 핵심 메커니즘: 후크와 필터
워드프레스 플러그인 개발의 핵심 철학은 “후크(Hooks)”입니다. 후크 메커니즘을 통해 워드프레스 코어 코드를 수정하지 않고도 특정 시점에 자신만의 코드를 추가하거나 다른 함수의 출력 데이터를 수정할 수 있습니다. 후크는 주로 두 가지 유형으로 나뉩니다. 액션(Action)과 필터(Filter)입니다.
액션 후크는 특정 이벤트가 발생할 때 사용자 정의 함수를 실행할 수 있게 해 줍니다. 예를 들어, 글이 게시되거나, 사용자가 로그인하거나, 백그라운드 메뉴가 로드되는 경우와 같습니다. add_action() 함수는 당신의 콜백 함수를 지정된 이벤트 후크에 연결할 수 있습니다.
추천 읽기 워드프레스 플러그인 개발 마스터하기: 첫 번째 확장 기능 모듈을 0부터 만들어보세요.。
필터 후크는 데이터를 수정할 수 있게 해 줍니다. WordPress의 처리 과정에서, 데이터(예: 글의 내용, 제목, 요약)는 데이터베이스나 브라우저에 출력되기 전에 여러 필터를 거칩니다. 당신은 이러한 필터를 사용할 수 있습니다. add_filter() 이 데이터를 수정하는 함수.
액션 후크를 추가하는 방법
각 글의 끝에 자동으로 저작권 문구를 추가하려고 가정해 보자. 이는 글의 내용이 렌더링된 후에 작업을 수행해야 하며, 더 정확히 말하자면 글의 내용을 수정해야 하기 때문에, 필터를 사용하는 것이 더 적합할 것입니다. 그러나, 작업 후크를 보여주기 위해 글이 게시되면 관리자에게 이메일을 보내보자고 생각해 봅시다.
먼저, 예를 들어 콜백 함수를 만들어야 합니다. myplugin_notify_admin_on_publish그런 다음, 사용하세요. add_action() 함수는 그것을 매핑합니다. publish_post 이 동작에서.
function myplugin_notify_admin_on_publish( $post_id, $post ) {
// 获取管理员邮箱
$admin_email = get_option( 'admin_email' );
$subject = '新文章已发布：' . $post->post_title;
$message = '您网站上的文章“' . $post->post_title . '”刚刚被发布。';
// 发送邮件
wp_mail( $admin_email, $subject, $message );
}
// 将函数挂载到 publish_post 动作钩子，优先级为10，接受2个参数
add_action( 'publish_post', 'myplugin_notify_admin_on_publish', 10, 2 );필터 후크를 추가하는 방법
자, 이제 우리는 원래 목표를 달성할 것입니다. 기사 내용의 끝에 저작권 정보를 추가하는 것입니다. 여기서는 필터가 필요합니다. the_content 이 데이터.
함수 myplugin_add_copyright_to_content( $content ) {
// 웹사이트의 전면 페이지인 단일 게시물 페이지에서만 실행되도록 하십시오.
if ( is_single() && in_the_loop() && is_main_query() ) {
$copyright_text = '<p><em>이 글의 저작권은 본 사이트에 있습니다. 재발행할 경우 출처를 명시해 주시기 바랍니다.</em></p>'만일 특정 게시물에 저작권 표시가 추가되어야 한다면, 다음과 같이 함수를 정의하고 필터에 추가하십시오.
function myplugin_add_copyright_to_content( $content ) {
if ( has_tags( $content, 'my_tag' ) ) {
$content .= '\n';
$content .= $copyright_text;
}
return $content; // 수정된 내용을 반드시 반환해야 합니다.
}
add_filter( 'the_content', 'myplugin_add_copyright_to_content' );후크를 이해하고 능숙하게 사용하는 것은 WordPress의 무한한 사용자 정화 기능을 해제하는 열쇠입니다.
플러그인 관리 백엔드 페이지를 만들기
많은 플러그인은 사용자에게 구성 옵션을 제공해야 하며, 이는 일반적으로 WordPress 관리 패널의 관리 메뉴 페이지를 통해 이루어집니다. WordPress는 최상위 메뉴 또는 하위 메뉴 항목을 추가하고 해당 설정 페이지를 렌더링하는 일련의 함수를 제공합니다.
추천 읽기 워드프레스 플러그인 개발을 처음부터 배우기: 첫 번째 사용자 정의 기능을 구축하기。
최고 관리 메뉴를 추가하세요.
활용 add_menu_page() 함수는 당신의 플러그인을 위한 별도의 백그라운드 메뉴 항목을 만들 수 있습니다. 이 함수는 페이지 타이틀, 메뉴 타이틀, 사용자 권한, 메뉴 별명, 콜백 함수 등을 포함한 여러 매개변수를 필요로 합니다.
아래 코드는 간단한 최상위 메뉴 페이지를 추가하는 방법을 보여줍니다.
함수 myplugin_add_admin_menu() {
add_menu_page(
'내 플러그인 설정', // 페이지 타이틀
'내 플러그인', // 메뉴 타이틀
'manage_options', // 필요한 권한(관리자)
'myplugin-settings', // 메뉴 별명(slug)
'myplugin_render_settings_page', // 페이지 내용을 표시하는 콜백 함수
'dashicons-admin-generic', // 아이콘(Dashicons 사용)
30 // 메뉴 위치
);
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );
// 설정 페이지를 렌더링하는 콜백 함수
function myplugin_render_settings_page() {
?>
<div class="wrap">
<h1></h1>
<form action="/ko/options.php/" method="post" data-trp-original-action="options.php">
<input type="hidden" name="trp-form-language" value="ko"/></form>
</div>
<?php
}페이지를 만드는 것만으로는 부족합니다. 일반적으로 페이지에 저장할 수 있는 설정 필드를 추가해야 합니다. 이는 WordPress의 설정 API(Settings API)와 함께 사용되어야 하며, 이 애플리케이션은 옵션의 등록, 인증 및 저장을 안전하게 처리할 수 있습니다.
설정 API를 사용하여 등록 옵션을 등록합니다.
설정 API는 입력 상자, 체크박스 등의 필드를 포함하는 양식을 만들고 자동으로 WordPress에 데이터를 저장할 수 있는 표준적이고 안전한 방법을 제공합니다. wp_options 데이터 시트에서.
먼저, 설정 옵션을 등록한 다음 설정 영역과 필드를 추가해야 합니다.
function myplugin_settings_init() {
// 注册一个新设置项 “myplugin_options”
register_setting(
'myplugin_options', // 选项组名
'myplugin_settings', // 存储在wp_options表中的option_name
'myplugin_sanitize_callback' // 可选的清理回调函数
);
// 在页面 “myplugin-settings” 上添加一个区域
add_settings_section(
'myplugin_section_general',
'通用设置',
'myplugin_section_general_callback',
'myplugin-settings'
);
// 向该区域添加一个字段
add_settings_field(
'myplugin_field_footer_text',
'页脚文本',
'myplugin_field_footer_text_callback',
'myplugin-settings',
'myplugin_section_general',
[ 'label_for' => 'myplugin_field_footer_text' ]
);
}
add_action( 'admin_init', 'myplugin_settings_init' );
// 字段渲染回调函数
function myplugin_field_footer_text_callback() {
$options = get_option( 'myplugin_settings' );
$value = $options['footer_text'] ?? ''; // PHP 7.0+ 空合并运算符
echo '<input type="text" id="myplugin_field_footer_text" name="myplugin_settings[footer_text]" value="' . esc_attr( $value ) . '" class="regular-text" />';
}이러한 방식으로 만들어진 백그라운드 페이지는 데이터 검증, 저장 및 보안 측면에서 워드프레스 코어에 의해 보호되며, 플러그인 관리 인터페이스를 개발할 때 최고의 방법으로 사용할 수 있습니다.
플러그인 보안 및 최고 실천 방법
인기 있는 플러그인을 개발할 때는 기능이 강력할 뿐만 아니라 안전하고, 효율적이며 유지 보수하기 쉽게 만들어야 합니다. 보안 코딩 표준을 준수하는 것은 사용자 웹사이트를 공격으로부터 보호하는 주요 책임입니다.
데이터 검증, 정리 및 이스케이피(Data Validation, Cleaning, and Escaping)
이것은 WordPress 보안의 3개의 방어선입니다. 간단히 말해 확인(Validation)은 입력 데이터가 예상된 형식(예: 이메일 주소)에 따르는지 여부를 확인하고, 정리(Sanitization)는 데이터가 데이터베이스에 저장되기 전에 비정상적이거나 불법적인 부분을 제거하며, 이스케이핑(Escaping)은 데이터가 브라우저(HTML, JavaScript, URL)에 출력되는 동안 실행 가능한 코드로 오해되지 않도록 합니다.
- 검증: 다음과 같은 함수를 사용하여
is_email(),absint()。 - 정리: 함수를 사용하여
sanitize_text_field(),sanitize_email(),wp_kses_post()(일부 HTML 내용을 허용하기 위한 용도). - 에스케이프: 함수를 사용하여
esc_html()（HTML 요소 내에 출력되어서）,esc_url()（URL 속성으로 출력）,esc_attr()（HTML 속성 내에 출력되어야 합니다）,wp_kses()(선택적으로 에스케이프 처리).
절대로 사용자의 입력을 신뢰하지 마십시오. 데이터를 받을 때(예: 사용자로부터 받을 때)에는 항상 주의를 기울여야 합니다. $_POST 또는 $_GET정리가 필요하며, 출력 데이터를 만들 때는 에스케이프가 필요합니다.
안전한 AJAX 엔드포인트 구현
AJAX 기능은 플러그인에서 매우 흔합니다. WordPress는 이를 제공합니다. wp_ajax_{action} 그리고 wp_ajax_nopriv_{action} 후크는 AJAX 요청을 처리합니다. 보안의 핵심은 권한(nonce) 및 사용자 능력을 확인하는 것입니다.
// 为登录用户添加AJAX处理
add_action( 'wp_ajax_myplugin_action', 'myplugin_handle_ajax_request' );
// 如果希望未登录用户也能访问，则需额外添加（慎用）
// add_action( 'wp_ajax_nopriv_myplugin_action', 'myplugin_handle_ajax_request' );
function myplugin_handle_ajax_request() {
// 1. 检查Nonce（防止跨站请求伪造）
check_ajax_referer( 'myplugin_secure_nonce', 'security' );
// 2. 检查用户权限（例如，只有管理员才能执行此操作）
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( '权限不足', 403 );
}
// 3. 获取并清理输入数据
$some_data = sanitize_text_field( $_POST['some_data'] ?? '' );
// 4. 处理业务逻辑...
$result = [ 'success' => true, 'message' => '处理成功' ];
// 5. 返回JSON响应
wp_send_json( $result );
}프론트엔드 자바스크립트에서 요청을 보낼 때에는 nonce를 전달해야 합니다. wp_localize_script 전달하세요.
플러그인 국제화 준비
당신의 플러그인을 전 세계의 사용자들이 사용할 수 있도록 하려면 국제화(i18n)를 준비해야 합니다. 이는 사용자가 보는 모든 문자열을 코드에 직접 포함시키지 않고 WordPress의 번역 함수로 감싸야 한다는 것을 의미합니다.
가장 많이 사용되는 함수는 __()(번역된 문자열을 받기) 그리고 _e()(출력된 번역된 문자열). 당신은 플러그인 헤더에서 정의해야 합니다. Text Domain그리고 코드에서 그것을 일관되게 사용하십시오.
// 在插件主文件头部已定义：Text Domain: my-first-plugin
// 在代码中使用
$greeting = __( 'Hello, world!', 'my-first-plugin' );
_e( 'This text will be echoed and translatable.', 'my-first-plugin' );그런 다음 Poedit 같은 도구를 사용하여 번역을 생성할 수 있습니다. .pot 템플릿 파일을 통해 번역자는 다양한 언어로 콘텐츠를 생성할 수 있습니다. .mo 문서. 번역된 문서는 플러그인의 /languages/ 카테고리 아래에서, WordPress는 웹사이트의 언어 설정에 따라 해당하는 번역을 자동으로 로드할 것입니다.
요약
WordPress 플러그인 개발은 창의력을 기능으로 바꾸는 과정이며, 이 과정의 기초는 후크 메커니즘을 이해하고, 보안 표준을 준수하며, 모듈식 코드 구조를 채택하는 것입니다. 환경 설정부터 첫 번째 주요 파일 작성, 액션 및 필터 후크를 통한 WordPress 핵심 기능의 심층 통합, 전문적인 관리 인터페이스 제작에 이르기까지, 각 단계마다 개발자의 전문성이 드러납니다. 보안은 플러그인의 생명선이며, 데이터 검증, 정리, 에스케이프 처리, 그리고 안전한 AJAX 구현은 반드시 준수해야 하는 표준입니다. 마지막으로, 국제화 준비를 통해 당신의 플러그인은 전 세계의 사용자들을 위해 서비스를 제공할 수 있습니다. 이러한 핵심 기술을 습득하면, 고품질의 WordPress 플러그인을 처음부터 개발할 수 있는 능력을 습득하게 됩니다.
자주 묻는 질문
WordPress 플러그인을 개발하려면 어떤 기초 지식이 필요한가요?
WordPress 플러그인을 개발하려면 플러그인 核心 로직이 PHP로 작성되기 때문에 PHP 프로그래밍 언어에 대한 기본 지식이 필요합니다. 또한, 프런트엔드 인터페이스와 상호 작용을 구축하는 데 사용되는 HTML, CSS 및 JavaScript에 대한 기본 지식이 필요합니다. 가장 중요한 점은 워드프레스의 기본 아키텍처, 특히 액션(Actions)과 필터(Filters)를 포함하는 후크(Hooks) 시스템을 이해해야 합니다. 이는 플러그인이 워드프레스와 상호 작용하는 주요 방법입니다.
내 WordPress 플러그인을 어떻게 디버깅하나요?
WP_DEBUG 모드를 사용하는 것이 좋습니다. WordPress 루트 디렉토리에서 wp-config.php 파일 내에서, 해당 내용을 처리할 것입니다. define( 'WP_DEBUG', false ); 로 변경 define( 'WP_DEBUG', true );이것은 PHP 오류 및 경고를 화면에 표시하고 로그에 기록합니다. /wp-content/debug.log 동시에, 데이터베이스 질의, 후크 실행 및 성능 병목 현상을 심층적으로 분석하려면 쿼리 모니터(Query Monitor)와 같은 질의 모니터링 플러그인을 설치할 수 있습니다. 브라우저의 개발자 도구(Console, Network)도 JavaScript 및 AJAX 요청을 디버그하는 데 매우 중요합니다.
제 플러그인은 테마나 다른 플러그인과 어떻게 호환되나요?
최대한 호환성을 보장하려면, WordPress 코딩 표준 및 최고 실천을 준수해야 합니다. 다른 코드와 이름 충돌을 방지하기 위해 플러그인별로 함수 이름이나 클래스 이름을 사용하십시오. 글로벌 변수를 신중하게 사용하십시오. 사용자 정의 데이터베이스 테이블을 추가할 때에도 테이블 이름에 접두사를 사용하십시오. 다른 개발자들이 확장할 수 있는 기능의 경우, 자체 후크를 제공하십시오. 글로벌 데이터(예: 질문 변수)를 수정하기 전에 먼저 상태를 확인하고 수정 후에는 원상태로 되돌리십시오. 다른 테마나 플러그인과의 테스트는 호환성을 보장하는 데 필수적입니다.
개발이 완료된 후 이 플러그인을 워드프레스 공식 디렉토리에 어떻게 게시할 수 있습니까?
우선, 당신은 플러그인이 공식 플러그인 개발 가이드라인과 코드 표준에 완전히 준수하는지 확인해야 합니다. WordPress.org에서 계정을 신청하고 플러그인을 제출해야 합니다. 플러그인 코드는 SVN 저장소에 호스팅되어야 하며, 상세한 Readme.txt 파일(특정 형식을 사용해야 합니다)을 제공해야 합니다. 플러그인은 공식 코드 검토를 통해 안전성, 코드 품질, 코드 주석(DocBlock 스타일 사용 필요) 및 악성 코드 여부에 대해 검사되어야 합니다. 성공적으로 제출된 후에는 SVN을 통해 플러그인 버전을 업데이트 및 유지할 수 있습니다.
다음 단계는 무엇인가요?
확장된 독서 및 실무 지식
다음은 이 도움말의 주제와 관련이 있으며 더 깊이 있게 읽기에 적합합니다. 현재 문제와 가장 가까운 문서부터 시작하여 점차 주변 주제로 확장하는 것이 우선순위를 정하는 것이 좋습니다.
한국어