WordPress 강화: 향상된 API 및 라이브러리 구축

웹사이트, 전화, 지하철 노선도 등 우리가 접하는 모든 것이 세심하게 디자인된 것 같은 느낌이 듭니다. 온도 조절기, 연기 감지기, 자동차 대시보드 등 우리가 당연하게 여겼던 것들도 이제 세심한 사용자 경험 처리를 받습니다.

디자인은 단순한 모양과 느낌 그 이상입니다. 또한 사용자가 장치/도구/화면/개체와 상호 작용하는 데 필요한 다양한 방식을 고려해야 합니다.

이것은 프로그래밍에도 적용됩니다.

(비)디자인의 프로그래밍

프로그래밍 언어는 크고 복잡한 세계입니다. 많은 프로그래밍 속물들이 너무 "단순하다"고 생각하는 PHP조차도 실제로는 매우 일관되지 않은 방식으로 작동하는 함수와 클래스의 상당히 복잡한 조합입니다.

구문, 방법 및 명명법은 수백만 명의 다양한 사용자와 애플리케이션에서 수년에 걸쳐 발전해 왔습니다. 대부분은 내부의 기본 구성을 반영하는 경향이 있지만 반드시 사용하려는 방식은 아닙니다.

API 디자인의 멋진 순간: jQuery

​​>

2006년쯤에 JavaScript를 작성하기 시작했을 때는 상황이 엉망이었습니다. 특정 클래스가 포함된 태그를 찾아 DOM에서 이동하는 방법은 다음과 같습니다.

으아악

완료!

jQuery는 JavaScript를 다시 재미있게 만듭니다. 2000년대 후반에는 그 영향이 너무 커서 아버지가 월스트리트저널에서 읽은 “뭔가 이상한 것”에 관해 나에게 물으셨던 기억이 난다. 그러나 엄청난 효과에도 불구하고 jQuery는 JavaScript에 "새로운 기능"을 추가하지 않습니다. 개발자가 해야 할 일을 매우 명확한 패턴으로 분류합니다.

페이지에서 콘텐츠를 찾는 방법을 재발명하는 대신 사람들이 이미 알고 있는 CSS 선택기를 활용했습니다. 그러면 일반적인 작업을 모아서 수십 가지 기능으로 구성하기만 하면 됩니다. 이제 jQuery를 사용하여 이전 예제를 다시 시도해 보겠습니다.

으아악

2006년에 680페이지짜리 Ajax 책을 샀어요. jQuery의 멋진 API를 사용하면 거의 다음으로 대체됩니다.

으아악

워드프레스 API

API는 "타사 서비스"를 의미하지만 이는 단순히 시스템과 통신하는 프로그래밍 인터페이스를 의미합니다. Twitter API나 Facebook API와 마찬가지로 WordPress API도 존재합니다. 게시물을 작성하기 위해 원시 데이터베이스 쿼리를 수행하지는 않을 것입니다. 그렇죠? wp_insert_post를 사용합니다.

그러나 WordPress API에는 많은 디자인 허점이 있습니다. get_the_title 但 get_the_permalink 会生成错误，您使用 get_permalink 를 사용할 수도 있습니다. 안녕하세요, 수천 명의 코드와 수백만 명의 사용자가 관련된 수십 년간의 오픈 소스 프로젝트를 운영한다면 몇 가지 문제에 직면하게 될 것입니다.

이러한 단점을 가리고 글을 쓰는 프로그래머(아마도 여러분)의 습관과 행동에 따라 글을 작성하면 많은 시간을 절약할 수 있습니다. 여기서는 매일 사용하는 플러그인과 테마를 프로그래밍하는 데 적합한 인터페이스를 디자인할 수 있습니다.

---

솔루션

작업 속도를 높이고 반복 작업을 줄이기 위해 항상 필요한 명령과 사용자 정의를 처리하는 라이브러리를 만들었습니다.

1. 일반적인 작업 바로가기

게시물의 썸네일 소스를 예로 들어보세요. WordPress에는 게시물 ID(첨부 파일 ID만)를 기반으로 썸네일을 가져오는 기능이 내장되어 있지 않은 것으로 나타났습니다.

이것은 내가 종종 다음과 같은 일을 한다는 것을 의미합니다:

으아악

하지만 더 좋은 방법이 있을 거예요!

으아악

2: 예측할 수 없는 입력, 예측 가능한 출력

훨씬 좋아졌어요! 사실, 당신은 그것을 항상 사용하고 회사의 다른 개발자들과 공유하는 자신을 발견하게 됩니다.

친구가 곤경에 처해 디버깅을 요청하면 다음과 같은 내용이 표시됩니다.

으아악

실수로 get_post 而不是 get_the_ID를 사용한 것 같습니다. 당신은 그에게 소리를 질렀습니다. 하지만 잠깐만요, 왜 좀 더 수용 가능하게 만들면 안 될까요?

아마도 WP_Post객체를 받아 사용자가 기대하는 바를 제공할 수 있도록 함수를 조정할 수 있을 것입니다. 함수로 돌아가 보겠습니다:

으아악

그러므로 상대방이 WP_Post 对象或一个数组，您的函数仍然可以帮助他们获得所需的内容。这是成功 API 的重要组成部分：隐藏混乱的内部结构。您可以为 get_thumbnail_src_by_post_id 和 get_thumbnail_src_by_wp_post_object.객체

또는

배열을 보내더라도 귀하의 함수는 그들이 필요한 것을 얻는 데 도움이 될 수 있습니다. 이는 성공적인 API의 중요한 부분입니다. 지저분한 내부를 숨기는 것입니다. get_thumbnail_src_by_post_id 및 get_thumbnail_src_by_wp_post_object.에 대해 별도의 함수를 만들 수 있습니다.

실제로 더 복잡한 변환에는 더 나을 수도 있지만 개별 기능을 올바른 서브루틴으로 라우팅하여 인터페이스를 단순화할 수 있습니다. 사용자가 무엇을 보내든 이 함수는 항상 이미지 소스의 문자열을 반환합니다.

🎜다음으로 넘어가겠습니다. 아무 것도 보내지 않으면 어떻게 되나요? 🎜

3。合理的默认值

function get_thumbnail_src( $post = false ) {

    if (  false === $post ) {
        $post = get_the_ID();
    } else if ( is_object( $post ) && isset( $post->ID ) ) {
        $post = $post->ID;
    } else if ( is_array( $post ) && isset( $post['ID'] ) ) {
        $post = $post['ID'];
    }
    
    $thumb_id = get_post_thumbnail_id( $post );
    $src = wp_get_attachment_thumb_url( $thumb_id );
    
    return $src;
    
}

我们再次进行了简化，因此用户无需发送帖子，甚至无需发送帖子 ID。在循环中时，所需要做的就是：

echo '<img  src="/static/imghwm/default1.png"  data-src="'.get_thumbnail_src().'"  class="lazy".get_thumbnail_src().'" / alt="WordPress 강화: 향상된 API 및 라이브러리 구축" >';

我们的函数将默认为当前帖子的 ID。这正在变成一个非常有价值的功能。为了确保它能很好地发挥作用，让我们将它包装在一个类中，这样它就不会污染全局命名空间。

/*
Plugin Name: JaredTools
Description: My toolbox for WordPress themes.
Author: Jared Novack
Version: 0.1
Author URI: http://upstatement.com/
*/

class JaredsTools {

    public static function get_thumbnail_src( $post = false ) {
    
        if (false === $post ) {
            $post = get_the_ID();
        } else if ( is_object( $post ) && isset( $post->ID ) ) {
            $post = $post->ID;
        } else if ( is_array( $post ) && isset( $post['ID'] ) ) {
            $post = $post['ID'];
        }
        
        $thumb_id = get_post_thumbnail_id( $post );
        $src = wp_get_attachment_thumb_url( $thumb_id );
        
        return $src;
        
    }
    
}

并且请不要在您的类前面添加 WP。我将其设为公共静态函数，因为我希望它可以在任何地方访问，并且它不会改变：输入或执行不会更改函数或对象。

该函数的最终调用是：

echo '<img  src="/static/imghwm/default1.png"  data-src="'.JaredsTools::get_thumbnail_src().'"  class="lazy".JaredsTools::get_thumbnail_src().'" alt="WordPress 강화: 향상된 API 및 라이브러리 구축" >';

先设计，后构建

让我们继续处理更复杂的需求。当我编写插件时，我发现我总是需要生成不同类型的错误和/或更新消息。

但是基于事件的语法一直困扰着我：

add_action( 'admin_notices', 'show_my_notice');
functon show_my_notice(){
    echo '<div class="updated"><p>Your thing has been updated</p></div>';
}

WordPress 遵循这种基于事件的架构有很多充分的理由。但这并不直观，除非您想坐下来记住不同的过滤器和操作。

让我们将此匹配作为最简单的用例：我需要显示管理员通知。我喜欢首先设计这个 API：我找出在代码中引用该函数的最佳方式。我希望它读起来像这样：

function thing_that_happens_in_my_plugin($post_id, $value){
    $updated = update_post_meta($post_id, $value);
    if ($updated){
        JaredsTools::show_admin_notice("Your thing has been updated")
    } else {
        JaredsTools::show_admin_notice("Error updating your thing", "error");
    }
}

一旦我设计了端点，我就可以满足设计要求：

class JaredsTools {
    public static function show_admin_notice($message, $class = 'updated'){
        add_action('admin_notices', function() use ($message, $class){
            echo '<div class="'.$class.'"><p>'.$message.'</p></div>';
        });
    }
}

好多了！现在我不需要创建所有这些额外的函数或记住疯狂的钩子名称。在这里，我使用 PHP 匿名函数（也称为“闭包”），它让我们可以将函数直接绑定到操作或过滤器。

这可以让您避免在文件中出现大量额外的函数。 use 命令让我们将参数从父函数传递到子闭包中。

保持直觉

现在另一位同事打电话给您。她不知道为什么她的管理通知没有变成红色：

JaredsTools::show_admin_notice("Error updating your thing", "red");

这是因为她正在发送“红色”（她希望将盒子变成红色），而实际上她应该发送触发红色的类名称。但为什么不让它变得更容易呢？

public static function show_notice( $message, $class = 'updated' ) {

    $class = trim( strtolower( $class ) );
    if ( 'yellow' == $class ) {
        $class = 'updated';
    }
    
    if ('red' == $class ) {
        $class = 'error';
    }
    
    add_action( 'admin_notices', function() use ( $text, $class ) {
        echo '<div class="'.$class.'"><p>' . $text . '</p></div>';
    });
}

我们现在已经接受了更多的用户容忍度，这将使我们在几个月后回来使用它时更容易分享。

---

结论

在构建了其中一些之后，以下是我学到的一些原则，这些原则使这些原则对我和我的团队真正有用。

1.首先进行设计，让函数的构建符合人们想要使用它的方式。

2. 拯救你的键盘！为常见任务创建快捷方式。

3. 提供合理的默认值。

4. 保持最小化。让您的库来处理处理。

5. 对输入要宽容，对输出要精确。

6. 也就是说，使用尽可能少的函数参数，最多四个是一个很好的参数。之后，您应该将其设为选项数组。

7. 将您的库组织成单独的类，以涵盖不同的领域（管理、图像、自定义帖子等）。

8. 包含示例代码的文档。

在 Upstatement，我们的 Timber 库使构建主题变得更加容易，而 Jigsaw 提供了节省时间的快捷方式来自定义每个安装。

这些工具节省的时间让我们可以花更多时间构建每个网站或应用程序的新的和创新的部分。通过执行深奥的命令（例如向管理帖子表添加一列）并制作简单的界面：我们公司的任何设计师或开发人员都可以使用与专业 WordPress 开发人员相同的能力完全自定义每个网站。

위 내용은 WordPress 강화: 향상된 API 및 라이브러리 구축의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!